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 "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #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"
49 #include "output_docbook.h"
51 #include "output_latex.h"
52 #include "output_xhtml.h"
53 #include "output_plaintext.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"
72 #include "insets/InsetBibtex.h"
73 #include "insets/InsetBranch.h"
74 #include "insets/InsetInclude.h"
75 #include "insets/InsetTabular.h"
76 #include "insets/InsetText.h"
78 #include "mathed/InsetMathHull.h"
79 #include "mathed/MacroTable.h"
80 #include "mathed/InsetMathMacroTemplate.h"
81 #include "mathed/MathSupport.h"
83 #include "graphics/GraphicsCache.h"
84 #include "graphics/PreviewLoader.h"
86 #include "frontends/Application.h"
87 #include "frontends/alert.h"
88 #include "frontends/Delegates.h"
89 #include "frontends/WorkAreaManager.h"
91 #include "support/lassert.h"
92 #include "support/convert.h"
93 #include "support/debug.h"
94 #include "support/docstring_list.h"
95 #include "support/ExceptionMessage.h"
96 #include "support/FileMonitor.h"
97 #include "support/FileName.h"
98 #include "support/FileNameList.h"
99 #include "support/filetools.h"
100 #include "support/ForkedCalls.h"
101 #include "support/gettext.h"
102 #include "support/gzstream.h"
103 #include "support/lstrings.h"
104 #include "support/lyxalgo.h"
105 #include "support/mutex.h"
106 #include "support/os.h"
107 #include "support/Package.h"
108 #include "support/PathChanger.h"
109 #include "support/Systemcall.h"
110 #include "support/TempFile.h"
111 #include "support/textutils.h"
112 #include "support/types.h"
114 #include "support/bind.h"
126 using namespace lyx::support;
127 using namespace lyx::graphics;
131 namespace Alert = frontend::Alert;
132 namespace os = support::os;
136 int const LYX_FORMAT = LYX_FORMAT_LYX;
138 typedef map<string, bool> DepClean;
140 // Information about labels and their associated refs
145 InsetLabel const * inset;
146 /// associated references cache
147 Buffer::References references;
148 /// whether this label is active (i.e., not deleted)
152 typedef vector<LabelInfo> LabelCache;
154 typedef map<docstring, Buffer::References> RefCache;
156 // A storehouse for the cloned buffers.
157 typedef list<CloneList_ptr> CloneStore;
158 CloneStore cloned_buffers;
167 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
171 delete preview_loader_;
179 /// search for macro in local (buffer) table or in children
180 MacroData const * getBufferMacro(docstring const & name,
181 DocIterator const & pos) const;
183 /// Update macro table starting with position of it \param it in some
185 void updateMacros(DocIterator & it, DocIterator & scope);
187 void setLabel(ParIterator & it, UpdateType utype) const;
189 /** If we have branches that use the file suffix
190 feature, return the file name with suffix appended.
192 FileName exportFileName() const;
199 mutable TexRow texrow;
201 /// need to regenerate .tex?
204 /// name of the file the buffer is associated with.
208 mutable TocBackend toc_backend;
213 ScopeMacro(DocIterator const & s, MacroData const & m)
214 : scope(s), macro(m) {}
218 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
219 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
220 /// map from the macro name to the position map,
221 /// which maps the macro definition position to the scope and the MacroData.
222 NamePositionScopeMacroMap macros;
224 /// positions of child buffers in the buffer
225 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
227 ScopeBuffer() : buffer(nullptr) {}
228 ScopeBuffer(DocIterator const & s, Buffer const * b)
229 : scope(s), buffer(b) {}
231 Buffer const * buffer;
233 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
234 /// position of children buffers in this buffer
235 BufferPositionMap children_positions;
236 /// map from children inclusion positions to their scope and their buffer
237 PositionScopeBufferMap position_to_children;
239 /// Contains the old buffer filePath() while saving-as, or the
240 /// directory where the document was last saved while loading.
243 /** Keeps track of the path of local layout files.
244 * If possible, it is always relative to the buffer path.
245 * Empty for layouts in system or user directory.
247 string layout_position;
249 /// Container for all sort of Buffer dependant errors.
250 map<string, ErrorList> errorLists;
252 /// checksum used to test if the file has been externally modified. Used to
253 /// double check whether the file had been externally modified when saving.
254 unsigned long checksum_;
257 frontend::WorkAreaManager * wa_;
259 frontend::GuiBufferDelegate * gui_;
264 /// A cache for the bibfiles (including bibfiles of loaded child
265 /// documents), needed for appropriate update of natbib labels.
266 mutable docstring_list bibfiles_cache_;
268 // FIXME The caching mechanism could be improved. At present, we have a
269 // cache for each Buffer, that caches all the bibliography info for that
270 // Buffer. A more efficient solution would be to have a global cache per
271 // file, and then to construct the Buffer's bibinfo from that.
272 /// A cache for bibliography info
273 mutable BiblioInfo bibinfo_;
274 /// Cache of timestamps of .bib files
275 map<FileName, time_t> bibfile_status_;
277 /// These two hold the file name and format, written to by
278 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
279 FileName preview_file_;
280 string preview_format_;
282 /// Cache the references associated to a label and their positions
284 mutable RefCache ref_cache_;
285 /// Cache the label insets and their activity status.
286 mutable LabelCache label_cache_;
288 /// our Text that should be wrapped in an InsetText
292 PreviewLoader * preview_loader_;
294 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
295 /// This one is useful for preview detached in a thread.
296 Buffer const * cloned_buffer_;
298 CloneList_ptr clone_list_;
301 /// So we can force access via the accessors.
302 mutable Buffer const * parent_buffer;
304 FileMonitorPtr file_monitor_;
306 /// ints and bools are all listed last so as to avoid alignment issues
308 /// original format of loaded file
311 /// are we in the process of exporting this buffer?
312 mutable bool doing_export;
314 /// If there was an error when previewing, on the next preview we do
315 /// a fresh compile (e.g. in case the user installed a package that
317 bool require_fresh_start_;
319 /// Indicates whether the bibinfo has changed since the last time
320 /// we ran updateBuffer(), i.e., whether citation labels may need
322 mutable bool cite_labels_valid_;
323 /// Do we have a bibliography environment?
324 mutable bool have_bibitems_;
327 mutable bool lyx_clean;
329 /// is autosave needed?
330 mutable bool bak_clean;
332 /// is this an unnamed file (New...)?
335 /// is this an internal bufffer?
336 bool internal_buffer;
341 /** Set to true only when the file is fully loaded.
342 * Used to prevent the premature generation of previews
343 * and by the citation inset.
345 bool file_fully_loaded;
347 /// if the file was originally loaded from an older format, do
348 /// we need to back it up still?
349 bool need_format_backup;
351 /// Ignore the parent (e.g. when exporting a child standalone)?
354 /// This seem to change the way Buffer::getMacro() works
355 mutable bool macro_lock;
357 /// has been externally modified? Can be reset by the user.
358 mutable bool externally_modified_;
360 /// whether the bibinfo cache is valid
361 mutable bool bibinfo_cache_valid_;
369 /// This is here to force the test to be done whenever parent_buffer
371 Buffer const * parent() const
373 // ignore_parent temporarily "orphans" a buffer
374 // (e.g. if a child is compiled standalone)
377 // if parent_buffer is not loaded, then it has been unloaded,
378 // which means that parent_buffer is an invalid pointer. So we
379 // set it to null in that case.
380 // however, the BufferList doesn't know about cloned buffers, so
381 // they will always be regarded as unloaded. in that case, we hope
383 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
384 parent_buffer = nullptr;
385 return parent_buffer;
389 void setParent(Buffer const * pb)
391 if (parent_buffer == pb)
394 if (!cloned_buffer_ && parent_buffer && pb)
395 LYXERR0("Warning: a buffer should not have two parents!");
397 if (!cloned_buffer_ && parent_buffer)
398 parent_buffer->invalidateBibinfoCache();
401 /// compute statistics
402 /// \p from initial position
403 /// \p to points to the end position
404 void updateStatistics(DocIterator & from, DocIterator & to,
405 bool skipNoOutput = true);
406 /// statistics accessor functions
407 int wordCount() const
411 int charCount(bool with_blanks) const
414 + (with_blanks ? blank_count_ : 0);
417 // Make sure the file monitor monitors the good file.
418 void refreshFileMonitor();
420 /// Notify or clear of external modification
421 void fileExternallyModified(bool exists);
423 ///Binding LaTeX lines with buffer positions.
424 //Common routine for LaTeX and Reference errors listing.
425 void traverseErrors(TeXErrors::Errors::const_iterator err,
426 TeXErrors::Errors::const_iterator end,
427 ErrorList & errorList) const;
431 /// Creates the per buffer temporary directory
432 static FileName createBufferTmpDir()
434 // FIXME This would be the ideal application for a TempDir class (like
435 // TempFile but for directories)
440 Mutex::Locker locker(&mutex);
441 counter = convert<string>(count++);
443 // We are in our own directory. Why bother to mangle name?
444 // In fact I wrote this code to circumvent a problematic behaviour
445 // (bug?) of EMX mkstemp().
446 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
449 if (!tmpfl.createDirectory(0777)) {
450 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
451 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
452 from_utf8(tmpfl.absFileName())));
458 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
459 Buffer const * cloned_buffer)
460 : owner_(owner), filename(file), toc_backend(owner), checksum_(0),
461 wa_(nullptr), gui_(nullptr), undo_(*owner), inset(nullptr),
462 preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
463 clone_list_(nullptr), parent_buffer(nullptr), file_format(LYX_FORMAT),
464 doing_export(false), require_fresh_start_(false), cite_labels_valid_(false),
465 have_bibitems_(false), lyx_clean(true), bak_clean(true), unnamed(false),
466 internal_buffer(false), read_only(readonly_), file_fully_loaded(false),
467 need_format_backup(false), ignore_parent(false), macro_lock(false),
468 externally_modified_(false), bibinfo_cache_valid_(false),
469 word_count_(0), char_count_(0), blank_count_(0)
471 refreshFileMonitor();
472 if (!cloned_buffer_) {
473 temppath = createBufferTmpDir();
474 lyxvc.setBuffer(owner_);
475 Language const * inplang = theApp() ?
476 languages.getFromCode(theApp()->inputLanguageCode())
479 params.language = inplang;
481 wa_ = new frontend::WorkAreaManager;
484 temppath = cloned_buffer_->d->temppath;
485 file_fully_loaded = true;
486 params = cloned_buffer_->d->params;
487 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
488 bibinfo_ = cloned_buffer_->d->bibinfo_;
489 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
490 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
491 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
492 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
493 unnamed = cloned_buffer_->d->unnamed;
494 internal_buffer = cloned_buffer_->d->internal_buffer;
495 layout_position = cloned_buffer_->d->layout_position;
496 preview_file_ = cloned_buffer_->d->preview_file_;
497 preview_format_ = cloned_buffer_->d->preview_format_;
498 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
502 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
503 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
505 LYXERR(Debug::INFO, "Buffer::Buffer()");
507 d->inset = new InsetText(*cloned_buffer->d->inset);
508 d->inset->setBuffer(*this);
509 // FIXME: optimize this loop somewhat, maybe by creating a new
510 // general recursive Inset::setId().
511 DocIterator it = doc_iterator_begin(this);
512 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
513 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
514 it.paragraph().setId(cloned_it.paragraph().id());
516 d->inset = new InsetText(this);
517 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
523 LYXERR(Debug::INFO, "Buffer::~Buffer()");
524 // here the buffer should take care that it is
525 // saved properly, before it goes into the void.
527 // GuiView already destroyed
531 // No need to do additional cleanups for internal buffer.
537 // this is in case of recursive includes: we won't try to delete
538 // ourselves as a child.
539 d->clone_list_->erase(this);
540 // loop over children
541 for (auto const & p : d->children_positions) {
542 Buffer * child = const_cast<Buffer *>(p.first);
543 if (d->clone_list_->erase(child))
546 // if we're the master buffer, then we should get rid of the list
549 // If this is not empty, we have leaked something. Worse, one of the
550 // children still has a reference to this list. But we will try to
551 // continue, rather than shut down.
552 LATTEST(d->clone_list_->empty());
553 // The clone list itself is empty, but it's still referenced in our list
554 // of clones. So let's find it and remove it.
555 CloneStore::iterator it =
556 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
557 if (it == cloned_buffers.end()) {
558 // We will leak in this case, but it is safe to continue.
561 cloned_buffers.erase(it);
563 // FIXME Do we really need to do this right before we delete d?
564 // clear references to children in macro tables
565 d->children_positions.clear();
566 d->position_to_children.clear();
568 // loop over children
569 for (auto const & p : d->children_positions) {
570 Buffer * child = const_cast<Buffer *>(p.first);
571 if (theBufferList().isLoaded(child)) {
572 if (theBufferList().isOthersChild(this, child))
573 child->setParent(nullptr);
575 theBufferList().release(child);
580 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
582 msg += emergencyWrite();
584 msg += " " + _("Save failed! Document is lost.");
586 Alert::warning(_("Attempting to close changed document!"), msg);
589 // FIXME Do we really need to do this right before we delete d?
590 // clear references to children in macro tables
591 d->children_positions.clear();
592 d->position_to_children.clear();
594 if (!d->temppath.destroyDirectory()) {
595 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
596 from_utf8(d->temppath.absFileName())));
605 Buffer * Buffer::cloneWithChildren() const
608 cloned_buffers.emplace_back(new CloneList);
609 CloneList_ptr clones = cloned_buffers.back();
611 cloneWithChildren(bufmap, clones);
613 // make sure we got cloned
614 BufferMap::const_iterator bit = bufmap.find(this);
615 LASSERT(bit != bufmap.end(), return nullptr);
616 Buffer * cloned_buffer = bit->second;
618 return cloned_buffer;
622 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList_ptr clones) const
624 // have we already been cloned?
625 if (bufmap.find(this) != bufmap.end())
628 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
630 // The clone needs its own DocumentClass, since running updateBuffer() will
631 // modify it, and we would otherwise be sharing it with the original Buffer.
632 buffer_clone->params().makeDocumentClass(true);
634 cap::switchBetweenClasses(
635 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
636 static_cast<InsetText &>(buffer_clone->inset()), el);
638 bufmap[this] = buffer_clone;
639 clones->insert(buffer_clone);
640 buffer_clone->d->clone_list_ = clones;
641 buffer_clone->d->macro_lock = true;
642 buffer_clone->d->children_positions.clear();
644 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
645 // math macro caches need to be rethought and simplified.
646 // I am not sure wether we should handle Buffer cloning here or in BufferList.
647 // Right now BufferList knows nothing about buffer clones.
648 for (auto const & p : d->position_to_children) {
649 DocIterator dit = p.first.clone(buffer_clone);
650 dit.setBuffer(buffer_clone);
651 Buffer * child = const_cast<Buffer *>(p.second.buffer);
653 child->cloneWithChildren(bufmap, clones);
654 BufferMap::iterator const bit = bufmap.find(child);
655 LASSERT(bit != bufmap.end(), continue);
656 Buffer * child_clone = bit->second;
658 Inset * inset = dit.nextInset();
659 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
660 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
661 inset_inc->setChildBuffer(child_clone);
662 child_clone->d->setParent(buffer_clone);
663 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
664 buffer_clone->setChild(dit, child_clone);
666 buffer_clone->d->macro_lock = false;
671 Buffer * Buffer::cloneBufferOnly() const {
672 cloned_buffers.emplace_back(new CloneList);
673 CloneList_ptr clones = cloned_buffers.back();
674 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
676 // The clone needs its own DocumentClass, since running updateBuffer() will
677 // modify it, and we would otherwise be sharing it with the original Buffer.
678 buffer_clone->params().makeDocumentClass(true);
680 cap::switchBetweenClasses(
681 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
682 static_cast<InsetText &>(buffer_clone->inset()), el);
684 clones->insert(buffer_clone);
685 buffer_clone->d->clone_list_ = clones;
687 // we won't be cloning the children
688 buffer_clone->d->children_positions.clear();
693 bool Buffer::isClone() const
695 return d->cloned_buffer_;
699 void Buffer::changed(bool update_metrics) const
702 d->wa_->redrawAll(update_metrics);
706 frontend::WorkAreaManager & Buffer::workAreaManager() const
713 Text & Buffer::text() const
715 return d->inset->text();
719 Inset & Buffer::inset() const
725 BufferParams & Buffer::params()
731 BufferParams const & Buffer::params() const
737 BufferParams const & Buffer::masterParams() const
739 if (masterBuffer() == this)
742 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
743 // Copy child authors to the params. We need those pointers.
744 for (Author const & a : params().authors())
745 mparams.authors().record(a);
750 double Buffer::fontScalingFactor() const
752 return isExporting() ? 75.0 * params().html_math_img_scale
753 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
757 ParagraphList & Buffer::paragraphs()
759 return text().paragraphs();
763 ParagraphList const & Buffer::paragraphs() const
765 return text().paragraphs();
769 LyXVC & Buffer::lyxvc()
775 LyXVC const & Buffer::lyxvc() const
781 string const Buffer::temppath() const
783 return d->temppath.absFileName();
787 TexRow & Buffer::texrow()
793 TexRow const & Buffer::texrow() const
799 TocBackend & Buffer::tocBackend() const
801 return d->toc_backend;
805 Undo & Buffer::undo()
811 void Buffer::setChild(DocIterator const & dit, Buffer * child)
813 d->children_positions[child] = dit;
817 string Buffer::latexName(bool const no_path) const
819 FileName latex_name =
820 makeLatexName(d->exportFileName());
821 return no_path ? latex_name.onlyFileName()
822 : latex_name.absFileName();
826 FileName Buffer::Impl::exportFileName() const
828 docstring const branch_suffix =
829 params.branchlist().getFileNameSuffix();
830 if (branch_suffix.empty())
833 string const name = addExtension(filename.onlyFileNameWithoutExt()
834 + to_utf8(branch_suffix), filename.extension());
835 FileName res(filename.onlyPath().absFileName() + "/" + name);
841 string Buffer::logName(LogType * type) const
843 string const filename = latexName(false);
845 if (filename.empty()) {
851 string const path = temppath();
853 FileName const fname(addName(temppath(),
854 onlyFileName(changeExtension(filename,
857 // FIXME: how do we know this is the name of the build log?
858 FileName const bname(
859 addName(path, onlyFileName(
860 changeExtension(filename,
861 theFormats().extension(params().bufferFormat()) + ".out"))));
863 // Also consider the master buffer log file
864 FileName masterfname = fname;
865 LogType mtype = latexlog;
866 if (masterBuffer() != this) {
867 string const mlogfile = masterBuffer()->logName(&mtype);
868 masterfname = FileName(mlogfile);
871 // If no Latex log or Build log is newer, show Build log
872 if (bname.exists() &&
873 ((!fname.exists() && !masterfname.exists())
874 || (fname.lastModified() < bname.lastModified()
875 && masterfname.lastModified() < bname.lastModified()))) {
876 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
879 return bname.absFileName();
880 // If we have a newer master file log or only a master log, show this
881 } else if (fname != masterfname
882 && (!fname.exists() && (masterfname.exists()
883 || fname.lastModified() < masterfname.lastModified()))) {
884 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
887 return masterfname.absFileName();
889 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
892 return fname.absFileName();
896 void Buffer::setReadonly(bool const flag)
898 if (d->read_only != flag) {
905 void Buffer::setFileName(FileName const & fname)
907 bool const changed = fname != d->filename;
909 d->refreshFileMonitor();
911 lyxvc().file_found_hook(fname);
912 setReadonly(d->filename.isReadOnly());
918 int Buffer::readHeader(Lexer & lex)
920 int unknown_tokens = 0;
922 int begin_header_line = -1;
924 // Initialize parameters that may be/go lacking in header:
925 params().branchlist().clear();
926 params().preamble.erase();
927 params().options.erase();
928 params().master.erase();
929 params().float_placement.erase();
930 params().float_alignment.erase();
931 params().paperwidth.erase();
932 params().paperheight.erase();
933 params().leftmargin.erase();
934 params().rightmargin.erase();
935 params().topmargin.erase();
936 params().bottommargin.erase();
937 params().headheight.erase();
938 params().headsep.erase();
939 params().footskip.erase();
940 params().columnsep.erase();
941 params().font_roman_opts.erase();
942 params().font_sans_opts.erase();
943 params().font_typewriter_opts.erase();
944 params().fonts_cjk.erase();
945 params().listings_params.clear();
946 params().clearLayoutModules();
947 params().clearRemovedModules();
948 params().clearIncludedChildren();
949 params().pdfoptions().clear();
950 params().indiceslist().clear();
951 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
952 params().isbackgroundcolor = false;
953 params().fontcolor = RGBColor(0, 0, 0);
954 params().isfontcolor = false;
955 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
956 params().boxbgcolor = RGBColor(0xFF, 0, 0);
957 params().html_latex_start.clear();
958 params().html_latex_end.clear();
959 params().html_math_img_scale = 1.0;
960 params().output_sync_macro.erase();
961 params().setLocalLayout(docstring(), false);
962 params().setLocalLayout(docstring(), true);
963 params().biblio_opts.erase();
964 params().biblatex_bibstyle.erase();
965 params().biblatex_citestyle.erase();
966 params().multibib.erase();
967 params().lineno_opts.clear();
969 for (int i = 0; i < 4; ++i) {
970 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
971 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
974 ErrorList & errorList = d->errorLists["Parse"];
983 if (token == "\\end_header")
987 if (token == "\\begin_header") {
988 begin_header_line = line;
992 LYXERR(Debug::PARSER, "Handling document header token: `"
995 string const result =
996 params().readToken(lex, token, d->filename.onlyPath());
997 if (!result.empty()) {
998 if (token == "\\textclass") {
999 d->layout_position = result;
1002 docstring const s = bformat(_("Unknown token: "
1005 lex.getDocString());
1006 errorList.push_back(ErrorItem(_("Document header error"), s));
1010 if (begin_header_line) {
1011 docstring const s = _("\\begin_header is missing");
1012 errorList.push_back(ErrorItem(_("Document header error"), s));
1015 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1017 params().makeDocumentClass();
1019 return unknown_tokens;
1024 // changed to be public and have one parameter
1025 // Returns true if "\end_document" is not read (Asger)
1026 bool Buffer::readDocument(Lexer & lex)
1028 ErrorList & errorList = d->errorLists["Parse"];
1031 // remove dummy empty par
1032 paragraphs().clear();
1034 if (!lex.checkFor("\\begin_document")) {
1035 docstring const s = _("\\begin_document is missing");
1036 errorList.push_back(ErrorItem(_("Document header error"), s));
1041 if (params().output_changes) {
1042 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1043 LaTeXFeatures::isAvailable("xcolor");
1046 Alert::warning(_("Changes not shown in LaTeX output"),
1047 _("Changes will not be highlighted in LaTeX output, "
1048 "because xcolor and ulem are not installed.\n"
1049 "Please install both packages or redefine "
1050 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1054 if (!parent() && !params().master.empty()) {
1055 FileName const master_file = makeAbsPath(params().master,
1056 onlyPath(absFileName()));
1057 if (isLyXFileName(master_file.absFileName())) {
1059 checkAndLoadLyXFile(master_file, true);
1061 // necessary e.g. after a reload
1062 // to re-register the child (bug 5873)
1063 // FIXME: clean up updateMacros (here, only
1064 // child registering is needed).
1065 master->updateMacros();
1066 // set master as master buffer, but only
1067 // if we are a real child
1068 if (master->isChild(this))
1070 // if the master is not fully loaded
1071 // it is probably just loading this
1072 // child. No warning needed then.
1073 else if (master->isFullyLoaded())
1074 LYXERR0("The master '"
1076 << "' assigned to this document ("
1078 << ") does not include "
1079 "this document. Ignoring the master assignment.");
1080 // If the master has just been created, un-hide it (#11162)
1081 if (!master->fileName().exists())
1082 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1083 master->absFileName()));
1088 // assure we have a default index
1089 params().indiceslist().addDefault(B_("Index"));
1092 if (FileName::isAbsolute(params().origin))
1093 d->old_position = params().origin;
1095 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)
1191 if (!lex.setFile(fname)) {
1192 Alert::error(_("File Not Found"),
1193 bformat(_("Unable to open file `%1$s'."),
1194 from_utf8(fn.absFileName())));
1195 return ReadFileNotFound;
1199 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1200 if (ret_plf != ReadSuccess)
1203 if (file_format != LYX_FORMAT) {
1205 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1206 if (ret_clf != ReadSuccess)
1208 ret_clf = readFile(tmpFile);
1209 if (ret_clf == ReadSuccess) {
1210 d->file_format = file_format;
1211 d->need_format_backup = true;
1216 // FIXME: InsetInfo needs to know whether the file is under VCS
1217 // during the parse process, so this has to be done before.
1218 lyxvc().file_found_hook(d->filename);
1220 if (readDocument(lex)) {
1221 Alert::error(_("Document format failure"),
1222 bformat(_("%1$s ended unexpectedly, which means"
1223 " that it is probably corrupted."),
1224 from_utf8(fn.absFileName())));
1225 return ReadDocumentFailure;
1228 d->file_fully_loaded = true;
1229 d->read_only = !d->filename.isWritable();
1230 params().compressed = theFormats().isZippedFile(d->filename);
1236 bool Buffer::isFullyLoaded() const
1238 return d->file_fully_loaded;
1242 void Buffer::setFullyLoaded(bool value)
1244 d->file_fully_loaded = value;
1248 bool Buffer::freshStartRequired() const
1250 return d->require_fresh_start_;
1253 void Buffer::requireFreshStart(bool const b) const
1255 d->require_fresh_start_ = b;
1259 PreviewLoader * Buffer::loader() const
1261 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1263 if (!d->preview_loader_)
1264 d->preview_loader_ = new PreviewLoader(*this);
1265 return d->preview_loader_;
1269 void Buffer::removePreviews() const
1271 delete d->preview_loader_;
1272 d->preview_loader_ = nullptr;
1276 void Buffer::updatePreviews() const
1278 PreviewLoader * ploader = loader();
1282 InsetIterator it = inset_iterator_begin(*d->inset);
1283 InsetIterator const end = inset_iterator_end(*d->inset);
1284 for (; it != end; ++it)
1285 it->addPreview(it, *ploader);
1287 ploader->startLoading();
1291 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1292 FileName const & fn, int & file_format) const
1294 if(!lex.checkFor("\\lyxformat")) {
1295 Alert::error(_("Document format failure"),
1296 bformat(_("%1$s is not a readable LyX document."),
1297 from_utf8(fn.absFileName())));
1298 return ReadNoLyXFormat;
1304 // LyX formats 217 and earlier were written as 2.17. This corresponds
1305 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1306 // these cases. See also: www.lyx.org/trac/changeset/1313.
1307 size_t dot = tmp_format.find_first_of(".,");
1308 if (dot != string::npos)
1309 tmp_format.erase(dot, 1);
1311 file_format = convert<int>(tmp_format);
1316 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1317 FileName & tmpfile, int from_format)
1319 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1320 tempfile.setAutoRemove(false);
1321 tmpfile = tempfile.name();
1322 if(tmpfile.empty()) {
1323 Alert::error(_("Conversion failed"),
1324 bformat(_("%1$s is from a different"
1325 " version of LyX, but a temporary"
1326 " file for converting it could"
1327 " not be created."),
1328 from_utf8(fn.absFileName())));
1329 return LyX2LyXNoTempFile;
1332 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1333 if (lyx2lyx.empty()) {
1334 Alert::error(_("Conversion script not found"),
1335 bformat(_("%1$s is from a different"
1336 " version of LyX, but the"
1337 " conversion script lyx2lyx"
1338 " could not be found."),
1339 from_utf8(fn.absFileName())));
1340 return LyX2LyXNotFound;
1344 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1345 ostringstream command;
1346 command << os::python()
1347 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1348 << " -t " << convert<string>(LYX_FORMAT)
1349 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1350 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1351 string const command_str = command.str();
1353 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1355 cmd_ret const ret = runCommand(command_str);
1356 if (ret.first != 0) {
1357 if (from_format < LYX_FORMAT) {
1358 Alert::error(_("Conversion script failed"),
1359 bformat(_("%1$s is from an older version"
1360 " of LyX and the lyx2lyx script"
1361 " failed to convert it."),
1362 from_utf8(fn.absFileName())));
1363 return LyX2LyXOlderFormat;
1365 Alert::error(_("Conversion script failed"),
1366 bformat(_("%1$s is from a newer version"
1367 " of LyX and the lyx2lyx script"
1368 " failed to convert it."),
1369 from_utf8(fn.absFileName())));
1370 return LyX2LyXNewerFormat;
1377 FileName Buffer::getBackupName() const {
1378 map<int, string> const file_formats = {
1395 FileName const & fn = fileName();
1396 string const fname = fn.onlyFileNameWithoutExt();
1397 string const fext = fn.extension() + "~";
1398 string const fpath = lyxrc.backupdir_path.empty() ?
1399 fn.onlyPath().absFileName() :
1400 lyxrc.backupdir_path;
1401 string backup_suffix;
1402 // If file format is from a stable series use version instead of file format
1403 auto const it = file_formats.find(d->file_format);
1404 if (it != file_formats.end())
1405 backup_suffix = "-lyx" + it->second;
1407 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1408 string const backname = fname + backup_suffix;
1409 FileName backup(addName(fpath, addExtension(backname, fext)));
1411 // limit recursion, just in case
1413 unsigned long orig_checksum = 0;
1414 while (backup.exists() && v < 100) {
1415 if (orig_checksum == 0)
1416 orig_checksum = fn.checksum();
1417 unsigned long new_checksum = backup.checksum();
1418 if (orig_checksum == new_checksum) {
1419 LYXERR(Debug::FILES, "Not backing up " << fn <<
1420 "since " << backup << "has the same checksum.");
1421 // a bit of a hack, but we have to check this anyway
1422 // below, and setting this is simpler than introducing
1423 // a special boolean for this purpose.
1427 string const newbackname = backname + "-" + convert<string>(v);
1428 backup.set(addName(fpath, addExtension(newbackname, fext)));
1431 return v < 100 ? backup : FileName();
1435 // Should probably be moved to somewhere else: BufferView? GuiView?
1436 bool Buffer::save() const
1438 docstring const file = makeDisplayPath(absFileName(), 20);
1439 d->filename.refresh();
1441 // check the read-only status before moving the file as a backup
1442 if (d->filename.exists()) {
1443 bool const read_only = !d->filename.isWritable();
1445 Alert::warning(_("File is read-only"),
1446 bformat(_("The file %1$s cannot be written because it "
1447 "is marked as read-only."), file));
1452 // ask if the disk file has been externally modified (use checksum method)
1453 if (fileName().exists() && isChecksumModified()) {
1455 bformat(_("Document %1$s has been externally modified. "
1456 "Are you sure you want to overwrite this file?"), file);
1457 int const ret = Alert::prompt(_("Overwrite modified file?"),
1458 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1463 // We don't need autosaves in the immediate future. (Asger)
1464 resetAutosaveTimers();
1466 // if the file does not yet exist, none of the backup activity
1467 // that follows is necessary
1468 if (!fileName().exists()) {
1469 if (!writeFile(fileName()))
1475 // we first write the file to a new name, then move it to its
1476 // proper location once that has been done successfully. that
1477 // way we preserve the original file if something goes wrong.
1478 string const justname = fileName().onlyFileNameWithoutExt();
1479 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1480 justname + "-XXXXXX.lyx");
1481 bool const symlink = fileName().isSymLink();
1483 tempfile->setAutoRemove(false);
1485 FileName savefile(tempfile->name());
1486 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1487 if (!savefile.clonePermissions(fileName()))
1488 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1490 if (!writeFile(savefile))
1493 // we will set this to false if we fail
1494 bool made_backup = true;
1496 FileName backupName;
1497 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1499 if (d->need_format_backup)
1500 backupName = getBackupName();
1502 // If we for some reason failed to find a backup name in case of
1503 // a format change, this will still set one. It's the best we can
1505 if (backupName.empty()) {
1506 backupName.set(fileName().absFileName() + "~");
1507 if (!lyxrc.backupdir_path.empty()) {
1508 string const mangledName =
1509 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1510 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1514 LYXERR(Debug::FILES, "Backing up original file to " <<
1515 backupName.absFileName());
1516 // Except file is symlink do not copy because of #6587.
1517 // Hard links have bad luck.
1518 made_backup = symlink ?
1519 fileName().copyTo(backupName):
1520 fileName().moveTo(backupName);
1523 Alert::error(_("Backup failure"),
1524 bformat(_("Cannot create backup file %1$s.\n"
1525 "Please check whether the directory exists and is writable."),
1526 from_utf8(backupName.absFileName())));
1527 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1528 } else if (d->need_format_backup) {
1529 // the original file has been backed up successfully, so we
1530 // will not need to do that again
1531 d->need_format_backup = false;
1535 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1536 // Only do this if tempfile is not in autoremove mode
1539 // If we have no symlink, we can simply rename the temp file.
1540 // Otherwise, we need to copy it so the symlink stays intact.
1541 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1542 savefile.moveTo(fileName()))
1544 // saveCheckSum() was already called by writeFile(), but the
1545 // time stamp is invalidated by copying/moving
1548 if (d->file_format != LYX_FORMAT)
1549 // the file associated with this buffer is now in the current format
1550 d->file_format = LYX_FORMAT;
1553 // else we saved the file, but failed to move it to the right location.
1555 if (needBackup && made_backup && !symlink) {
1556 // the original file was moved to some new location, so it will look
1557 // to the user as if it was deleted. (see bug #9234.) we could try
1558 // to restore it, but that would basically mean trying to do again
1559 // what we just failed to do. better to leave things as they are.
1560 Alert::error(_("Write failure"),
1561 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1562 "But LyX could not move it to:\n %2$s.\n"
1563 "Your original file has been backed up to:\n %3$s"),
1564 from_utf8(savefile.absFileName()),
1565 from_utf8(fileName().absFileName()),
1566 from_utf8(backupName.absFileName())));
1568 // either we did not try to make a backup, or else we tried and failed,
1569 // or else the original file was a symlink, in which case it was copied,
1570 // not moved. so the original file is intact.
1571 Alert::error(_("Write failure"),
1572 bformat(_("Cannot move saved file to:\n %1$s.\n"
1573 "But the file has successfully been saved as:\n %2$s."),
1574 from_utf8(fileName().absFileName()),
1575 from_utf8(savefile.absFileName())));
1581 bool Buffer::writeFile(FileName const & fname) const
1583 if (d->read_only && fname == d->filename)
1586 bool retval = false;
1588 docstring const str = bformat(_("Saving document %1$s..."),
1589 makeDisplayPath(fname.absFileName()));
1592 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1594 if (params().compressed) {
1595 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1596 retval = ofs && write(ofs);
1598 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1599 retval = ofs && write(ofs);
1603 message(str + _(" could not write file!"));
1608 // removeAutosaveFile();
1611 message(str + _(" done."));
1617 docstring Buffer::emergencyWrite()
1619 // No need to save if the buffer has not changed.
1623 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1625 docstring user_message = bformat(
1626 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1628 // We try to save three places:
1629 // 1) Same place as document. Unless it is an unnamed doc.
1631 string s = absFileName();
1634 if (writeFile(FileName(s))) {
1636 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1637 return user_message;
1639 user_message += " " + _("Save failed! Trying again...\n");
1643 // 2) In HOME directory.
1644 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1646 lyxerr << ' ' << s << endl;
1647 if (writeFile(FileName(s))) {
1649 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1650 return user_message;
1653 user_message += " " + _("Save failed! Trying yet again...\n");
1655 // 3) In "/tmp" directory.
1656 // MakeAbsPath to prepend the current
1657 // drive letter on OS/2
1658 s = addName(package().temp_dir().absFileName(), absFileName());
1660 lyxerr << ' ' << s << endl;
1661 if (writeFile(FileName(s))) {
1663 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1664 return user_message;
1667 user_message += " " + _("Save failed! Document is lost.");
1670 return user_message;
1674 bool Buffer::write(ostream & ofs) const
1677 // Use the standard "C" locale for file output.
1678 ofs.imbue(locale::classic());
1681 // The top of the file should not be written by params().
1683 // write out a comment in the top of the file
1684 // Important: Keep the version formatting in sync with lyx2lyx and
1685 // tex2lyx (bug 7951)
1686 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1687 << " created this file. For more info see https://www.lyx.org/\n"
1688 << "\\lyxformat " << LYX_FORMAT << "\n"
1689 << "\\begin_document\n";
1691 /// For each author, set 'used' to true if there is a change
1692 /// by this author in the document; otherwise set it to 'false'.
1693 for (Author const & a : params().authors())
1696 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1697 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1698 for ( ; it != end; ++it)
1699 it->checkAuthors(params().authors());
1701 // now write out the buffer parameters.
1702 ofs << "\\begin_header\n";
1703 params().writeFile(ofs, this);
1704 ofs << "\\end_header\n";
1707 ofs << "\n\\begin_body\n";
1709 ofs << "\n\\end_body\n";
1711 // Write marker that shows file is complete
1712 ofs << "\\end_document" << endl;
1714 // Shouldn't really be needed....
1717 // how to check if close went ok?
1718 // Following is an attempt... (BE 20001011)
1720 // good() returns false if any error occurred, including some
1721 // formatting error.
1722 // bad() returns true if something bad happened in the buffer,
1723 // which should include file system full errors.
1728 lyxerr << "File was not closed properly." << endl;
1735 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1736 string const & original_path,
1737 OutputParams const & runparams_in,
1738 OutputWhat output) const
1740 OutputParams runparams = runparams_in;
1742 string const encoding = runparams.encoding->iconvName();
1743 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1746 try { ofs.reset(encoding); }
1747 catch (iconv_codecvt_facet_exception const & e) {
1748 lyxerr << "Caught iconv exception: " << e.what() << endl;
1749 Alert::error(_("Iconv software exception Detected"),
1750 bformat(_("Please verify that the `iconv' support software is"
1751 " properly installed and supports the selected encoding"
1752 " (%1$s), or change the encoding in"
1753 " Document>Settings>Language."), from_ascii(encoding)));
1756 if (!openFileWrite(ofs, fname))
1759 ErrorList & errorList = d->errorLists["Export"];
1761 ExportStatus status = ExportSuccess;
1764 // make sure we are ready to export
1765 // this needs to be done before we validate
1766 // FIXME Do we need to do this all the time? I.e., in children
1767 // of a master we are exporting?
1769 updateMacroInstances(OutputUpdate);
1771 ExportStatus retval;
1773 retval = writeLaTeXSource(os, original_path, runparams, output);
1774 if (retval == ExportKilled)
1775 return ExportKilled;
1777 catch (EncodingException const & e) {
1778 docstring const failed(1, e.failed_char);
1780 oss << "0x" << hex << e.failed_char << dec;
1781 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1782 docstring msg = bformat(_("Uncodable character '%1$s'"
1783 " (code point %2$s)"),
1784 failed, from_utf8(oss.str()));
1785 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1786 "representable in specific verbatim contexts.\n"
1787 "Changing the document encoding to utf8 could help."),
1788 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1790 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1791 " (code point %2$s)"),
1792 failed, from_utf8(oss.str()));
1793 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1794 "representable in the chosen encoding.\n"
1795 "Changing the document encoding to utf8 could help."),
1796 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1798 status = ExportError;
1800 catch (iconv_codecvt_facet_exception const & e) {
1801 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1803 status = ExportError;
1805 catch (exception const & e) {
1806 errorList.push_back(ErrorItem(_("conversion failed"),
1808 lyxerr << e.what() << endl;
1809 status = ExportError;
1812 lyxerr << "Caught some really weird exception..." << endl;
1816 d->texrow = move(os.texrow());
1820 status = ExportError;
1821 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1824 if (runparams_in.silent)
1832 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1833 string const & original_path,
1834 OutputParams const & runparams_in,
1835 OutputWhat output) const
1837 // The child documents, if any, shall be already loaded at this point.
1839 OutputParams runparams = runparams_in;
1841 // Some macros rely on font encoding
1842 runparams.main_fontenc = params().main_font_encoding();
1844 // If we are compiling a file standalone, even if this is the
1845 // child of some other buffer, let's cut the link here, so the
1846 // file is really independent and no concurring settings from
1847 // the master (e.g. branch state) interfere (see #8100).
1848 if (!runparams.is_child)
1849 d->ignore_parent = true;
1851 // Classify the unicode characters appearing in math insets
1852 BufferEncodings::initUnicodeMath(*this);
1854 // validate the buffer.
1855 LYXERR(Debug::LATEX, " Validating buffer...");
1856 LaTeXFeatures features(*this, params(), runparams);
1858 // This is only set once per document (in master)
1859 if (!runparams.is_child) {
1860 runparams.use_polyglossia = features.usePolyglossia();
1861 runparams.use_CJK = features.mustProvide("CJK");
1863 LYXERR(Debug::LATEX, " Buffer validation done.");
1865 bool const output_preamble =
1866 output == FullSource || output == OnlyPreamble;
1867 bool const output_body =
1868 output == FullSource || output == OnlyBody;
1870 // The starting paragraph of the coming rows is the
1871 // first paragraph of the document. (Asger)
1872 if (output_preamble && runparams.nice) {
1873 os << "%% LyX " << lyx_version << " created this file. "
1874 "For more info, see https://www.lyx.org/.\n"
1875 "%% Do not edit unless you really know what "
1878 LYXERR(Debug::INFO, "lyx document header finished");
1880 // There are a few differences between nice LaTeX and usual files:
1881 // usual files have \batchmode and special input@path to allow
1882 // inclusion of figures specified by an explicitly relative path
1883 // (i.e., a path starting with './' or '../') with either \input or
1884 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1885 // input@path is set when the actual parameter original_path is set.
1886 // This is done for usual tex-file, but not for nice-latex-file.
1887 // (Matthias 250696)
1888 // Note that input@path is only needed for something the user does
1889 // in the preamble, included .tex files or ERT, files included by
1890 // LyX work without it.
1891 if (output_preamble) {
1892 if (!runparams.nice) {
1893 // code for usual, NOT nice-latex-file
1894 os << "\\batchmode\n"; // changed from \nonstopmode
1896 if (!original_path.empty()) {
1898 // We don't know the encoding of inputpath
1899 docstring const inputpath = from_utf8(original_path);
1900 docstring uncodable_glyphs;
1901 Encoding const * const enc = runparams.encoding;
1903 for (size_t n = 0; n < inputpath.size(); ++n) {
1904 if (!enc->encodable(inputpath[n])) {
1905 docstring const glyph(1, inputpath[n]);
1906 LYXERR0("Uncodable character '"
1908 << "' in input path!");
1909 uncodable_glyphs += glyph;
1914 // warn user if we found uncodable glyphs.
1915 if (!uncodable_glyphs.empty()) {
1916 frontend::Alert::warning(
1917 _("Uncodable character in file path"),
1919 _("The path of your document\n"
1921 "contains glyphs that are unknown "
1922 "in the current document encoding "
1923 "(namely %2$s). This may result in "
1924 "incomplete output, unless "
1925 "TEXINPUTS contains the document "
1926 "directory and you don't use "
1927 "explicitly relative paths (i.e., "
1928 "paths starting with './' or "
1929 "'../') in the preamble or in ERT."
1930 "\n\nIn case of problems, choose "
1931 "an appropriate document encoding\n"
1932 "(such as utf8) or change the "
1934 inputpath, uncodable_glyphs));
1936 string docdir = os::latex_path(original_path);
1937 if (contains(docdir, '#')) {
1938 docdir = subst(docdir, "#", "\\#");
1939 os << "\\catcode`\\#=11"
1940 "\\def\\#{#}\\catcode`\\#=6\n";
1942 if (contains(docdir, '%')) {
1943 docdir = subst(docdir, "%", "\\%");
1944 os << "\\catcode`\\%=11"
1945 "\\def\\%{%}\\catcode`\\%=14\n";
1947 if (contains(docdir, '~'))
1948 docdir = subst(docdir, "~", "\\string~");
1949 bool const nonascii = !isAscii(from_utf8(docdir));
1950 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1951 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1952 bool const detokenize = !utfpathlatex && nonascii;
1953 bool const quote = contains(docdir, ' ');
1954 if (utfpathlatex && nonascii)
1955 os << "\\UseRawInputEncoding\n";
1956 os << "\\makeatletter\n"
1957 << "\\def\\input@path{{";
1959 os << "\\detokenize{";
1968 << "\\makeatother\n";
1972 // get parent macros (if this buffer has a parent) which will be
1973 // written at the document begin further down.
1974 MacroSet parentMacros;
1975 listParentMacros(parentMacros, features);
1977 // Write the preamble
1978 runparams.use_babel = params().writeLaTeX(os, features,
1979 d->filename.onlyPath());
1981 // Active characters
1982 runparams.active_chars = features.getActiveChars();
1984 // Biblatex bibliographies are loaded here
1985 if (params().useBiblatex()) {
1986 vector<pair<docstring, string>> const bibfiles =
1987 prepareBibFilePaths(runparams, getBibfiles(), true);
1988 for (pair<docstring, string> const & file: bibfiles) {
1989 os << "\\addbibresource";
1990 if (!file.second.empty())
1991 os << "[bibencoding=" << file.second << "]";
1992 os << "{" << file.first << "}\n";
1996 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1997 && !features.hasOnlyPolyglossiaLanguages()) {
2000 vector<string> bll = features.getBabelExclusiveLanguages();
2001 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2004 for (string const & sit : bll) {
2009 blangs = bll.size() > 1 ?
2010 bformat(_("The languages %1$s are only supported by Babel."), langs)
2011 : bformat(_("The language %1$s is only supported by Babel."), langs);
2015 for (string const & pit : pll) {
2020 plangs = pll.size() > 1 ?
2021 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2022 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2023 if (!blangs.empty())
2027 frontend::Alert::warning(
2028 _("Incompatible Languages!"),
2030 _("You cannot use the following languages "
2031 "together in one LaTeX document because "
2032 "they require conflicting language packages:\n"
2037 // Japanese might be required only in some children of a document,
2038 // but once required, we must keep use_japanese true.
2039 runparams.use_japanese |= features.isRequired("japanese");
2042 // Restore the parenthood if needed
2043 if (!runparams.is_child)
2044 d->ignore_parent = false;
2045 return ExportSuccess;
2049 // mark the beginning of the body to separate it from InPreamble insets
2050 os.texrow().start(TexRow::beginDocument());
2051 os << "\\begin{document}\n";
2053 // mark the start of a new paragraph by simulating a newline,
2054 // so that os.afterParbreak() returns true at document start
2057 // output the parent macros
2058 for (auto const & mac : parentMacros) {
2059 int num_lines = mac->write(os.os(), true);
2060 os.texrow().newlines(num_lines);
2063 } // output_preamble
2065 LYXERR(Debug::INFO, "preamble finished, now the body.");
2069 latexParagraphs(*this, text(), os, runparams);
2071 catch (ConversionException const &) { return ExportKilled; }
2073 // Restore the parenthood if needed
2074 if (!runparams.is_child)
2075 d->ignore_parent = false;
2077 // add this just in case after all the paragraphs
2080 if (output_preamble) {
2081 os << "\\end{document}\n";
2082 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2084 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2086 runparams_in.encoding = runparams.encoding;
2088 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2089 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2090 return ExportSuccess;
2094 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2095 OutputParams const & runparams,
2096 OutputWhat output) const
2098 LYXERR(Debug::LATEX, "makeDocBookFile...");
2101 if (!openFileWrite(ofs, fname))
2104 // make sure we are ready to export
2105 // this needs to be done before we validate
2107 updateMacroInstances(OutputUpdate);
2109 ExportStatus const retval =
2110 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2111 if (retval == ExportKilled)
2112 return ExportKilled;
2116 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2117 return ExportSuccess;
2121 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2122 OutputParams const & runparams,
2123 OutputWhat output) const
2125 LaTeXFeatures features(*this, params(), runparams);
2130 DocumentClass const & tclass = params().documentClass();
2131 string const & top_element = tclass.latexname();
2133 bool const output_preamble =
2134 output == FullSource || output == OnlyPreamble;
2135 bool const output_body =
2136 output == FullSource || output == OnlyBody;
2138 if (output_preamble) {
2139 if (runparams.flavor == OutputParams::XML)
2140 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2143 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2146 if (! tclass.class_header().empty())
2147 os << from_ascii(tclass.class_header());
2148 else if (runparams.flavor == OutputParams::XML)
2149 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2150 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2152 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2154 docstring preamble = params().preamble;
2155 if (runparams.flavor != OutputParams::XML ) {
2156 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2157 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2158 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2159 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2162 string const name = runparams.nice
2163 ? changeExtension(absFileName(), ".sgml") : fname;
2164 preamble += features.getIncludedFiles(name);
2165 preamble += features.getLyXSGMLEntities();
2167 if (!preamble.empty()) {
2168 os << "\n [ " << preamble << " ]";
2174 string top = top_element;
2176 if (runparams.flavor == OutputParams::XML)
2177 top += params().language->code();
2179 top += params().language->code().substr(0, 2);
2182 if (!params().options.empty()) {
2184 top += params().options;
2187 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2188 << " file was created by LyX " << lyx_version
2189 << "\n See https://www.lyx.org/ for more information -->\n";
2191 params().documentClass().counters().reset();
2193 sgml::openTag(os, top);
2196 docbookParagraphs(text(), *this, os, runparams);
2198 catch (ConversionException const &) { return ExportKilled; }
2199 sgml::closeTag(os, top_element);
2201 return ExportSuccess;
2205 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2206 OutputParams const & runparams) const
2208 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2211 if (!openFileWrite(ofs, fname))
2214 // make sure we are ready to export
2215 // this has to be done before we validate
2216 updateBuffer(UpdateMaster, OutputUpdate);
2217 updateMacroInstances(OutputUpdate);
2219 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2220 if (retval == ExportKilled)
2225 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2230 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2231 OutputParams const & runparams,
2232 OutputWhat output) const
2234 LaTeXFeatures features(*this, params(), runparams);
2236 d->bibinfo_.makeCitationLabels(*this);
2238 bool const output_preamble =
2239 output == FullSource || output == OnlyPreamble;
2240 bool const output_body =
2241 output == FullSource || output == OnlyBody || output == IncludedFile;
2243 if (output_preamble) {
2244 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2245 << "<!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"
2246 // FIXME Language should be set properly.
2247 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2249 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2250 // FIXME Presumably need to set this right
2251 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2253 docstring const & doctitle = features.htmlTitle();
2255 << (doctitle.empty() ?
2256 from_ascii("LyX Document") :
2257 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2260 docstring styles = features.getTClassHTMLPreamble();
2261 if (!styles.empty())
2262 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2264 // we will collect CSS information in a stream, and then output it
2265 // either here, as part of the header, or else in a separate file.
2266 odocstringstream css;
2267 styles = features.getCSSSnippets();
2268 if (!styles.empty())
2269 css << "/* LyX Provided Styles */\n" << styles << '\n';
2271 styles = features.getTClassHTMLStyles();
2272 if (!styles.empty())
2273 css << "/* Layout-provided Styles */\n" << styles << '\n';
2275 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2276 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2277 if (needfg || needbg) {
2278 css << "\nbody {\n";
2281 << from_ascii(X11hexname(params().fontcolor))
2284 css << " background-color: "
2285 << from_ascii(X11hexname(params().backgroundcolor))
2290 docstring const dstyles = css.str();
2291 if (!dstyles.empty()) {
2292 bool written = false;
2293 if (params().html_css_as_file) {
2294 // open a file for CSS info
2296 string const fcssname = addName(temppath(), "docstyle.css");
2297 FileName const fcssfile = FileName(fcssname);
2298 if (openFileWrite(ocss, fcssfile)) {
2302 // write link to header
2303 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2305 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2308 // we are here if the CSS is supposed to be written to the header
2309 // or if we failed to write it to an external file.
2311 os << "<style type='text/css'>\n"
2320 bool const output_body_tag = (output != IncludedFile);
2321 if (output_body_tag)
2322 os << "<body dir=\"auto\">\n";
2324 if (output != IncludedFile)
2325 // if we're an included file, the counters are in the master.
2326 params().documentClass().counters().reset();
2328 xhtmlParagraphs(text(), *this, xs, runparams);
2330 catch (ConversionException const &) { return ExportKilled; }
2331 if (output_body_tag)
2335 if (output_preamble)
2338 return ExportSuccess;
2342 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2343 // Other flags: -wall -v0 -x
2344 int Buffer::runChktex()
2348 // get LaTeX-Filename
2349 FileName const path(temppath());
2350 string const name = addName(path.absFileName(), latexName());
2351 string const org_path = filePath();
2353 PathChanger p(path); // path to LaTeX file
2354 message(_("Running chktex..."));
2356 // Generate the LaTeX file if neccessary
2357 OutputParams runparams(¶ms().encoding());
2358 runparams.flavor = OutputParams::LATEX;
2359 runparams.nice = false;
2360 runparams.linelen = lyxrc.plaintext_linelen;
2361 ExportStatus const retval =
2362 makeLaTeXFile(FileName(name), org_path, runparams);
2363 if (retval != ExportSuccess) {
2364 // error code on failure
2369 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2370 int const res = chktex.run(terr); // run chktex
2373 Alert::error(_("chktex failure"),
2374 _("Could not run chktex successfully."));
2376 ErrorList & errlist = d->errorLists["ChkTeX"];
2378 bufferErrors(terr, errlist);
2383 if (runparams.silent)
2384 d->errorLists["ChkTeX"].clear();
2392 void Buffer::validate(LaTeXFeatures & features) const
2394 // Validate the buffer params, but not for included
2395 // files, since they also use the parent buffer's
2397 if (!features.runparams().is_child)
2398 params().validate(features);
2400 for (Paragraph const & p : paragraphs())
2401 p.validate(features);
2403 if (lyxerr.debugging(Debug::LATEX)) {
2404 features.showStruct();
2409 void Buffer::getLabelList(vector<docstring> & list) const
2411 // If this is a child document, use the master's list instead.
2413 masterBuffer()->getLabelList(list);
2418 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2419 for (auto const & tocit : *toc) {
2420 if (tocit.depth() == 0)
2421 list.push_back(tocit.str());
2426 void Buffer::invalidateBibinfoCache() const
2428 d->bibinfo_cache_valid_ = false;
2429 d->cite_labels_valid_ = false;
2430 removeBiblioTempFiles();
2431 // also invalidate the cache for the parent buffer
2432 Buffer const * const pbuf = d->parent();
2434 pbuf->invalidateBibinfoCache();
2438 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2440 // FIXME This is probably unnecessary, given where we call this.
2441 // If this is a child document, use the master instead.
2442 Buffer const * const pbuf = masterBuffer();
2443 if (pbuf != this && scope != UpdateChildOnly)
2444 return pbuf->getBibfiles();
2446 // In 2.3.x, we have:
2447 //if (!d->bibfile_cache_valid_)
2448 // this->updateBibfilesCache(scope);
2449 // I think that is a leftover, but there have been so many back-
2450 // and-forths with this, due to Windows issues, that I am not sure.
2452 return d->bibfiles_cache_;
2456 BiblioInfo const & Buffer::masterBibInfo() const
2458 Buffer const * const tmp = masterBuffer();
2460 return tmp->masterBibInfo();
2465 BiblioInfo const & Buffer::bibInfo() const
2471 void Buffer::registerBibfiles(const docstring_list & bf) const
2473 // We register the bib files in the master buffer,
2474 // if there is one, but also in every single buffer,
2475 // in case a child is compiled alone.
2476 Buffer const * const tmp = masterBuffer();
2478 tmp->registerBibfiles(bf);
2480 for (auto const & p : bf) {
2481 docstring_list::const_iterator temp =
2482 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2483 if (temp == d->bibfiles_cache_.end())
2484 d->bibfiles_cache_.push_back(p);
2489 static map<docstring, FileName> bibfileCache;
2491 FileName Buffer::getBibfilePath(docstring const & bibid) const
2493 map<docstring, FileName>::const_iterator it =
2494 bibfileCache.find(bibid);
2495 if (it != bibfileCache.end()) {
2496 // i.e., return bibfileCache[bibid];
2500 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2501 string const texfile = changeExtension(to_utf8(bibid), "bib");
2502 // we need to check first if this file exists where it's said to be.
2503 // there's a weird bug that occurs otherwise: if the file is in the
2504 // Buffer's directory but has the same name as some file that would be
2505 // found by kpsewhich, then we find the latter, not the former.
2506 FileName const local_file = makeAbsPath(texfile, filePath());
2507 FileName file = local_file;
2508 if (!file.exists()) {
2509 // there's no need now to check whether the file can be found
2511 file = findtexfile(texfile, "bib", true);
2515 LYXERR(Debug::FILES, "Found at: " << file);
2517 bibfileCache[bibid] = file;
2518 return bibfileCache[bibid];
2522 void Buffer::checkIfBibInfoCacheIsValid() const
2524 // use the master's cache
2525 Buffer const * const tmp = masterBuffer();
2527 tmp->checkIfBibInfoCacheIsValid();
2531 // If we already know the cache is invalid, stop here.
2532 // This is important in the case when the bibliography
2533 // environment (rather than Bib[la]TeX) is used.
2534 // In that case, the timestamp check below gives no
2535 // sensible result. Rather than that, the cache will
2536 // be invalidated explicitly via invalidateBibInfoCache()
2537 // by the Bibitem inset.
2538 // Same applies for bib encoding changes, which trigger
2539 // invalidateBibInfoCache() by InsetBibtex.
2540 if (!d->bibinfo_cache_valid_)
2543 if (d->have_bibitems_) {
2544 // We have a bibliography environment.
2545 // Invalidate the bibinfo cache unconditionally.
2546 // Cite labels will get invalidated by the inset if needed.
2547 d->bibinfo_cache_valid_ = false;
2551 // OK. This is with Bib(la)tex. We'll assume the cache
2552 // is valid and change this if we find changes in the bibs.
2553 d->bibinfo_cache_valid_ = true;
2554 d->cite_labels_valid_ = true;
2556 // compare the cached timestamps with the actual ones.
2557 docstring_list const & bibfiles_cache = getBibfiles();
2558 for (auto const & bf : bibfiles_cache) {
2559 FileName const fn = getBibfilePath(bf);
2560 time_t lastw = fn.lastModified();
2561 time_t prevw = d->bibfile_status_[fn];
2562 if (lastw != prevw) {
2563 d->bibinfo_cache_valid_ = false;
2564 d->cite_labels_valid_ = false;
2565 d->bibfile_status_[fn] = lastw;
2571 void Buffer::clearBibFileCache() const
2573 bibfileCache.clear();
2577 void Buffer::reloadBibInfoCache(bool const force) const
2579 // we should not need to do this for internal buffers
2583 // use the master's cache
2584 Buffer const * const tmp = masterBuffer();
2586 tmp->reloadBibInfoCache(force);
2591 checkIfBibInfoCacheIsValid();
2592 if (d->bibinfo_cache_valid_)
2596 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2597 // re-read file locations when this info changes
2598 // FIXME Is this sufficient? Or should we also force that
2599 // in some other cases? If so, then it is easy enough to
2600 // add the following line in some other places.
2601 clearBibFileCache();
2602 d->bibinfo_.clear();
2603 FileNameList checkedFiles;
2604 d->have_bibitems_ = false;
2605 collectBibKeys(checkedFiles);
2606 d->bibinfo_cache_valid_ = true;
2610 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2612 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2613 it->collectBibKeys(it, checkedFiles);
2614 if (it->lyxCode() == BIBITEM_CODE) {
2615 if (parent() != nullptr)
2616 parent()->d->have_bibitems_ = true;
2618 d->have_bibitems_ = true;
2624 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2626 // We add the biblio info to the master buffer,
2627 // if there is one, but also to every single buffer,
2628 // in case a child is compiled alone.
2629 BiblioInfo & bi = d->bibinfo_;
2630 bi.mergeBiblioInfo(bin);
2632 if (parent() != nullptr) {
2633 BiblioInfo & masterbi = parent()->d->bibinfo_;
2634 masterbi.mergeBiblioInfo(bin);
2639 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2641 // We add the bibtex info to the master buffer,
2642 // if there is one, but also to every single buffer,
2643 // in case a child is compiled alone.
2644 BiblioInfo & bi = d->bibinfo_;
2647 if (parent() != nullptr) {
2648 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2649 masterbi[key] = bin;
2654 void Buffer::makeCitationLabels() const
2656 Buffer const * const master = masterBuffer();
2657 return d->bibinfo_.makeCitationLabels(*master);
2661 void Buffer::invalidateCiteLabels() const
2663 masterBuffer()->d->cite_labels_valid_ = false;
2666 bool Buffer::citeLabelsValid() const
2668 return masterBuffer()->d->cite_labels_valid_;
2672 void Buffer::removeBiblioTempFiles() const
2674 // We remove files that contain LaTeX commands specific to the
2675 // particular bibliographic style being used, in order to avoid
2676 // LaTeX errors when we switch style.
2677 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2678 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2679 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2680 aux_file.removeFile();
2681 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2682 bbl_file.removeFile();
2683 // Also for the parent buffer
2684 Buffer const * const pbuf = parent();
2686 pbuf->removeBiblioTempFiles();
2690 bool Buffer::isDepClean(string const & name) const
2692 DepClean::const_iterator const it = d->dep_clean.find(name);
2693 if (it == d->dep_clean.end())
2699 void Buffer::markDepClean(string const & name)
2701 d->dep_clean[name] = true;
2705 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2708 // FIXME? if there is an Buffer LFUN that can be dispatched even
2709 // if internal, put a switch '(cmd.action)' here.
2715 switch (cmd.action()) {
2717 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2718 flag.setOnOff(hasReadonlyFlag());
2721 // FIXME: There is need for a command-line import.
2722 //case LFUN_BUFFER_IMPORT:
2724 case LFUN_BUFFER_AUTO_SAVE:
2727 case LFUN_BUFFER_EXPORT_CUSTOM:
2728 // FIXME: Nothing to check here?
2731 case LFUN_BUFFER_EXPORT: {
2732 docstring const arg = cmd.argument();
2733 if (arg == "custom") {
2737 string format = (arg.empty() || arg == "default") ?
2738 params().getDefaultOutputFormat() : to_utf8(arg);
2739 size_t pos = format.find(' ');
2740 if (pos != string::npos)
2741 format = format.substr(0, pos);
2742 enable = params().isExportable(format, false);
2744 flag.message(bformat(
2745 _("Don't know how to export to format: %1$s"), arg));
2749 case LFUN_BUILD_PROGRAM:
2750 enable = params().isExportable("program", false);
2753 case LFUN_BRANCH_ACTIVATE:
2754 case LFUN_BRANCH_DEACTIVATE:
2755 case LFUN_BRANCH_MASTER_ACTIVATE:
2756 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2757 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2758 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2759 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2760 : params().branchlist();
2761 docstring const branchName = cmd.argument();
2762 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2766 case LFUN_BRANCH_ADD:
2767 case LFUN_BRANCHES_RENAME:
2768 // if no Buffer is present, then of course we won't be called!
2771 case LFUN_BUFFER_LANGUAGE:
2772 enable = !isReadonly();
2775 case LFUN_BUFFER_VIEW_CACHE:
2776 (d->preview_file_).refresh();
2777 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2780 case LFUN_CHANGES_TRACK:
2781 flag.setEnabled(true);
2782 flag.setOnOff(params().track_changes);
2785 case LFUN_CHANGES_OUTPUT:
2786 flag.setEnabled(true);
2787 flag.setOnOff(params().output_changes);
2790 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2791 flag.setOnOff(params().compressed);
2794 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2795 flag.setOnOff(params().output_sync);
2798 case LFUN_BUFFER_ANONYMIZE:
2804 flag.setEnabled(enable);
2809 void Buffer::dispatch(string const & command, DispatchResult & result)
2811 return dispatch(lyxaction.lookupFunc(command), result);
2815 // NOTE We can end up here even if we have no GUI, because we are called
2816 // by LyX::exec to handled command-line requests. So we may need to check
2817 // whether we have a GUI or not. The boolean use_gui holds this information.
2818 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2821 // FIXME? if there is an Buffer LFUN that can be dispatched even
2822 // if internal, put a switch '(cmd.action())' here.
2823 dr.dispatched(false);
2826 string const argument = to_utf8(func.argument());
2827 // We'll set this back to false if need be.
2828 bool dispatched = true;
2829 // This handles undo groups automagically
2830 UndoGroupHelper ugh(this);
2832 switch (func.action()) {
2833 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2834 if (lyxvc().inUse()) {
2835 string log = lyxvc().toggleReadOnly();
2840 setReadonly(!hasReadonlyFlag());
2843 case LFUN_BUFFER_EXPORT: {
2844 string const format = (argument.empty() || argument == "default") ?
2845 params().getDefaultOutputFormat() : argument;
2846 ExportStatus const status = doExport(format, false);
2847 dr.setError(status != ExportSuccess);
2848 if (status != ExportSuccess)
2849 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2850 from_utf8(format)));
2854 case LFUN_BUILD_PROGRAM: {
2855 ExportStatus const status = doExport("program", true);
2856 dr.setError(status != ExportSuccess);
2857 if (status != ExportSuccess)
2858 dr.setMessage(_("Error generating literate programming code."));
2862 case LFUN_BUFFER_EXPORT_CUSTOM: {
2864 string command = split(argument, format_name, ' ');
2865 Format const * format = theFormats().getFormat(format_name);
2867 lyxerr << "Format \"" << format_name
2868 << "\" not recognized!"
2873 // The name of the file created by the conversion process
2876 // Output to filename
2877 if (format->name() == "lyx") {
2878 string const latexname = latexName(false);
2879 filename = changeExtension(latexname,
2880 format->extension());
2881 filename = addName(temppath(), filename);
2883 if (!writeFile(FileName(filename)))
2887 doExport(format_name, true, filename);
2890 // Substitute $$FName for filename
2891 if (!contains(command, "$$FName"))
2892 command = "( " + command + " ) < $$FName";
2893 command = subst(command, "$$FName", filename);
2895 // Execute the command in the background
2897 call.startscript(Systemcall::DontWait, command,
2898 filePath(), layoutPos());
2902 // FIXME: There is need for a command-line import.
2904 case LFUN_BUFFER_IMPORT:
2909 case LFUN_BUFFER_AUTO_SAVE:
2911 resetAutosaveTimers();
2914 case LFUN_BRANCH_ACTIVATE:
2915 case LFUN_BRANCH_DEACTIVATE:
2916 case LFUN_BRANCH_MASTER_ACTIVATE:
2917 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2918 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2919 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2920 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2923 docstring const branch_name = func.argument();
2924 // the case without a branch name is handled elsewhere
2925 if (branch_name.empty()) {
2929 Branch * branch = buf->params().branchlist().find(branch_name);
2931 LYXERR0("Branch " << branch_name << " does not exist.");
2933 docstring const msg =
2934 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2938 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2939 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2940 if (branch->isSelected() != activate) {
2941 buf->undo().recordUndoBufferParams(CursorData());
2942 branch->setSelected(activate);
2944 dr.screenUpdate(Update::Force);
2945 dr.forceBufferUpdate();
2950 case LFUN_BRANCH_ADD: {
2951 docstring branchnames = func.argument();
2952 if (branchnames.empty()) {
2956 BranchList & branch_list = params().branchlist();
2957 vector<docstring> const branches =
2958 getVectorFromString(branchnames, branch_list.separator());
2960 for (docstring const & branch_name : branches) {
2961 Branch * branch = branch_list.find(branch_name);
2963 LYXERR0("Branch " << branch_name << " already exists.");
2967 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2969 undo().recordUndoBufferParams(CursorData());
2970 branch_list.add(branch_name);
2971 branch = branch_list.find(branch_name);
2972 string const x11hexname = X11hexname(branch->color());
2973 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2974 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2976 dr.screenUpdate(Update::Force);
2984 case LFUN_BRANCHES_RENAME: {
2985 if (func.argument().empty())
2988 docstring const oldname = from_utf8(func.getArg(0));
2989 docstring const newname = from_utf8(func.getArg(1));
2990 InsetIterator it = inset_iterator_begin(inset());
2991 InsetIterator const end = inset_iterator_end(inset());
2992 bool success = false;
2993 for (; it != end; ++it) {
2994 if (it->lyxCode() == BRANCH_CODE) {
2995 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2996 if (ins.branch() == oldname) {
2997 undo().recordUndo(CursorData(it));
2998 ins.rename(newname);
3003 if (it->lyxCode() == INCLUDE_CODE) {
3004 // get buffer of external file
3005 InsetInclude const & ins =
3006 static_cast<InsetInclude const &>(*it);
3007 Buffer * child = ins.getChildBuffer();
3010 child->dispatch(func, dr);
3015 dr.screenUpdate(Update::Force);
3016 dr.forceBufferUpdate();
3021 case LFUN_BUFFER_VIEW_CACHE:
3022 if (!theFormats().view(*this, d->preview_file_,
3023 d->preview_format_))
3024 dr.setMessage(_("Error viewing the output file."));
3027 case LFUN_CHANGES_TRACK:
3028 if (params().save_transient_properties)
3029 undo().recordUndoBufferParams(CursorData());
3030 params().track_changes = !params().track_changes;
3033 case LFUN_CHANGES_OUTPUT:
3034 if (params().save_transient_properties)
3035 undo().recordUndoBufferParams(CursorData());
3036 params().output_changes = !params().output_changes;
3037 if (params().output_changes) {
3038 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3039 LaTeXFeatures::isAvailable("xcolor");
3042 Alert::warning(_("Changes not shown in LaTeX output"),
3043 _("Changes will not be highlighted in LaTeX output, "
3044 "because xcolor and ulem are not installed.\n"
3045 "Please install both packages or redefine "
3046 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3051 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3052 // turn compression on/off
3053 undo().recordUndoBufferParams(CursorData());
3054 params().compressed = !params().compressed;
3057 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3058 undo().recordUndoBufferParams(CursorData());
3059 params().output_sync = !params().output_sync;
3062 case LFUN_BUFFER_ANONYMIZE: {
3063 undo().recordUndoFullBuffer(CursorData());
3064 CursorData cur(doc_iterator_begin(this));
3065 for ( ; cur ; cur.forwardPar())
3066 cur.paragraph().anonymize();
3067 dr.forceBufferUpdate();
3068 dr.screenUpdate(Update::Force);
3076 dr.dispatched(dispatched);
3080 void Buffer::changeLanguage(Language const * from, Language const * to)
3082 LASSERT(from, return);
3083 LASSERT(to, return);
3085 for_each(par_iterator_begin(),
3087 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3091 bool Buffer::isMultiLingual() const
3093 ParConstIterator end = par_iterator_end();
3094 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3095 if (it->isMultiLingual(params()))
3102 std::set<Language const *> Buffer::getLanguages() const
3104 std::set<Language const *> langs;
3105 getLanguages(langs);
3110 void Buffer::getLanguages(std::set<Language const *> & langs) const
3112 ParConstIterator end = par_iterator_end();
3113 // add the buffer language, even if it's not actively used
3114 langs.insert(language());
3115 // iterate over the paragraphs
3116 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3117 it->getLanguages(langs);
3119 ListOfBuffers clist = getDescendants();
3120 for (auto const & cit : clist)
3121 cit->getLanguages(langs);
3125 DocIterator Buffer::getParFromID(int const id) const
3127 Buffer * buf = const_cast<Buffer *>(this);
3129 // This means non-existent
3130 return doc_iterator_end(buf);
3132 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3133 if (it.paragraph().id() == id)
3136 return doc_iterator_end(buf);
3140 bool Buffer::hasParWithID(int const id) const
3142 return !getParFromID(id).atEnd();
3146 ParIterator Buffer::par_iterator_begin()
3148 return ParIterator(doc_iterator_begin(this));
3152 ParIterator Buffer::par_iterator_end()
3154 return ParIterator(doc_iterator_end(this));
3158 ParConstIterator Buffer::par_iterator_begin() const
3160 return ParConstIterator(doc_iterator_begin(this));
3164 ParConstIterator Buffer::par_iterator_end() const
3166 return ParConstIterator(doc_iterator_end(this));
3170 Language const * Buffer::language() const
3172 return params().language;
3176 docstring Buffer::B_(string const & l10n) const
3178 return params().B_(l10n);
3182 bool Buffer::isClean() const
3184 return d->lyx_clean;
3188 bool Buffer::isChecksumModified() const
3190 LASSERT(d->filename.exists(), return false);
3191 return d->checksum_ != d->filename.checksum();
3195 void Buffer::saveCheckSum() const
3197 FileName const & file = d->filename;
3199 d->checksum_ = file.exists() ? file.checksum()
3200 : 0; // in the case of save to a new file.
3204 void Buffer::markClean() const
3206 if (!d->lyx_clean) {
3207 d->lyx_clean = true;
3210 // if the .lyx file has been saved, we don't need an
3212 d->bak_clean = true;
3213 d->undo_.markDirty();
3214 clearExternalModification();
3218 void Buffer::setUnnamed(bool flag)
3224 bool Buffer::isUnnamed() const
3231 /// Don't check unnamed, here: isInternal() is used in
3232 /// newBuffer(), where the unnamed flag has not been set by anyone
3233 /// yet. Also, for an internal buffer, there should be no need for
3234 /// retrieving fileName() nor for checking if it is unnamed or not.
3235 bool Buffer::isInternal() const
3237 return d->internal_buffer;
3241 void Buffer::setInternal(bool flag)
3243 d->internal_buffer = flag;
3247 void Buffer::markDirty()
3250 d->lyx_clean = false;
3253 d->bak_clean = false;
3255 for (auto & depit : d->dep_clean)
3256 depit.second = false;
3260 FileName Buffer::fileName() const
3266 string Buffer::absFileName() const
3268 return d->filename.absFileName();
3272 string Buffer::filePath() const
3274 string const abs = d->filename.onlyPath().absFileName();
3277 int last = abs.length() - 1;
3279 return abs[last] == '/' ? abs : abs + '/';
3283 DocFileName Buffer::getReferencedFileName(string const & fn) const
3286 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3287 result.set(fn, filePath());
3289 // filePath() ends with a path separator
3290 FileName const test(filePath() + fn);
3292 result.set(fn, filePath());
3294 result.set(fn, params().origin);
3301 string const Buffer::prepareFileNameForLaTeX(string const & name,
3302 string const & ext, bool nice) const
3304 string const fname = makeAbsPath(name, filePath()).absFileName();
3305 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3311 return to_utf8(makeRelPath(from_utf8(fname),
3312 from_utf8(masterBuffer()->filePath())));
3316 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3317 docstring_list const & bibfilelist,
3318 bool const add_extension) const
3320 // If we are processing the LaTeX file in a temp directory then
3321 // copy the .bib databases to this temp directory, mangling their
3322 // names in the process. Store this mangled name in the list of
3324 // (We need to do all this because BibTeX *really*, *really*
3325 // can't handle "files with spaces" and Windows users tend to
3326 // use such filenames.)
3327 // Otherwise, store the (maybe absolute) path to the original,
3328 // unmangled database name.
3330 vector<pair<docstring, string>> res;
3332 // determine the export format
3333 string const tex_format = flavor2format(runparams.flavor);
3335 // check for spaces in paths
3336 bool found_space = false;
3338 for (auto const & bit : bibfilelist) {
3339 string utf8input = to_utf8(bit);
3341 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3342 FileName try_in_file =
3343 makeAbsPath(database + ".bib", filePath());
3344 bool not_from_texmf = try_in_file.isReadableFile();
3345 // If the file has not been found, try with the real file name
3346 // (it might come from a child in a sub-directory)
3347 if (!not_from_texmf) {
3348 try_in_file = getBibfilePath(bit);
3349 if (try_in_file.isReadableFile()) {
3350 // Check if the file is in texmf
3351 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3352 not_from_texmf = kpsefile.empty()
3353 || kpsefile.absFileName() != try_in_file.absFileName();
3355 // If this exists, make path relative to the master
3358 removeExtension(prepareFileNameForLaTeX(
3359 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3360 from_utf8(filePath()))),
3361 ".bib", runparams.nice));
3365 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3367 // mangledFileName() needs the extension
3368 DocFileName const in_file = DocFileName(try_in_file);
3369 database = removeExtension(in_file.mangledFileName());
3370 FileName const out_file = makeAbsPath(database + ".bib",
3371 masterBuffer()->temppath());
3372 bool const success = in_file.copyTo(out_file);
3374 LYXERR0("Failed to copy '" << in_file
3375 << "' to '" << out_file << "'");
3377 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3378 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3379 if (!isValidLaTeXFileName(database)) {
3380 frontend::Alert::warning(_("Invalid filename"),
3381 _("The following filename will cause troubles "
3382 "when running the exported file through LaTeX: ") +
3383 from_utf8(database));
3385 if (!isValidDVIFileName(database)) {
3386 frontend::Alert::warning(_("Problematic filename for DVI"),
3387 _("The following filename can cause troubles "
3388 "when running the exported file through LaTeX "
3389 "and opening the resulting DVI: ") +
3390 from_utf8(database), true);
3398 docstring const path = from_utf8(latex_path(database));
3400 if (contains(path, ' '))
3403 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3404 enc = params().bibFileEncoding(utf8input);
3406 bool recorded = false;
3407 for (auto const & pe : res) {
3408 if (pe.first == path) {
3415 res.push_back(make_pair(path, enc));
3418 // Check if there are spaces in the path and warn BibTeX users, if so.
3419 // (biber can cope with such paths)
3420 if (!prefixIs(runparams.bibtex_command, "biber")) {
3421 // Post this warning only once.
3422 static bool warned_about_spaces = false;
3423 if (!warned_about_spaces &&
3424 runparams.nice && found_space) {
3425 warned_about_spaces = true;
3426 Alert::warning(_("Export Warning!"),
3427 _("There are spaces in the paths to your BibTeX databases.\n"
3428 "BibTeX will be unable to find them."));
3437 string Buffer::layoutPos() const
3439 return d->layout_position;
3443 void Buffer::setLayoutPos(string const & path)
3446 d->layout_position.clear();
3450 LATTEST(FileName::isAbsolute(path));
3452 d->layout_position =
3453 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3455 if (d->layout_position.empty())
3456 d->layout_position = ".";
3460 bool Buffer::hasReadonlyFlag() const
3462 return d->read_only;
3466 bool Buffer::isReadonly() const
3468 return hasReadonlyFlag() || notifiesExternalModification();
3472 void Buffer::setParent(Buffer const * buffer)
3474 // Avoids recursive include.
3475 d->setParent(buffer == this ? nullptr : buffer);
3480 Buffer const * Buffer::parent() const
3486 ListOfBuffers Buffer::allRelatives() const
3488 ListOfBuffers lb = masterBuffer()->getDescendants();
3489 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3494 Buffer const * Buffer::masterBuffer() const
3496 // FIXME Should be make sure we are not in some kind
3497 // of recursive include? A -> B -> A will crash this.
3498 Buffer const * const pbuf = d->parent();
3502 return pbuf->masterBuffer();
3506 bool Buffer::isChild(Buffer * child) const
3508 return d->children_positions.find(child) != d->children_positions.end();
3512 DocIterator Buffer::firstChildPosition(Buffer const * child)
3514 Impl::BufferPositionMap::iterator it;
3515 it = d->children_positions.find(child);
3516 if (it == d->children_positions.end())
3517 return DocIterator(this);
3522 bool Buffer::hasChildren() const
3524 return !d->children_positions.empty();
3528 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3530 // loop over children
3531 for (auto const & p : d->children_positions) {
3532 Buffer * child = const_cast<Buffer *>(p.first);
3534 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3535 if (bit != clist.end())
3537 clist.push_back(child);
3539 // there might be grandchildren
3540 child->collectChildren(clist, true);
3545 ListOfBuffers Buffer::getChildren() const
3548 collectChildren(v, false);
3549 // Make sure we have not included ourselves.
3550 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3551 if (bit != v.end()) {
3552 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3559 ListOfBuffers Buffer::getDescendants() const
3562 collectChildren(v, true);
3563 // Make sure we have not included ourselves.
3564 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3565 if (bit != v.end()) {
3566 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3573 template<typename M>
3574 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3579 typename M::const_iterator it = m.lower_bound(x);
3580 if (it == m.begin())
3588 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3589 DocIterator const & pos) const
3591 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3593 // if paragraphs have no macro context set, pos will be empty
3597 // we haven't found anything yet
3598 DocIterator bestPos = owner_->par_iterator_begin();
3599 MacroData const * bestData = nullptr;
3601 // find macro definitions for name
3602 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3603 if (nameIt != macros.end()) {
3604 // find last definition in front of pos or at pos itself
3605 PositionScopeMacroMap::const_iterator it
3606 = greatest_below(nameIt->second, pos);
3607 if (it != nameIt->second.end()) {
3609 // scope ends behind pos?
3610 if (pos < it->second.scope) {
3611 // Looks good, remember this. If there
3612 // is no external macro behind this,
3613 // we found the right one already.
3614 bestPos = it->first;
3615 bestData = &it->second.macro;
3619 // try previous macro if there is one
3620 if (it == nameIt->second.begin())
3627 // find macros in included files
3628 PositionScopeBufferMap::const_iterator it
3629 = greatest_below(position_to_children, pos);
3630 if (it == position_to_children.end())
3631 // no children before
3635 // do we know something better (i.e. later) already?
3636 if (it->first < bestPos )
3639 // scope ends behind pos?
3640 if (pos < it->second.scope
3641 && (cloned_buffer_ ||
3642 theBufferList().isLoaded(it->second.buffer))) {
3643 // look for macro in external file
3645 MacroData const * data
3646 = it->second.buffer->getMacro(name, false);
3649 bestPos = it->first;
3655 // try previous file if there is one
3656 if (it == position_to_children.begin())
3661 // return the best macro we have found
3666 MacroData const * Buffer::getMacro(docstring const & name,
3667 DocIterator const & pos, bool global) const
3672 // query buffer macros
3673 MacroData const * data = d->getBufferMacro(name, pos);
3674 if (data != nullptr)
3677 // If there is a master buffer, query that
3678 Buffer const * const pbuf = d->parent();
3680 d->macro_lock = true;
3681 MacroData const * macro = pbuf->getMacro(
3682 name, *this, false);
3683 d->macro_lock = false;
3689 data = MacroTable::globalMacros().get(name);
3690 if (data != nullptr)
3698 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3700 // set scope end behind the last paragraph
3701 DocIterator scope = par_iterator_begin();
3702 scope.pit() = scope.lastpit() + 1;
3704 return getMacro(name, scope, global);
3708 MacroData const * Buffer::getMacro(docstring const & name,
3709 Buffer const & child, bool global) const
3711 // look where the child buffer is included first
3712 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3713 if (it == d->children_positions.end())
3716 // check for macros at the inclusion position
3717 return getMacro(name, it->second, global);
3721 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3723 pit_type const lastpit = it.lastpit();
3725 // look for macros in each paragraph
3726 while (it.pit() <= lastpit) {
3727 Paragraph & par = it.paragraph();
3729 // FIXME Can this be done with the new-style iterators?
3730 // iterate over the insets of the current paragraph
3731 for (auto const & insit : par.insetList()) {
3732 it.pos() = insit.pos;
3734 // is it a nested text inset?
3735 if (insit.inset->asInsetText()) {
3736 // Inset needs its own scope?
3737 InsetText const * itext = insit.inset->asInsetText();
3738 bool newScope = itext->isMacroScope();
3740 // scope which ends just behind the inset
3741 DocIterator insetScope = it;
3744 // collect macros in inset
3745 it.push_back(CursorSlice(*insit.inset));
3746 updateMacros(it, newScope ? insetScope : scope);
3751 if (insit.inset->asInsetTabular()) {
3752 CursorSlice slice(*insit.inset);
3753 size_t const numcells = slice.nargs();
3754 for (; slice.idx() < numcells; slice.forwardIdx()) {
3755 it.push_back(slice);
3756 updateMacros(it, scope);
3762 // is it an external file?
3763 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3764 // get buffer of external file
3765 InsetInclude const & incinset =
3766 static_cast<InsetInclude const &>(*insit.inset);
3768 Buffer * child = incinset.getChildBuffer();
3773 // register its position, but only when it is
3774 // included first in the buffer
3775 if (children_positions.find(child) ==
3776 children_positions.end())
3777 children_positions[child] = it;
3779 // register child with its scope
3780 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3784 InsetMath * im = insit.inset->asInsetMath();
3785 if (doing_export && im) {
3786 InsetMathHull * hull = im->asHullInset();
3788 hull->recordLocation(it);
3791 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3795 InsetMathMacroTemplate & macroTemplate =
3796 *insit.inset->asInsetMath()->asMacroTemplate();
3797 MacroContext mc(owner_, it);
3798 macroTemplate.updateToContext(mc);
3801 bool valid = macroTemplate.validMacro();
3802 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3803 // then the BufferView's cursor will be invalid in
3804 // some cases which leads to crashes.
3809 // FIXME (Abdel), I don't understand why we pass 'it' here
3810 // instead of 'macroTemplate' defined above... is this correct?
3811 macros[macroTemplate.name()][it] =
3812 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3822 void Buffer::updateMacros() const
3827 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3829 // start with empty table
3831 d->children_positions.clear();
3832 d->position_to_children.clear();
3834 // Iterate over buffer, starting with first paragraph
3835 // The scope must be bigger than any lookup DocIterator
3836 // later. For the global lookup, lastpit+1 is used, hence
3837 // we use lastpit+2 here.
3838 DocIterator it = par_iterator_begin();
3839 DocIterator outerScope = it;
3840 outerScope.pit() = outerScope.lastpit() + 2;
3841 d->updateMacros(it, outerScope);
3845 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3847 InsetIterator it = inset_iterator_begin(inset());
3848 InsetIterator const end = inset_iterator_end(inset());
3849 for (; it != end; ++it) {
3850 if (it->lyxCode() == BRANCH_CODE) {
3851 InsetBranch & br = static_cast<InsetBranch &>(*it);
3852 docstring const name = br.branch();
3853 if (!from_master && !params().branchlist().find(name))
3854 result.push_back(name);
3855 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3856 result.push_back(name);
3859 if (it->lyxCode() == INCLUDE_CODE) {
3860 // get buffer of external file
3861 InsetInclude const & ins =
3862 static_cast<InsetInclude const &>(*it);
3863 Buffer * child = ins.getChildBuffer();
3866 child->getUsedBranches(result, true);
3869 // remove duplicates
3874 void Buffer::updateMacroInstances(UpdateType utype) const
3876 LYXERR(Debug::MACROS, "updateMacroInstances for "
3877 << d->filename.onlyFileName());
3878 DocIterator it = doc_iterator_begin(this);
3880 DocIterator const end = doc_iterator_end(this);
3881 for (; it != end; it.forwardInset()) {
3882 // look for MathData cells in InsetMathNest insets
3883 InsetMath * minset = it.nextInset()->asInsetMath();
3887 // update macro in all cells of the InsetMathNest
3888 DocIterator::idx_type n = minset->nargs();
3889 MacroContext mc = MacroContext(this, it);
3890 for (DocIterator::idx_type i = 0; i < n; ++i) {
3891 MathData & data = minset->cell(i);
3892 data.updateMacros(nullptr, mc, utype, 0);
3898 void Buffer::listMacroNames(MacroNameSet & macros) const
3903 d->macro_lock = true;
3905 // loop over macro names
3906 for (auto const & nameit : d->macros)
3907 macros.insert(nameit.first);
3909 // loop over children
3910 for (auto const & p : d->children_positions) {
3911 Buffer * child = const_cast<Buffer *>(p.first);
3912 // The buffer might have been closed (see #10766).
3913 if (theBufferList().isLoaded(child))
3914 child->listMacroNames(macros);
3918 Buffer const * const pbuf = d->parent();
3920 pbuf->listMacroNames(macros);
3922 d->macro_lock = false;
3926 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3928 Buffer const * const pbuf = d->parent();
3933 pbuf->listMacroNames(names);
3936 for (auto const & mit : names) {
3938 MacroData const * data = pbuf->getMacro(mit, *this, false);
3940 macros.insert(data);
3942 // we cannot access the original InsetMathMacroTemplate anymore
3943 // here to calls validate method. So we do its work here manually.
3944 // FIXME: somehow make the template accessible here.
3945 if (data->optionals() > 0)
3946 features.require("xargs");
3952 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3955 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3957 RefCache::iterator it = d->ref_cache_.find(label);
3958 if (it != d->ref_cache_.end())
3961 static References const dummy_refs = References();
3962 it = d->ref_cache_.insert(
3963 make_pair(label, dummy_refs)).first;
3968 Buffer::References const & Buffer::references(docstring const & label) const
3970 return const_cast<Buffer *>(this)->getReferenceCache(label);
3974 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3976 References & refs = getReferenceCache(label);
3977 refs.push_back(make_pair(inset, it));
3981 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3985 linfo.label = label;
3987 linfo.active = active;
3988 masterBuffer()->d->label_cache_.push_back(linfo);
3992 InsetLabel const * Buffer::insetLabel(docstring const & label,
3993 bool const active) const
3995 for (auto const & rc : masterBuffer()->d->label_cache_) {
3996 if (rc.label == label && (rc.active || !active))
4003 bool Buffer::activeLabel(docstring const & label) const
4005 if (!insetLabel(label, true))
4012 void Buffer::clearReferenceCache() const
4015 d->ref_cache_.clear();
4016 d->label_cache_.clear();
4021 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4023 //FIXME: This does not work for child documents yet.
4024 reloadBibInfoCache();
4026 // Check if the label 'from' appears more than once
4027 vector<docstring> labels;
4028 for (auto const & bibit : masterBibInfo())
4029 labels.push_back(bibit.first);
4031 if (count(labels.begin(), labels.end(), from) > 1)
4034 string const paramName = "key";
4035 UndoGroupHelper ugh(this);
4036 InsetIterator it = inset_iterator_begin(inset());
4038 if (it->lyxCode() != CITE_CODE)
4040 InsetCommand * inset = it->asInsetCommand();
4041 docstring const oldValue = inset->getParam(paramName);
4042 if (oldValue == from) {
4043 undo().recordUndo(CursorData(it));
4044 inset->setParam(paramName, to);
4049 // returns NULL if id-to-row conversion is unsupported
4050 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4051 pit_type par_begin, pit_type par_end,
4052 OutputWhat output, bool master) const
4054 unique_ptr<TexRow> texrow;
4055 OutputParams runparams(¶ms().encoding());
4056 runparams.nice = true;
4057 runparams.flavor = params().getOutputFlavor(format);
4058 runparams.linelen = lyxrc.plaintext_linelen;
4059 // No side effect of file copying and image conversion
4060 runparams.dryrun = true;
4062 // Some macros rely on font encoding
4063 runparams.main_fontenc = params().main_font_encoding();
4065 if (output == CurrentParagraph) {
4066 runparams.par_begin = par_begin;
4067 runparams.par_end = par_end;
4068 if (par_begin + 1 == par_end) {
4070 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4074 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4075 convert<docstring>(par_begin),
4076 convert<docstring>(par_end - 1))
4079 // output paragraphs
4080 if (runparams.flavor == OutputParams::LYX) {
4081 Paragraph const & par = text().paragraphs()[par_begin];
4083 depth_type dt = par.getDepth();
4084 par.write(ods, params(), dt);
4085 os << from_utf8(ods.str());
4086 } else if (runparams.flavor == OutputParams::HTML) {
4088 setMathFlavor(runparams);
4089 xhtmlParagraphs(text(), *this, xs, runparams);
4090 } else if (runparams.flavor == OutputParams::TEXT) {
4092 // FIXME Handles only one paragraph, unlike the others.
4093 // Probably should have some routine with a signature like them.
4094 writePlaintextParagraph(*this,
4095 text().paragraphs()[par_begin], os, runparams, dummy);
4096 } else if (params().isDocBook()) {
4097 docbookParagraphs(text(), *this, os, runparams);
4099 // If we are previewing a paragraph, even if this is the
4100 // child of some other buffer, let's cut the link here,
4101 // so that no concurring settings from the master
4102 // (e.g. branch state) interfere (see #8101).
4104 d->ignore_parent = true;
4105 // We need to validate the Buffer params' features here
4106 // in order to know if we should output polyglossia
4107 // macros (instead of babel macros)
4108 LaTeXFeatures features(*this, params(), runparams);
4110 runparams.use_polyglossia = features.usePolyglossia();
4111 // latex or literate
4114 ots.texrow().newlines(2);
4116 latexParagraphs(*this, text(), ots, runparams);
4117 texrow = ots.releaseTexRow();
4119 // Restore the parenthood
4121 d->ignore_parent = false;
4125 if (output == FullSource)
4126 os << _("Preview source code");
4127 else if (output == OnlyPreamble)
4128 os << _("Preview preamble");
4129 else if (output == OnlyBody)
4130 os << _("Preview body");
4132 if (runparams.flavor == OutputParams::LYX) {
4134 if (output == FullSource)
4136 else if (output == OnlyPreamble)
4137 params().writeFile(ods, this);
4138 else if (output == OnlyBody)
4140 os << from_utf8(ods.str());
4141 } else if (runparams.flavor == OutputParams::HTML) {
4142 writeLyXHTMLSource(os, runparams, output);
4143 } else if (runparams.flavor == OutputParams::TEXT) {
4144 if (output == OnlyPreamble) {
4145 os << "% "<< _("Plain text does not have a preamble.");
4147 writePlaintextFile(*this, os, runparams);
4148 } else if (params().isDocBook()) {
4149 writeDocBookSource(os, absFileName(), runparams, output);
4151 // latex or literate
4154 ots.texrow().newlines(2);
4156 runparams.is_child = true;
4158 writeLaTeXSource(ots, string(), runparams, output);
4159 texrow = ots.releaseTexRow();
4166 ErrorList & Buffer::errorList(string const & type) const
4168 return d->errorLists[type];
4172 void Buffer::updateTocItem(std::string const & type,
4173 DocIterator const & dit) const
4176 d->gui_->updateTocItem(type, dit);
4180 void Buffer::structureChanged() const
4183 d->gui_->structureChanged();
4187 void Buffer::errors(string const & err, bool from_master) const
4190 d->gui_->errors(err, from_master);
4194 void Buffer::message(docstring const & msg) const
4197 d->gui_->message(msg);
4201 void Buffer::setBusy(bool on) const
4204 d->gui_->setBusy(on);
4208 void Buffer::updateTitles() const
4211 d->wa_->updateTitles();
4215 void Buffer::resetAutosaveTimers() const
4218 d->gui_->resetAutosaveTimers();
4222 bool Buffer::hasGuiDelegate() const
4228 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4234 FileName Buffer::getEmergencyFileName() const
4236 return FileName(d->filename.absFileName() + ".emergency");
4240 FileName Buffer::getAutosaveFileName() const
4242 // if the document is unnamed try to save in the backup dir, else
4243 // in the default document path, and as a last try in the filePath,
4244 // which will most often be the temporary directory
4247 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4248 : lyxrc.backupdir_path;
4249 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4252 string const fname = "#" + d->filename.onlyFileName() + "#";
4254 return makeAbsPath(fname, fpath);
4258 void Buffer::removeAutosaveFile() const
4260 FileName const f = getAutosaveFileName();
4266 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4268 FileName const newauto = getAutosaveFileName();
4270 if (newauto != oldauto && oldauto.exists())
4271 if (!oldauto.moveTo(newauto))
4272 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4276 bool Buffer::autoSave() const
4278 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4279 if (buf->d->bak_clean || hasReadonlyFlag())
4282 message(_("Autosaving current document..."));
4283 buf->d->bak_clean = true;
4285 FileName const fname = getAutosaveFileName();
4286 LASSERT(d->cloned_buffer_, return false);
4288 // If this buffer is cloned, we assume that
4289 // we are running in a separate thread already.
4290 TempFile tempfile("lyxautoXXXXXX.lyx");
4291 tempfile.setAutoRemove(false);
4292 FileName const tmp_ret = tempfile.name();
4293 if (!tmp_ret.empty()) {
4295 // assume successful write of tmp_ret
4296 if (tmp_ret.moveTo(fname))
4299 // failed to write/rename tmp_ret so try writing direct
4300 return writeFile(fname);
4304 void Buffer::setExportStatus(bool e) const
4306 d->doing_export = e;
4307 ListOfBuffers clist = getDescendants();
4308 for (auto const & bit : clist)
4309 bit->d->doing_export = e;
4313 bool Buffer::isExporting() const
4315 return d->doing_export;
4319 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4323 return doExport(target, put_in_tempdir, result_file);
4326 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4327 string & result_file) const
4329 bool const update_unincluded =
4330 params().maintain_unincluded_children != BufferParams::CM_None
4331 && !params().getIncludedChildren().empty();
4333 // (1) export with all included children (omit \includeonly)
4334 if (update_unincluded) {
4335 ExportStatus const status =
4336 doExport(target, put_in_tempdir, true, result_file);
4337 if (status != ExportSuccess)
4340 // (2) export with included children only
4341 return doExport(target, put_in_tempdir, false, result_file);
4345 void Buffer::setMathFlavor(OutputParams & op) const
4347 switch (params().html_math_output) {
4348 case BufferParams::MathML:
4349 op.math_flavor = OutputParams::MathAsMathML;
4351 case BufferParams::HTML:
4352 op.math_flavor = OutputParams::MathAsHTML;
4354 case BufferParams::Images:
4355 op.math_flavor = OutputParams::MathAsImages;
4357 case BufferParams::LaTeX:
4358 op.math_flavor = OutputParams::MathAsLaTeX;
4364 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4365 bool includeall, string & result_file) const
4367 LYXERR(Debug::FILES, "target=" << target);
4368 OutputParams runparams(¶ms().encoding());
4369 string format = target;
4370 string dest_filename;
4371 size_t pos = target.find(' ');
4372 if (pos != string::npos) {
4373 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4374 format = target.substr(0, pos);
4375 if (format == "default")
4376 format = params().getDefaultOutputFormat();
4377 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4378 FileName(dest_filename).onlyPath().createPath();
4379 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4381 MarkAsExporting exporting(this);
4382 string backend_format;
4383 runparams.flavor = OutputParams::LATEX;
4384 runparams.linelen = lyxrc.plaintext_linelen;
4385 runparams.includeall = includeall;
4386 vector<string> backs = params().backends();
4387 Converters converters = theConverters();
4388 bool need_nice_file = false;
4389 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4390 // Get shortest path to format
4391 converters.buildGraph();
4392 Graph::EdgePath path;
4393 for (string const & sit : backs) {
4394 Graph::EdgePath p = converters.getPath(sit, format);
4395 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4396 backend_format = sit;
4401 if (!put_in_tempdir) {
4402 // Only show this alert if this is an export to a non-temporary
4403 // file (not for previewing).
4404 docstring s = bformat(_("No information for exporting the format %1$s."),
4405 theFormats().prettyName(format));
4406 if (format == "pdf4")
4408 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4409 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4410 Alert::error(_("Couldn't export file"), s);
4412 return ExportNoPathToFormat;
4414 runparams.flavor = converters.getFlavor(path, this);
4415 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4416 for (auto const & edge : path)
4417 if (theConverters().get(edge).nice()) {
4418 need_nice_file = true;
4423 backend_format = format;
4424 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4425 // FIXME: Don't hardcode format names here, but use a flag
4426 if (backend_format == "pdflatex")
4427 runparams.flavor = OutputParams::PDFLATEX;
4428 else if (backend_format == "luatex")
4429 runparams.flavor = OutputParams::LUATEX;
4430 else if (backend_format == "dviluatex")
4431 runparams.flavor = OutputParams::DVILUATEX;
4432 else if (backend_format == "xetex")
4433 runparams.flavor = OutputParams::XETEX;
4436 string filename = latexName(false);
4437 filename = addName(temppath(), filename);
4438 filename = changeExtension(filename,
4439 theFormats().extension(backend_format));
4440 LYXERR(Debug::FILES, "filename=" << filename);
4442 // Plain text backend
4443 if (backend_format == "text") {
4444 runparams.flavor = OutputParams::TEXT;
4446 writePlaintextFile(*this, FileName(filename), runparams);
4448 catch (ConversionException const &) { return ExportCancel; }
4451 else if (backend_format == "xhtml") {
4452 runparams.flavor = OutputParams::HTML;
4453 setMathFlavor(runparams);
4454 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4455 return ExportKilled;
4456 } else if (backend_format == "lyx")
4457 writeFile(FileName(filename));
4459 else if (params().isDocBook()) {
4460 runparams.nice = !put_in_tempdir;
4461 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4462 return ExportKilled;
4465 else if (backend_format == format || need_nice_file) {
4466 runparams.nice = true;
4467 ExportStatus const retval =
4468 makeLaTeXFile(FileName(filename), string(), runparams);
4469 if (retval == ExportKilled)
4470 return ExportKilled;
4471 if (d->cloned_buffer_)
4472 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4473 if (retval != ExportSuccess)
4475 } else if (!lyxrc.tex_allows_spaces
4476 && contains(filePath(), ' ')) {
4477 Alert::error(_("File name error"),
4478 bformat(_("The directory path to the document\n%1$s\n"
4479 "contains spaces, but your TeX installation does "
4480 "not allow them. You should save the file to a directory "
4481 "whose name does not contain spaces."), from_utf8(filePath())));
4482 return ExportTexPathHasSpaces;
4484 runparams.nice = false;
4485 ExportStatus const retval =
4486 makeLaTeXFile(FileName(filename), filePath(), runparams);
4487 if (retval == ExportKilled)
4488 return ExportKilled;
4489 if (d->cloned_buffer_)
4490 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4491 if (retval != ExportSuccess)
4495 string const error_type = (format == "program")
4496 ? "Build" : params().bufferFormat();
4497 ErrorList & error_list = d->errorLists[error_type];
4498 string const ext = theFormats().extension(format);
4499 FileName const tmp_result_file(changeExtension(filename, ext));
4500 Converters::RetVal const retval =
4501 converters.convert(this, FileName(filename), tmp_result_file,
4502 FileName(absFileName()), backend_format, format,
4503 error_list, Converters::none, includeall);
4504 if (retval == Converters::KILLED)
4505 return ExportCancel;
4506 bool success = (retval == Converters::SUCCESS);
4508 // Emit the signal to show the error list or copy it back to the
4509 // cloned Buffer so that it can be emitted afterwards.
4510 if (format != backend_format) {
4511 if (runparams.silent)
4513 else if (d->cloned_buffer_)
4514 d->cloned_buffer_->d->errorLists[error_type] =
4515 d->errorLists[error_type];
4518 // also to the children, in case of master-buffer-view
4519 ListOfBuffers clist = getDescendants();
4520 for (auto const & bit : clist) {
4521 if (runparams.silent)
4522 bit->d->errorLists[error_type].clear();
4523 else if (d->cloned_buffer_) {
4524 // Enable reverse search by copying back the
4525 // texrow object to the cloned buffer.
4526 // FIXME: this is not thread safe.
4527 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4528 bit->d->cloned_buffer_->d->errorLists[error_type] =
4529 bit->d->errorLists[error_type];
4531 bit->errors(error_type, true);
4535 if (d->cloned_buffer_) {
4536 // Enable reverse dvi or pdf to work by copying back the texrow
4537 // object to the cloned buffer.
4538 // FIXME: There is a possibility of concurrent access to texrow
4539 // here from the main GUI thread that should be securized.
4540 d->cloned_buffer_->d->texrow = d->texrow;
4541 string const err_type = params().bufferFormat();
4542 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4546 if (put_in_tempdir) {
4547 result_file = tmp_result_file.absFileName();
4548 return success ? ExportSuccess : ExportConverterError;
4551 if (dest_filename.empty())
4552 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4554 result_file = dest_filename;
4555 // We need to copy referenced files (e. g. included graphics
4556 // if format == "dvi") to the result dir.
4557 vector<ExportedFile> const extfiles =
4558 runparams.exportdata->externalFiles(format);
4559 string const dest = runparams.export_folder.empty() ?
4560 onlyPath(result_file) : runparams.export_folder;
4561 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4562 : force_overwrite == ALL_FILES;
4563 CopyStatus status = use_force ? FORCE : SUCCESS;
4565 for (ExportedFile const & exp : extfiles) {
4566 if (status == CANCEL) {
4567 message(_("Document export cancelled."));
4568 return ExportCancel;
4570 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4571 string fixedName = exp.exportName;
4572 if (!runparams.export_folder.empty()) {
4573 // Relative pathnames starting with ../ will be sanitized
4574 // if exporting to a different folder
4575 while (fixedName.substr(0, 3) == "../")
4576 fixedName = fixedName.substr(3, fixedName.length() - 3);
4578 FileName fixedFileName = makeAbsPath(fixedName, dest);
4579 fixedFileName.onlyPath().createPath();
4580 status = copyFile(fmt, exp.sourceName,
4582 exp.exportName, status == FORCE,
4583 runparams.export_folder.empty());
4587 if (tmp_result_file.exists()) {
4588 // Finally copy the main file
4589 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4590 : force_overwrite != NO_FILES;
4591 if (status == SUCCESS && use_force)
4593 status = copyFile(format, tmp_result_file,
4594 FileName(result_file), result_file,
4596 if (status == CANCEL) {
4597 message(_("Document export cancelled."));
4598 return ExportCancel;
4600 message(bformat(_("Document exported as %1$s "
4602 theFormats().prettyName(format),
4603 makeDisplayPath(result_file)));
4606 // This must be a dummy converter like fax (bug 1888)
4607 message(bformat(_("Document exported as %1$s"),
4608 theFormats().prettyName(format)));
4611 return success ? ExportSuccess : ExportConverterError;
4615 Buffer::ExportStatus Buffer::preview(string const & format) const
4617 bool const update_unincluded =
4618 params().maintain_unincluded_children != BufferParams::CM_None
4619 && !params().getIncludedChildren().empty();
4620 return preview(format, update_unincluded);
4624 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4626 MarkAsExporting exporting(this);
4628 // (1) export with all included children (omit \includeonly)
4630 ExportStatus const status = doExport(format, true, true, result_file);
4631 if (status != ExportSuccess)
4634 // (2) export with included children only
4635 ExportStatus const status = doExport(format, true, false, result_file);
4636 FileName const previewFile(result_file);
4638 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4639 theimpl->preview_file_ = previewFile;
4640 theimpl->preview_format_ = format;
4641 theimpl->require_fresh_start_ = (status != ExportSuccess);
4643 if (status != ExportSuccess)
4646 if (previewFile.exists())
4647 return theFormats().view(*this, previewFile, format) ?
4648 PreviewSuccess : PreviewError;
4650 // Successful export but no output file?
4651 // Probably a bug in error detection.
4652 LATTEST(status != ExportSuccess);
4657 Buffer::ReadStatus Buffer::extractFromVC()
4659 bool const found = LyXVC::file_not_found_hook(d->filename);
4661 return ReadFileNotFound;
4662 if (!d->filename.isReadableFile())
4668 Buffer::ReadStatus Buffer::loadEmergency()
4670 FileName const emergencyFile = getEmergencyFileName();
4671 if (!emergencyFile.exists()
4672 || emergencyFile.lastModified() <= d->filename.lastModified())
4673 return ReadFileNotFound;
4675 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4676 docstring const text = bformat(_("An emergency save of the document "
4677 "%1$s exists.\n\nRecover emergency save?"), file);
4679 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4680 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4686 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4687 bool const success = (ret_llf == ReadSuccess);
4689 if (hasReadonlyFlag()) {
4690 Alert::warning(_("File is read-only"),
4691 bformat(_("An emergency file is successfully loaded, "
4692 "but the original file %1$s is marked read-only. "
4693 "Please make sure to save the document as a different "
4694 "file."), from_utf8(d->filename.absFileName())));
4697 lyxvc().file_found_hook(d->filename);
4698 str = _("Document was successfully recovered.");
4700 str = _("Document was NOT successfully recovered.");
4701 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4702 makeDisplayPath(emergencyFile.absFileName()));
4704 int const del_emerg =
4705 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4706 _("&Remove"), _("&Keep"));
4707 if (del_emerg == 0) {
4708 emergencyFile.removeFile();
4710 Alert::warning(_("Emergency file deleted"),
4711 _("Do not forget to save your file now!"), true);
4713 return success ? ReadSuccess : ReadEmergencyFailure;
4716 int const del_emerg =
4717 Alert::prompt(_("Delete emergency file?"),
4718 _("Remove emergency file now?"), 1, 1,
4719 _("&Remove"), _("&Keep"));
4721 emergencyFile.removeFile();
4725 string const ename = emergencyFile.absFileName();
4727 // Surely we can find one in 100 tries?
4728 for (int i = 1; i < 100; ++i) {
4729 newname.set(ename + to_string(i) + ".lyx");
4730 if (!newname.exists()) {
4736 // renameTo returns true on success. So inverting that
4737 // will give us true if we fail.
4738 noname = !emergencyFile.renameTo(newname);
4741 Alert::warning(_("Can't rename emergency file!"),
4742 _("LyX was unable to rename the emergency file. "
4743 "You should do so manually. Otherwise, you will be "
4744 "asked about it again the next time you try to load "
4745 "this file, and may over-write your own work."));
4747 Alert::warning(_("Emergency File Renames"),
4748 bformat(_("Emergency file renamed as:\n %1$s"),
4749 from_utf8(newname.onlyFileName())));
4752 return ReadOriginal;
4762 Buffer::ReadStatus Buffer::loadAutosave()
4764 // Now check if autosave file is newer.
4765 FileName const autosaveFile = getAutosaveFileName();
4766 if (!autosaveFile.exists()
4767 || autosaveFile.lastModified() <= d->filename.lastModified())
4768 return ReadFileNotFound;
4770 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4771 docstring const text = bformat(_("The backup of the document %1$s "
4772 "is newer.\n\nLoad the backup instead?"), file);
4773 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4774 _("&Load backup"), _("Load &original"), _("&Cancel"));
4779 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4780 // the file is not saved if we load the autosave file.
4781 if (ret_llf == ReadSuccess) {
4782 if (hasReadonlyFlag()) {
4783 Alert::warning(_("File is read-only"),
4784 bformat(_("A backup file is successfully loaded, "
4785 "but the original file %1$s is marked read-only. "
4786 "Please make sure to save the document as a "
4788 from_utf8(d->filename.absFileName())));
4791 lyxvc().file_found_hook(d->filename);
4794 return ReadAutosaveFailure;
4797 // Here we delete the autosave
4798 autosaveFile.removeFile();
4799 return ReadOriginal;
4807 Buffer::ReadStatus Buffer::loadLyXFile()
4809 if (!d->filename.isReadableFile()) {
4810 ReadStatus const ret_rvc = extractFromVC();
4811 if (ret_rvc != ReadSuccess)
4815 ReadStatus const ret_re = loadEmergency();
4816 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4819 ReadStatus const ret_ra = loadAutosave();
4820 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4823 return loadThisLyXFile(d->filename);
4827 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4829 return readFile(fn);
4833 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4835 for (; err != end; ++err) {
4836 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4837 int errorRow = err->error_in_line;
4838 Buffer const * buf = nullptr;
4839 Impl const * p = this;
4840 if (err->child_name.empty())
4841 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4843 // The error occurred in a child
4844 for (Buffer const * child : owner_->getDescendants()) {
4845 string const child_name =
4846 DocFileName(changeExtension(child->absFileName(), "tex")).
4848 if (err->child_name != child_name)
4850 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4851 if (!TexRow::isNone(start)) {
4852 buf = this->cloned_buffer_
4853 ? child->d->cloned_buffer_->d->owner_
4860 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4866 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4868 TeXErrors::Errors::const_iterator err = terr.begin();
4869 TeXErrors::Errors::const_iterator end = terr.end();
4871 d->traverseErrors(err, end, errorList);
4875 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4877 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4878 TeXErrors::Errors::const_iterator end = terr.end_ref();
4880 d->traverseErrors(err, end, errorList);
4884 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4886 LBUFERR(!text().paragraphs().empty());
4888 // Use the master text class also for child documents
4889 Buffer const * const master = masterBuffer();
4890 DocumentClass const & textclass = master->params().documentClass();
4892 docstring_list old_bibfiles;
4893 // Do this only if we are the top-level Buffer. We also need to account
4894 // for the case of a previewed child with ignored parent here.
4895 if (master == this && !d->ignore_parent) {
4896 textclass.counters().reset(from_ascii("bibitem"));
4897 reloadBibInfoCache();
4898 // we will re-read this cache as we go through, but we need
4899 // to know whether it's changed to know whether we need to
4900 // update the bibinfo cache.
4901 old_bibfiles = d->bibfiles_cache_;
4902 d->bibfiles_cache_.clear();
4905 // keep the buffers to be children in this set. If the call from the
4906 // master comes back we can see which of them were actually seen (i.e.
4907 // via an InsetInclude). The remaining ones in the set need still be updated.
4908 static std::set<Buffer const *> bufToUpdate;
4909 if (scope == UpdateMaster) {
4910 // If this is a child document start with the master
4911 if (master != this) {
4912 bufToUpdate.insert(this);
4913 master->updateBuffer(UpdateMaster, utype);
4914 // If the master buffer has no gui associated with it, then the TocModel is
4915 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4916 // (bug 5699). The same happens if the master buffer is open in a different
4917 // window. This test catches both possibilities.
4918 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4919 // There remains a problem here: If there is another child open in yet a third
4920 // window, that TOC is not updated. So some more general solution is needed at
4922 if (master->d->gui_ != d->gui_)
4925 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4926 if (bufToUpdate.find(this) == bufToUpdate.end())
4930 // start over the counters in the master
4931 textclass.counters().reset();
4934 // update will be done below for this buffer
4935 bufToUpdate.erase(this);
4937 // update all caches
4938 clearReferenceCache();
4941 Buffer & cbuf = const_cast<Buffer &>(*this);
4942 // if we are reloading, then we could have a dangling TOC,
4943 // in effect. so we need to go ahead and reset, even though
4944 // we will do so again when we rebuild the TOC later.
4945 cbuf.tocBackend().reset();
4948 ParIterator parit = cbuf.par_iterator_begin();
4949 updateBuffer(parit, utype);
4951 // If this document has siblings, then update the TocBackend later. The
4952 // reason is to ensure that later siblings are up to date when e.g. the
4953 // broken or not status of references is computed. The update is called
4954 // in InsetInclude::addToToc.
4958 // if the bibfiles changed, the cache of bibinfo is invalid
4959 docstring_list new_bibfiles = d->bibfiles_cache_;
4960 // this is a trick to determine whether the two vectors have
4961 // the same elements.
4962 sort(new_bibfiles.begin(), new_bibfiles.end());
4963 sort(old_bibfiles.begin(), old_bibfiles.end());
4964 if (old_bibfiles != new_bibfiles) {
4965 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4966 invalidateBibinfoCache();
4967 reloadBibInfoCache();
4968 // We relied upon the bibinfo cache when recalculating labels. But that
4969 // cache was invalid, although we didn't find that out until now. So we
4970 // have to do it all again.
4971 // That said, the only thing we really need to do is update the citation
4972 // labels. Nothing else will have changed. So we could create a new
4973 // UpdateType that would signal that fact, if we needed to do so.
4974 parit = cbuf.par_iterator_begin();
4975 // we will be re-doing the counters and references and such.
4976 textclass.counters().reset();
4977 clearReferenceCache();
4978 // we should not need to do this again?
4980 updateBuffer(parit, utype);
4981 // this will already have been done by reloadBibInfoCache();
4982 // d->bibinfo_cache_valid_ = true;
4985 LYXERR(Debug::FILES, "Bibfiles unchanged.");
4986 // this is also set to true on the other path, by reloadBibInfoCache.
4987 d->bibinfo_cache_valid_ = true;
4989 d->cite_labels_valid_ = true;
4991 cbuf.tocBackend().update(true, utype);
4992 if (scope == UpdateMaster)
4993 cbuf.structureChanged();
4997 static depth_type getDepth(DocIterator const & it)
4999 depth_type depth = 0;
5000 for (size_t i = 0 ; i < it.depth() ; ++i)
5001 if (!it[i].inset().inMathed())
5002 depth += it[i].paragraph().getDepth() + 1;
5003 // remove 1 since the outer inset does not count
5004 // we should have at least one non-math inset, so
5005 // depth should nevery be 0. but maybe it is worth
5006 // marking this, just in case.
5008 // coverity[INTEGER_OVERFLOW]
5012 static depth_type getItemDepth(ParIterator const & it)
5014 Paragraph const & par = *it;
5015 LabelType const labeltype = par.layout().labeltype;
5017 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5020 // this will hold the lowest depth encountered up to now.
5021 depth_type min_depth = getDepth(it);
5022 ParIterator prev_it = it;
5025 --prev_it.top().pit();
5027 // start of nested inset: go to outer par
5029 if (prev_it.empty()) {
5030 // start of document: nothing to do
5035 // We search for the first paragraph with same label
5036 // that is not more deeply nested.
5037 Paragraph & prev_par = *prev_it;
5038 depth_type const prev_depth = getDepth(prev_it);
5039 if (labeltype == prev_par.layout().labeltype) {
5040 if (prev_depth < min_depth)
5041 return prev_par.itemdepth + 1;
5042 if (prev_depth == min_depth)
5043 return prev_par.itemdepth;
5045 min_depth = min(min_depth, prev_depth);
5046 // small optimization: if we are at depth 0, we won't
5047 // find anything else
5048 if (prev_depth == 0)
5054 static bool needEnumCounterReset(ParIterator const & it)
5056 Paragraph const & par = *it;
5057 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5058 depth_type const cur_depth = par.getDepth();
5059 ParIterator prev_it = it;
5060 while (prev_it.pit()) {
5061 --prev_it.top().pit();
5062 Paragraph const & prev_par = *prev_it;
5063 if (prev_par.getDepth() <= cur_depth)
5064 return prev_par.layout().name() != par.layout().name();
5066 // start of nested inset: reset
5071 // set the label of a paragraph. This includes the counters.
5072 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5074 BufferParams const & bp = owner_->masterBuffer()->params();
5075 DocumentClass const & textclass = bp.documentClass();
5076 Paragraph & par = it.paragraph();
5077 Layout const & layout = par.layout();
5078 Counters & counters = textclass.counters();
5080 if (par.params().startOfAppendix()) {
5081 // We want to reset the counter corresponding to toplevel sectioning
5082 Layout const & lay = textclass.getTOCLayout();
5083 docstring const cnt = lay.counter;
5085 counters.reset(cnt);
5086 counters.appendix(true);
5088 par.params().appendix(counters.appendix());
5090 // Compute the item depth of the paragraph
5091 par.itemdepth = getItemDepth(it);
5093 if (layout.margintype == MARGIN_MANUAL) {
5094 if (par.params().labelWidthString().empty())
5095 par.params().labelWidthString(par.expandLabel(layout, bp));
5096 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5097 // we do not need to do anything here, since the empty case is
5098 // handled during export.
5100 par.params().labelWidthString(docstring());
5103 switch(layout.labeltype) {
5104 case LABEL_ITEMIZE: {
5105 // At some point of time we should do something more
5106 // clever here, like:
5107 // par.params().labelString(
5108 // bp.user_defined_bullet(par.itemdepth).getText());
5109 // for now, use a simple hardcoded label
5110 docstring itemlabel;
5111 switch (par.itemdepth) {
5114 itemlabel = char_type(0x2022);
5118 itemlabel = char_type(0x2013);
5121 // ∗ U+2217 ASTERISK OPERATOR
5122 itemlabel = char_type(0x2217);
5125 // · U+00B7 MIDDLE DOT
5126 itemlabel = char_type(0x00b7);
5129 par.params().labelString(itemlabel);
5133 case LABEL_ENUMERATE: {
5134 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5136 switch (par.itemdepth) {
5147 enumcounter += "iv";
5150 // not a valid enumdepth...
5154 if (needEnumCounterReset(it)) {
5155 // Increase the master counter?
5156 if (layout.stepmastercounter)
5157 counters.stepMaster(enumcounter, utype);
5158 // Maybe we have to reset the enumeration counter.
5159 if (!layout.resumecounter)
5160 counters.reset(enumcounter);
5162 counters.step(enumcounter, utype);
5164 string const & lang = par.getParLanguage(bp)->code();
5165 par.params().labelString(counters.theCounter(enumcounter, lang));
5170 case LABEL_SENSITIVE: {
5171 string const & type = counters.current_float();
5172 docstring full_label;
5174 full_label = owner_->B_("Senseless!!! ");
5176 docstring name = owner_->B_(textclass.floats().getType(type).name());
5177 if (counters.hasCounter(from_utf8(type))) {
5178 string const & lang = par.getParLanguage(bp)->code();
5179 counters.step(from_utf8(type), utype);
5180 full_label = bformat(from_ascii("%1$s %2$s:"),
5182 counters.theCounter(from_utf8(type), lang));
5184 full_label = bformat(from_ascii("%1$s #:"), name);
5186 par.params().labelString(full_label);
5190 case LABEL_NO_LABEL:
5191 par.params().labelString(docstring());
5195 case LABEL_CENTERED:
5196 case LABEL_STATIC: {
5197 docstring const & lcounter = layout.counter;
5198 if (!lcounter.empty()) {
5199 if (layout.toclevel <= bp.secnumdepth
5200 && (layout.latextype != LATEX_ENVIRONMENT
5201 || it.text()->isFirstInSequence(it.pit()))) {
5202 if (counters.hasCounter(lcounter))
5203 counters.step(lcounter, utype);
5204 par.params().labelString(par.expandLabel(layout, bp));
5206 par.params().labelString(docstring());
5208 par.params().labelString(par.expandLabel(layout, bp));
5214 par.params().labelString(par.expandLabel(layout, bp));
5219 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted) const
5221 // LASSERT: Is it safe to continue here, or should we just return?
5222 LASSERT(parit.pit() == 0, /**/);
5224 // Set the position of the text in the buffer to be able
5225 // to resolve macros in it.
5226 parit.text()->setMacrocontextPosition(parit);
5228 // Reset bibitem counter in master (#8499)
5229 Buffer const * const master = masterBuffer();
5230 if (master == this && !d->ignore_parent)
5231 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5233 depth_type maxdepth = 0;
5234 pit_type const lastpit = parit.lastpit();
5235 bool changed = false;
5236 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5237 // reduce depth if necessary
5238 if (parit->params().depth() > maxdepth) {
5239 /** FIXME: this function is const, but
5240 * nevertheless it modifies the buffer. To be
5241 * cleaner, one should modify the buffer in
5242 * another function, which is actually
5243 * non-const. This would however be costly in
5244 * terms of code duplication.
5246 CursorData(parit).recordUndo();
5247 parit->params().depth(maxdepth);
5249 maxdepth = parit->getMaxDepthAfter();
5251 if (utype == OutputUpdate) {
5252 // track the active counters
5253 // we have to do this for the master buffer, since the local
5254 // buffer isn't tracking anything.
5255 masterBuffer()->params().documentClass().counters().
5256 setActiveLayout(parit->layout());
5259 // set the counter for this paragraph
5260 d->setLabel(parit, utype);
5263 for (auto const & insit : parit->insetList()) {
5264 parit.pos() = insit.pos;
5265 insit.inset->updateBuffer(parit, utype, deleted || parit->isDeleted(insit.pos));
5266 changed |= insit.inset->isChanged();
5269 // are there changes in this paragraph?
5270 changed |= parit->isChanged();
5273 // set change indicator for the inset (or the cell that the iterator
5274 // points to, if applicable).
5275 parit.text()->inset().isChanged(changed);
5279 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5280 WordLangTuple & word_lang, docstring_list & suggestions) const
5284 suggestions.clear();
5285 word_lang = WordLangTuple();
5286 bool const to_end = to.empty();
5287 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5288 // OK, we start from here.
5289 for (; from != end; from.forwardPos()) {
5290 // This skips all insets with spell check disabled.
5291 while (!from.allowSpellCheck()) {
5295 // If from is at the end of the document (which is possible
5296 // when "from" was changed above) LyX will crash later otherwise.
5297 if (from.atEnd() || (!to_end && from >= end))
5300 from.paragraph().spellCheck();
5301 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5302 if (SpellChecker::misspelled(res)) {
5306 // Do not increase progress when from == to, otherwise the word
5307 // count will be wrong.
5317 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5319 bool inword = false;
5324 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5325 if (!dit.inTexted()) {
5330 Paragraph const & par = dit.paragraph();
5331 pos_type const pos = dit.pos();
5333 // Copied and adapted from isWordSeparator() in Paragraph
5334 if (pos == dit.lastpos()) {
5337 Inset const * ins = par.getInset(pos);
5338 if (ins && skipNoOutput && !ins->producesOutput()) {
5341 // stop if end of range was skipped
5342 if (!to.atEnd() && dit >= to)
5345 } else if (!par.isDeleted(pos)) {
5346 if (par.isWordSeparator(pos))
5352 if (ins && ins->isLetter())
5354 else if (ins && ins->isSpace())
5357 char_type const c = par.getChar(pos);
5358 if (isPrintableNonspace(c))
5360 else if (isSpace(c))
5370 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5372 d->updateStatistics(from, to, skipNoOutput);
5376 int Buffer::wordCount() const
5378 return d->wordCount();
5382 int Buffer::charCount(bool with_blanks) const
5384 return d->charCount(with_blanks);
5388 bool Buffer::areChangesPresent() const
5390 return inset().isChanged();
5394 Buffer::ReadStatus Buffer::reload()
5397 // c.f. bug https://www.lyx.org/trac/ticket/6587
5398 removeAutosaveFile();
5399 // e.g., read-only status could have changed due to version control
5400 d->filename.refresh();
5401 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5403 // clear parent. this will get reset if need be.
5404 d->setParent(nullptr);
5405 ReadStatus const status = loadLyXFile();
5406 if (status == ReadSuccess) {
5411 message(bformat(_("Document %1$s reloaded."), disp_fn));
5414 message(bformat(_("Could not reload document %1$s."), disp_fn));
5424 bool Buffer::saveAs(FileName const & fn)
5426 FileName const old_name = fileName();
5427 FileName const old_auto = getAutosaveFileName();
5428 bool const old_unnamed = isUnnamed();
5429 bool success = true;
5430 d->old_position = filePath();
5437 // bring the autosave file with us, just in case.
5438 moveAutosaveFile(old_auto);
5439 // validate version control data and
5440 // correct buffer title
5441 lyxvc().file_found_hook(fileName());
5443 // the file has now been saved to the new location.
5444 // we need to check that the locations of child buffers
5446 checkChildBuffers();
5447 checkMasterBuffer();
5450 // reset the old filename and unnamed state
5451 setFileName(old_name);
5452 setUnnamed(old_unnamed);
5456 d->old_position.clear();
5461 void Buffer::checkChildBuffers()
5463 for (auto const & bit : d->children_positions) {
5464 DocIterator dit = bit.second;
5465 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5466 if (!cbuf || !theBufferList().isLoaded(cbuf))
5468 Inset * inset = dit.nextInset();
5469 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5470 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5471 docstring const & incfile = inset_inc->getParam("filename");
5472 string oldloc = cbuf->absFileName();
5473 string newloc = makeAbsPath(to_utf8(incfile),
5474 onlyPath(absFileName())).absFileName();
5475 if (oldloc == newloc)
5477 // the location of the child file is incorrect.
5478 cbuf->setParent(nullptr);
5479 inset_inc->setChildBuffer(nullptr);
5481 // invalidate cache of children
5482 d->children_positions.clear();
5483 d->position_to_children.clear();
5487 // If a child has been saved under a different name/path, it might have been
5488 // orphaned. Therefore the master needs to be reset (bug 8161).
5489 void Buffer::checkMasterBuffer()
5491 Buffer const * const master = masterBuffer();
5495 // necessary to re-register the child (bug 5873)
5496 // FIXME: clean up updateMacros (here, only
5497 // child registering is needed).
5498 master->updateMacros();
5499 // (re)set master as master buffer, but only
5500 // if we are a real child
5501 if (master->isChild(this))
5508 string Buffer::includedFilePath(string const & name, string const & ext) const
5510 if (d->old_position.empty() ||
5511 equivalent(FileName(d->old_position), FileName(filePath())))
5514 bool isabsolute = FileName::isAbsolute(name);
5515 // both old_position and filePath() end with a path separator
5516 string absname = isabsolute ? name : d->old_position + name;
5518 // if old_position is set to origin, we need to do the equivalent of
5519 // getReferencedFileName() (see readDocument())
5520 if (!isabsolute && d->old_position == params().origin) {
5521 FileName const test(addExtension(filePath() + name, ext));
5523 absname = filePath() + name;
5526 if (!FileName(addExtension(absname, ext)).exists())
5530 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5532 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5533 from_utf8(filePath())));
5537 void Buffer::Impl::refreshFileMonitor()
5539 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5540 file_monitor_->refresh();
5544 // The previous file monitor is invalid
5545 // This also destroys the previous file monitor and all its connections
5546 file_monitor_ = FileSystemWatcher::monitor(filename);
5547 // file_monitor_ will be destroyed with *this, so it is not going to call a
5548 // destroyed object method.
5549 file_monitor_->connect([this](bool exists) {
5550 fileExternallyModified(exists);
5555 void Buffer::Impl::fileExternallyModified(bool const exists)
5557 // ignore notifications after our own saving operations
5558 if (checksum_ == filename.checksum()) {
5559 LYXERR(Debug::FILES, "External modification but "
5560 "checksum unchanged: " << filename);
5563 // If the file has been deleted, only mark the file as dirty since it is
5564 // pointless to prompt for reloading. If later a file is moved into this
5565 // location, then the externally modified warning will appear then.
5567 externally_modified_ = true;
5568 // Update external modification notification.
5569 // Dirty buffers must be visible at all times.
5570 if (wa_ && wa_->unhide(owner_))
5571 wa_->updateTitles();
5573 // Unable to unhide the buffer (e.g. no GUI or not current View)
5578 bool Buffer::notifiesExternalModification() const
5580 return d->externally_modified_;
5584 void Buffer::clearExternalModification() const
5586 d->externally_modified_ = false;
5588 d->wa_->updateTitles();