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 std::list<CloneList *> cloned_buffers;
166 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
170 delete preview_loader_;
178 /// search for macro in local (buffer) table or in children
179 MacroData const * getBufferMacro(docstring const & name,
180 DocIterator const & pos) const;
182 /// Update macro table starting with position of it \param it in some
184 void updateMacros(DocIterator & it, DocIterator & scope);
186 void setLabel(ParIterator & it, UpdateType utype) const;
188 /** If we have branches that use the file suffix
189 feature, return the file name with suffix appended.
191 FileName exportFileName() const;
198 mutable TexRow texrow;
200 /// need to regenerate .tex?
204 mutable bool lyx_clean;
206 /// is autosave needed?
207 mutable bool bak_clean;
209 /// is this an unnamed file (New...)?
212 /// is this an internal bufffer?
213 bool internal_buffer;
218 /// name of the file the buffer is associated with.
221 /** Set to true only when the file is fully loaded.
222 * Used to prevent the premature generation of previews
223 * and by the citation inset.
225 bool file_fully_loaded;
227 /// original format of loaded file
230 /// if the file was originally loaded from an older format, do
231 /// we need to back it up still?
232 bool need_format_backup;
234 /// Ignore the parent (e.g. when exporting a child standalone)?
238 mutable TocBackend toc_backend;
243 ScopeMacro(DocIterator const & s, MacroData const & m)
244 : scope(s), macro(m) {}
248 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
249 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
250 /// map from the macro name to the position map,
251 /// which maps the macro definition position to the scope and the MacroData.
252 NamePositionScopeMacroMap macros;
253 /// This seem to change the way Buffer::getMacro() works
254 mutable bool macro_lock;
256 /// positions of child buffers in the buffer
257 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
259 ScopeBuffer() : buffer(nullptr) {}
260 ScopeBuffer(DocIterator const & s, Buffer const * b)
261 : scope(s), buffer(b) {}
263 Buffer const * buffer;
265 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
266 /// position of children buffers in this buffer
267 BufferPositionMap children_positions;
268 /// map from children inclusion positions to their scope and their buffer
269 PositionScopeBufferMap position_to_children;
271 /// Contains the old buffer filePath() while saving-as, or the
272 /// directory where the document was last saved while loading.
275 /** Keeps track of the path of local layout files.
276 * If possible, it is always relative to the buffer path.
277 * Empty for layouts in system or user directory.
279 string layout_position;
281 /// Container for all sort of Buffer dependant errors.
282 map<string, ErrorList> errorLists;
284 /// checksum used to test if the file has been externally modified. Used to
285 /// double check whether the file had been externally modified when saving.
286 unsigned long checksum_;
289 frontend::WorkAreaManager * wa_;
291 frontend::GuiBufferDelegate * gui_;
296 /// A cache for the bibfiles (including bibfiles of loaded child
297 /// documents), needed for appropriate update of natbib labels.
298 mutable docstring_list bibfiles_cache_;
300 // FIXME The caching mechanism could be improved. At present, we have a
301 // cache for each Buffer, that caches all the bibliography info for that
302 // Buffer. A more efficient solution would be to have a global cache per
303 // file, and then to construct the Buffer's bibinfo from that.
304 /// A cache for bibliography info
305 mutable BiblioInfo bibinfo_;
306 /// whether the bibinfo cache is valid
307 mutable bool bibinfo_cache_valid_;
308 /// Cache of timestamps of .bib files
309 map<FileName, time_t> bibfile_status_;
310 /// Indicates whether the bibinfo has changed since the last time
311 /// we ran updateBuffer(), i.e., whether citation labels may need
313 mutable bool cite_labels_valid_;
314 /// Do we have a bibliography environment?
315 mutable bool have_bibitems_;
317 /// These two hold the file name and format, written to by
318 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
319 FileName preview_file_;
320 string preview_format_;
321 /// If there was an error when previewing, on the next preview we do
322 /// a fresh compile (e.g. in case the user installed a package that
324 bool require_fresh_start_;
326 /// Cache the references associated to a label and their positions
328 mutable RefCache ref_cache_;
329 /// Cache the label insets and their activity status.
330 mutable LabelCache label_cache_;
332 /// our Text that should be wrapped in an InsetText
336 PreviewLoader * preview_loader_;
338 /// This is here to force the test to be done whenever parent_buffer
340 Buffer const * parent() const
342 // ignore_parent temporarily "orphans" a buffer
343 // (e.g. if a child is compiled standalone)
346 // if parent_buffer is not loaded, then it has been unloaded,
347 // which means that parent_buffer is an invalid pointer. So we
348 // set it to null in that case.
349 // however, the BufferList doesn't know about cloned buffers, so
350 // they will always be regarded as unloaded. in that case, we hope
352 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
353 parent_buffer = nullptr;
354 return parent_buffer;
358 void setParent(Buffer const * pb)
360 if (parent_buffer == pb)
363 if (!cloned_buffer_ && parent_buffer && pb)
364 LYXERR0("Warning: a buffer should not have two parents!");
366 if (!cloned_buffer_ && parent_buffer)
367 parent_buffer->invalidateBibinfoCache();
370 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
371 /// This one is useful for preview detached in a thread.
372 Buffer const * cloned_buffer_;
374 CloneList * clone_list_;
375 /// are we in the process of exporting this buffer?
376 mutable bool doing_export;
378 /// compute statistics
379 /// \p from initial position
380 /// \p to points to the end position
381 void updateStatistics(DocIterator & from, DocIterator & to,
382 bool skipNoOutput = true);
383 /// statistics accessor functions
384 int wordCount() const
388 int charCount(bool with_blanks) const
391 + (with_blanks ? blank_count_ : 0);
394 // Make sure the file monitor monitors the good file.
395 void refreshFileMonitor();
397 /// Notify or clear of external modification
398 void fileExternallyModified(bool exists);
400 /// has been externally modified? Can be reset by the user.
401 mutable bool externally_modified_;
403 ///Binding LaTeX lines with buffer positions.
404 //Common routine for LaTeX and Reference errors listing.
405 void traverseErrors(TeXErrors::Errors::const_iterator err,
406 TeXErrors::Errors::const_iterator end,
407 ErrorList & errorList) const;
410 /// So we can force access via the accessors.
411 mutable Buffer const * parent_buffer;
417 FileMonitorPtr file_monitor_;
421 /// Creates the per buffer temporary directory
422 static FileName createBufferTmpDir()
424 // FIXME This would be the ideal application for a TempDir class (like
425 // TempFile but for directories)
430 Mutex::Locker locker(&mutex);
431 counter = convert<string>(count++);
433 // We are in our own directory. Why bother to mangle name?
434 // In fact I wrote this code to circumvent a problematic behaviour
435 // (bug?) of EMX mkstemp().
436 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
439 if (!tmpfl.createDirectory(0777)) {
440 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
441 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
442 from_utf8(tmpfl.absFileName())));
448 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
449 Buffer const * cloned_buffer)
450 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
451 internal_buffer(false), read_only(readonly_), filename(file),
452 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
453 ignore_parent(false), toc_backend(owner), macro_lock(false),
454 checksum_(0), wa_(nullptr), gui_(nullptr), undo_(*owner), bibinfo_cache_valid_(false),
455 cite_labels_valid_(false), have_bibitems_(false), require_fresh_start_(false),
456 inset(nullptr), preview_loader_(nullptr), cloned_buffer_(cloned_buffer),
457 clone_list_(nullptr), doing_export(false),
458 externally_modified_(false), parent_buffer(nullptr),
459 word_count_(0), char_count_(0), blank_count_(0)
461 refreshFileMonitor();
462 if (!cloned_buffer_) {
463 temppath = createBufferTmpDir();
464 lyxvc.setBuffer(owner_);
465 Language const * inplang = theApp() ?
466 languages.getFromCode(theApp()->inputLanguageCode())
469 params.language = inplang;
471 wa_ = new frontend::WorkAreaManager;
474 temppath = cloned_buffer_->d->temppath;
475 file_fully_loaded = true;
476 params = cloned_buffer_->d->params;
477 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
478 bibinfo_ = cloned_buffer_->d->bibinfo_;
479 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
480 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
481 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
482 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
483 unnamed = cloned_buffer_->d->unnamed;
484 internal_buffer = cloned_buffer_->d->internal_buffer;
485 layout_position = cloned_buffer_->d->layout_position;
486 preview_file_ = cloned_buffer_->d->preview_file_;
487 preview_format_ = cloned_buffer_->d->preview_format_;
488 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
492 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
493 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
495 LYXERR(Debug::INFO, "Buffer::Buffer()");
497 d->inset = new InsetText(*cloned_buffer->d->inset);
498 d->inset->setBuffer(*this);
499 // FIXME: optimize this loop somewhat, maybe by creating a new
500 // general recursive Inset::setId().
501 DocIterator it = doc_iterator_begin(this);
502 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
503 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
504 it.paragraph().setId(cloned_it.paragraph().id());
506 d->inset = new InsetText(this);
507 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
513 LYXERR(Debug::INFO, "Buffer::~Buffer()");
514 // here the buffer should take care that it is
515 // saved properly, before it goes into the void.
517 // GuiView already destroyed
521 // No need to do additional cleanups for internal buffer.
527 // this is in case of recursive includes: we won't try to delete
528 // ourselves as a child.
529 d->clone_list_->erase(this);
530 // loop over children
531 for (auto const & p : d->children_positions) {
532 Buffer * child = const_cast<Buffer *>(p.first);
533 if (d->clone_list_->erase(child))
536 // if we're the master buffer, then we should get rid of the list
539 // If this is not empty, we have leaked something. Worse, one of the
540 // children still has a reference to this list. But we will try to
541 // continue, rather than shut down.
542 LATTEST(d->clone_list_->empty());
543 list<CloneList *>::iterator it =
544 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
545 if (it == cloned_buffers.end()) {
546 // We will leak in this case, but it is safe to continue.
549 cloned_buffers.erase(it);
550 delete d->clone_list_;
552 // FIXME Do we really need to do this right before we delete d?
553 // clear references to children in macro tables
554 d->children_positions.clear();
555 d->position_to_children.clear();
557 // loop over children
558 for (auto const & p : d->children_positions) {
559 Buffer * child = const_cast<Buffer *>(p.first);
560 if (theBufferList().isLoaded(child)) {
561 if (theBufferList().isOthersChild(this, child))
562 child->setParent(nullptr);
564 theBufferList().release(child);
569 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
571 msg += emergencyWrite();
573 msg += " " + _("Save failed! Document is lost.");
575 Alert::warning(_("Attempting to close changed document!"), msg);
578 // FIXME Do we really need to do this right before we delete d?
579 // clear references to children in macro tables
580 d->children_positions.clear();
581 d->position_to_children.clear();
583 if (!d->temppath.destroyDirectory()) {
584 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
585 from_utf8(d->temppath.absFileName())));
594 Buffer * Buffer::cloneWithChildren() const
597 cloned_buffers.push_back(new CloneList);
598 CloneList * clones = cloned_buffers.back();
600 cloneWithChildren(bufmap, clones);
602 // make sure we got cloned
603 BufferMap::const_iterator bit = bufmap.find(this);
604 LASSERT(bit != bufmap.end(), return nullptr);
605 Buffer * cloned_buffer = bit->second;
607 return cloned_buffer;
611 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
613 // have we already been cloned?
614 if (bufmap.find(this) != bufmap.end())
617 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
619 // The clone needs its own DocumentClass, since running updateBuffer() will
620 // modify it, and we would otherwise be sharing it with the original Buffer.
621 buffer_clone->params().makeDocumentClass(true);
623 cap::switchBetweenClasses(
624 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
625 static_cast<InsetText &>(buffer_clone->inset()), el);
627 bufmap[this] = buffer_clone;
628 clones->insert(buffer_clone);
629 buffer_clone->d->clone_list_ = clones;
630 buffer_clone->d->macro_lock = true;
631 buffer_clone->d->children_positions.clear();
633 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
634 // math macro caches need to be rethought and simplified.
635 // I am not sure wether we should handle Buffer cloning here or in BufferList.
636 // Right now BufferList knows nothing about buffer clones.
637 for (auto const & p : d->position_to_children) {
638 DocIterator dit = p.first.clone(buffer_clone);
639 dit.setBuffer(buffer_clone);
640 Buffer * child = const_cast<Buffer *>(p.second.buffer);
642 child->cloneWithChildren(bufmap, clones);
643 BufferMap::iterator const bit = bufmap.find(child);
644 LASSERT(bit != bufmap.end(), continue);
645 Buffer * child_clone = bit->second;
647 Inset * inset = dit.nextInset();
648 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
649 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
650 inset_inc->setChildBuffer(child_clone);
651 child_clone->d->setParent(buffer_clone);
652 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
653 buffer_clone->setChild(dit, child_clone);
655 buffer_clone->d->macro_lock = false;
660 Buffer * Buffer::cloneBufferOnly() const {
661 cloned_buffers.push_back(new CloneList);
662 CloneList * clones = cloned_buffers.back();
663 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
665 // The clone needs its own DocumentClass, since running updateBuffer() will
666 // modify it, and we would otherwise be sharing it with the original Buffer.
667 buffer_clone->params().makeDocumentClass(true);
669 cap::switchBetweenClasses(
670 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
671 static_cast<InsetText &>(buffer_clone->inset()), el);
673 clones->insert(buffer_clone);
674 buffer_clone->d->clone_list_ = clones;
676 // we won't be cloning the children
677 buffer_clone->d->children_positions.clear();
682 bool Buffer::isClone() const
684 return d->cloned_buffer_;
688 void Buffer::changed(bool update_metrics) const
691 d->wa_->redrawAll(update_metrics);
695 frontend::WorkAreaManager & Buffer::workAreaManager() const
702 Text & Buffer::text() const
704 return d->inset->text();
708 Inset & Buffer::inset() const
714 BufferParams & Buffer::params()
720 BufferParams const & Buffer::params() const
726 BufferParams const & Buffer::masterParams() const
728 if (masterBuffer() == this)
731 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
732 // Copy child authors to the params. We need those pointers.
733 for (Author const & a : params().authors())
734 mparams.authors().record(a);
739 double Buffer::fontScalingFactor() const
741 return isExporting() ? 75.0 * params().html_math_img_scale
742 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
746 ParagraphList & Buffer::paragraphs()
748 return text().paragraphs();
752 ParagraphList const & Buffer::paragraphs() const
754 return text().paragraphs();
758 LyXVC & Buffer::lyxvc()
764 LyXVC const & Buffer::lyxvc() const
770 string const Buffer::temppath() const
772 return d->temppath.absFileName();
776 TexRow & Buffer::texrow()
782 TexRow const & Buffer::texrow() const
788 TocBackend & Buffer::tocBackend() const
790 return d->toc_backend;
794 Undo & Buffer::undo()
800 void Buffer::setChild(DocIterator const & dit, Buffer * child)
802 d->children_positions[child] = dit;
806 string Buffer::latexName(bool const no_path) const
808 FileName latex_name =
809 makeLatexName(d->exportFileName());
810 return no_path ? latex_name.onlyFileName()
811 : latex_name.absFileName();
815 FileName Buffer::Impl::exportFileName() const
817 docstring const branch_suffix =
818 params.branchlist().getFileNameSuffix();
819 if (branch_suffix.empty())
822 string const name = addExtension(filename.onlyFileNameWithoutExt()
823 + to_utf8(branch_suffix), filename.extension());
824 FileName res(filename.onlyPath().absFileName() + "/" + name);
830 string Buffer::logName(LogType * type) const
832 string const filename = latexName(false);
834 if (filename.empty()) {
840 string const path = temppath();
842 FileName const fname(addName(temppath(),
843 onlyFileName(changeExtension(filename,
846 // FIXME: how do we know this is the name of the build log?
847 FileName const bname(
848 addName(path, onlyFileName(
849 changeExtension(filename,
850 theFormats().extension(params().bufferFormat()) + ".out"))));
852 // Also consider the master buffer log file
853 FileName masterfname = fname;
854 LogType mtype = latexlog;
855 if (masterBuffer() != this) {
856 string const mlogfile = masterBuffer()->logName(&mtype);
857 masterfname = FileName(mlogfile);
860 // If no Latex log or Build log is newer, show Build log
861 if (bname.exists() &&
862 ((!fname.exists() && !masterfname.exists())
863 || (fname.lastModified() < bname.lastModified()
864 && masterfname.lastModified() < bname.lastModified()))) {
865 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
868 return bname.absFileName();
869 // If we have a newer master file log or only a master log, show this
870 } else if (fname != masterfname
871 && (!fname.exists() && (masterfname.exists()
872 || fname.lastModified() < masterfname.lastModified()))) {
873 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
876 return masterfname.absFileName();
878 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
881 return fname.absFileName();
885 void Buffer::setReadonly(bool const flag)
887 if (d->read_only != flag) {
894 void Buffer::setFileName(FileName const & fname)
896 bool const changed = fname != d->filename;
898 d->refreshFileMonitor();
900 lyxvc().file_found_hook(fname);
901 setReadonly(d->filename.isReadOnly());
907 int Buffer::readHeader(Lexer & lex)
909 int unknown_tokens = 0;
911 int begin_header_line = -1;
913 // Initialize parameters that may be/go lacking in header:
914 params().branchlist().clear();
915 params().preamble.erase();
916 params().options.erase();
917 params().master.erase();
918 params().float_placement.erase();
919 params().float_alignment.erase();
920 params().paperwidth.erase();
921 params().paperheight.erase();
922 params().leftmargin.erase();
923 params().rightmargin.erase();
924 params().topmargin.erase();
925 params().bottommargin.erase();
926 params().headheight.erase();
927 params().headsep.erase();
928 params().footskip.erase();
929 params().columnsep.erase();
930 params().font_roman_opts.erase();
931 params().font_sans_opts.erase();
932 params().font_typewriter_opts.erase();
933 params().fonts_cjk.erase();
934 params().listings_params.clear();
935 params().clearLayoutModules();
936 params().clearRemovedModules();
937 params().clearIncludedChildren();
938 params().pdfoptions().clear();
939 params().indiceslist().clear();
940 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
941 params().isbackgroundcolor = false;
942 params().fontcolor = RGBColor(0, 0, 0);
943 params().isfontcolor = false;
944 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
945 params().boxbgcolor = RGBColor(0xFF, 0, 0);
946 params().html_latex_start.clear();
947 params().html_latex_end.clear();
948 params().html_math_img_scale = 1.0;
949 params().output_sync_macro.erase();
950 params().setLocalLayout(docstring(), false);
951 params().setLocalLayout(docstring(), true);
952 params().biblio_opts.erase();
953 params().biblatex_bibstyle.erase();
954 params().biblatex_citestyle.erase();
955 params().multibib.erase();
956 params().lineno_opts.clear();
958 for (int i = 0; i < 4; ++i) {
959 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
960 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
963 ErrorList & errorList = d->errorLists["Parse"];
972 if (token == "\\end_header")
976 if (token == "\\begin_header") {
977 begin_header_line = line;
981 LYXERR(Debug::PARSER, "Handling document header token: `"
984 string const result =
985 params().readToken(lex, token, d->filename.onlyPath());
986 if (!result.empty()) {
987 if (token == "\\textclass") {
988 d->layout_position = result;
991 docstring const s = bformat(_("Unknown token: "
995 errorList.push_back(ErrorItem(_("Document header error"), s));
999 if (begin_header_line) {
1000 docstring const s = _("\\begin_header is missing");
1001 errorList.push_back(ErrorItem(_("Document header error"), s));
1004 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1006 params().makeDocumentClass();
1008 return unknown_tokens;
1013 // changed to be public and have one parameter
1014 // Returns true if "\end_document" is not read (Asger)
1015 bool Buffer::readDocument(Lexer & lex)
1017 ErrorList & errorList = d->errorLists["Parse"];
1020 // remove dummy empty par
1021 paragraphs().clear();
1023 if (!lex.checkFor("\\begin_document")) {
1024 docstring const s = _("\\begin_document is missing");
1025 errorList.push_back(ErrorItem(_("Document header error"), s));
1030 if (params().output_changes) {
1031 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1032 LaTeXFeatures::isAvailable("xcolor");
1035 Alert::warning(_("Changes not shown in LaTeX output"),
1036 _("Changes will not be highlighted in LaTeX output, "
1037 "because xcolor and ulem are not installed.\n"
1038 "Please install both packages or redefine "
1039 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1043 if (!parent() && !params().master.empty()) {
1044 FileName const master_file = makeAbsPath(params().master,
1045 onlyPath(absFileName()));
1046 if (isLyXFileName(master_file.absFileName())) {
1048 checkAndLoadLyXFile(master_file, true);
1050 // necessary e.g. after a reload
1051 // to re-register the child (bug 5873)
1052 // FIXME: clean up updateMacros (here, only
1053 // child registering is needed).
1054 master->updateMacros();
1055 // set master as master buffer, but only
1056 // if we are a real child
1057 if (master->isChild(this))
1059 // if the master is not fully loaded
1060 // it is probably just loading this
1061 // child. No warning needed then.
1062 else if (master->isFullyLoaded())
1063 LYXERR0("The master '"
1065 << "' assigned to this document ("
1067 << ") does not include "
1068 "this document. Ignoring the master assignment.");
1069 // If the master has just been created, un-hide it (#11162)
1070 if (!master->fileName().exists())
1071 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1072 master->absFileName()));
1077 // assure we have a default index
1078 params().indiceslist().addDefault(B_("Index"));
1081 if (FileName::isAbsolute(params().origin))
1082 d->old_position = params().origin;
1084 d->old_position = filePath();
1085 bool const res = text().read(lex, errorList, d->inset);
1086 d->old_position.clear();
1088 // inform parent buffer about local macros
1090 Buffer const * pbuf = parent();
1091 for (auto const & m : usermacros)
1092 pbuf->usermacros.insert(m);
1096 updateMacroInstances(InternalUpdate);
1101 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1103 Format const * fmt = theFormats().getFormat(format);
1106 // It is important to use the correct extension here, since some
1107 // converters create a wrong output file otherwise (e.g. html2latex)
1108 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1109 ofdocstream os(name.toFilesystemEncoding().c_str());
1110 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1111 bool const success = !(os << contents).fail();
1114 bool converted = false;
1116 params().compressed = false;
1118 // remove dummy empty par
1119 paragraphs().clear();
1121 converted = importFile(format, name, errorList);
1124 removeTempFile(name);
1129 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1131 if (!theConverters().isReachable(format, "lyx"))
1134 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1135 Converters::RetVal const retval =
1136 theConverters().convert(nullptr, name, lyx, name, format, "lyx", errorList);
1137 if (retval == Converters::SUCCESS) {
1138 bool const success = readFile(lyx) == ReadSuccess;
1139 removeTempFile(lyx);
1147 bool Buffer::readString(string const & s)
1149 params().compressed = false;
1152 istringstream is(s);
1154 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1155 FileName const fn = tempfile.name();
1158 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1160 if (success && file_format != LYX_FORMAT) {
1161 // We need to call lyx2lyx, so write the input to a file
1162 ofstream os(fn.toFilesystemEncoding().c_str());
1165 // lyxvc in readFile
1166 if (readFile(fn) != ReadSuccess)
1170 if (readDocument(lex))
1176 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1180 if (!lex.setFile(fname)) {
1181 Alert::error(_("File Not Found"),
1182 bformat(_("Unable to open file `%1$s'."),
1183 from_utf8(fn.absFileName())));
1184 return ReadFileNotFound;
1188 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1189 if (ret_plf != ReadSuccess)
1192 if (file_format != LYX_FORMAT) {
1194 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1195 if (ret_clf != ReadSuccess)
1197 ret_clf = readFile(tmpFile);
1198 if (ret_clf == ReadSuccess) {
1199 d->file_format = file_format;
1200 d->need_format_backup = true;
1205 // FIXME: InsetInfo needs to know whether the file is under VCS
1206 // during the parse process, so this has to be done before.
1207 lyxvc().file_found_hook(d->filename);
1209 if (readDocument(lex)) {
1210 Alert::error(_("Document format failure"),
1211 bformat(_("%1$s ended unexpectedly, which means"
1212 " that it is probably corrupted."),
1213 from_utf8(fn.absFileName())));
1214 return ReadDocumentFailure;
1217 d->file_fully_loaded = true;
1218 d->read_only = !d->filename.isWritable();
1219 params().compressed = theFormats().isZippedFile(d->filename);
1225 bool Buffer::isFullyLoaded() const
1227 return d->file_fully_loaded;
1231 void Buffer::setFullyLoaded(bool value)
1233 d->file_fully_loaded = value;
1237 bool Buffer::freshStartRequired() const
1239 return d->require_fresh_start_;
1242 void Buffer::requireFreshStart(bool const b) const
1244 d->require_fresh_start_ = b;
1248 PreviewLoader * Buffer::loader() const
1250 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1252 if (!d->preview_loader_)
1253 d->preview_loader_ = new PreviewLoader(*this);
1254 return d->preview_loader_;
1258 void Buffer::removePreviews() const
1260 delete d->preview_loader_;
1261 d->preview_loader_ = nullptr;
1265 void Buffer::updatePreviews() const
1267 PreviewLoader * ploader = loader();
1271 InsetIterator it = inset_iterator_begin(*d->inset);
1272 InsetIterator const end = inset_iterator_end(*d->inset);
1273 for (; it != end; ++it)
1274 it->addPreview(it, *ploader);
1276 ploader->startLoading();
1280 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1281 FileName const & fn, int & file_format) const
1283 if(!lex.checkFor("\\lyxformat")) {
1284 Alert::error(_("Document format failure"),
1285 bformat(_("%1$s is not a readable LyX document."),
1286 from_utf8(fn.absFileName())));
1287 return ReadNoLyXFormat;
1293 // LyX formats 217 and earlier were written as 2.17. This corresponds
1294 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1295 // these cases. See also: www.lyx.org/trac/changeset/1313.
1296 size_t dot = tmp_format.find_first_of(".,");
1297 if (dot != string::npos)
1298 tmp_format.erase(dot, 1);
1300 file_format = convert<int>(tmp_format);
1305 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1306 FileName & tmpfile, int from_format)
1308 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1309 tempfile.setAutoRemove(false);
1310 tmpfile = tempfile.name();
1311 if(tmpfile.empty()) {
1312 Alert::error(_("Conversion failed"),
1313 bformat(_("%1$s is from a different"
1314 " version of LyX, but a temporary"
1315 " file for converting it could"
1316 " not be created."),
1317 from_utf8(fn.absFileName())));
1318 return LyX2LyXNoTempFile;
1321 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1322 if (lyx2lyx.empty()) {
1323 Alert::error(_("Conversion script not found"),
1324 bformat(_("%1$s is from a different"
1325 " version of LyX, but the"
1326 " conversion script lyx2lyx"
1327 " could not be found."),
1328 from_utf8(fn.absFileName())));
1329 return LyX2LyXNotFound;
1333 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1334 ostringstream command;
1335 command << os::python()
1336 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1337 << " -t " << convert<string>(LYX_FORMAT)
1338 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1339 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1340 string const command_str = command.str();
1342 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1344 cmd_ret const ret = runCommand(command_str);
1345 if (ret.first != 0) {
1346 if (from_format < LYX_FORMAT) {
1347 Alert::error(_("Conversion script failed"),
1348 bformat(_("%1$s is from an older version"
1349 " of LyX and the lyx2lyx script"
1350 " failed to convert it."),
1351 from_utf8(fn.absFileName())));
1352 return LyX2LyXOlderFormat;
1354 Alert::error(_("Conversion script failed"),
1355 bformat(_("%1$s is from a newer version"
1356 " of LyX and the lyx2lyx script"
1357 " failed to convert it."),
1358 from_utf8(fn.absFileName())));
1359 return LyX2LyXNewerFormat;
1366 FileName Buffer::getBackupName() const {
1367 map<int, string> const file_formats = {
1384 FileName const & fn = fileName();
1385 string const fname = fn.onlyFileNameWithoutExt();
1386 string const fext = fn.extension() + "~";
1387 string const fpath = lyxrc.backupdir_path.empty() ?
1388 fn.onlyPath().absFileName() :
1389 lyxrc.backupdir_path;
1390 string backup_suffix;
1391 // If file format is from a stable series use version instead of file format
1392 auto const it = file_formats.find(d->file_format);
1393 if (it != file_formats.end())
1394 backup_suffix = "-lyx" + it->second;
1396 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1397 string const backname = fname + backup_suffix;
1398 FileName backup(addName(fpath, addExtension(backname, fext)));
1400 // limit recursion, just in case
1402 unsigned long orig_checksum = 0;
1403 while (backup.exists() && v < 100) {
1404 if (orig_checksum == 0)
1405 orig_checksum = fn.checksum();
1406 unsigned long new_checksum = backup.checksum();
1407 if (orig_checksum == new_checksum) {
1408 LYXERR(Debug::FILES, "Not backing up " << fn <<
1409 "since " << backup << "has the same checksum.");
1410 // a bit of a hack, but we have to check this anyway
1411 // below, and setting this is simpler than introducing
1412 // a special boolean for this purpose.
1416 string const newbackname = backname + "-" + convert<string>(v);
1417 backup.set(addName(fpath, addExtension(newbackname, fext)));
1420 return v < 100 ? backup : FileName();
1424 // Should probably be moved to somewhere else: BufferView? GuiView?
1425 bool Buffer::save() const
1427 docstring const file = makeDisplayPath(absFileName(), 20);
1428 d->filename.refresh();
1430 // check the read-only status before moving the file as a backup
1431 if (d->filename.exists()) {
1432 bool const read_only = !d->filename.isWritable();
1434 Alert::warning(_("File is read-only"),
1435 bformat(_("The file %1$s cannot be written because it "
1436 "is marked as read-only."), file));
1441 // ask if the disk file has been externally modified (use checksum method)
1442 if (fileName().exists() && isChecksumModified()) {
1444 bformat(_("Document %1$s has been externally modified. "
1445 "Are you sure you want to overwrite this file?"), file);
1446 int const ret = Alert::prompt(_("Overwrite modified file?"),
1447 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1452 // We don't need autosaves in the immediate future. (Asger)
1453 resetAutosaveTimers();
1455 // if the file does not yet exist, none of the backup activity
1456 // that follows is necessary
1457 if (!fileName().exists()) {
1458 if (!writeFile(fileName()))
1464 // we first write the file to a new name, then move it to its
1465 // proper location once that has been done successfully. that
1466 // way we preserve the original file if something goes wrong.
1467 string const justname = fileName().onlyFileNameWithoutExt();
1468 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1469 justname + "-XXXXXX.lyx");
1470 bool const symlink = fileName().isSymLink();
1472 tempfile->setAutoRemove(false);
1474 FileName savefile(tempfile->name());
1475 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1476 if (!savefile.clonePermissions(fileName()))
1477 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1479 if (!writeFile(savefile))
1482 // we will set this to false if we fail
1483 bool made_backup = true;
1485 FileName backupName;
1486 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1488 if (d->need_format_backup)
1489 backupName = getBackupName();
1491 // If we for some reason failed to find a backup name in case of
1492 // a format change, this will still set one. It's the best we can
1494 if (backupName.empty()) {
1495 backupName.set(fileName().absFileName() + "~");
1496 if (!lyxrc.backupdir_path.empty()) {
1497 string const mangledName =
1498 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1499 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1503 LYXERR(Debug::FILES, "Backing up original file to " <<
1504 backupName.absFileName());
1505 // Except file is symlink do not copy because of #6587.
1506 // Hard links have bad luck.
1507 made_backup = symlink ?
1508 fileName().copyTo(backupName):
1509 fileName().moveTo(backupName);
1512 Alert::error(_("Backup failure"),
1513 bformat(_("Cannot create backup file %1$s.\n"
1514 "Please check whether the directory exists and is writable."),
1515 from_utf8(backupName.absFileName())));
1516 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1517 } else if (d->need_format_backup) {
1518 // the original file has been backed up successfully, so we
1519 // will not need to do that again
1520 d->need_format_backup = false;
1524 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1525 // Only do this if tempfile is not in autoremove mode
1528 // If we have no symlink, we can simply rename the temp file.
1529 // Otherwise, we need to copy it so the symlink stays intact.
1530 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1531 savefile.moveTo(fileName()))
1533 // saveCheckSum() was already called by writeFile(), but the
1534 // time stamp is invalidated by copying/moving
1537 if (d->file_format != LYX_FORMAT)
1538 // the file associated with this buffer is now in the current format
1539 d->file_format = LYX_FORMAT;
1542 // else we saved the file, but failed to move it to the right location.
1544 if (needBackup && made_backup && !symlink) {
1545 // the original file was moved to some new location, so it will look
1546 // to the user as if it was deleted. (see bug #9234.) we could try
1547 // to restore it, but that would basically mean trying to do again
1548 // what we just failed to do. better to leave things as they are.
1549 Alert::error(_("Write failure"),
1550 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1551 "But LyX could not move it to:\n %2$s.\n"
1552 "Your original file has been backed up to:\n %3$s"),
1553 from_utf8(savefile.absFileName()),
1554 from_utf8(fileName().absFileName()),
1555 from_utf8(backupName.absFileName())));
1557 // either we did not try to make a backup, or else we tried and failed,
1558 // or else the original file was a symlink, in which case it was copied,
1559 // not moved. so the original file is intact.
1560 Alert::error(_("Write failure"),
1561 bformat(_("Cannot move saved file to:\n %1$s.\n"
1562 "But the file has successfully been saved as:\n %2$s."),
1563 from_utf8(fileName().absFileName()),
1564 from_utf8(savefile.absFileName())));
1570 bool Buffer::writeFile(FileName const & fname) const
1572 if (d->read_only && fname == d->filename)
1575 bool retval = false;
1577 docstring const str = bformat(_("Saving document %1$s..."),
1578 makeDisplayPath(fname.absFileName()));
1581 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1583 if (params().compressed) {
1584 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1585 retval = ofs && write(ofs);
1587 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1588 retval = ofs && write(ofs);
1592 message(str + _(" could not write file!"));
1597 // removeAutosaveFile();
1600 message(str + _(" done."));
1606 docstring Buffer::emergencyWrite()
1608 // No need to save if the buffer has not changed.
1612 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1614 docstring user_message = bformat(
1615 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1617 // We try to save three places:
1618 // 1) Same place as document. Unless it is an unnamed doc.
1620 string s = absFileName();
1623 if (writeFile(FileName(s))) {
1625 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1626 return user_message;
1628 user_message += " " + _("Save failed! Trying again...\n");
1632 // 2) In HOME directory.
1633 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1635 lyxerr << ' ' << s << endl;
1636 if (writeFile(FileName(s))) {
1638 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1639 return user_message;
1642 user_message += " " + _("Save failed! Trying yet again...\n");
1644 // 3) In "/tmp" directory.
1645 // MakeAbsPath to prepend the current
1646 // drive letter on OS/2
1647 s = addName(package().temp_dir().absFileName(), absFileName());
1649 lyxerr << ' ' << s << endl;
1650 if (writeFile(FileName(s))) {
1652 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1653 return user_message;
1656 user_message += " " + _("Save failed! Document is lost.");
1659 return user_message;
1663 bool Buffer::write(ostream & ofs) const
1666 // Use the standard "C" locale for file output.
1667 ofs.imbue(locale::classic());
1670 // The top of the file should not be written by params().
1672 // write out a comment in the top of the file
1673 // Important: Keep the version formatting in sync with lyx2lyx and
1674 // tex2lyx (bug 7951)
1675 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1676 << " created this file. For more info see https://www.lyx.org/\n"
1677 << "\\lyxformat " << LYX_FORMAT << "\n"
1678 << "\\begin_document\n";
1680 /// For each author, set 'used' to true if there is a change
1681 /// by this author in the document; otherwise set it to 'false'.
1682 for (Author const & a : params().authors())
1685 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1686 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1687 for ( ; it != end; ++it)
1688 it->checkAuthors(params().authors());
1690 // now write out the buffer parameters.
1691 ofs << "\\begin_header\n";
1692 params().writeFile(ofs, this);
1693 ofs << "\\end_header\n";
1696 ofs << "\n\\begin_body\n";
1698 ofs << "\n\\end_body\n";
1700 // Write marker that shows file is complete
1701 ofs << "\\end_document" << endl;
1703 // Shouldn't really be needed....
1706 // how to check if close went ok?
1707 // Following is an attempt... (BE 20001011)
1709 // good() returns false if any error occurred, including some
1710 // formatting error.
1711 // bad() returns true if something bad happened in the buffer,
1712 // which should include file system full errors.
1717 lyxerr << "File was not closed properly." << endl;
1724 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1725 string const & original_path,
1726 OutputParams const & runparams_in,
1727 OutputWhat output) const
1729 OutputParams runparams = runparams_in;
1731 string const encoding = runparams.encoding->iconvName();
1732 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1735 try { ofs.reset(encoding); }
1736 catch (iconv_codecvt_facet_exception const & e) {
1737 lyxerr << "Caught iconv exception: " << e.what() << endl;
1738 Alert::error(_("Iconv software exception Detected"),
1739 bformat(_("Please verify that the `iconv' support software is"
1740 " properly installed and supports the selected encoding"
1741 " (%1$s), or change the encoding in"
1742 " Document>Settings>Language."), from_ascii(encoding)));
1745 if (!openFileWrite(ofs, fname))
1748 ErrorList & errorList = d->errorLists["Export"];
1750 ExportStatus status = ExportSuccess;
1753 // make sure we are ready to export
1754 // this needs to be done before we validate
1755 // FIXME Do we need to do this all the time? I.e., in children
1756 // of a master we are exporting?
1758 updateMacroInstances(OutputUpdate);
1760 ExportStatus retval;
1762 retval = writeLaTeXSource(os, original_path, runparams, output);
1763 if (retval == ExportKilled)
1764 return ExportKilled;
1766 catch (EncodingException const & e) {
1767 docstring const failed(1, e.failed_char);
1769 oss << "0x" << hex << e.failed_char << dec;
1770 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1771 docstring msg = bformat(_("Uncodable character '%1$s'"
1772 " (code point %2$s)"),
1773 failed, from_utf8(oss.str()));
1774 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1775 "representable in specific verbatim contexts.\n"
1776 "Changing the document encoding to utf8 could help."),
1777 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1779 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1780 " (code point %2$s)"),
1781 failed, from_utf8(oss.str()));
1782 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1783 "representable in the chosen encoding.\n"
1784 "Changing the document encoding to utf8 could help."),
1785 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1787 status = ExportError;
1789 catch (iconv_codecvt_facet_exception const & e) {
1790 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1792 status = ExportError;
1794 catch (exception const & e) {
1795 errorList.push_back(ErrorItem(_("conversion failed"),
1797 lyxerr << e.what() << endl;
1798 status = ExportError;
1801 lyxerr << "Caught some really weird exception..." << endl;
1805 d->texrow = move(os.texrow());
1809 status = ExportError;
1810 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1813 if (runparams_in.silent)
1821 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1822 string const & original_path,
1823 OutputParams const & runparams_in,
1824 OutputWhat output) const
1826 // The child documents, if any, shall be already loaded at this point.
1828 OutputParams runparams = runparams_in;
1830 // Some macros rely on font encoding
1831 runparams.main_fontenc = params().main_font_encoding();
1833 // If we are compiling a file standalone, even if this is the
1834 // child of some other buffer, let's cut the link here, so the
1835 // file is really independent and no concurring settings from
1836 // the master (e.g. branch state) interfere (see #8100).
1837 if (!runparams.is_child)
1838 d->ignore_parent = true;
1840 // Classify the unicode characters appearing in math insets
1841 BufferEncodings::initUnicodeMath(*this);
1843 // validate the buffer.
1844 LYXERR(Debug::LATEX, " Validating buffer...");
1845 LaTeXFeatures features(*this, params(), runparams);
1847 // This is only set once per document (in master)
1848 if (!runparams.is_child) {
1849 runparams.use_polyglossia = features.usePolyglossia();
1850 runparams.use_CJK = features.mustProvide("CJK");
1852 LYXERR(Debug::LATEX, " Buffer validation done.");
1854 bool const output_preamble =
1855 output == FullSource || output == OnlyPreamble;
1856 bool const output_body =
1857 output == FullSource || output == OnlyBody;
1859 // The starting paragraph of the coming rows is the
1860 // first paragraph of the document. (Asger)
1861 if (output_preamble && runparams.nice) {
1862 os << "%% LyX " << lyx_version << " created this file. "
1863 "For more info, see https://www.lyx.org/.\n"
1864 "%% Do not edit unless you really know what "
1867 LYXERR(Debug::INFO, "lyx document header finished");
1869 // There are a few differences between nice LaTeX and usual files:
1870 // usual files have \batchmode and special input@path to allow
1871 // inclusion of figures specified by an explicitly relative path
1872 // (i.e., a path starting with './' or '../') with either \input or
1873 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1874 // input@path is set when the actual parameter original_path is set.
1875 // This is done for usual tex-file, but not for nice-latex-file.
1876 // (Matthias 250696)
1877 // Note that input@path is only needed for something the user does
1878 // in the preamble, included .tex files or ERT, files included by
1879 // LyX work without it.
1880 if (output_preamble) {
1881 if (!runparams.nice) {
1882 // code for usual, NOT nice-latex-file
1883 os << "\\batchmode\n"; // changed from \nonstopmode
1885 if (!original_path.empty()) {
1887 // We don't know the encoding of inputpath
1888 docstring const inputpath = from_utf8(original_path);
1889 docstring uncodable_glyphs;
1890 Encoding const * const enc = runparams.encoding;
1892 for (size_t n = 0; n < inputpath.size(); ++n) {
1893 if (!enc->encodable(inputpath[n])) {
1894 docstring const glyph(1, inputpath[n]);
1895 LYXERR0("Uncodable character '"
1897 << "' in input path!");
1898 uncodable_glyphs += glyph;
1903 // warn user if we found uncodable glyphs.
1904 if (!uncodable_glyphs.empty()) {
1905 frontend::Alert::warning(
1906 _("Uncodable character in file path"),
1908 _("The path of your document\n"
1910 "contains glyphs that are unknown "
1911 "in the current document encoding "
1912 "(namely %2$s). This may result in "
1913 "incomplete output, unless "
1914 "TEXINPUTS contains the document "
1915 "directory and you don't use "
1916 "explicitly relative paths (i.e., "
1917 "paths starting with './' or "
1918 "'../') in the preamble or in ERT."
1919 "\n\nIn case of problems, choose "
1920 "an appropriate document encoding\n"
1921 "(such as utf8) or change the "
1923 inputpath, uncodable_glyphs));
1925 string docdir = os::latex_path(original_path);
1926 if (contains(docdir, '#')) {
1927 docdir = subst(docdir, "#", "\\#");
1928 os << "\\catcode`\\#=11"
1929 "\\def\\#{#}\\catcode`\\#=6\n";
1931 if (contains(docdir, '%')) {
1932 docdir = subst(docdir, "%", "\\%");
1933 os << "\\catcode`\\%=11"
1934 "\\def\\%{%}\\catcode`\\%=14\n";
1936 if (contains(docdir, '~'))
1937 docdir = subst(docdir, "~", "\\string~");
1938 bool const nonascii = !isAscii(from_utf8(docdir));
1939 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1940 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1941 bool const detokenize = !utfpathlatex && nonascii;
1942 bool const quote = contains(docdir, ' ');
1943 if (utfpathlatex && nonascii)
1944 os << "\\UseRawInputEncoding\n";
1945 os << "\\makeatletter\n"
1946 << "\\def\\input@path{{";
1948 os << "\\detokenize{";
1957 << "\\makeatother\n";
1961 // get parent macros (if this buffer has a parent) which will be
1962 // written at the document begin further down.
1963 MacroSet parentMacros;
1964 listParentMacros(parentMacros, features);
1966 // Write the preamble
1967 runparams.use_babel = params().writeLaTeX(os, features,
1968 d->filename.onlyPath());
1970 // Active characters
1971 runparams.active_chars = features.getActiveChars();
1973 // Biblatex bibliographies are loaded here
1974 if (params().useBiblatex()) {
1975 vector<pair<docstring, string>> const bibfiles =
1976 prepareBibFilePaths(runparams, getBibfiles(), true);
1977 for (pair<docstring, string> const & file: bibfiles) {
1978 os << "\\addbibresource";
1979 if (!file.second.empty())
1980 os << "[bibencoding=" << file.second << "]";
1981 os << "{" << file.first << "}\n";
1985 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1986 && !features.hasOnlyPolyglossiaLanguages()) {
1989 vector<string> bll = features.getBabelExclusiveLanguages();
1990 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1993 for (string const & sit : bll) {
1998 blangs = bll.size() > 1 ?
1999 bformat(_("The languages %1$s are only supported by Babel."), langs)
2000 : bformat(_("The language %1$s is only supported by Babel."), langs);
2004 for (string const & pit : pll) {
2009 plangs = pll.size() > 1 ?
2010 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2011 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2012 if (!blangs.empty())
2016 frontend::Alert::warning(
2017 _("Incompatible Languages!"),
2019 _("You cannot use the following languages "
2020 "together in one LaTeX document because "
2021 "they require conflicting language packages:\n"
2026 // Japanese might be required only in some children of a document,
2027 // but once required, we must keep use_japanese true.
2028 runparams.use_japanese |= features.isRequired("japanese");
2031 // Restore the parenthood if needed
2032 if (!runparams.is_child)
2033 d->ignore_parent = false;
2034 return ExportSuccess;
2038 // mark the beginning of the body to separate it from InPreamble insets
2039 os.texrow().start(TexRow::beginDocument());
2040 os << "\\begin{document}\n";
2042 // mark the start of a new paragraph by simulating a newline,
2043 // so that os.afterParbreak() returns true at document start
2046 // output the parent macros
2047 for (auto const & mac : parentMacros) {
2048 int num_lines = mac->write(os.os(), true);
2049 os.texrow().newlines(num_lines);
2052 } // output_preamble
2054 LYXERR(Debug::INFO, "preamble finished, now the body.");
2058 latexParagraphs(*this, text(), os, runparams);
2060 catch (ConversionException const &) { return ExportKilled; }
2062 // Restore the parenthood if needed
2063 if (!runparams.is_child)
2064 d->ignore_parent = false;
2066 // add this just in case after all the paragraphs
2069 if (output_preamble) {
2070 os << "\\end{document}\n";
2071 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2073 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2075 runparams_in.encoding = runparams.encoding;
2077 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2078 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2079 return ExportSuccess;
2083 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2084 OutputParams const & runparams,
2085 OutputWhat output) const
2087 LYXERR(Debug::LATEX, "makeDocBookFile...");
2090 if (!openFileWrite(ofs, fname))
2093 // make sure we are ready to export
2094 // this needs to be done before we validate
2096 updateMacroInstances(OutputUpdate);
2098 ExportStatus const retval =
2099 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2100 if (retval == ExportKilled)
2101 return ExportKilled;
2105 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2106 return ExportSuccess;
2110 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2111 OutputParams const & runparams,
2112 OutputWhat output) const
2114 LaTeXFeatures features(*this, params(), runparams);
2119 DocumentClass const & tclass = params().documentClass();
2120 string const & top_element = tclass.latexname();
2122 bool const output_preamble =
2123 output == FullSource || output == OnlyPreamble;
2124 bool const output_body =
2125 output == FullSource || output == OnlyBody;
2127 if (output_preamble) {
2128 if (runparams.flavor == OutputParams::XML)
2129 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2132 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2135 if (! tclass.class_header().empty())
2136 os << from_ascii(tclass.class_header());
2137 else if (runparams.flavor == OutputParams::XML)
2138 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2139 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2141 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2143 docstring preamble = params().preamble;
2144 if (runparams.flavor != OutputParams::XML ) {
2145 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2146 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2147 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2148 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2151 string const name = runparams.nice
2152 ? changeExtension(absFileName(), ".sgml") : fname;
2153 preamble += features.getIncludedFiles(name);
2154 preamble += features.getLyXSGMLEntities();
2156 if (!preamble.empty()) {
2157 os << "\n [ " << preamble << " ]";
2163 string top = top_element;
2165 if (runparams.flavor == OutputParams::XML)
2166 top += params().language->code();
2168 top += params().language->code().substr(0, 2);
2171 if (!params().options.empty()) {
2173 top += params().options;
2176 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2177 << " file was created by LyX " << lyx_version
2178 << "\n See https://www.lyx.org/ for more information -->\n";
2180 params().documentClass().counters().reset();
2182 sgml::openTag(os, top);
2185 docbookParagraphs(text(), *this, os, runparams);
2187 catch (ConversionException const &) { return ExportKilled; }
2188 sgml::closeTag(os, top_element);
2190 return ExportSuccess;
2194 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2195 OutputParams const & runparams) const
2197 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2200 if (!openFileWrite(ofs, fname))
2203 // make sure we are ready to export
2204 // this has to be done before we validate
2205 updateBuffer(UpdateMaster, OutputUpdate);
2206 updateMacroInstances(OutputUpdate);
2208 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2209 if (retval == ExportKilled)
2214 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2219 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2220 OutputParams const & runparams,
2221 OutputWhat output) const
2223 LaTeXFeatures features(*this, params(), runparams);
2225 d->bibinfo_.makeCitationLabels(*this);
2227 bool const output_preamble =
2228 output == FullSource || output == OnlyPreamble;
2229 bool const output_body =
2230 output == FullSource || output == OnlyBody || output == IncludedFile;
2232 if (output_preamble) {
2233 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2234 << "<!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"
2235 // FIXME Language should be set properly.
2236 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2238 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2239 // FIXME Presumably need to set this right
2240 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2242 docstring const & doctitle = features.htmlTitle();
2244 << (doctitle.empty() ?
2245 from_ascii("LyX Document") :
2246 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2249 docstring styles = features.getTClassHTMLPreamble();
2250 if (!styles.empty())
2251 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2253 styles = features.getPreambleSnippets().str;
2254 if (!styles.empty())
2255 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2257 // we will collect CSS information in a stream, and then output it
2258 // either here, as part of the header, or else in a separate file.
2259 odocstringstream css;
2260 styles = features.getCSSSnippets();
2261 if (!styles.empty())
2262 css << "/* LyX Provided Styles */\n" << styles << '\n';
2264 styles = features.getTClassHTMLStyles();
2265 if (!styles.empty())
2266 css << "/* Layout-provided Styles */\n" << styles << '\n';
2268 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2269 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2270 if (needfg || needbg) {
2271 css << "\nbody {\n";
2274 << from_ascii(X11hexname(params().fontcolor))
2277 css << " background-color: "
2278 << from_ascii(X11hexname(params().backgroundcolor))
2283 docstring const dstyles = css.str();
2284 if (!dstyles.empty()) {
2285 bool written = false;
2286 if (params().html_css_as_file) {
2287 // open a file for CSS info
2289 string const fcssname = addName(temppath(), "docstyle.css");
2290 FileName const fcssfile = FileName(fcssname);
2291 if (openFileWrite(ocss, fcssfile)) {
2295 // write link to header
2296 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2298 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2301 // we are here if the CSS is supposed to be written to the header
2302 // or if we failed to write it to an external file.
2304 os << "<style type='text/css'>\n"
2313 bool const output_body_tag = (output != IncludedFile);
2314 if (output_body_tag)
2315 os << "<body dir=\"auto\">\n";
2317 if (output != IncludedFile)
2318 // if we're an included file, the counters are in the master.
2319 params().documentClass().counters().reset();
2321 xhtmlParagraphs(text(), *this, xs, runparams);
2323 catch (ConversionException const &) { return ExportKilled; }
2324 if (output_body_tag)
2328 if (output_preamble)
2331 return ExportSuccess;
2335 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2336 // Other flags: -wall -v0 -x
2337 int Buffer::runChktex()
2341 // get LaTeX-Filename
2342 FileName const path(temppath());
2343 string const name = addName(path.absFileName(), latexName());
2344 string const org_path = filePath();
2346 PathChanger p(path); // path to LaTeX file
2347 message(_("Running chktex..."));
2349 // Generate the LaTeX file if neccessary
2350 OutputParams runparams(¶ms().encoding());
2351 runparams.flavor = OutputParams::LATEX;
2352 runparams.nice = false;
2353 runparams.linelen = lyxrc.plaintext_linelen;
2354 ExportStatus const retval =
2355 makeLaTeXFile(FileName(name), org_path, runparams);
2356 if (retval != ExportSuccess) {
2357 // error code on failure
2362 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2363 int const res = chktex.run(terr); // run chktex
2366 Alert::error(_("chktex failure"),
2367 _("Could not run chktex successfully."));
2369 ErrorList & errlist = d->errorLists["ChkTeX"];
2371 bufferErrors(terr, errlist);
2376 if (runparams.silent)
2377 d->errorLists["ChkTeX"].clear();
2385 void Buffer::validate(LaTeXFeatures & features) const
2387 // Validate the buffer params, but not for included
2388 // files, since they also use the parent buffer's
2390 if (!features.runparams().is_child)
2391 params().validate(features);
2393 for (Paragraph const & p : paragraphs())
2394 p.validate(features);
2396 if (lyxerr.debugging(Debug::LATEX)) {
2397 features.showStruct();
2402 void Buffer::getLabelList(vector<docstring> & list) const
2404 // If this is a child document, use the master's list instead.
2406 masterBuffer()->getLabelList(list);
2411 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2412 for (auto const & tocit : *toc) {
2413 if (tocit.depth() == 0)
2414 list.push_back(tocit.str());
2419 void Buffer::invalidateBibinfoCache() const
2421 d->bibinfo_cache_valid_ = false;
2422 d->cite_labels_valid_ = false;
2423 removeBiblioTempFiles();
2424 // also invalidate the cache for the parent buffer
2425 Buffer const * const pbuf = d->parent();
2427 pbuf->invalidateBibinfoCache();
2431 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2433 // FIXME This is probably unnecessary, given where we call this.
2434 // If this is a child document, use the master instead.
2435 Buffer const * const pbuf = masterBuffer();
2436 if (pbuf != this && scope != UpdateChildOnly)
2437 return pbuf->getBibfiles();
2439 // In 2.3.x, we have:
2440 //if (!d->bibfile_cache_valid_)
2441 // this->updateBibfilesCache(scope);
2442 // I think that is a leftover, but there have been so many back-
2443 // and-forths with this, due to Windows issues, that I am not sure.
2445 return d->bibfiles_cache_;
2449 BiblioInfo const & Buffer::masterBibInfo() const
2451 Buffer const * const tmp = masterBuffer();
2453 return tmp->masterBibInfo();
2458 BiblioInfo const & Buffer::bibInfo() const
2464 void Buffer::registerBibfiles(const docstring_list & bf) const
2466 // We register the bib files in the master buffer,
2467 // if there is one, but also in every single buffer,
2468 // in case a child is compiled alone.
2469 Buffer const * const tmp = masterBuffer();
2471 tmp->registerBibfiles(bf);
2473 for (auto const & p : bf) {
2474 docstring_list::const_iterator temp =
2475 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2476 if (temp == d->bibfiles_cache_.end())
2477 d->bibfiles_cache_.push_back(p);
2482 static map<docstring, FileName> bibfileCache;
2484 FileName Buffer::getBibfilePath(docstring const & bibid) const
2486 map<docstring, FileName>::const_iterator it =
2487 bibfileCache.find(bibid);
2488 if (it != bibfileCache.end()) {
2489 // i.e., return bibfileCache[bibid];
2493 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2494 string const texfile = changeExtension(to_utf8(bibid), "bib");
2495 // we need to check first if this file exists where it's said to be.
2496 // there's a weird bug that occurs otherwise: if the file is in the
2497 // Buffer's directory but has the same name as some file that would be
2498 // found by kpsewhich, then we find the latter, not the former.
2499 FileName const local_file = makeAbsPath(texfile, filePath());
2500 FileName file = local_file;
2501 if (!file.exists()) {
2502 // there's no need now to check whether the file can be found
2504 file = findtexfile(texfile, "bib", true);
2508 LYXERR(Debug::FILES, "Found at: " << file);
2510 bibfileCache[bibid] = file;
2511 return bibfileCache[bibid];
2515 void Buffer::checkIfBibInfoCacheIsValid() const
2517 // use the master's cache
2518 Buffer const * const tmp = masterBuffer();
2520 tmp->checkIfBibInfoCacheIsValid();
2524 // If we already know the cache is invalid, stop here.
2525 // This is important in the case when the bibliography
2526 // environment (rather than Bib[la]TeX) is used.
2527 // In that case, the timestamp check below gives no
2528 // sensible result. Rather than that, the cache will
2529 // be invalidated explicitly via invalidateBibInfoCache()
2530 // by the Bibitem inset.
2531 // Same applies for bib encoding changes, which trigger
2532 // invalidateBibInfoCache() by InsetBibtex.
2533 if (!d->bibinfo_cache_valid_)
2536 if (d->have_bibitems_) {
2537 // We have a bibliography environment.
2538 // Invalidate the bibinfo cache unconditionally.
2539 // Cite labels will get invalidated by the inset if needed.
2540 d->bibinfo_cache_valid_ = false;
2544 // OK. This is with Bib(la)tex. We'll assume the cache
2545 // is valid and change this if we find changes in the bibs.
2546 d->bibinfo_cache_valid_ = true;
2547 d->cite_labels_valid_ = true;
2549 // compare the cached timestamps with the actual ones.
2550 docstring_list const & bibfiles_cache = getBibfiles();
2551 for (auto const & bf : bibfiles_cache) {
2552 FileName const fn = getBibfilePath(bf);
2553 time_t lastw = fn.lastModified();
2554 time_t prevw = d->bibfile_status_[fn];
2555 if (lastw != prevw) {
2556 d->bibinfo_cache_valid_ = false;
2557 d->cite_labels_valid_ = false;
2558 d->bibfile_status_[fn] = lastw;
2564 void Buffer::clearBibFileCache() const
2566 bibfileCache.clear();
2570 void Buffer::reloadBibInfoCache(bool const force) const
2572 // we should not need to do this for internal buffers
2576 // use the master's cache
2577 Buffer const * const tmp = masterBuffer();
2579 tmp->reloadBibInfoCache(force);
2584 checkIfBibInfoCacheIsValid();
2585 if (d->bibinfo_cache_valid_)
2589 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2590 // re-read file locations when this info changes
2591 // FIXME Is this sufficient? Or should we also force that
2592 // in some other cases? If so, then it is easy enough to
2593 // add the following line in some other places.
2594 clearBibFileCache();
2595 d->bibinfo_.clear();
2596 FileNameList checkedFiles;
2597 d->have_bibitems_ = false;
2598 collectBibKeys(checkedFiles);
2599 d->bibinfo_cache_valid_ = true;
2603 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2605 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2606 it->collectBibKeys(it, checkedFiles);
2607 if (it->lyxCode() == BIBITEM_CODE) {
2608 if (parent() != nullptr)
2609 parent()->d->have_bibitems_ = true;
2611 d->have_bibitems_ = true;
2617 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2619 // We add the biblio info to the master buffer,
2620 // if there is one, but also to every single buffer,
2621 // in case a child is compiled alone.
2622 BiblioInfo & bi = d->bibinfo_;
2623 bi.mergeBiblioInfo(bin);
2625 if (parent() != nullptr) {
2626 BiblioInfo & masterbi = parent()->d->bibinfo_;
2627 masterbi.mergeBiblioInfo(bin);
2632 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2634 // We add the bibtex info to the master buffer,
2635 // if there is one, but also to every single buffer,
2636 // in case a child is compiled alone.
2637 BiblioInfo & bi = d->bibinfo_;
2640 if (parent() != nullptr) {
2641 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2642 masterbi[key] = bin;
2647 void Buffer::makeCitationLabels() const
2649 Buffer const * const master = masterBuffer();
2650 return d->bibinfo_.makeCitationLabels(*master);
2654 void Buffer::invalidateCiteLabels() const
2656 masterBuffer()->d->cite_labels_valid_ = false;
2659 bool Buffer::citeLabelsValid() const
2661 return masterBuffer()->d->cite_labels_valid_;
2665 void Buffer::removeBiblioTempFiles() const
2667 // We remove files that contain LaTeX commands specific to the
2668 // particular bibliographic style being used, in order to avoid
2669 // LaTeX errors when we switch style.
2670 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2671 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2672 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2673 aux_file.removeFile();
2674 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2675 bbl_file.removeFile();
2676 // Also for the parent buffer
2677 Buffer const * const pbuf = parent();
2679 pbuf->removeBiblioTempFiles();
2683 bool Buffer::isDepClean(string const & name) const
2685 DepClean::const_iterator const it = d->dep_clean.find(name);
2686 if (it == d->dep_clean.end())
2692 void Buffer::markDepClean(string const & name)
2694 d->dep_clean[name] = true;
2698 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2701 // FIXME? if there is an Buffer LFUN that can be dispatched even
2702 // if internal, put a switch '(cmd.action)' here.
2708 switch (cmd.action()) {
2710 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2711 flag.setOnOff(hasReadonlyFlag());
2714 // FIXME: There is need for a command-line import.
2715 //case LFUN_BUFFER_IMPORT:
2717 case LFUN_BUFFER_AUTO_SAVE:
2720 case LFUN_BUFFER_EXPORT_CUSTOM:
2721 // FIXME: Nothing to check here?
2724 case LFUN_BUFFER_EXPORT: {
2725 docstring const arg = cmd.argument();
2726 if (arg == "custom") {
2730 string format = (arg.empty() || arg == "default") ?
2731 params().getDefaultOutputFormat() : to_utf8(arg);
2732 size_t pos = format.find(' ');
2733 if (pos != string::npos)
2734 format = format.substr(0, pos);
2735 enable = params().isExportable(format, false);
2737 flag.message(bformat(
2738 _("Don't know how to export to format: %1$s"), arg));
2742 case LFUN_BUILD_PROGRAM:
2743 enable = params().isExportable("program", false);
2746 case LFUN_BRANCH_ACTIVATE:
2747 case LFUN_BRANCH_DEACTIVATE:
2748 case LFUN_BRANCH_MASTER_ACTIVATE:
2749 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2750 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2751 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2752 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2753 : params().branchlist();
2754 docstring const branchName = cmd.argument();
2755 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2759 case LFUN_BRANCH_ADD:
2760 case LFUN_BRANCHES_RENAME:
2761 // if no Buffer is present, then of course we won't be called!
2764 case LFUN_BUFFER_LANGUAGE:
2765 enable = !isReadonly();
2768 case LFUN_BUFFER_VIEW_CACHE:
2769 (d->preview_file_).refresh();
2770 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2773 case LFUN_CHANGES_TRACK:
2774 flag.setEnabled(true);
2775 flag.setOnOff(params().track_changes);
2778 case LFUN_CHANGES_OUTPUT:
2779 flag.setEnabled(true);
2780 flag.setOnOff(params().output_changes);
2783 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2784 flag.setOnOff(params().compressed);
2787 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2788 flag.setOnOff(params().output_sync);
2791 case LFUN_BUFFER_ANONYMIZE:
2797 flag.setEnabled(enable);
2802 void Buffer::dispatch(string const & command, DispatchResult & result)
2804 return dispatch(lyxaction.lookupFunc(command), result);
2808 // NOTE We can end up here even if we have no GUI, because we are called
2809 // by LyX::exec to handled command-line requests. So we may need to check
2810 // whether we have a GUI or not. The boolean use_gui holds this information.
2811 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2814 // FIXME? if there is an Buffer LFUN that can be dispatched even
2815 // if internal, put a switch '(cmd.action())' here.
2816 dr.dispatched(false);
2819 string const argument = to_utf8(func.argument());
2820 // We'll set this back to false if need be.
2821 bool dispatched = true;
2822 // This handles undo groups automagically
2823 UndoGroupHelper ugh(this);
2825 switch (func.action()) {
2826 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2827 if (lyxvc().inUse()) {
2828 string log = lyxvc().toggleReadOnly();
2833 setReadonly(!hasReadonlyFlag());
2836 case LFUN_BUFFER_EXPORT: {
2837 string const format = (argument.empty() || argument == "default") ?
2838 params().getDefaultOutputFormat() : argument;
2839 ExportStatus const status = doExport(format, false);
2840 dr.setError(status != ExportSuccess);
2841 if (status != ExportSuccess)
2842 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2843 from_utf8(format)));
2847 case LFUN_BUILD_PROGRAM: {
2848 ExportStatus const status = doExport("program", true);
2849 dr.setError(status != ExportSuccess);
2850 if (status != ExportSuccess)
2851 dr.setMessage(_("Error generating literate programming code."));
2855 case LFUN_BUFFER_EXPORT_CUSTOM: {
2857 string command = split(argument, format_name, ' ');
2858 Format const * format = theFormats().getFormat(format_name);
2860 lyxerr << "Format \"" << format_name
2861 << "\" not recognized!"
2866 // The name of the file created by the conversion process
2869 // Output to filename
2870 if (format->name() == "lyx") {
2871 string const latexname = latexName(false);
2872 filename = changeExtension(latexname,
2873 format->extension());
2874 filename = addName(temppath(), filename);
2876 if (!writeFile(FileName(filename)))
2880 doExport(format_name, true, filename);
2883 // Substitute $$FName for filename
2884 if (!contains(command, "$$FName"))
2885 command = "( " + command + " ) < $$FName";
2886 command = subst(command, "$$FName", filename);
2888 // Execute the command in the background
2890 call.startscript(Systemcall::DontWait, command,
2891 filePath(), layoutPos());
2895 // FIXME: There is need for a command-line import.
2897 case LFUN_BUFFER_IMPORT:
2902 case LFUN_BUFFER_AUTO_SAVE:
2904 resetAutosaveTimers();
2907 case LFUN_BRANCH_ACTIVATE:
2908 case LFUN_BRANCH_DEACTIVATE:
2909 case LFUN_BRANCH_MASTER_ACTIVATE:
2910 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2911 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2912 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2913 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2916 docstring const branch_name = func.argument();
2917 // the case without a branch name is handled elsewhere
2918 if (branch_name.empty()) {
2922 Branch * branch = buf->params().branchlist().find(branch_name);
2924 LYXERR0("Branch " << branch_name << " does not exist.");
2926 docstring const msg =
2927 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2931 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2932 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2933 if (branch->isSelected() != activate) {
2934 buf->undo().recordUndoBufferParams(CursorData());
2935 branch->setSelected(activate);
2937 dr.screenUpdate(Update::Force);
2938 dr.forceBufferUpdate();
2943 case LFUN_BRANCH_ADD: {
2944 docstring branchnames = func.argument();
2945 if (branchnames.empty()) {
2949 BranchList & branch_list = params().branchlist();
2950 vector<docstring> const branches =
2951 getVectorFromString(branchnames, branch_list.separator());
2953 for (docstring const & branch_name : branches) {
2954 Branch * branch = branch_list.find(branch_name);
2956 LYXERR0("Branch " << branch_name << " already exists.");
2960 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2962 undo().recordUndoBufferParams(CursorData());
2963 branch_list.add(branch_name);
2964 branch = branch_list.find(branch_name);
2965 string const x11hexname = X11hexname(branch->color());
2966 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2967 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2969 dr.screenUpdate(Update::Force);
2977 case LFUN_BRANCHES_RENAME: {
2978 if (func.argument().empty())
2981 docstring const oldname = from_utf8(func.getArg(0));
2982 docstring const newname = from_utf8(func.getArg(1));
2983 InsetIterator it = inset_iterator_begin(inset());
2984 InsetIterator const end = inset_iterator_end(inset());
2985 bool success = false;
2986 for (; it != end; ++it) {
2987 if (it->lyxCode() == BRANCH_CODE) {
2988 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2989 if (ins.branch() == oldname) {
2990 undo().recordUndo(CursorData(it));
2991 ins.rename(newname);
2996 if (it->lyxCode() == INCLUDE_CODE) {
2997 // get buffer of external file
2998 InsetInclude const & ins =
2999 static_cast<InsetInclude const &>(*it);
3000 Buffer * child = ins.getChildBuffer();
3003 child->dispatch(func, dr);
3008 dr.screenUpdate(Update::Force);
3009 dr.forceBufferUpdate();
3014 case LFUN_BUFFER_VIEW_CACHE:
3015 if (!theFormats().view(*this, d->preview_file_,
3016 d->preview_format_))
3017 dr.setMessage(_("Error viewing the output file."));
3020 case LFUN_CHANGES_TRACK:
3021 if (params().save_transient_properties)
3022 undo().recordUndoBufferParams(CursorData());
3023 params().track_changes = !params().track_changes;
3026 case LFUN_CHANGES_OUTPUT:
3027 if (params().save_transient_properties)
3028 undo().recordUndoBufferParams(CursorData());
3029 params().output_changes = !params().output_changes;
3030 if (params().output_changes) {
3031 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3032 LaTeXFeatures::isAvailable("xcolor");
3035 Alert::warning(_("Changes not shown in LaTeX output"),
3036 _("Changes will not be highlighted in LaTeX output, "
3037 "because xcolor and ulem are not installed.\n"
3038 "Please install both packages or redefine "
3039 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3044 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3045 // turn compression on/off
3046 undo().recordUndoBufferParams(CursorData());
3047 params().compressed = !params().compressed;
3050 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3051 undo().recordUndoBufferParams(CursorData());
3052 params().output_sync = !params().output_sync;
3055 case LFUN_BUFFER_ANONYMIZE: {
3056 undo().recordUndoFullBuffer(CursorData());
3057 CursorData cur(doc_iterator_begin(this));
3058 for ( ; cur ; cur.forwardPar())
3059 cur.paragraph().anonymize();
3060 dr.forceBufferUpdate();
3061 dr.screenUpdate(Update::Force);
3069 dr.dispatched(dispatched);
3073 void Buffer::changeLanguage(Language const * from, Language const * to)
3075 LASSERT(from, return);
3076 LASSERT(to, return);
3078 for_each(par_iterator_begin(),
3080 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3084 bool Buffer::isMultiLingual() const
3086 ParConstIterator end = par_iterator_end();
3087 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3088 if (it->isMultiLingual(params()))
3095 std::set<Language const *> Buffer::getLanguages() const
3097 std::set<Language const *> langs;
3098 getLanguages(langs);
3103 void Buffer::getLanguages(std::set<Language const *> & langs) const
3105 ParConstIterator end = par_iterator_end();
3106 // add the buffer language, even if it's not actively used
3107 langs.insert(language());
3108 // iterate over the paragraphs
3109 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3110 it->getLanguages(langs);
3112 ListOfBuffers clist = getDescendants();
3113 for (auto const & cit : clist)
3114 cit->getLanguages(langs);
3118 DocIterator Buffer::getParFromID(int const id) const
3120 Buffer * buf = const_cast<Buffer *>(this);
3122 // This means non-existent
3123 return doc_iterator_end(buf);
3125 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3126 if (it.paragraph().id() == id)
3129 return doc_iterator_end(buf);
3133 bool Buffer::hasParWithID(int const id) const
3135 return !getParFromID(id).atEnd();
3139 ParIterator Buffer::par_iterator_begin()
3141 return ParIterator(doc_iterator_begin(this));
3145 ParIterator Buffer::par_iterator_end()
3147 return ParIterator(doc_iterator_end(this));
3151 ParConstIterator Buffer::par_iterator_begin() const
3153 return ParConstIterator(doc_iterator_begin(this));
3157 ParConstIterator Buffer::par_iterator_end() const
3159 return ParConstIterator(doc_iterator_end(this));
3163 Language const * Buffer::language() const
3165 return params().language;
3169 docstring const Buffer::B_(string const & l10n) const
3171 return params().B_(l10n);
3175 bool Buffer::isClean() const
3177 return d->lyx_clean;
3181 bool Buffer::isChecksumModified() const
3183 LASSERT(d->filename.exists(), return false);
3184 return d->checksum_ != d->filename.checksum();
3188 void Buffer::saveCheckSum() const
3190 FileName const & file = d->filename;
3192 d->checksum_ = file.exists() ? file.checksum()
3193 : 0; // in the case of save to a new file.
3197 void Buffer::markClean() const
3199 if (!d->lyx_clean) {
3200 d->lyx_clean = true;
3203 // if the .lyx file has been saved, we don't need an
3205 d->bak_clean = true;
3206 d->undo_.markDirty();
3207 clearExternalModification();
3211 void Buffer::setUnnamed(bool flag)
3217 bool Buffer::isUnnamed() const
3224 /// Don't check unnamed, here: isInternal() is used in
3225 /// newBuffer(), where the unnamed flag has not been set by anyone
3226 /// yet. Also, for an internal buffer, there should be no need for
3227 /// retrieving fileName() nor for checking if it is unnamed or not.
3228 bool Buffer::isInternal() const
3230 return d->internal_buffer;
3234 void Buffer::setInternal(bool flag)
3236 d->internal_buffer = flag;
3240 void Buffer::markDirty()
3243 d->lyx_clean = false;
3246 d->bak_clean = false;
3248 for (auto & depit : d->dep_clean)
3249 depit.second = false;
3253 FileName Buffer::fileName() const
3259 string Buffer::absFileName() const
3261 return d->filename.absFileName();
3265 string Buffer::filePath() const
3267 string const abs = d->filename.onlyPath().absFileName();
3270 int last = abs.length() - 1;
3272 return abs[last] == '/' ? abs : abs + '/';
3276 DocFileName Buffer::getReferencedFileName(string const & fn) const
3279 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3280 result.set(fn, filePath());
3282 // filePath() ends with a path separator
3283 FileName const test(filePath() + fn);
3285 result.set(fn, filePath());
3287 result.set(fn, params().origin);
3294 string const Buffer::prepareFileNameForLaTeX(string const & name,
3295 string const & ext, bool nice) const
3297 string const fname = makeAbsPath(name, filePath()).absFileName();
3298 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3304 return to_utf8(makeRelPath(from_utf8(fname),
3305 from_utf8(masterBuffer()->filePath())));
3309 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3310 docstring_list const & bibfilelist,
3311 bool const add_extension) const
3313 // If we are processing the LaTeX file in a temp directory then
3314 // copy the .bib databases to this temp directory, mangling their
3315 // names in the process. Store this mangled name in the list of
3317 // (We need to do all this because BibTeX *really*, *really*
3318 // can't handle "files with spaces" and Windows users tend to
3319 // use such filenames.)
3320 // Otherwise, store the (maybe absolute) path to the original,
3321 // unmangled database name.
3323 vector<pair<docstring, string>> res;
3325 // determine the export format
3326 string const tex_format = flavor2format(runparams.flavor);
3328 // check for spaces in paths
3329 bool found_space = false;
3331 for (auto const & bit : bibfilelist) {
3332 string utf8input = to_utf8(bit);
3334 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3335 FileName try_in_file =
3336 makeAbsPath(database + ".bib", filePath());
3337 bool not_from_texmf = try_in_file.isReadableFile();
3338 // If the file has not been found, try with the real file name
3339 // (it might come from a child in a sub-directory)
3340 if (!not_from_texmf) {
3341 try_in_file = getBibfilePath(bit);
3342 if (try_in_file.isReadableFile()) {
3343 // Check if the file is in texmf
3344 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3345 not_from_texmf = kpsefile.empty()
3346 || kpsefile.absFileName() != try_in_file.absFileName();
3348 // If this exists, make path relative to the master
3351 removeExtension(prepareFileNameForLaTeX(
3352 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3353 from_utf8(filePath()))),
3354 ".bib", runparams.nice));
3358 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3360 // mangledFileName() needs the extension
3361 DocFileName const in_file = DocFileName(try_in_file);
3362 database = removeExtension(in_file.mangledFileName());
3363 FileName const out_file = makeAbsPath(database + ".bib",
3364 masterBuffer()->temppath());
3365 bool const success = in_file.copyTo(out_file);
3367 LYXERR0("Failed to copy '" << in_file
3368 << "' to '" << out_file << "'");
3370 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3371 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3372 if (!isValidLaTeXFileName(database)) {
3373 frontend::Alert::warning(_("Invalid filename"),
3374 _("The following filename will cause troubles "
3375 "when running the exported file through LaTeX: ") +
3376 from_utf8(database));
3378 if (!isValidDVIFileName(database)) {
3379 frontend::Alert::warning(_("Problematic filename for DVI"),
3380 _("The following filename can cause troubles "
3381 "when running the exported file through LaTeX "
3382 "and opening the resulting DVI: ") +
3383 from_utf8(database), true);
3391 docstring const path = from_utf8(latex_path(database));
3393 if (contains(path, ' '))
3396 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3397 enc = params().bibFileEncoding(utf8input);
3399 bool recorded = false;
3400 for (pair<docstring, string> pe : res) {
3401 if (pe.first == path) {
3408 res.push_back(make_pair(path, enc));
3411 // Check if there are spaces in the path and warn BibTeX users, if so.
3412 // (biber can cope with such paths)
3413 if (!prefixIs(runparams.bibtex_command, "biber")) {
3414 // Post this warning only once.
3415 static bool warned_about_spaces = false;
3416 if (!warned_about_spaces &&
3417 runparams.nice && found_space) {
3418 warned_about_spaces = true;
3419 Alert::warning(_("Export Warning!"),
3420 _("There are spaces in the paths to your BibTeX databases.\n"
3421 "BibTeX will be unable to find them."));
3430 string Buffer::layoutPos() const
3432 return d->layout_position;
3436 void Buffer::setLayoutPos(string const & path)
3439 d->layout_position.clear();
3443 LATTEST(FileName::isAbsolute(path));
3445 d->layout_position =
3446 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3448 if (d->layout_position.empty())
3449 d->layout_position = ".";
3453 bool Buffer::hasReadonlyFlag() const
3455 return d->read_only;
3459 bool Buffer::isReadonly() const
3461 return hasReadonlyFlag() || notifiesExternalModification();
3465 void Buffer::setParent(Buffer const * buffer)
3467 // Avoids recursive include.
3468 d->setParent(buffer == this ? nullptr : buffer);
3473 Buffer const * Buffer::parent() const
3479 ListOfBuffers Buffer::allRelatives() const
3481 ListOfBuffers lb = masterBuffer()->getDescendants();
3482 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3487 Buffer const * Buffer::masterBuffer() const
3489 // FIXME Should be make sure we are not in some kind
3490 // of recursive include? A -> B -> A will crash this.
3491 Buffer const * const pbuf = d->parent();
3495 return pbuf->masterBuffer();
3499 bool Buffer::isChild(Buffer * child) const
3501 return d->children_positions.find(child) != d->children_positions.end();
3505 DocIterator Buffer::firstChildPosition(Buffer const * child)
3507 Impl::BufferPositionMap::iterator it;
3508 it = d->children_positions.find(child);
3509 if (it == d->children_positions.end())
3510 return DocIterator(this);
3515 bool Buffer::hasChildren() const
3517 return !d->children_positions.empty();
3521 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3523 // loop over children
3524 for (auto const & p : d->children_positions) {
3525 Buffer * child = const_cast<Buffer *>(p.first);
3527 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3528 if (bit != clist.end())
3530 clist.push_back(child);
3532 // there might be grandchildren
3533 child->collectChildren(clist, true);
3538 ListOfBuffers Buffer::getChildren() const
3541 collectChildren(v, false);
3542 // Make sure we have not included ourselves.
3543 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3544 if (bit != v.end()) {
3545 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3552 ListOfBuffers Buffer::getDescendants() const
3555 collectChildren(v, true);
3556 // Make sure we have not included ourselves.
3557 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3558 if (bit != v.end()) {
3559 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3566 template<typename M>
3567 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3572 typename M::const_iterator it = m.lower_bound(x);
3573 if (it == m.begin())
3581 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3582 DocIterator const & pos) const
3584 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3586 // if paragraphs have no macro context set, pos will be empty
3590 // we haven't found anything yet
3591 DocIterator bestPos = owner_->par_iterator_begin();
3592 MacroData const * bestData = nullptr;
3594 // find macro definitions for name
3595 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3596 if (nameIt != macros.end()) {
3597 // find last definition in front of pos or at pos itself
3598 PositionScopeMacroMap::const_iterator it
3599 = greatest_below(nameIt->second, pos);
3600 if (it != nameIt->second.end()) {
3602 // scope ends behind pos?
3603 if (pos < it->second.scope) {
3604 // Looks good, remember this. If there
3605 // is no external macro behind this,
3606 // we found the right one already.
3607 bestPos = it->first;
3608 bestData = &it->second.macro;
3612 // try previous macro if there is one
3613 if (it == nameIt->second.begin())
3620 // find macros in included files
3621 PositionScopeBufferMap::const_iterator it
3622 = greatest_below(position_to_children, pos);
3623 if (it == position_to_children.end())
3624 // no children before
3628 // do we know something better (i.e. later) already?
3629 if (it->first < bestPos )
3632 // scope ends behind pos?
3633 if (pos < it->second.scope
3634 && (cloned_buffer_ ||
3635 theBufferList().isLoaded(it->second.buffer))) {
3636 // look for macro in external file
3638 MacroData const * data
3639 = it->second.buffer->getMacro(name, false);
3642 bestPos = it->first;
3648 // try previous file if there is one
3649 if (it == position_to_children.begin())
3654 // return the best macro we have found
3659 MacroData const * Buffer::getMacro(docstring const & name,
3660 DocIterator const & pos, bool global) const
3665 // query buffer macros
3666 MacroData const * data = d->getBufferMacro(name, pos);
3667 if (data != nullptr)
3670 // If there is a master buffer, query that
3671 Buffer const * const pbuf = d->parent();
3673 d->macro_lock = true;
3674 MacroData const * macro = pbuf->getMacro(
3675 name, *this, false);
3676 d->macro_lock = false;
3682 data = MacroTable::globalMacros().get(name);
3683 if (data != nullptr)
3691 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3693 // set scope end behind the last paragraph
3694 DocIterator scope = par_iterator_begin();
3695 scope.pit() = scope.lastpit() + 1;
3697 return getMacro(name, scope, global);
3701 MacroData const * Buffer::getMacro(docstring const & name,
3702 Buffer const & child, bool global) const
3704 // look where the child buffer is included first
3705 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3706 if (it == d->children_positions.end())
3709 // check for macros at the inclusion position
3710 return getMacro(name, it->second, global);
3714 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3716 pit_type const lastpit = it.lastpit();
3718 // look for macros in each paragraph
3719 while (it.pit() <= lastpit) {
3720 Paragraph & par = it.paragraph();
3722 // FIXME Can this be done with the new-style iterators?
3723 // iterate over the insets of the current paragraph
3724 for (auto const & insit : par.insetList()) {
3725 it.pos() = insit.pos;
3727 // is it a nested text inset?
3728 if (insit.inset->asInsetText()) {
3729 // Inset needs its own scope?
3730 InsetText const * itext = insit.inset->asInsetText();
3731 bool newScope = itext->isMacroScope();
3733 // scope which ends just behind the inset
3734 DocIterator insetScope = it;
3737 // collect macros in inset
3738 it.push_back(CursorSlice(*insit.inset));
3739 updateMacros(it, newScope ? insetScope : scope);
3744 if (insit.inset->asInsetTabular()) {
3745 CursorSlice slice(*insit.inset);
3746 size_t const numcells = slice.nargs();
3747 for (; slice.idx() < numcells; slice.forwardIdx()) {
3748 it.push_back(slice);
3749 updateMacros(it, scope);
3755 // is it an external file?
3756 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3757 // get buffer of external file
3758 InsetInclude const & incinset =
3759 static_cast<InsetInclude const &>(*insit.inset);
3761 Buffer * child = incinset.getChildBuffer();
3766 // register its position, but only when it is
3767 // included first in the buffer
3768 if (children_positions.find(child) ==
3769 children_positions.end())
3770 children_positions[child] = it;
3772 // register child with its scope
3773 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3777 InsetMath * im = insit.inset->asInsetMath();
3778 if (doing_export && im) {
3779 InsetMathHull * hull = im->asHullInset();
3781 hull->recordLocation(it);
3784 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3788 InsetMathMacroTemplate & macroTemplate =
3789 *insit.inset->asInsetMath()->asMacroTemplate();
3790 MacroContext mc(owner_, it);
3791 macroTemplate.updateToContext(mc);
3794 bool valid = macroTemplate.validMacro();
3795 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3796 // then the BufferView's cursor will be invalid in
3797 // some cases which leads to crashes.
3802 // FIXME (Abdel), I don't understand why we pass 'it' here
3803 // instead of 'macroTemplate' defined above... is this correct?
3804 macros[macroTemplate.name()][it] =
3805 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3815 void Buffer::updateMacros() const
3820 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3822 // start with empty table
3824 d->children_positions.clear();
3825 d->position_to_children.clear();
3827 // Iterate over buffer, starting with first paragraph
3828 // The scope must be bigger than any lookup DocIterator
3829 // later. For the global lookup, lastpit+1 is used, hence
3830 // we use lastpit+2 here.
3831 DocIterator it = par_iterator_begin();
3832 DocIterator outerScope = it;
3833 outerScope.pit() = outerScope.lastpit() + 2;
3834 d->updateMacros(it, outerScope);
3838 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3840 InsetIterator it = inset_iterator_begin(inset());
3841 InsetIterator const end = inset_iterator_end(inset());
3842 for (; it != end; ++it) {
3843 if (it->lyxCode() == BRANCH_CODE) {
3844 InsetBranch & br = static_cast<InsetBranch &>(*it);
3845 docstring const name = br.branch();
3846 if (!from_master && !params().branchlist().find(name))
3847 result.push_back(name);
3848 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3849 result.push_back(name);
3852 if (it->lyxCode() == INCLUDE_CODE) {
3853 // get buffer of external file
3854 InsetInclude const & ins =
3855 static_cast<InsetInclude const &>(*it);
3856 Buffer * child = ins.getChildBuffer();
3859 child->getUsedBranches(result, true);
3862 // remove duplicates
3867 void Buffer::updateMacroInstances(UpdateType utype) const
3869 LYXERR(Debug::MACROS, "updateMacroInstances for "
3870 << d->filename.onlyFileName());
3871 DocIterator it = doc_iterator_begin(this);
3873 DocIterator const end = doc_iterator_end(this);
3874 for (; it != end; it.forwardInset()) {
3875 // look for MathData cells in InsetMathNest insets
3876 InsetMath * minset = it.nextInset()->asInsetMath();
3880 // update macro in all cells of the InsetMathNest
3881 DocIterator::idx_type n = minset->nargs();
3882 MacroContext mc = MacroContext(this, it);
3883 for (DocIterator::idx_type i = 0; i < n; ++i) {
3884 MathData & data = minset->cell(i);
3885 data.updateMacros(nullptr, mc, utype, 0);
3891 void Buffer::listMacroNames(MacroNameSet & macros) const
3896 d->macro_lock = true;
3898 // loop over macro names
3899 for (auto const & nameit : d->macros)
3900 macros.insert(nameit.first);
3902 // loop over children
3903 for (auto const & p : d->children_positions) {
3904 Buffer * child = const_cast<Buffer *>(p.first);
3905 // The buffer might have been closed (see #10766).
3906 if (theBufferList().isLoaded(child))
3907 child->listMacroNames(macros);
3911 Buffer const * const pbuf = d->parent();
3913 pbuf->listMacroNames(macros);
3915 d->macro_lock = false;
3919 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3921 Buffer const * const pbuf = d->parent();
3926 pbuf->listMacroNames(names);
3929 for (auto const & mit : names) {
3931 MacroData const * data = pbuf->getMacro(mit, *this, false);
3933 macros.insert(data);
3935 // we cannot access the original InsetMathMacroTemplate anymore
3936 // here to calls validate method. So we do its work here manually.
3937 // FIXME: somehow make the template accessible here.
3938 if (data->optionals() > 0)
3939 features.require("xargs");
3945 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3948 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3950 RefCache::iterator it = d->ref_cache_.find(label);
3951 if (it != d->ref_cache_.end())
3954 static References const dummy_refs = References();
3955 it = d->ref_cache_.insert(
3956 make_pair(label, dummy_refs)).first;
3961 Buffer::References const & Buffer::references(docstring const & label) const
3963 return const_cast<Buffer *>(this)->getReferenceCache(label);
3967 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3969 References & refs = getReferenceCache(label);
3970 refs.push_back(make_pair(inset, it));
3974 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3978 linfo.label = label;
3980 linfo.active = active;
3981 masterBuffer()->d->label_cache_.push_back(linfo);
3985 InsetLabel const * Buffer::insetLabel(docstring const & label,
3986 bool const active) const
3988 for (auto & rc : masterBuffer()->d->label_cache_) {
3989 if (rc.label == label && (rc.active || !active))
3996 bool Buffer::activeLabel(docstring const & label) const
3998 if (!insetLabel(label, true))
4005 void Buffer::clearReferenceCache() const
4008 d->ref_cache_.clear();
4009 d->label_cache_.clear();
4014 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4016 //FIXME: This does not work for child documents yet.
4017 reloadBibInfoCache();
4019 // Check if the label 'from' appears more than once
4020 vector<docstring> labels;
4021 for (auto const & bibit : masterBibInfo())
4022 labels.push_back(bibit.first);
4024 if (count(labels.begin(), labels.end(), from) > 1)
4027 string const paramName = "key";
4028 UndoGroupHelper ugh(this);
4029 InsetIterator it = inset_iterator_begin(inset());
4031 if (it->lyxCode() != CITE_CODE)
4033 InsetCommand * inset = it->asInsetCommand();
4034 docstring const oldValue = inset->getParam(paramName);
4035 if (oldValue == from) {
4036 undo().recordUndo(CursorData(it));
4037 inset->setParam(paramName, to);
4042 // returns NULL if id-to-row conversion is unsupported
4043 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4044 pit_type par_begin, pit_type par_end,
4045 OutputWhat output, bool master) const
4047 unique_ptr<TexRow> texrow;
4048 OutputParams runparams(¶ms().encoding());
4049 runparams.nice = true;
4050 runparams.flavor = params().getOutputFlavor(format);
4051 runparams.linelen = lyxrc.plaintext_linelen;
4052 // No side effect of file copying and image conversion
4053 runparams.dryrun = true;
4055 // Some macros rely on font encoding
4056 runparams.main_fontenc = params().main_font_encoding();
4058 if (output == CurrentParagraph) {
4059 runparams.par_begin = par_begin;
4060 runparams.par_end = par_end;
4061 if (par_begin + 1 == par_end) {
4063 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4067 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4068 convert<docstring>(par_begin),
4069 convert<docstring>(par_end - 1))
4072 // output paragraphs
4073 if (runparams.flavor == OutputParams::LYX) {
4074 Paragraph const & par = text().paragraphs()[par_begin];
4076 depth_type dt = par.getDepth();
4077 par.write(ods, params(), dt);
4078 os << from_utf8(ods.str());
4079 } else if (runparams.flavor == OutputParams::HTML) {
4081 setMathFlavor(runparams);
4082 xhtmlParagraphs(text(), *this, xs, runparams);
4083 } else if (runparams.flavor == OutputParams::TEXT) {
4085 // FIXME Handles only one paragraph, unlike the others.
4086 // Probably should have some routine with a signature like them.
4087 writePlaintextParagraph(*this,
4088 text().paragraphs()[par_begin], os, runparams, dummy);
4089 } else if (params().isDocBook()) {
4090 docbookParagraphs(text(), *this, os, runparams);
4092 // If we are previewing a paragraph, even if this is the
4093 // child of some other buffer, let's cut the link here,
4094 // so that no concurring settings from the master
4095 // (e.g. branch state) interfere (see #8101).
4097 d->ignore_parent = true;
4098 // We need to validate the Buffer params' features here
4099 // in order to know if we should output polyglossia
4100 // macros (instead of babel macros)
4101 LaTeXFeatures features(*this, params(), runparams);
4103 runparams.use_polyglossia = features.usePolyglossia();
4104 // latex or literate
4107 ots.texrow().newlines(2);
4109 latexParagraphs(*this, text(), ots, runparams);
4110 texrow = ots.releaseTexRow();
4112 // Restore the parenthood
4114 d->ignore_parent = false;
4118 if (output == FullSource)
4119 os << _("Preview source code");
4120 else if (output == OnlyPreamble)
4121 os << _("Preview preamble");
4122 else if (output == OnlyBody)
4123 os << _("Preview body");
4125 if (runparams.flavor == OutputParams::LYX) {
4127 if (output == FullSource)
4129 else if (output == OnlyPreamble)
4130 params().writeFile(ods, this);
4131 else if (output == OnlyBody)
4133 os << from_utf8(ods.str());
4134 } else if (runparams.flavor == OutputParams::HTML) {
4135 writeLyXHTMLSource(os, runparams, output);
4136 } else if (runparams.flavor == OutputParams::TEXT) {
4137 if (output == OnlyPreamble) {
4138 os << "% "<< _("Plain text does not have a preamble.");
4140 writePlaintextFile(*this, os, runparams);
4141 } else if (params().isDocBook()) {
4142 writeDocBookSource(os, absFileName(), runparams, output);
4144 // latex or literate
4147 ots.texrow().newlines(2);
4149 runparams.is_child = true;
4151 writeLaTeXSource(ots, string(), runparams, output);
4152 texrow = ots.releaseTexRow();
4159 ErrorList & Buffer::errorList(string const & type) const
4161 return d->errorLists[type];
4165 void Buffer::updateTocItem(std::string const & type,
4166 DocIterator const & dit) const
4169 d->gui_->updateTocItem(type, dit);
4173 void Buffer::structureChanged() const
4176 d->gui_->structureChanged();
4180 void Buffer::errors(string const & err, bool from_master) const
4183 d->gui_->errors(err, from_master);
4187 void Buffer::message(docstring const & msg) const
4190 d->gui_->message(msg);
4194 void Buffer::setBusy(bool on) const
4197 d->gui_->setBusy(on);
4201 void Buffer::updateTitles() const
4204 d->wa_->updateTitles();
4208 void Buffer::resetAutosaveTimers() const
4211 d->gui_->resetAutosaveTimers();
4215 bool Buffer::hasGuiDelegate() const
4221 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4230 class AutoSaveBuffer : public ForkedProcess {
4233 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4234 : buffer_(buffer), fname_(fname) {}
4236 virtual shared_ptr<ForkedProcess> clone() const
4238 return make_shared<AutoSaveBuffer>(*this);
4243 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4244 from_utf8(fname_.absFileName())));
4245 return run(DontWait);
4249 virtual int generateChild();
4251 Buffer const & buffer_;
4256 int AutoSaveBuffer::generateChild()
4258 #if defined(__APPLE__)
4259 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4260 * We should use something else like threads.
4262 * Since I do not know how to determine at run time what is the OS X
4263 * version, I just disable forking altogether for now (JMarc)
4265 pid_t const pid = -1;
4267 // tmp_ret will be located (usually) in /tmp
4268 // will that be a problem?
4269 // Note that this calls ForkedCalls::fork(), so it's
4270 // ok cross-platform.
4271 pid_t const pid = fork();
4272 // If you want to debug the autosave
4273 // you should set pid to -1, and comment out the fork.
4274 if (pid != 0 && pid != -1)
4278 // pid = -1 signifies that lyx was unable
4279 // to fork. But we will do the save
4281 bool failed = false;
4282 TempFile tempfile("lyxautoXXXXXX.lyx");
4283 tempfile.setAutoRemove(false);
4284 FileName const tmp_ret = tempfile.name();
4285 if (!tmp_ret.empty()) {
4286 if (!buffer_.writeFile(tmp_ret))
4288 else if (!tmp_ret.moveTo(fname_))
4294 // failed to write/rename tmp_ret so try writing direct
4295 if (!buffer_.writeFile(fname_)) {
4296 // It is dangerous to do this in the child,
4297 // but safe in the parent, so...
4298 if (pid == -1) // emit message signal.
4299 buffer_.message(_("Autosave failed!"));
4303 if (pid == 0) // we are the child so...
4312 FileName Buffer::getEmergencyFileName() const
4314 return FileName(d->filename.absFileName() + ".emergency");
4318 FileName Buffer::getAutosaveFileName() const
4320 // if the document is unnamed try to save in the backup dir, else
4321 // in the default document path, and as a last try in the filePath,
4322 // which will most often be the temporary directory
4325 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4326 : lyxrc.backupdir_path;
4327 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4330 string const fname = "#" + d->filename.onlyFileName() + "#";
4332 return makeAbsPath(fname, fpath);
4336 void Buffer::removeAutosaveFile() const
4338 FileName const f = getAutosaveFileName();
4344 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4346 FileName const newauto = getAutosaveFileName();
4348 if (newauto != oldauto && oldauto.exists())
4349 if (!oldauto.moveTo(newauto))
4350 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4354 bool Buffer::autoSave() const
4356 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4357 if (buf->d->bak_clean || hasReadonlyFlag())
4360 message(_("Autosaving current document..."));
4361 buf->d->bak_clean = true;
4363 FileName const fname = getAutosaveFileName();
4364 LASSERT(d->cloned_buffer_, return false);
4366 // If this buffer is cloned, we assume that
4367 // we are running in a separate thread already.
4368 TempFile tempfile("lyxautoXXXXXX.lyx");
4369 tempfile.setAutoRemove(false);
4370 FileName const tmp_ret = tempfile.name();
4371 if (!tmp_ret.empty()) {
4373 // assume successful write of tmp_ret
4374 if (tmp_ret.moveTo(fname))
4377 // failed to write/rename tmp_ret so try writing direct
4378 return writeFile(fname);
4382 void Buffer::setExportStatus(bool e) const
4384 d->doing_export = e;
4385 ListOfBuffers clist = getDescendants();
4386 for (auto const & bit : clist)
4387 bit->d->doing_export = e;
4391 bool Buffer::isExporting() const
4393 return d->doing_export;
4397 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4401 return doExport(target, put_in_tempdir, result_file);
4404 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4405 string & result_file) const
4407 bool const update_unincluded =
4408 params().maintain_unincluded_children
4409 && !params().getIncludedChildren().empty();
4411 // (1) export with all included children (omit \includeonly)
4412 if (update_unincluded) {
4413 ExportStatus const status =
4414 doExport(target, put_in_tempdir, true, result_file);
4415 if (status != ExportSuccess)
4418 // (2) export with included children only
4419 return doExport(target, put_in_tempdir, false, result_file);
4423 void Buffer::setMathFlavor(OutputParams & op) const
4425 switch (params().html_math_output) {
4426 case BufferParams::MathML:
4427 op.math_flavor = OutputParams::MathAsMathML;
4429 case BufferParams::HTML:
4430 op.math_flavor = OutputParams::MathAsHTML;
4432 case BufferParams::Images:
4433 op.math_flavor = OutputParams::MathAsImages;
4435 case BufferParams::LaTeX:
4436 op.math_flavor = OutputParams::MathAsLaTeX;
4442 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4443 bool includeall, string & result_file) const
4445 LYXERR(Debug::FILES, "target=" << target);
4446 OutputParams runparams(¶ms().encoding());
4447 string format = target;
4448 string dest_filename;
4449 size_t pos = target.find(' ');
4450 if (pos != string::npos) {
4451 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4452 format = target.substr(0, pos);
4453 if (format == "default")
4454 format = params().getDefaultOutputFormat();
4455 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4456 FileName(dest_filename).onlyPath().createPath();
4457 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4459 MarkAsExporting exporting(this);
4460 string backend_format;
4461 runparams.flavor = OutputParams::LATEX;
4462 runparams.linelen = lyxrc.plaintext_linelen;
4463 runparams.includeall = includeall;
4464 vector<string> backs = params().backends();
4465 Converters converters = theConverters();
4466 bool need_nice_file = false;
4467 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4468 // Get shortest path to format
4469 converters.buildGraph();
4470 Graph::EdgePath path;
4471 for (string const & sit : backs) {
4472 Graph::EdgePath p = converters.getPath(sit, format);
4473 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4474 backend_format = sit;
4479 if (!put_in_tempdir) {
4480 // Only show this alert if this is an export to a non-temporary
4481 // file (not for previewing).
4482 docstring s = bformat(_("No information for exporting the format %1$s."),
4483 theFormats().prettyName(format));
4484 if (format == "pdf4")
4486 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4487 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4488 Alert::error(_("Couldn't export file"), s);
4490 return ExportNoPathToFormat;
4492 runparams.flavor = converters.getFlavor(path, this);
4493 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4494 for (auto const & edge : path)
4495 if (theConverters().get(edge).nice()) {
4496 need_nice_file = true;
4501 backend_format = format;
4502 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4503 // FIXME: Don't hardcode format names here, but use a flag
4504 if (backend_format == "pdflatex")
4505 runparams.flavor = OutputParams::PDFLATEX;
4506 else if (backend_format == "luatex")
4507 runparams.flavor = OutputParams::LUATEX;
4508 else if (backend_format == "dviluatex")
4509 runparams.flavor = OutputParams::DVILUATEX;
4510 else if (backend_format == "xetex")
4511 runparams.flavor = OutputParams::XETEX;
4514 string filename = latexName(false);
4515 filename = addName(temppath(), filename);
4516 filename = changeExtension(filename,
4517 theFormats().extension(backend_format));
4518 LYXERR(Debug::FILES, "filename=" << filename);
4520 // Plain text backend
4521 if (backend_format == "text") {
4522 runparams.flavor = OutputParams::TEXT;
4524 writePlaintextFile(*this, FileName(filename), runparams);
4526 catch (ConversionException const &) { return ExportCancel; }
4529 else if (backend_format == "xhtml") {
4530 runparams.flavor = OutputParams::HTML;
4531 setMathFlavor(runparams);
4532 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4533 return ExportKilled;
4534 } else if (backend_format == "lyx")
4535 writeFile(FileName(filename));
4537 else if (params().isDocBook()) {
4538 runparams.nice = !put_in_tempdir;
4539 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4540 return ExportKilled;
4543 else if (backend_format == format || need_nice_file) {
4544 runparams.nice = true;
4545 ExportStatus const retval =
4546 makeLaTeXFile(FileName(filename), string(), runparams);
4547 if (retval == ExportKilled)
4548 return ExportKilled;
4549 if (d->cloned_buffer_)
4550 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4551 if (retval != ExportSuccess)
4553 } else if (!lyxrc.tex_allows_spaces
4554 && contains(filePath(), ' ')) {
4555 Alert::error(_("File name error"),
4556 bformat(_("The directory path to the document\n%1$s\n"
4557 "contains spaces, but your TeX installation does "
4558 "not allow them. You should save the file to a directory "
4559 "whose name does not contain spaces."), from_utf8(filePath())));
4560 return ExportTexPathHasSpaces;
4562 runparams.nice = false;
4563 ExportStatus const retval =
4564 makeLaTeXFile(FileName(filename), filePath(), runparams);
4565 if (retval == ExportKilled)
4566 return ExportKilled;
4567 if (d->cloned_buffer_)
4568 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4569 if (retval != ExportSuccess)
4573 string const error_type = (format == "program")
4574 ? "Build" : params().bufferFormat();
4575 ErrorList & error_list = d->errorLists[error_type];
4576 string const ext = theFormats().extension(format);
4577 FileName const tmp_result_file(changeExtension(filename, ext));
4578 Converters::RetVal const retval =
4579 converters.convert(this, FileName(filename), tmp_result_file,
4580 FileName(absFileName()), backend_format, format, error_list);
4581 if (retval == Converters::KILLED)
4582 return ExportCancel;
4583 bool success = (retval == Converters::SUCCESS);
4585 // Emit the signal to show the error list or copy it back to the
4586 // cloned Buffer so that it can be emitted afterwards.
4587 if (format != backend_format) {
4588 if (runparams.silent)
4590 else if (d->cloned_buffer_)
4591 d->cloned_buffer_->d->errorLists[error_type] =
4592 d->errorLists[error_type];
4595 // also to the children, in case of master-buffer-view
4596 ListOfBuffers clist = getDescendants();
4597 for (auto const & bit : clist) {
4598 if (runparams.silent)
4599 bit->d->errorLists[error_type].clear();
4600 else if (d->cloned_buffer_) {
4601 // Enable reverse search by copying back the
4602 // texrow object to the cloned buffer.
4603 // FIXME: this is not thread safe.
4604 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4605 bit->d->cloned_buffer_->d->errorLists[error_type] =
4606 bit->d->errorLists[error_type];
4608 bit->errors(error_type, true);
4612 if (d->cloned_buffer_) {
4613 // Enable reverse dvi or pdf to work by copying back the texrow
4614 // object to the cloned buffer.
4615 // FIXME: There is a possibility of concurrent access to texrow
4616 // here from the main GUI thread that should be securized.
4617 d->cloned_buffer_->d->texrow = d->texrow;
4618 string const err_type = params().bufferFormat();
4619 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4623 if (put_in_tempdir) {
4624 result_file = tmp_result_file.absFileName();
4625 return success ? ExportSuccess : ExportConverterError;
4628 if (dest_filename.empty())
4629 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4631 result_file = dest_filename;
4632 // We need to copy referenced files (e. g. included graphics
4633 // if format == "dvi") to the result dir.
4634 vector<ExportedFile> const extfiles =
4635 runparams.exportdata->externalFiles(format);
4636 string const dest = runparams.export_folder.empty() ?
4637 onlyPath(result_file) : runparams.export_folder;
4638 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4639 : force_overwrite == ALL_FILES;
4640 CopyStatus status = use_force ? FORCE : SUCCESS;
4642 for (ExportedFile const & exp : extfiles) {
4643 if (status == CANCEL) {
4644 message(_("Document export cancelled."));
4645 return ExportCancel;
4647 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4648 string fixedName = exp.exportName;
4649 if (!runparams.export_folder.empty()) {
4650 // Relative pathnames starting with ../ will be sanitized
4651 // if exporting to a different folder
4652 while (fixedName.substr(0, 3) == "../")
4653 fixedName = fixedName.substr(3, fixedName.length() - 3);
4655 FileName fixedFileName = makeAbsPath(fixedName, dest);
4656 fixedFileName.onlyPath().createPath();
4657 status = copyFile(fmt, exp.sourceName,
4659 exp.exportName, status == FORCE,
4660 runparams.export_folder.empty());
4664 if (tmp_result_file.exists()) {
4665 // Finally copy the main file
4666 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4667 : force_overwrite != NO_FILES;
4668 if (status == SUCCESS && use_force)
4670 status = copyFile(format, tmp_result_file,
4671 FileName(result_file), result_file,
4673 if (status == CANCEL) {
4674 message(_("Document export cancelled."));
4675 return ExportCancel;
4677 message(bformat(_("Document exported as %1$s "
4679 theFormats().prettyName(format),
4680 makeDisplayPath(result_file)));
4683 // This must be a dummy converter like fax (bug 1888)
4684 message(bformat(_("Document exported as %1$s"),
4685 theFormats().prettyName(format)));
4688 return success ? ExportSuccess : ExportConverterError;
4692 Buffer::ExportStatus Buffer::preview(string const & format) const
4694 bool const update_unincluded =
4695 params().maintain_unincluded_children
4696 && !params().getIncludedChildren().empty();
4697 return preview(format, update_unincluded);
4701 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4703 MarkAsExporting exporting(this);
4705 // (1) export with all included children (omit \includeonly)
4707 ExportStatus const status = doExport(format, true, true, result_file);
4708 if (status != ExportSuccess)
4711 // (2) export with included children only
4712 ExportStatus const status = doExport(format, true, false, result_file);
4713 FileName const previewFile(result_file);
4715 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4716 theimpl->preview_file_ = previewFile;
4717 theimpl->preview_format_ = format;
4718 theimpl->require_fresh_start_ = (status != ExportSuccess);
4720 if (status != ExportSuccess)
4723 if (previewFile.exists())
4724 return theFormats().view(*this, previewFile, format) ?
4725 PreviewSuccess : PreviewError;
4727 // Successful export but no output file?
4728 // Probably a bug in error detection.
4729 LATTEST(status != ExportSuccess);
4734 Buffer::ReadStatus Buffer::extractFromVC()
4736 bool const found = LyXVC::file_not_found_hook(d->filename);
4738 return ReadFileNotFound;
4739 if (!d->filename.isReadableFile())
4745 Buffer::ReadStatus Buffer::loadEmergency()
4747 FileName const emergencyFile = getEmergencyFileName();
4748 if (!emergencyFile.exists()
4749 || emergencyFile.lastModified() <= d->filename.lastModified())
4750 return ReadFileNotFound;
4752 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4753 docstring const text = bformat(_("An emergency save of the document "
4754 "%1$s exists.\n\nRecover emergency save?"), file);
4756 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4757 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4763 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4764 bool const success = (ret_llf == ReadSuccess);
4766 if (hasReadonlyFlag()) {
4767 Alert::warning(_("File is read-only"),
4768 bformat(_("An emergency file is successfully loaded, "
4769 "but the original file %1$s is marked read-only. "
4770 "Please make sure to save the document as a different "
4771 "file."), from_utf8(d->filename.absFileName())));
4774 lyxvc().file_found_hook(d->filename);
4775 str = _("Document was successfully recovered.");
4777 str = _("Document was NOT successfully recovered.");
4778 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4779 makeDisplayPath(emergencyFile.absFileName()));
4781 int const del_emerg =
4782 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4783 _("&Remove"), _("&Keep"));
4784 if (del_emerg == 0) {
4785 emergencyFile.removeFile();
4787 Alert::warning(_("Emergency file deleted"),
4788 _("Do not forget to save your file now!"), true);
4790 return success ? ReadSuccess : ReadEmergencyFailure;
4793 int const del_emerg =
4794 Alert::prompt(_("Delete emergency file?"),
4795 _("Remove emergency file now?"), 1, 1,
4796 _("&Remove"), _("&Keep"));
4798 emergencyFile.removeFile();
4802 string const ename = emergencyFile.absFileName();
4804 // Surely we can find one in 100 tries?
4805 for (int i = 1; i < 100; ++i) {
4806 newname.set(ename + to_string(i) + ".lyx");
4807 if (!newname.exists()) {
4813 // renameTo returns true on success. So inverting that
4814 // will give us true if we fail.
4815 noname = !emergencyFile.renameTo(newname);
4818 Alert::warning(_("Can't rename emergency file!"),
4819 _("LyX was unable to rename the emergency file. "
4820 "You should do so manually. Otherwise, you will be "
4821 "asked about it again the next time you try to load "
4822 "this file, and may over-write your own work."));
4824 Alert::warning(_("Emergency File Renames"),
4825 bformat(_("Emergency file renamed as:\n %1$s"),
4826 from_utf8(newname.onlyFileName())));
4829 return ReadOriginal;
4839 Buffer::ReadStatus Buffer::loadAutosave()
4841 // Now check if autosave file is newer.
4842 FileName const autosaveFile = getAutosaveFileName();
4843 if (!autosaveFile.exists()
4844 || autosaveFile.lastModified() <= d->filename.lastModified())
4845 return ReadFileNotFound;
4847 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4848 docstring const text = bformat(_("The backup of the document %1$s "
4849 "is newer.\n\nLoad the backup instead?"), file);
4850 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4851 _("&Load backup"), _("Load &original"), _("&Cancel"));
4856 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4857 // the file is not saved if we load the autosave file.
4858 if (ret_llf == ReadSuccess) {
4859 if (hasReadonlyFlag()) {
4860 Alert::warning(_("File is read-only"),
4861 bformat(_("A backup file is successfully loaded, "
4862 "but the original file %1$s is marked read-only. "
4863 "Please make sure to save the document as a "
4865 from_utf8(d->filename.absFileName())));
4868 lyxvc().file_found_hook(d->filename);
4871 return ReadAutosaveFailure;
4874 // Here we delete the autosave
4875 autosaveFile.removeFile();
4876 return ReadOriginal;
4884 Buffer::ReadStatus Buffer::loadLyXFile()
4886 if (!d->filename.isReadableFile()) {
4887 ReadStatus const ret_rvc = extractFromVC();
4888 if (ret_rvc != ReadSuccess)
4892 ReadStatus const ret_re = loadEmergency();
4893 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4896 ReadStatus const ret_ra = loadAutosave();
4897 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4900 return loadThisLyXFile(d->filename);
4904 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4906 return readFile(fn);
4910 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4912 for (; err != end; ++err) {
4913 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4914 int errorRow = err->error_in_line;
4915 Buffer const * buf = nullptr;
4916 Impl const * p = this;
4917 if (err->child_name.empty())
4918 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4920 // The error occurred in a child
4921 for (Buffer const * child : owner_->getDescendants()) {
4922 string const child_name =
4923 DocFileName(changeExtension(child->absFileName(), "tex")).
4925 if (err->child_name != child_name)
4927 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4928 if (!TexRow::isNone(start)) {
4929 buf = this->cloned_buffer_
4930 ? child->d->cloned_buffer_->d->owner_
4937 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4943 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4945 TeXErrors::Errors::const_iterator err = terr.begin();
4946 TeXErrors::Errors::const_iterator end = terr.end();
4948 d->traverseErrors(err, end, errorList);
4952 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4954 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4955 TeXErrors::Errors::const_iterator end = terr.end_ref();
4957 d->traverseErrors(err, end, errorList);
4961 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4963 LBUFERR(!text().paragraphs().empty());
4965 // Use the master text class also for child documents
4966 Buffer const * const master = masterBuffer();
4967 DocumentClass const & textclass = master->params().documentClass();
4969 docstring_list old_bibfiles;
4970 // Do this only if we are the top-level Buffer. We also need to account
4971 // for the case of a previewed child with ignored parent here.
4972 if (master == this && !d->ignore_parent) {
4973 textclass.counters().reset(from_ascii("bibitem"));
4974 reloadBibInfoCache();
4975 // we will re-read this cache as we go through, but we need
4976 // to know whether it's changed to know whether we need to
4977 // update the bibinfo cache.
4978 old_bibfiles = d->bibfiles_cache_;
4979 d->bibfiles_cache_.clear();
4982 // keep the buffers to be children in this set. If the call from the
4983 // master comes back we can see which of them were actually seen (i.e.
4984 // via an InsetInclude). The remaining ones in the set need still be updated.
4985 static std::set<Buffer const *> bufToUpdate;
4986 if (scope == UpdateMaster) {
4987 // If this is a child document start with the master
4988 if (master != this) {
4989 bufToUpdate.insert(this);
4990 master->updateBuffer(UpdateMaster, utype);
4991 // If the master buffer has no gui associated with it, then the TocModel is
4992 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4993 // (bug 5699). The same happens if the master buffer is open in a different
4994 // window. This test catches both possibilities.
4995 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4996 // There remains a problem here: If there is another child open in yet a third
4997 // window, that TOC is not updated. So some more general solution is needed at
4999 if (master->d->gui_ != d->gui_)
5002 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5003 if (bufToUpdate.find(this) == bufToUpdate.end())
5007 // start over the counters in the master
5008 textclass.counters().reset();
5011 // update will be done below for this buffer
5012 bufToUpdate.erase(this);
5014 // update all caches
5015 clearReferenceCache();
5018 Buffer & cbuf = const_cast<Buffer &>(*this);
5019 // if we are reloading, then we could have a dangling TOC,
5020 // in effect. so we need to go ahead and reset, even though
5021 // we will do so again when we rebuild the TOC later.
5022 cbuf.tocBackend().reset();
5025 ParIterator parit = cbuf.par_iterator_begin();
5026 updateBuffer(parit, utype);
5028 // If this document has siblings, then update the TocBackend later. The
5029 // reason is to ensure that later siblings are up to date when e.g. the
5030 // broken or not status of references is computed. The update is called
5031 // in InsetInclude::addToToc.
5035 // if the bibfiles changed, the cache of bibinfo is invalid
5036 docstring_list new_bibfiles = d->bibfiles_cache_;
5037 // this is a trick to determine whether the two vectors have
5038 // the same elements.
5039 sort(new_bibfiles.begin(), new_bibfiles.end());
5040 sort(old_bibfiles.begin(), old_bibfiles.end());
5041 if (old_bibfiles != new_bibfiles) {
5042 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5043 invalidateBibinfoCache();
5044 reloadBibInfoCache();
5045 // We relied upon the bibinfo cache when recalculating labels. But that
5046 // cache was invalid, although we didn't find that out until now. So we
5047 // have to do it all again.
5048 // That said, the only thing we really need to do is update the citation
5049 // labels. Nothing else will have changed. So we could create a new
5050 // UpdateType that would signal that fact, if we needed to do so.
5051 parit = cbuf.par_iterator_begin();
5052 // we will be re-doing the counters and references and such.
5053 textclass.counters().reset();
5054 clearReferenceCache();
5055 // we should not need to do this again?
5057 updateBuffer(parit, utype);
5058 // this will already have been done by reloadBibInfoCache();
5059 // d->bibinfo_cache_valid_ = true;
5062 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5063 // this is also set to true on the other path, by reloadBibInfoCache.
5064 d->bibinfo_cache_valid_ = true;
5066 d->cite_labels_valid_ = true;
5068 cbuf.tocBackend().update(true, utype);
5069 if (scope == UpdateMaster)
5070 cbuf.structureChanged();
5074 static depth_type getDepth(DocIterator const & it)
5076 depth_type depth = 0;
5077 for (size_t i = 0 ; i < it.depth() ; ++i)
5078 if (!it[i].inset().inMathed())
5079 depth += it[i].paragraph().getDepth() + 1;
5080 // remove 1 since the outer inset does not count
5081 // we should have at least one non-math inset, so
5082 // depth should nevery be 0. but maybe it is worth
5083 // marking this, just in case.
5085 // coverity[INTEGER_OVERFLOW]
5089 static depth_type getItemDepth(ParIterator const & it)
5091 Paragraph const & par = *it;
5092 LabelType const labeltype = par.layout().labeltype;
5094 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5097 // this will hold the lowest depth encountered up to now.
5098 depth_type min_depth = getDepth(it);
5099 ParIterator prev_it = it;
5102 --prev_it.top().pit();
5104 // start of nested inset: go to outer par
5106 if (prev_it.empty()) {
5107 // start of document: nothing to do
5112 // We search for the first paragraph with same label
5113 // that is not more deeply nested.
5114 Paragraph & prev_par = *prev_it;
5115 depth_type const prev_depth = getDepth(prev_it);
5116 if (labeltype == prev_par.layout().labeltype) {
5117 if (prev_depth < min_depth)
5118 return prev_par.itemdepth + 1;
5119 if (prev_depth == min_depth)
5120 return prev_par.itemdepth;
5122 min_depth = min(min_depth, prev_depth);
5123 // small optimization: if we are at depth 0, we won't
5124 // find anything else
5125 if (prev_depth == 0)
5131 static bool needEnumCounterReset(ParIterator const & it)
5133 Paragraph const & par = *it;
5134 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5135 depth_type const cur_depth = par.getDepth();
5136 ParIterator prev_it = it;
5137 while (prev_it.pit()) {
5138 --prev_it.top().pit();
5139 Paragraph const & prev_par = *prev_it;
5140 if (prev_par.getDepth() <= cur_depth)
5141 return prev_par.layout().name() != par.layout().name();
5143 // start of nested inset: reset
5148 // set the label of a paragraph. This includes the counters.
5149 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5151 BufferParams const & bp = owner_->masterBuffer()->params();
5152 DocumentClass const & textclass = bp.documentClass();
5153 Paragraph & par = it.paragraph();
5154 Layout const & layout = par.layout();
5155 Counters & counters = textclass.counters();
5157 if (par.params().startOfAppendix()) {
5158 // We want to reset the counter corresponding to toplevel sectioning
5159 Layout const & lay = textclass.getTOCLayout();
5160 docstring const cnt = lay.counter;
5162 counters.reset(cnt);
5163 counters.appendix(true);
5165 par.params().appendix(counters.appendix());
5167 // Compute the item depth of the paragraph
5168 par.itemdepth = getItemDepth(it);
5170 if (layout.margintype == MARGIN_MANUAL) {
5171 if (par.params().labelWidthString().empty())
5172 par.params().labelWidthString(par.expandLabel(layout, bp));
5173 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5174 // we do not need to do anything here, since the empty case is
5175 // handled during export.
5177 par.params().labelWidthString(docstring());
5180 switch(layout.labeltype) {
5181 case LABEL_ITEMIZE: {
5182 // At some point of time we should do something more
5183 // clever here, like:
5184 // par.params().labelString(
5185 // bp.user_defined_bullet(par.itemdepth).getText());
5186 // for now, use a simple hardcoded label
5187 docstring itemlabel;
5188 switch (par.itemdepth) {
5191 itemlabel = char_type(0x2022);
5195 itemlabel = char_type(0x2013);
5198 // ∗ U+2217 ASTERISK OPERATOR
5199 itemlabel = char_type(0x2217);
5202 // · U+00B7 MIDDLE DOT
5203 itemlabel = char_type(0x00b7);
5206 par.params().labelString(itemlabel);
5210 case LABEL_ENUMERATE: {
5211 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5213 switch (par.itemdepth) {
5224 enumcounter += "iv";
5227 // not a valid enumdepth...
5231 if (needEnumCounterReset(it)) {
5232 // Increase the master counter?
5233 if (layout.stepmastercounter)
5234 counters.stepMaster(enumcounter, utype);
5235 // Maybe we have to reset the enumeration counter.
5236 if (!layout.resumecounter)
5237 counters.reset(enumcounter);
5239 counters.step(enumcounter, utype);
5241 string const & lang = par.getParLanguage(bp)->code();
5242 par.params().labelString(counters.theCounter(enumcounter, lang));
5247 case LABEL_SENSITIVE: {
5248 string const & type = counters.current_float();
5249 docstring full_label;
5251 full_label = owner_->B_("Senseless!!! ");
5253 docstring name = owner_->B_(textclass.floats().getType(type).name());
5254 if (counters.hasCounter(from_utf8(type))) {
5255 string const & lang = par.getParLanguage(bp)->code();
5256 counters.step(from_utf8(type), utype);
5257 full_label = bformat(from_ascii("%1$s %2$s:"),
5259 counters.theCounter(from_utf8(type), lang));
5261 full_label = bformat(from_ascii("%1$s #:"), name);
5263 par.params().labelString(full_label);
5267 case LABEL_NO_LABEL:
5268 par.params().labelString(docstring());
5272 case LABEL_CENTERED:
5273 case LABEL_STATIC: {
5274 docstring const & lcounter = layout.counter;
5275 if (!lcounter.empty()) {
5276 if (layout.toclevel <= bp.secnumdepth
5277 && (layout.latextype != LATEX_ENVIRONMENT
5278 || it.text()->isFirstInSequence(it.pit()))) {
5279 if (counters.hasCounter(lcounter))
5280 counters.step(lcounter, utype);
5281 par.params().labelString(par.expandLabel(layout, bp));
5283 par.params().labelString(docstring());
5285 par.params().labelString(par.expandLabel(layout, bp));
5291 par.params().labelString(par.expandLabel(layout, bp));
5296 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5298 // LASSERT: Is it safe to continue here, or should we just return?
5299 LASSERT(parit.pit() == 0, /**/);
5301 // Set the position of the text in the buffer to be able
5302 // to resolve macros in it.
5303 parit.text()->setMacrocontextPosition(parit);
5305 // Reset bibitem counter in master (#8499)
5306 Buffer const * const master = masterBuffer();
5307 if (master == this && !d->ignore_parent)
5308 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5310 depth_type maxdepth = 0;
5311 pit_type const lastpit = parit.lastpit();
5312 bool changed = false;
5313 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5314 // reduce depth if necessary
5315 if (parit->params().depth() > maxdepth) {
5316 /** FIXME: this function is const, but
5317 * nevertheless it modifies the buffer. To be
5318 * cleaner, one should modify the buffer in
5319 * another function, which is actually
5320 * non-const. This would however be costly in
5321 * terms of code duplication.
5323 CursorData(parit).recordUndo();
5324 parit->params().depth(maxdepth);
5326 maxdepth = parit->getMaxDepthAfter();
5328 if (utype == OutputUpdate) {
5329 // track the active counters
5330 // we have to do this for the master buffer, since the local
5331 // buffer isn't tracking anything.
5332 masterBuffer()->params().documentClass().counters().
5333 setActiveLayout(parit->layout());
5336 // set the counter for this paragraph
5337 d->setLabel(parit, utype);
5340 for (auto const & insit : parit->insetList()) {
5341 parit.pos() = insit.pos;
5342 insit.inset->updateBuffer(parit, utype);
5343 changed |= insit.inset->isChanged();
5346 // are there changes in this paragraph?
5347 changed |= parit->isChanged();
5350 // set change indicator for the inset (or the cell that the iterator
5351 // points to, if applicable).
5352 parit.text()->inset().isChanged(changed);
5356 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5357 WordLangTuple & word_lang, docstring_list & suggestions) const
5361 suggestions.clear();
5362 word_lang = WordLangTuple();
5363 bool const to_end = to.empty();
5364 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5365 // OK, we start from here.
5366 for (; from != end; from.forwardPos()) {
5367 // This skips all insets with spell check disabled.
5368 while (!from.allowSpellCheck()) {
5372 // If from is at the end of the document (which is possible
5373 // when "from" was changed above) LyX will crash later otherwise.
5374 if (from.atEnd() || (!to_end && from >= end))
5377 from.paragraph().spellCheck();
5378 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5379 if (SpellChecker::misspelled(res)) {
5383 // Do not increase progress when from == to, otherwise the word
5384 // count will be wrong.
5394 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5396 bool inword = false;
5401 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5402 if (!dit.inTexted()) {
5407 Paragraph const & par = dit.paragraph();
5408 pos_type const pos = dit.pos();
5410 // Copied and adapted from isWordSeparator() in Paragraph
5411 if (pos == dit.lastpos()) {
5414 Inset const * ins = par.getInset(pos);
5415 if (ins && skipNoOutput && !ins->producesOutput()) {
5418 // stop if end of range was skipped
5419 if (!to.atEnd() && dit >= to)
5422 } else if (!par.isDeleted(pos)) {
5423 if (par.isWordSeparator(pos))
5429 if (ins && ins->isLetter())
5431 else if (ins && ins->isSpace())
5434 char_type const c = par.getChar(pos);
5435 if (isPrintableNonspace(c))
5437 else if (isSpace(c))
5447 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5449 d->updateStatistics(from, to, skipNoOutput);
5453 int Buffer::wordCount() const
5455 return d->wordCount();
5459 int Buffer::charCount(bool with_blanks) const
5461 return d->charCount(with_blanks);
5465 bool Buffer::areChangesPresent() const
5467 return inset().isChanged();
5471 Buffer::ReadStatus Buffer::reload()
5474 // c.f. bug https://www.lyx.org/trac/ticket/6587
5475 removeAutosaveFile();
5476 // e.g., read-only status could have changed due to version control
5477 d->filename.refresh();
5478 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5480 // clear parent. this will get reset if need be.
5481 d->setParent(nullptr);
5482 ReadStatus const status = loadLyXFile();
5483 if (status == ReadSuccess) {
5488 message(bformat(_("Document %1$s reloaded."), disp_fn));
5491 message(bformat(_("Could not reload document %1$s."), disp_fn));
5501 bool Buffer::saveAs(FileName const & fn)
5503 FileName const old_name = fileName();
5504 FileName const old_auto = getAutosaveFileName();
5505 bool const old_unnamed = isUnnamed();
5506 bool success = true;
5507 d->old_position = filePath();
5514 // bring the autosave file with us, just in case.
5515 moveAutosaveFile(old_auto);
5516 // validate version control data and
5517 // correct buffer title
5518 lyxvc().file_found_hook(fileName());
5520 // the file has now been saved to the new location.
5521 // we need to check that the locations of child buffers
5523 checkChildBuffers();
5524 checkMasterBuffer();
5527 // reset the old filename and unnamed state
5528 setFileName(old_name);
5529 setUnnamed(old_unnamed);
5533 d->old_position.clear();
5538 void Buffer::checkChildBuffers()
5540 for (auto const & bit : d->children_positions) {
5541 DocIterator dit = bit.second;
5542 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5543 if (!cbuf || !theBufferList().isLoaded(cbuf))
5545 Inset * inset = dit.nextInset();
5546 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5547 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5548 docstring const & incfile = inset_inc->getParam("filename");
5549 string oldloc = cbuf->absFileName();
5550 string newloc = makeAbsPath(to_utf8(incfile),
5551 onlyPath(absFileName())).absFileName();
5552 if (oldloc == newloc)
5554 // the location of the child file is incorrect.
5555 cbuf->setParent(nullptr);
5556 inset_inc->setChildBuffer(nullptr);
5558 // invalidate cache of children
5559 d->children_positions.clear();
5560 d->position_to_children.clear();
5564 // If a child has been saved under a different name/path, it might have been
5565 // orphaned. Therefore the master needs to be reset (bug 8161).
5566 void Buffer::checkMasterBuffer()
5568 Buffer const * const master = masterBuffer();
5572 // necessary to re-register the child (bug 5873)
5573 // FIXME: clean up updateMacros (here, only
5574 // child registering is needed).
5575 master->updateMacros();
5576 // (re)set master as master buffer, but only
5577 // if we are a real child
5578 if (master->isChild(this))
5585 string Buffer::includedFilePath(string const & name, string const & ext) const
5587 if (d->old_position.empty() ||
5588 equivalent(FileName(d->old_position), FileName(filePath())))
5591 bool isabsolute = FileName::isAbsolute(name);
5592 // both old_position and filePath() end with a path separator
5593 string absname = isabsolute ? name : d->old_position + name;
5595 // if old_position is set to origin, we need to do the equivalent of
5596 // getReferencedFileName() (see readDocument())
5597 if (!isabsolute && d->old_position == params().origin) {
5598 FileName const test(addExtension(filePath() + name, ext));
5600 absname = filePath() + name;
5603 if (!FileName(addExtension(absname, ext)).exists())
5607 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5609 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5610 from_utf8(filePath())));
5614 void Buffer::Impl::refreshFileMonitor()
5616 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5617 file_monitor_->refresh();
5621 // The previous file monitor is invalid
5622 // This also destroys the previous file monitor and all its connections
5623 file_monitor_ = FileSystemWatcher::monitor(filename);
5624 // file_monitor_ will be destroyed with *this, so it is not going to call a
5625 // destroyed object method.
5626 file_monitor_->connect([this](bool exists) {
5627 fileExternallyModified(exists);
5632 void Buffer::Impl::fileExternallyModified(bool const exists)
5634 // ignore notifications after our own saving operations
5635 if (checksum_ == filename.checksum()) {
5636 LYXERR(Debug::FILES, "External modification but "
5637 "checksum unchanged: " << filename);
5640 // If the file has been deleted, only mark the file as dirty since it is
5641 // pointless to prompt for reloading. If later a file is moved into this
5642 // location, then the externally modified warning will appear then.
5644 externally_modified_ = true;
5645 // Update external modification notification.
5646 // Dirty buffers must be visible at all times.
5647 if (wa_ && wa_->unhide(owner_))
5648 wa_->updateTitles();
5650 // Unable to unhide the buffer (e.g. no GUI or not current View)
5655 bool Buffer::notifiesExternalModification() const
5657 return d->externally_modified_;
5661 void Buffer::clearExternalModification() const
5663 d->externally_modified_ = false;
5665 d->wa_->updateTitles();