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/alert.h"
87 #include "frontends/Delegates.h"
88 #include "frontends/WorkAreaManager.h"
90 #include "support/lassert.h"
91 #include "support/convert.h"
92 #include "support/debug.h"
93 #include "support/docstring_list.h"
94 #include "support/ExceptionMessage.h"
95 #include "support/FileMonitor.h"
96 #include "support/FileName.h"
97 #include "support/FileNameList.h"
98 #include "support/filetools.h"
99 #include "support/ForkedCalls.h"
100 #include "support/gettext.h"
101 #include "support/gzstream.h"
102 #include "support/lstrings.h"
103 #include "support/lyxalgo.h"
104 #include "support/mutex.h"
105 #include "support/os.h"
106 #include "support/Package.h"
107 #include "support/PathChanger.h"
108 #include "support/Systemcall.h"
109 #include "support/TempFile.h"
110 #include "support/textutils.h"
111 #include "support/types.h"
113 #include "support/bind.h"
125 using namespace lyx::support;
126 using namespace lyx::graphics;
130 namespace Alert = frontend::Alert;
131 namespace os = support::os;
135 int const LYX_FORMAT = LYX_FORMAT_LYX;
137 typedef map<string, bool> DepClean;
139 // Information about labels and their associated refs
144 InsetLabel const * inset;
145 /// associated references cache
146 Buffer::References references;
147 /// whether this label is active (i.e., not deleted)
151 typedef vector<LabelInfo> LabelCache;
153 typedef map<docstring, Buffer::References> RefCache;
158 // A storehouse for the cloned buffers.
159 list<CloneList *> cloned_buffers;
165 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
169 delete preview_loader_;
177 /// search for macro in local (buffer) table or in children
178 MacroData const * getBufferMacro(docstring const & name,
179 DocIterator const & pos) const;
181 /// Update macro table starting with position of it \param it in some
183 void updateMacros(DocIterator & it, DocIterator & scope);
185 void setLabel(ParIterator & it, UpdateType utype) const;
187 /** If we have branches that use the file suffix
188 feature, return the file name with suffix appended.
190 FileName exportFileName() const;
197 mutable TexRow texrow;
199 /// need to regenerate .tex?
203 mutable bool lyx_clean;
205 /// is autosave needed?
206 mutable bool bak_clean;
208 /// is this an unnamed file (New...)?
211 /// is this an internal bufffer?
212 bool internal_buffer;
217 /// name of the file the buffer is associated with.
220 /** Set to true only when the file is fully loaded.
221 * Used to prevent the premature generation of previews
222 * and by the citation inset.
224 bool file_fully_loaded;
226 /// original format of loaded file
229 /// if the file was originally loaded from an older format, do
230 /// we need to back it up still?
231 bool need_format_backup;
233 /// Ignore the parent (e.g. when exporting a child standalone)?
237 mutable TocBackend toc_backend;
242 ScopeMacro(DocIterator const & s, MacroData const & m)
243 : scope(s), macro(m) {}
247 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
248 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
249 /// map from the macro name to the position map,
250 /// which maps the macro definition position to the scope and the MacroData.
251 NamePositionScopeMacroMap macros;
252 /// This seem to change the way Buffer::getMacro() works
253 mutable bool macro_lock;
255 /// positions of child buffers in the buffer
256 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
258 ScopeBuffer() : buffer(0) {}
259 ScopeBuffer(DocIterator const & s, Buffer const * b)
260 : scope(s), buffer(b) {}
262 Buffer const * buffer;
264 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
265 /// position of children buffers in this buffer
266 BufferPositionMap children_positions;
267 /// map from children inclusion positions to their scope and their buffer
268 PositionScopeBufferMap position_to_children;
270 /// Contains the old buffer filePath() while saving-as, or the
271 /// directory where the document was last saved while loading.
274 /** Keeps track of the path of local layout files.
275 * If possible, it is always relative to the buffer path.
276 * Empty for layouts in system or user directory.
278 string layout_position;
280 /// Container for all sort of Buffer dependant errors.
281 map<string, ErrorList> errorLists;
283 /// checksum used to test if the file has been externally modified. Used to
284 /// double check whether the file had been externally modified when saving.
285 unsigned long checksum_;
288 frontend::WorkAreaManager * wa_;
290 frontend::GuiBufferDelegate * gui_;
295 /// A cache for the bibfiles (including bibfiles of loaded child
296 /// documents), needed for appropriate update of natbib labels.
297 mutable docstring_list bibfiles_cache_;
299 // FIXME The caching mechanism could be improved. At present, we have a
300 // cache for each Buffer, that caches all the bibliography info for that
301 // Buffer. A more efficient solution would be to have a global cache per
302 // file, and then to construct the Buffer's bibinfo from that.
303 /// A cache for bibliography info
304 mutable BiblioInfo bibinfo_;
305 /// whether the bibinfo cache is valid
306 mutable bool bibinfo_cache_valid_;
307 /// Cache of timestamps of .bib files
308 map<FileName, time_t> bibfile_status_;
309 /// Indicates whether the bibinfo has changed since the last time
310 /// we ran updateBuffer(), i.e., whether citation labels may need
312 mutable bool cite_labels_valid_;
313 /// Do we have a bibliography environment?
314 mutable bool have_bibitems_;
316 /// These two hold the file name and format, written to by
317 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
318 FileName preview_file_;
319 string preview_format_;
320 /// If there was an error when previewing, on the next preview we do
321 /// a fresh compile (e.g. in case the user installed a package that
325 /// Cache the references associated to a label and their positions
327 mutable RefCache ref_cache_;
328 /// Cache the label insets and their activity status.
329 mutable LabelCache label_cache_;
331 /// our Text that should be wrapped in an InsetText
335 PreviewLoader * preview_loader_;
337 /// This is here to force the test to be done whenever parent_buffer
339 Buffer const * parent() const
341 // ignore_parent temporarily "orphans" a buffer
342 // (e.g. if a child is compiled standalone)
345 // if parent_buffer is not loaded, then it has been unloaded,
346 // which means that parent_buffer is an invalid pointer. So we
347 // set it to null in that case.
348 // however, the BufferList doesn't know about cloned buffers, so
349 // they will always be regarded as unloaded. in that case, we hope
351 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
353 return parent_buffer;
357 void setParent(Buffer const * pb)
359 if (parent_buffer == pb)
362 if (!cloned_buffer_ && parent_buffer && pb)
363 LYXERR0("Warning: a buffer should not have two parents!");
365 if (!cloned_buffer_ && parent_buffer)
366 parent_buffer->invalidateBibinfoCache();
369 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
370 /// This one is useful for preview detached in a thread.
371 Buffer const * cloned_buffer_;
373 CloneList * clone_list_;
374 /// are we in the process of exporting this buffer?
375 mutable bool doing_export;
377 /// compute statistics
378 /// \p from initial position
379 /// \p to points to the end position
380 void updateStatistics(DocIterator & from, DocIterator & to,
381 bool skipNoOutput = true);
382 /// statistics accessor functions
383 int wordCount() const
387 int charCount(bool with_blanks) const
390 + (with_blanks ? blank_count_ : 0);
393 // does the buffer contain tracked changes? (if so, we automatically
394 // display the review toolbar, for instance)
395 mutable bool tracked_changes_present_;
397 // Make sure the file monitor monitors the good file.
398 void refreshFileMonitor();
400 /// Notify or clear of external modification
401 void fileExternallyModified(bool exists);
403 /// has been externally modified? Can be reset by the user.
404 mutable bool externally_modified_;
407 /// So we can force access via the accessors.
408 mutable Buffer const * parent_buffer;
414 FileMonitorPtr file_monitor_;
418 /// Creates the per buffer temporary directory
419 static FileName createBufferTmpDir()
421 // FIXME This would be the ideal application for a TempDir class (like
422 // TempFile but for directories)
427 Mutex::Locker locker(&mutex);
428 counter = convert<string>(count++);
430 // We are in our own directory. Why bother to mangle name?
431 // In fact I wrote this code to circumvent a problematic behaviour
432 // (bug?) of EMX mkstemp().
433 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
436 if (!tmpfl.createDirectory(0777)) {
437 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
438 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
439 from_utf8(tmpfl.absFileName())));
445 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
446 Buffer const * cloned_buffer)
447 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
448 internal_buffer(false), read_only(readonly_), filename(file),
449 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
450 ignore_parent(false), toc_backend(owner), macro_lock(false),
451 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
452 cite_labels_valid_(false), have_bibitems_(false), preview_error_(false),
453 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
454 clone_list_(0), doing_export(false),
455 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
456 word_count_(0), char_count_(0), blank_count_(0)
458 refreshFileMonitor();
459 if (!cloned_buffer_) {
460 temppath = createBufferTmpDir();
461 lyxvc.setBuffer(owner_);
463 wa_ = new frontend::WorkAreaManager;
466 temppath = cloned_buffer_->d->temppath;
467 file_fully_loaded = true;
468 params = cloned_buffer_->d->params;
469 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
470 bibinfo_ = cloned_buffer_->d->bibinfo_;
471 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
472 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
473 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
474 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
475 unnamed = cloned_buffer_->d->unnamed;
476 internal_buffer = cloned_buffer_->d->internal_buffer;
477 layout_position = cloned_buffer_->d->layout_position;
478 preview_file_ = cloned_buffer_->d->preview_file_;
479 preview_format_ = cloned_buffer_->d->preview_format_;
480 preview_error_ = cloned_buffer_->d->preview_error_;
481 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
485 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
486 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
488 LYXERR(Debug::INFO, "Buffer::Buffer()");
490 d->inset = new InsetText(*cloned_buffer->d->inset);
491 d->inset->setBuffer(*this);
492 // FIXME: optimize this loop somewhat, maybe by creating a new
493 // general recursive Inset::setId().
494 DocIterator it = doc_iterator_begin(this);
495 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
496 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
497 it.paragraph().setId(cloned_it.paragraph().id());
499 d->inset = new InsetText(this);
500 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
506 LYXERR(Debug::INFO, "Buffer::~Buffer()");
507 // here the buffer should take care that it is
508 // saved properly, before it goes into the void.
510 // GuiView already destroyed
514 // No need to do additional cleanups for internal buffer.
520 // this is in case of recursive includes: we won't try to delete
521 // ourselves as a child.
522 d->clone_list_->erase(this);
523 // loop over children
524 for (auto const & p : d->children_positions) {
525 Buffer * child = const_cast<Buffer *>(p.first);
526 if (d->clone_list_->erase(child))
529 // if we're the master buffer, then we should get rid of the list
532 // If this is not empty, we have leaked something. Worse, one of the
533 // children still has a reference to this list. But we will try to
534 // continue, rather than shut down.
535 LATTEST(d->clone_list_->empty());
536 list<CloneList *>::iterator it =
537 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
538 if (it == cloned_buffers.end()) {
539 // We will leak in this case, but it is safe to continue.
542 cloned_buffers.erase(it);
543 delete d->clone_list_;
545 // FIXME Do we really need to do this right before we delete d?
546 // clear references to children in macro tables
547 d->children_positions.clear();
548 d->position_to_children.clear();
550 // loop over children
551 for (auto const & p : d->children_positions) {
552 Buffer * child = const_cast<Buffer *>(p.first);
553 if (theBufferList().isLoaded(child)) {
554 if (theBufferList().isOthersChild(this, child))
557 theBufferList().release(child);
562 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
564 msg += emergencyWrite();
566 msg += " " + _("Save failed! Document is lost.");
568 Alert::warning(_("Attempting to close changed document!"), msg);
571 // FIXME Do we really need to do this right before we delete d?
572 // clear references to children in macro tables
573 d->children_positions.clear();
574 d->position_to_children.clear();
576 if (!d->temppath.destroyDirectory()) {
577 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
578 from_utf8(d->temppath.absFileName())));
587 Buffer * Buffer::cloneWithChildren() const
590 cloned_buffers.push_back(new CloneList);
591 CloneList * clones = cloned_buffers.back();
593 cloneWithChildren(bufmap, clones);
595 // make sure we got cloned
596 BufferMap::const_iterator bit = bufmap.find(this);
597 LASSERT(bit != bufmap.end(), return 0);
598 Buffer * cloned_buffer = bit->second;
600 return cloned_buffer;
604 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
606 // have we already been cloned?
607 if (bufmap.find(this) != bufmap.end())
610 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
612 // The clone needs its own DocumentClass, since running updateBuffer() will
613 // modify it, and we would otherwise be sharing it with the original Buffer.
614 buffer_clone->params().makeDocumentClass(true);
616 cap::switchBetweenClasses(
617 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
618 static_cast<InsetText &>(buffer_clone->inset()), el);
620 bufmap[this] = buffer_clone;
621 clones->insert(buffer_clone);
622 buffer_clone->d->clone_list_ = clones;
623 buffer_clone->d->macro_lock = true;
624 buffer_clone->d->children_positions.clear();
626 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
627 // math macro caches need to be rethought and simplified.
628 // I am not sure wether we should handle Buffer cloning here or in BufferList.
629 // Right now BufferList knows nothing about buffer clones.
630 for (auto const & p : d->position_to_children) {
631 DocIterator dit = p.first.clone(buffer_clone);
632 dit.setBuffer(buffer_clone);
633 Buffer * child = const_cast<Buffer *>(p.second.buffer);
635 child->cloneWithChildren(bufmap, clones);
636 BufferMap::iterator const bit = bufmap.find(child);
637 LASSERT(bit != bufmap.end(), continue);
638 Buffer * child_clone = bit->second;
640 Inset * inset = dit.nextInset();
641 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
642 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
643 inset_inc->setChildBuffer(child_clone);
644 child_clone->d->setParent(buffer_clone);
645 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
646 buffer_clone->setChild(dit, child_clone);
648 buffer_clone->d->macro_lock = false;
653 Buffer * Buffer::cloneBufferOnly() const {
654 cloned_buffers.push_back(new CloneList);
655 CloneList * clones = cloned_buffers.back();
656 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
658 // The clone needs its own DocumentClass, since running updateBuffer() will
659 // modify it, and we would otherwise be sharing it with the original Buffer.
660 buffer_clone->params().makeDocumentClass(true);
662 cap::switchBetweenClasses(
663 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
664 static_cast<InsetText &>(buffer_clone->inset()), el);
666 clones->insert(buffer_clone);
667 buffer_clone->d->clone_list_ = clones;
669 // we won't be cloning the children
670 buffer_clone->d->children_positions.clear();
675 bool Buffer::isClone() const
677 return d->cloned_buffer_;
681 void Buffer::changed(bool update_metrics) const
684 d->wa_->redrawAll(update_metrics);
688 frontend::WorkAreaManager & Buffer::workAreaManager() const
695 Text & Buffer::text() const
697 return d->inset->text();
701 Inset & Buffer::inset() const
707 BufferParams & Buffer::params()
713 BufferParams const & Buffer::params() const
719 BufferParams const & Buffer::masterParams() const
721 if (masterBuffer() == this)
724 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
725 // Copy child authors to the params. We need those pointers.
726 for (Author const & a : params().authors())
727 mparams.authors().record(a);
732 double Buffer::fontScalingFactor() const
734 return isExporting() ? 75.0 * params().html_math_img_scale
735 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
739 ParagraphList & Buffer::paragraphs()
741 return text().paragraphs();
745 ParagraphList const & Buffer::paragraphs() const
747 return text().paragraphs();
751 LyXVC & Buffer::lyxvc()
757 LyXVC const & Buffer::lyxvc() const
763 string const Buffer::temppath() const
765 return d->temppath.absFileName();
769 TexRow & Buffer::texrow()
775 TexRow const & Buffer::texrow() const
781 TocBackend & Buffer::tocBackend() const
783 return d->toc_backend;
787 Undo & Buffer::undo()
793 void Buffer::setChild(DocIterator const & dit, Buffer * child)
795 d->children_positions[child] = dit;
799 string Buffer::latexName(bool const no_path) const
801 FileName latex_name =
802 makeLatexName(d->exportFileName());
803 return no_path ? latex_name.onlyFileName()
804 : latex_name.absFileName();
808 FileName Buffer::Impl::exportFileName() const
810 docstring const branch_suffix =
811 params.branchlist().getFileNameSuffix();
812 if (branch_suffix.empty())
815 string const name = addExtension(filename.onlyFileNameWithoutExt()
816 + to_utf8(branch_suffix), filename.extension());
817 FileName res(filename.onlyPath().absFileName() + "/" + name);
823 string Buffer::logName(LogType * type) const
825 string const filename = latexName(false);
827 if (filename.empty()) {
833 string const path = temppath();
835 FileName const fname(addName(temppath(),
836 onlyFileName(changeExtension(filename,
839 // FIXME: how do we know this is the name of the build log?
840 FileName const bname(
841 addName(path, onlyFileName(
842 changeExtension(filename,
843 theFormats().extension(params().bufferFormat()) + ".out"))));
845 // Also consider the master buffer log file
846 FileName masterfname = fname;
847 LogType mtype = latexlog;
848 if (masterBuffer() != this) {
849 string const mlogfile = masterBuffer()->logName(&mtype);
850 masterfname = FileName(mlogfile);
853 // If no Latex log or Build log is newer, show Build log
854 if (bname.exists() &&
855 ((!fname.exists() && !masterfname.exists())
856 || (fname.lastModified() < bname.lastModified()
857 && masterfname.lastModified() < bname.lastModified()))) {
858 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
861 return bname.absFileName();
862 // If we have a newer master file log or only a master log, show this
863 } else if (fname != masterfname
864 && (!fname.exists() && (masterfname.exists()
865 || fname.lastModified() < masterfname.lastModified()))) {
866 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
869 return masterfname.absFileName();
871 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
874 return fname.absFileName();
878 void Buffer::setReadonly(bool const flag)
880 if (d->read_only != flag) {
887 void Buffer::setFileName(FileName const & fname)
889 bool const changed = fname != d->filename;
891 d->refreshFileMonitor();
893 lyxvc().file_found_hook(fname);
894 setReadonly(d->filename.isReadOnly());
900 int Buffer::readHeader(Lexer & lex)
902 int unknown_tokens = 0;
904 int begin_header_line = -1;
906 // Initialize parameters that may be/go lacking in header:
907 params().branchlist().clear();
908 params().preamble.erase();
909 params().options.erase();
910 params().master.erase();
911 params().float_placement.erase();
912 params().float_alignment.erase();
913 params().paperwidth.erase();
914 params().paperheight.erase();
915 params().leftmargin.erase();
916 params().rightmargin.erase();
917 params().topmargin.erase();
918 params().bottommargin.erase();
919 params().headheight.erase();
920 params().headsep.erase();
921 params().footskip.erase();
922 params().columnsep.erase();
923 params().fonts_cjk.erase();
924 params().listings_params.clear();
925 params().clearLayoutModules();
926 params().clearRemovedModules();
927 params().clearIncludedChildren();
928 params().pdfoptions().clear();
929 params().indiceslist().clear();
930 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
931 params().isbackgroundcolor = false;
932 params().fontcolor = RGBColor(0, 0, 0);
933 params().isfontcolor = false;
934 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
935 params().boxbgcolor = RGBColor(0xFF, 0, 0);
936 params().html_latex_start.clear();
937 params().html_latex_end.clear();
938 params().html_math_img_scale = 1.0;
939 params().output_sync_macro.erase();
940 params().setLocalLayout(docstring(), false);
941 params().setLocalLayout(docstring(), true);
942 params().biblio_opts.erase();
943 params().biblatex_bibstyle.erase();
944 params().biblatex_citestyle.erase();
945 params().multibib.erase();
947 for (int i = 0; i < 4; ++i) {
948 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
949 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
952 ErrorList & errorList = d->errorLists["Parse"];
961 if (token == "\\end_header")
965 if (token == "\\begin_header") {
966 begin_header_line = line;
970 LYXERR(Debug::PARSER, "Handling document header token: `"
973 string const result =
974 params().readToken(lex, token, d->filename.onlyPath());
975 if (!result.empty()) {
976 if (token == "\\textclass") {
977 d->layout_position = result;
980 docstring const s = bformat(_("Unknown token: "
984 errorList.push_back(ErrorItem(_("Document header error"), s));
988 if (begin_header_line) {
989 docstring const s = _("\\begin_header is missing");
990 errorList.push_back(ErrorItem(_("Document header error"), s));
993 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
995 params().makeDocumentClass();
997 return unknown_tokens;
1002 // changed to be public and have one parameter
1003 // Returns true if "\end_document" is not read (Asger)
1004 bool Buffer::readDocument(Lexer & lex)
1006 ErrorList & errorList = d->errorLists["Parse"];
1009 // remove dummy empty par
1010 paragraphs().clear();
1012 if (!lex.checkFor("\\begin_document")) {
1013 docstring const s = _("\\begin_document is missing");
1014 errorList.push_back(ErrorItem(_("Document header error"), s));
1019 if (params().output_changes) {
1020 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1021 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1022 LaTeXFeatures::isAvailable("xcolor");
1024 if (!dvipost && !xcolorulem) {
1025 Alert::warning(_("Changes not shown in LaTeX output"),
1026 _("Changes will not be highlighted in LaTeX output, "
1027 "because neither dvipost nor xcolor/ulem are installed.\n"
1028 "Please install these packages or redefine "
1029 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1030 } else if (!xcolorulem) {
1031 Alert::warning(_("Changes not shown in LaTeX output"),
1032 _("Changes will not be highlighted in LaTeX output "
1033 "when using pdflatex, because xcolor and ulem are not installed.\n"
1034 "Please install both packages or redefine "
1035 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1039 if (!parent() && !params().master.empty()) {
1040 FileName const master_file = makeAbsPath(params().master,
1041 onlyPath(absFileName()));
1042 if (isLyXFileName(master_file.absFileName())) {
1044 checkAndLoadLyXFile(master_file, true);
1046 // necessary e.g. after a reload
1047 // to re-register the child (bug 5873)
1048 // FIXME: clean up updateMacros (here, only
1049 // child registering is needed).
1050 master->updateMacros();
1051 // set master as master buffer, but only
1052 // if we are a real child
1053 if (master->isChild(this))
1055 // if the master is not fully loaded
1056 // it is probably just loading this
1057 // child. No warning needed then.
1058 else if (master->isFullyLoaded())
1059 LYXERR0("The master '"
1061 << "' assigned to this document ("
1063 << ") does not include "
1064 "this document. Ignoring the master assignment.");
1065 // If the master has just been created, un-hide it (#11162)
1066 if (!master->fileName().exists())
1067 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1068 master->absFileName()));
1073 // assure we have a default index
1074 params().indiceslist().addDefault(B_("Index"));
1077 if (FileName::isAbsolute(params().origin))
1078 d->old_position = params().origin;
1080 d->old_position = filePath();
1081 bool const res = text().read(lex, errorList, d->inset);
1082 d->old_position.clear();
1084 // inform parent buffer about local macros
1086 Buffer const * pbuf = parent();
1087 for (auto const & m : usermacros)
1088 pbuf->usermacros.insert(m);
1092 updateMacroInstances(InternalUpdate);
1097 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1099 Format const * fmt = theFormats().getFormat(format);
1102 // It is important to use the correct extension here, since some
1103 // converters create a wrong output file otherwise (e.g. html2latex)
1104 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1105 ofdocstream os(name.toFilesystemEncoding().c_str());
1106 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1107 bool const success = !(os << contents).fail();
1110 bool converted = false;
1112 params().compressed = false;
1114 // remove dummy empty par
1115 paragraphs().clear();
1117 converted = importFile(format, name, errorList);
1120 removeTempFile(name);
1125 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1127 if (!theConverters().isReachable(format, "lyx"))
1130 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1131 Converters::RetVal const retval =
1132 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1133 if (retval == Converters::SUCCESS) {
1134 bool const success = readFile(lyx) == ReadSuccess;
1135 removeTempFile(lyx);
1143 bool Buffer::readString(string const & s)
1145 params().compressed = false;
1148 istringstream is(s);
1150 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1151 FileName const fn = tempfile.name();
1154 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1156 if (success && file_format != LYX_FORMAT) {
1157 // We need to call lyx2lyx, so write the input to a file
1158 ofstream os(fn.toFilesystemEncoding().c_str());
1161 // lyxvc in readFile
1162 if (readFile(fn) != ReadSuccess)
1166 if (readDocument(lex))
1172 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1176 if (!lex.setFile(fname)) {
1177 Alert::error(_("File Not Found"),
1178 bformat(_("Unable to open file `%1$s'."),
1179 from_utf8(fn.absFileName())));
1180 return ReadFileNotFound;
1184 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1185 if (ret_plf != ReadSuccess)
1188 if (file_format != LYX_FORMAT) {
1190 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1191 if (ret_clf != ReadSuccess)
1193 ret_clf = readFile(tmpFile);
1194 if (ret_clf == ReadSuccess) {
1195 d->file_format = file_format;
1196 d->need_format_backup = true;
1201 // FIXME: InsetInfo needs to know whether the file is under VCS
1202 // during the parse process, so this has to be done before.
1203 lyxvc().file_found_hook(d->filename);
1205 if (readDocument(lex)) {
1206 Alert::error(_("Document format failure"),
1207 bformat(_("%1$s ended unexpectedly, which means"
1208 " that it is probably corrupted."),
1209 from_utf8(fn.absFileName())));
1210 return ReadDocumentFailure;
1213 d->file_fully_loaded = true;
1214 d->read_only = !d->filename.isWritable();
1215 params().compressed = theFormats().isZippedFile(d->filename);
1221 bool Buffer::isFullyLoaded() const
1223 return d->file_fully_loaded;
1227 void Buffer::setFullyLoaded(bool value)
1229 d->file_fully_loaded = value;
1233 bool Buffer::lastPreviewError() const
1235 return d->preview_error_;
1239 PreviewLoader * Buffer::loader() const
1241 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1243 if (!d->preview_loader_)
1244 d->preview_loader_ = new PreviewLoader(*this);
1245 return d->preview_loader_;
1249 void Buffer::removePreviews() const
1251 delete d->preview_loader_;
1252 d->preview_loader_ = 0;
1256 void Buffer::updatePreviews() const
1258 PreviewLoader * ploader = loader();
1262 InsetIterator it = inset_iterator_begin(*d->inset);
1263 InsetIterator const end = inset_iterator_end(*d->inset);
1264 for (; it != end; ++it)
1265 it->addPreview(it, *ploader);
1267 ploader->startLoading();
1271 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1272 FileName const & fn, int & file_format) const
1274 if(!lex.checkFor("\\lyxformat")) {
1275 Alert::error(_("Document format failure"),
1276 bformat(_("%1$s is not a readable LyX document."),
1277 from_utf8(fn.absFileName())));
1278 return ReadNoLyXFormat;
1284 // LyX formats 217 and earlier were written as 2.17. This corresponds
1285 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1286 // these cases. See also: www.lyx.org/trac/changeset/1313.
1287 size_t dot = tmp_format.find_first_of(".,");
1288 if (dot != string::npos)
1289 tmp_format.erase(dot, 1);
1291 file_format = convert<int>(tmp_format);
1296 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1297 FileName & tmpfile, int from_format)
1299 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1300 tempfile.setAutoRemove(false);
1301 tmpfile = tempfile.name();
1302 if(tmpfile.empty()) {
1303 Alert::error(_("Conversion failed"),
1304 bformat(_("%1$s is from a different"
1305 " version of LyX, but a temporary"
1306 " file for converting it could"
1307 " not be created."),
1308 from_utf8(fn.absFileName())));
1309 return LyX2LyXNoTempFile;
1312 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1313 if (lyx2lyx.empty()) {
1314 Alert::error(_("Conversion script not found"),
1315 bformat(_("%1$s is from a different"
1316 " version of LyX, but the"
1317 " conversion script lyx2lyx"
1318 " could not be found."),
1319 from_utf8(fn.absFileName())));
1320 return LyX2LyXNotFound;
1324 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1325 ostringstream command;
1326 command << os::python()
1327 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1328 << " -t " << convert<string>(LYX_FORMAT)
1329 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1330 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1331 string const command_str = command.str();
1333 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1335 cmd_ret const ret = runCommand(command_str);
1336 if (ret.first != 0) {
1337 if (from_format < LYX_FORMAT) {
1338 Alert::error(_("Conversion script failed"),
1339 bformat(_("%1$s is from an older version"
1340 " of LyX and the lyx2lyx script"
1341 " failed to convert it."),
1342 from_utf8(fn.absFileName())));
1343 return LyX2LyXOlderFormat;
1345 Alert::error(_("Conversion script failed"),
1346 bformat(_("%1$s is from a newer version"
1347 " of LyX and the lyx2lyx script"
1348 " failed to convert it."),
1349 from_utf8(fn.absFileName())));
1350 return LyX2LyXNewerFormat;
1357 FileName Buffer::getBackupName() const {
1358 map<int, string> const file_formats = {
1375 FileName const & fn = fileName();
1376 string const fname = fn.onlyFileNameWithoutExt();
1377 string const fext = fn.extension() + "~";
1378 string const fpath = lyxrc.backupdir_path.empty() ?
1379 fn.onlyPath().absFileName() :
1380 lyxrc.backupdir_path;
1381 string backup_suffix;
1382 // If file format is from a stable series use version instead of file format
1383 auto const it = file_formats.find(d->file_format);
1384 if (it != file_formats.end())
1385 backup_suffix = "-lyx" + it->second;
1387 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1388 string const backname = fname + backup_suffix;
1389 FileName backup(addName(fpath, addExtension(backname, fext)));
1391 // limit recursion, just in case
1393 unsigned long orig_checksum = 0;
1394 while (backup.exists() && v < 100) {
1395 if (orig_checksum == 0)
1396 orig_checksum = fn.checksum();
1397 unsigned long new_checksum = backup.checksum();
1398 if (orig_checksum == new_checksum) {
1399 LYXERR(Debug::FILES, "Not backing up " << fn <<
1400 "since " << backup << "has the same checksum.");
1401 // a bit of a hack, but we have to check this anyway
1402 // below, and setting this is simpler than introducing
1403 // a special boolean for this purpose.
1407 string const newbackname = backname + "-" + convert<string>(v);
1408 backup.set(addName(fpath, addExtension(newbackname, fext)));
1411 return v < 100 ? backup : FileName();
1415 // Should probably be moved to somewhere else: BufferView? GuiView?
1416 bool Buffer::save() const
1418 docstring const file = makeDisplayPath(absFileName(), 20);
1419 d->filename.refresh();
1421 // check the read-only status before moving the file as a backup
1422 if (d->filename.exists()) {
1423 bool const read_only = !d->filename.isWritable();
1425 Alert::warning(_("File is read-only"),
1426 bformat(_("The file %1$s cannot be written because it "
1427 "is marked as read-only."), file));
1432 // ask if the disk file has been externally modified (use checksum method)
1433 if (fileName().exists() && isChecksumModified()) {
1435 bformat(_("Document %1$s has been externally modified. "
1436 "Are you sure you want to overwrite this file?"), file);
1437 int const ret = Alert::prompt(_("Overwrite modified file?"),
1438 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1443 // We don't need autosaves in the immediate future. (Asger)
1444 resetAutosaveTimers();
1446 // if the file does not yet exist, none of the backup activity
1447 // that follows is necessary
1448 if (!fileName().exists()) {
1449 if (!writeFile(fileName()))
1455 // we first write the file to a new name, then move it to its
1456 // proper location once that has been done successfully. that
1457 // way we preserve the original file if something goes wrong.
1458 string const justname = fileName().onlyFileNameWithoutExt();
1459 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1460 justname + "-XXXXXX.lyx");
1461 bool const symlink = fileName().isSymLink();
1463 tempfile->setAutoRemove(false);
1465 FileName savefile(tempfile->name());
1466 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1467 if (!savefile.clonePermissions(fileName()))
1468 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1470 if (!writeFile(savefile))
1473 // we will set this to false if we fail
1474 bool made_backup = true;
1476 FileName backupName;
1477 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1479 if (d->need_format_backup)
1480 backupName = getBackupName();
1482 // If we for some reason failed to find a backup name in case of
1483 // a format change, this will still set one. It's the best we can
1485 if (backupName.empty()) {
1486 backupName.set(fileName().absFileName() + "~");
1487 if (!lyxrc.backupdir_path.empty()) {
1488 string const mangledName =
1489 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1490 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1494 LYXERR(Debug::FILES, "Backing up original file to " <<
1495 backupName.absFileName());
1496 // Except file is symlink do not copy because of #6587.
1497 // Hard links have bad luck.
1498 made_backup = symlink ?
1499 fileName().copyTo(backupName):
1500 fileName().moveTo(backupName);
1503 Alert::error(_("Backup failure"),
1504 bformat(_("Cannot create backup file %1$s.\n"
1505 "Please check whether the directory exists and is writable."),
1506 from_utf8(backupName.absFileName())));
1507 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1508 } else if (d->need_format_backup) {
1509 // the original file has been backed up successfully, so we
1510 // will not need to do that again
1511 d->need_format_backup = false;
1515 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1516 // Only do this if tempfile is not in autoremove mode
1519 // If we have no symlink, we can simply rename the temp file.
1520 // Otherwise, we need to copy it so the symlink stays intact.
1521 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1522 savefile.moveTo(fileName()))
1524 // saveCheckSum() was already called by writeFile(), but the
1525 // time stamp is invalidated by copying/moving
1528 if (d->file_format != LYX_FORMAT)
1529 // the file associated with this buffer is now in the current format
1530 d->file_format = LYX_FORMAT;
1533 // else we saved the file, but failed to move it to the right location.
1535 if (needBackup && made_backup && !symlink) {
1536 // the original file was moved to some new location, so it will look
1537 // to the user as if it was deleted. (see bug #9234.) we could try
1538 // to restore it, but that would basically mean trying to do again
1539 // what we just failed to do. better to leave things as they are.
1540 Alert::error(_("Write failure"),
1541 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1542 "But LyX could not move it to:\n %2$s.\n"
1543 "Your original file has been backed up to:\n %3$s"),
1544 from_utf8(savefile.absFileName()),
1545 from_utf8(fileName().absFileName()),
1546 from_utf8(backupName.absFileName())));
1548 // either we did not try to make a backup, or else we tried and failed,
1549 // or else the original file was a symlink, in which case it was copied,
1550 // not moved. so the original file is intact.
1551 Alert::error(_("Write failure"),
1552 bformat(_("Cannot move saved file to:\n %1$s.\n"
1553 "But the file has successfully been saved as:\n %2$s."),
1554 from_utf8(fileName().absFileName()),
1555 from_utf8(savefile.absFileName())));
1561 bool Buffer::writeFile(FileName const & fname) const
1563 if (d->read_only && fname == d->filename)
1566 bool retval = false;
1568 docstring const str = bformat(_("Saving document %1$s..."),
1569 makeDisplayPath(fname.absFileName()));
1572 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1574 if (params().compressed) {
1575 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1576 retval = ofs && write(ofs);
1578 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1579 retval = ofs && write(ofs);
1583 message(str + _(" could not write file!"));
1588 // removeAutosaveFile();
1591 message(str + _(" done."));
1597 docstring Buffer::emergencyWrite()
1599 // No need to save if the buffer has not changed.
1603 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1605 docstring user_message = bformat(
1606 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1608 // We try to save three places:
1609 // 1) Same place as document. Unless it is an unnamed doc.
1611 string s = absFileName();
1614 if (writeFile(FileName(s))) {
1616 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1617 return user_message;
1619 user_message += " " + _("Save failed! Trying again...\n");
1623 // 2) In HOME directory.
1624 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1626 lyxerr << ' ' << s << endl;
1627 if (writeFile(FileName(s))) {
1629 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1630 return user_message;
1633 user_message += " " + _("Save failed! Trying yet again...\n");
1635 // 3) In "/tmp" directory.
1636 // MakeAbsPath to prepend the current
1637 // drive letter on OS/2
1638 s = addName(package().temp_dir().absFileName(), absFileName());
1640 lyxerr << ' ' << s << endl;
1641 if (writeFile(FileName(s))) {
1643 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1644 return user_message;
1647 user_message += " " + _("Save failed! Document is lost.");
1650 return user_message;
1654 bool Buffer::write(ostream & ofs) const
1657 // Use the standard "C" locale for file output.
1658 ofs.imbue(locale::classic());
1661 // The top of the file should not be written by params().
1663 // write out a comment in the top of the file
1664 // Important: Keep the version formatting in sync with lyx2lyx and
1665 // tex2lyx (bug 7951)
1666 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1667 << " created this file. For more info see https://www.lyx.org/\n"
1668 << "\\lyxformat " << LYX_FORMAT << "\n"
1669 << "\\begin_document\n";
1671 /// For each author, set 'used' to true if there is a change
1672 /// by this author in the document; otherwise set it to 'false'.
1673 for (Author const & a : params().authors())
1676 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1677 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1678 for ( ; it != end; ++it)
1679 it->checkAuthors(params().authors());
1681 // now write out the buffer parameters.
1682 ofs << "\\begin_header\n";
1683 params().writeFile(ofs, this);
1684 ofs << "\\end_header\n";
1687 ofs << "\n\\begin_body\n";
1689 ofs << "\n\\end_body\n";
1691 // Write marker that shows file is complete
1692 ofs << "\\end_document" << endl;
1694 // Shouldn't really be needed....
1697 // how to check if close went ok?
1698 // Following is an attempt... (BE 20001011)
1700 // good() returns false if any error occurred, including some
1701 // formatting error.
1702 // bad() returns true if something bad happened in the buffer,
1703 // which should include file system full errors.
1708 lyxerr << "File was not closed properly." << endl;
1715 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1716 string const & original_path,
1717 OutputParams const & runparams_in,
1718 OutputWhat output) const
1720 OutputParams runparams = runparams_in;
1722 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1723 // Check here, because the "flavor" is not known in BufferParams::encoding()
1724 // (power users can override this safety measure selecting "utf8-plain").
1725 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1726 && (runparams.encoding->name() != "utf8-plain"))
1727 runparams.encoding = encodings.fromLyXName("ascii");
1729 string const encoding = runparams.encoding->iconvName();
1730 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1733 try { ofs.reset(encoding); }
1734 catch (iconv_codecvt_facet_exception const & e) {
1735 lyxerr << "Caught iconv exception: " << e.what() << endl;
1736 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1737 "verify that the support software for your encoding (%1$s) is "
1738 "properly installed"), from_ascii(encoding)));
1741 if (!openFileWrite(ofs, fname))
1744 ErrorList & errorList = d->errorLists["Export"];
1746 ExportStatus status = ExportSuccess;
1749 // make sure we are ready to export
1750 // this needs to be done before we validate
1751 // FIXME Do we need to do this all the time? I.e., in children
1752 // of a master we are exporting?
1754 updateMacroInstances(OutputUpdate);
1756 ExportStatus retval;
1758 retval = writeLaTeXSource(os, original_path, runparams, output);
1759 if (retval == ExportKilled)
1760 return ExportKilled;
1762 catch (EncodingException const & e) {
1763 docstring const failed(1, e.failed_char);
1765 oss << "0x" << hex << e.failed_char << dec;
1766 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1767 docstring msg = bformat(_("Uncodable character '%1$s'"
1768 " (code point %2$s)"),
1769 failed, from_utf8(oss.str()));
1770 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1771 "representable in specific verbatim contexts.\n"
1772 "Changing the document encoding to utf8 could help."),
1773 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1775 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1776 " (code point %2$s)"),
1777 failed, from_utf8(oss.str()));
1778 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1779 "representable in the chosen encoding.\n"
1780 "Changing the document encoding to utf8 could help."),
1781 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1783 status = ExportError;
1785 catch (iconv_codecvt_facet_exception const & e) {
1786 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1788 status = ExportError;
1790 catch (exception const & e) {
1791 errorList.push_back(ErrorItem(_("conversion failed"),
1793 lyxerr << e.what() << endl;
1794 status = ExportError;
1797 lyxerr << "Caught some really weird exception..." << endl;
1801 d->texrow = move(os.texrow());
1805 status = ExportError;
1806 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1809 if (runparams_in.silent)
1817 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1818 string const & original_path,
1819 OutputParams const & runparams_in,
1820 OutputWhat output) const
1822 // The child documents, if any, shall be already loaded at this point.
1824 OutputParams runparams = runparams_in;
1826 // XeTeX with TeX fonts is only safe with ASCII encoding,
1827 // Check here, because the "flavor" is not known in BufferParams::encoding()
1828 // (power users can override this safety measure selecting "utf8-plain").
1829 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1830 && (runparams.encoding->name() != "utf8-plain"))
1831 runparams.encoding = encodings.fromLyXName("ascii");
1832 // FIXME: when only the current paragraph is shown, this is ignored
1833 // (or not reached) and characters encodable in the current
1834 // encoding are not converted to ASCII-representation.
1836 // Some macros rely on font encoding
1837 runparams.main_fontenc = params().main_font_encoding();
1839 // If we are compiling a file standalone, even if this is the
1840 // child of some other buffer, let's cut the link here, so the
1841 // file is really independent and no concurring settings from
1842 // the master (e.g. branch state) interfere (see #8100).
1843 if (!runparams.is_child)
1844 d->ignore_parent = true;
1846 // Classify the unicode characters appearing in math insets
1847 BufferEncodings::initUnicodeMath(*this);
1849 // validate the buffer.
1850 LYXERR(Debug::LATEX, " Validating buffer...");
1851 LaTeXFeatures features(*this, params(), runparams);
1853 // This is only set once per document (in master)
1854 if (!runparams.is_child) {
1855 runparams.use_polyglossia = features.usePolyglossia();
1856 runparams.use_CJK = features.mustProvide("CJK");
1858 LYXERR(Debug::LATEX, " Buffer validation done.");
1860 bool const output_preamble =
1861 output == FullSource || output == OnlyPreamble;
1862 bool const output_body =
1863 output == FullSource || output == OnlyBody;
1865 // The starting paragraph of the coming rows is the
1866 // first paragraph of the document. (Asger)
1867 if (output_preamble && runparams.nice) {
1868 os << "%% LyX " << lyx_version << " created this file. "
1869 "For more info, see https://www.lyx.org/.\n"
1870 "%% Do not edit unless you really know what "
1873 LYXERR(Debug::INFO, "lyx document header finished");
1875 // There are a few differences between nice LaTeX and usual files:
1876 // usual files have \batchmode and special input@path to allow
1877 // inclusion of figures specified by an explicitly relative path
1878 // (i.e., a path starting with './' or '../') with either \input or
1879 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1880 // input@path is set when the actual parameter original_path is set.
1881 // This is done for usual tex-file, but not for nice-latex-file.
1882 // (Matthias 250696)
1883 // Note that input@path is only needed for something the user does
1884 // in the preamble, included .tex files or ERT, files included by
1885 // LyX work without it.
1886 if (output_preamble) {
1887 if (!runparams.nice) {
1888 // code for usual, NOT nice-latex-file
1889 os << "\\batchmode\n"; // changed from \nonstopmode
1891 if (!original_path.empty()) {
1893 // We don't know the encoding of inputpath
1894 docstring const inputpath = from_utf8(original_path);
1895 docstring uncodable_glyphs;
1896 Encoding const * const enc = runparams.encoding;
1898 for (size_t n = 0; n < inputpath.size(); ++n) {
1899 if (!enc->encodable(inputpath[n])) {
1900 docstring const glyph(1, inputpath[n]);
1901 LYXERR0("Uncodable character '"
1903 << "' in input path!");
1904 uncodable_glyphs += glyph;
1909 // warn user if we found uncodable glyphs.
1910 if (!uncodable_glyphs.empty()) {
1911 frontend::Alert::warning(
1912 _("Uncodable character in file path"),
1914 _("The path of your document\n"
1916 "contains glyphs that are unknown "
1917 "in the current document encoding "
1918 "(namely %2$s). This may result in "
1919 "incomplete output, unless "
1920 "TEXINPUTS contains the document "
1921 "directory and you don't use "
1922 "explicitly relative paths (i.e., "
1923 "paths starting with './' or "
1924 "'../') in the preamble or in ERT."
1925 "\n\nIn case of problems, choose "
1926 "an appropriate document encoding\n"
1927 "(such as utf8) or change the "
1929 inputpath, uncodable_glyphs));
1931 string docdir = os::latex_path(original_path);
1932 if (contains(docdir, '#')) {
1933 docdir = subst(docdir, "#", "\\#");
1934 os << "\\catcode`\\#=11"
1935 "\\def\\#{#}\\catcode`\\#=6\n";
1937 if (contains(docdir, '%')) {
1938 docdir = subst(docdir, "%", "\\%");
1939 os << "\\catcode`\\%=11"
1940 "\\def\\%{%}\\catcode`\\%=14\n";
1942 bool const detokenize = !isAscii(from_utf8(docdir));
1943 bool const quote = contains(docdir, ' ');
1944 os << "\\makeatletter\n"
1945 << "\\def\\input@path{{";
1947 os << "\\detokenize{";
1956 << "\\makeatother\n";
1960 // get parent macros (if this buffer has a parent) which will be
1961 // written at the document begin further down.
1962 MacroSet parentMacros;
1963 listParentMacros(parentMacros, features);
1965 // Write the preamble
1966 runparams.use_babel = params().writeLaTeX(os, features,
1967 d->filename.onlyPath());
1969 // Biblatex bibliographies are loaded here
1970 if (params().useBiblatex()) {
1971 vector<docstring> const bibfiles =
1972 prepareBibFilePaths(runparams, getBibfiles(), true);
1973 for (docstring const & file: bibfiles)
1974 os << "\\addbibresource{" << file << "}\n";
1977 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1978 && !features.hasOnlyPolyglossiaLanguages()) {
1981 vector<string> bll = features.getBabelExclusiveLanguages();
1982 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1985 for (string const & sit : bll) {
1990 blangs = bll.size() > 1 ?
1991 bformat(_("The languages %1$s are only supported by Babel."), langs)
1992 : bformat(_("The language %1$s is only supported by Babel."), langs);
1996 for (string const & pit : pll) {
2001 plangs = pll.size() > 1 ?
2002 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2003 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2004 if (!blangs.empty())
2008 frontend::Alert::warning(
2009 _("Incompatible Languages!"),
2011 _("You cannot use the following languages "
2012 "together in one LaTeX document because "
2013 "they require conflicting language packages:\n"
2018 // Japanese might be required only in some children of a document,
2019 // but once required, we must keep use_japanese true.
2020 runparams.use_japanese |= features.isRequired("japanese");
2023 // Restore the parenthood if needed
2024 if (!runparams.is_child)
2025 d->ignore_parent = false;
2026 return ExportSuccess;
2030 // mark the beginning of the body to separate it from InPreamble insets
2031 os.texrow().start(TexRow::beginDocument());
2032 os << "\\begin{document}\n";
2034 // mark the start of a new paragraph by simulating a newline,
2035 // so that os.afterParbreak() returns true at document start
2038 // output the parent macros
2039 for (auto const & mac : parentMacros) {
2040 int num_lines = mac->write(os.os(), true);
2041 os.texrow().newlines(num_lines);
2044 } // output_preamble
2046 LYXERR(Debug::INFO, "preamble finished, now the body.");
2050 latexParagraphs(*this, text(), os, runparams);
2052 catch (ConversionException const &) { return ExportKilled; }
2054 // Restore the parenthood if needed
2055 if (!runparams.is_child)
2056 d->ignore_parent = false;
2058 // add this just in case after all the paragraphs
2061 if (output_preamble) {
2062 os << "\\end{document}\n";
2063 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2065 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2067 runparams_in.encoding = runparams.encoding;
2069 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2070 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2071 return ExportSuccess;
2075 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2076 OutputParams const & runparams,
2077 OutputWhat output) const
2079 LYXERR(Debug::LATEX, "makeDocBookFile...");
2082 if (!openFileWrite(ofs, fname))
2085 // make sure we are ready to export
2086 // this needs to be done before we validate
2088 updateMacroInstances(OutputUpdate);
2090 ExportStatus const retval =
2091 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2092 if (retval == ExportKilled)
2093 return ExportKilled;
2097 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2098 return ExportSuccess;
2102 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2103 OutputParams const & runparams,
2104 OutputWhat output) const
2106 LaTeXFeatures features(*this, params(), runparams);
2111 DocumentClass const & tclass = params().documentClass();
2112 string const & top_element = tclass.latexname();
2114 bool const output_preamble =
2115 output == FullSource || output == OnlyPreamble;
2116 bool const output_body =
2117 output == FullSource || output == OnlyBody;
2119 if (output_preamble) {
2120 if (runparams.flavor == OutputParams::XML)
2121 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2124 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2127 if (! tclass.class_header().empty())
2128 os << from_ascii(tclass.class_header());
2129 else if (runparams.flavor == OutputParams::XML)
2130 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2131 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2133 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2135 docstring preamble = params().preamble;
2136 if (runparams.flavor != OutputParams::XML ) {
2137 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2138 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2139 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2140 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2143 string const name = runparams.nice
2144 ? changeExtension(absFileName(), ".sgml") : fname;
2145 preamble += features.getIncludedFiles(name);
2146 preamble += features.getLyXSGMLEntities();
2148 if (!preamble.empty()) {
2149 os << "\n [ " << preamble << " ]";
2155 string top = top_element;
2157 if (runparams.flavor == OutputParams::XML)
2158 top += params().language->code();
2160 top += params().language->code().substr(0, 2);
2163 if (!params().options.empty()) {
2165 top += params().options;
2168 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2169 << " file was created by LyX " << lyx_version
2170 << "\n See https://www.lyx.org/ for more information -->\n";
2172 params().documentClass().counters().reset();
2174 sgml::openTag(os, top);
2177 docbookParagraphs(text(), *this, os, runparams);
2179 catch (ConversionException const &) { return ExportKilled; }
2180 sgml::closeTag(os, top_element);
2182 return ExportSuccess;
2186 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2187 OutputParams const & runparams) const
2189 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2192 if (!openFileWrite(ofs, fname))
2195 // make sure we are ready to export
2196 // this has to be done before we validate
2197 updateBuffer(UpdateMaster, OutputUpdate);
2198 updateMacroInstances(OutputUpdate);
2200 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2201 if (retval == ExportKilled)
2206 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2211 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2212 OutputParams const & runparams,
2213 OutputWhat output) const
2215 LaTeXFeatures features(*this, params(), runparams);
2217 d->bibinfo_.makeCitationLabels(*this);
2219 bool const output_preamble =
2220 output == FullSource || output == OnlyPreamble;
2221 bool const output_body =
2222 output == FullSource || output == OnlyBody || output == IncludedFile;
2224 if (output_preamble) {
2225 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2226 << "<!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"
2227 // FIXME Language should be set properly.
2228 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2230 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2231 // FIXME Presumably need to set this right
2232 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2234 docstring const & doctitle = features.htmlTitle();
2236 << (doctitle.empty() ?
2237 from_ascii("LyX Document") :
2238 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2241 docstring styles = features.getTClassHTMLPreamble();
2242 if (!styles.empty())
2243 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2245 styles = features.getPreambleSnippets().str;
2246 if (!styles.empty())
2247 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2249 // we will collect CSS information in a stream, and then output it
2250 // either here, as part of the header, or else in a separate file.
2251 odocstringstream css;
2252 styles = features.getCSSSnippets();
2253 if (!styles.empty())
2254 css << "/* LyX Provided Styles */\n" << styles << '\n';
2256 styles = features.getTClassHTMLStyles();
2257 if (!styles.empty())
2258 css << "/* Layout-provided Styles */\n" << styles << '\n';
2260 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2261 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2262 if (needfg || needbg) {
2263 css << "\nbody {\n";
2266 << from_ascii(X11hexname(params().fontcolor))
2269 css << " background-color: "
2270 << from_ascii(X11hexname(params().backgroundcolor))
2275 docstring const dstyles = css.str();
2276 if (!dstyles.empty()) {
2277 bool written = false;
2278 if (params().html_css_as_file) {
2279 // open a file for CSS info
2281 string const fcssname = addName(temppath(), "docstyle.css");
2282 FileName const fcssfile = FileName(fcssname);
2283 if (openFileWrite(ocss, fcssfile)) {
2287 // write link to header
2288 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2290 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2293 // we are here if the CSS is supposed to be written to the header
2294 // or if we failed to write it to an external file.
2296 os << "<style type='text/css'>\n"
2305 bool const output_body_tag = (output != IncludedFile);
2306 if (output_body_tag)
2307 os << "<body dir=\"auto\">\n";
2309 if (output != IncludedFile)
2310 // if we're an included file, the counters are in the master.
2311 params().documentClass().counters().reset();
2313 xhtmlParagraphs(text(), *this, xs, runparams);
2315 catch (ConversionException const &) { return ExportKilled; }
2316 if (output_body_tag)
2320 if (output_preamble)
2323 return ExportSuccess;
2327 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2328 // Other flags: -wall -v0 -x
2329 int Buffer::runChktex()
2333 // get LaTeX-Filename
2334 FileName const path(temppath());
2335 string const name = addName(path.absFileName(), latexName());
2336 string const org_path = filePath();
2338 PathChanger p(path); // path to LaTeX file
2339 message(_("Running chktex..."));
2341 // Generate the LaTeX file if neccessary
2342 OutputParams runparams(¶ms().encoding());
2343 runparams.flavor = OutputParams::LATEX;
2344 runparams.nice = false;
2345 runparams.linelen = lyxrc.plaintext_linelen;
2346 ExportStatus const retval =
2347 makeLaTeXFile(FileName(name), org_path, runparams);
2348 if (retval != ExportSuccess) {
2349 // error code on failure
2354 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2355 int const res = chktex.run(terr); // run chktex
2358 Alert::error(_("chktex failure"),
2359 _("Could not run chktex successfully."));
2361 ErrorList & errlist = d->errorLists["ChkTeX"];
2363 bufferErrors(terr, errlist);
2368 if (runparams.silent)
2369 d->errorLists["ChkTeX"].clear();
2377 void Buffer::validate(LaTeXFeatures & features) const
2379 // Validate the buffer params, but not for included
2380 // files, since they also use the parent buffer's
2382 if (!features.runparams().is_child)
2383 params().validate(features);
2385 for (Paragraph const & p : paragraphs())
2386 p.validate(features);
2388 if (lyxerr.debugging(Debug::LATEX)) {
2389 features.showStruct();
2394 void Buffer::getLabelList(vector<docstring> & list) const
2396 // If this is a child document, use the master's list instead.
2398 masterBuffer()->getLabelList(list);
2403 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2404 for (auto const & tocit : *toc) {
2405 if (tocit.depth() == 0)
2406 list.push_back(tocit.str());
2411 void Buffer::invalidateBibinfoCache() const
2413 d->bibinfo_cache_valid_ = false;
2414 d->cite_labels_valid_ = false;
2415 removeBiblioTempFiles();
2416 // also invalidate the cache for the parent buffer
2417 Buffer const * const pbuf = d->parent();
2419 pbuf->invalidateBibinfoCache();
2423 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2425 // FIXME This is probably unnecessary, given where we call this.
2426 // If this is a child document, use the master instead.
2427 Buffer const * const pbuf = masterBuffer();
2428 if (pbuf != this && scope != UpdateChildOnly)
2429 return pbuf->getBibfiles();
2431 // In 2.3.x, we have:
2432 //if (!d->bibfile_cache_valid_)
2433 // this->updateBibfilesCache(scope);
2434 // I think that is a leftover, but there have been so many back-
2435 // and-forths with this, due to Windows issues, that I am not sure.
2437 return d->bibfiles_cache_;
2441 BiblioInfo const & Buffer::masterBibInfo() const
2443 Buffer const * const tmp = masterBuffer();
2445 return tmp->masterBibInfo();
2450 BiblioInfo const & Buffer::bibInfo() const
2456 void Buffer::registerBibfiles(const docstring_list & bf) const
2458 // We register the bib files in the master buffer,
2459 // if there is one, but also in every single buffer,
2460 // in case a child is compiled alone.
2461 Buffer const * const tmp = masterBuffer();
2463 tmp->registerBibfiles(bf);
2465 for (auto const & p : bf) {
2466 docstring_list::const_iterator temp =
2467 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2468 if (temp == d->bibfiles_cache_.end())
2469 d->bibfiles_cache_.push_back(p);
2474 static map<docstring, FileName> bibfileCache;
2476 FileName Buffer::getBibfilePath(docstring const & bibid) const
2478 map<docstring, FileName>::const_iterator it =
2479 bibfileCache.find(bibid);
2480 if (it != bibfileCache.end()) {
2481 // i.e., bibfileCache[bibid]
2485 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2486 string texfile = changeExtension(to_utf8(bibid), "bib");
2487 // note that, if the filename can be found directly from the path,
2488 // findtexfile will just return a FileName object for that path.
2489 FileName file(findtexfile(texfile, "bib"));
2491 file = FileName(makeAbsPath(texfile, filePath()));
2492 LYXERR(Debug::FILES, "Found at: " << file);
2494 bibfileCache[bibid] = file;
2495 return bibfileCache[bibid];
2499 void Buffer::checkIfBibInfoCacheIsValid() const
2501 // use the master's cache
2502 Buffer const * const tmp = masterBuffer();
2504 tmp->checkIfBibInfoCacheIsValid();
2508 // If we already know the cache is invalid, stop here.
2509 // This is important in the case when the bibliography
2510 // environment (rather than Bib[la]TeX) is used.
2511 // In that case, the timestamp check below gives no
2512 // sensible result. Rather than that, the cache will
2513 // be invalidated explicitly via invalidateBibInfoCache()
2514 // by the Bibitem inset.
2515 // Same applies for bib encoding changes, which trigger
2516 // invalidateBibInfoCache() by InsetBibtex.
2517 if (!d->bibinfo_cache_valid_)
2520 if (d->have_bibitems_) {
2521 // We have a bibliography environment.
2522 // Invalidate the bibinfo cache unconditionally.
2523 // Cite labels will get invalidated by the inset if needed.
2524 d->bibinfo_cache_valid_ = false;
2528 // OK. This is with Bib(la)tex. We'll assume the cache
2529 // is valid and change this if we find changes in the bibs.
2530 d->bibinfo_cache_valid_ = true;
2531 d->cite_labels_valid_ = true;
2533 // compare the cached timestamps with the actual ones.
2534 docstring_list const & bibfiles_cache = getBibfiles();
2535 for (auto const & bf : bibfiles_cache) {
2536 FileName const fn = getBibfilePath(bf);
2537 time_t lastw = fn.lastModified();
2538 time_t prevw = d->bibfile_status_[fn];
2539 if (lastw != prevw) {
2540 d->bibinfo_cache_valid_ = false;
2541 d->cite_labels_valid_ = false;
2542 d->bibfile_status_[fn] = lastw;
2548 void Buffer::clearBibFileCache() const
2550 bibfileCache.clear();
2554 void Buffer::reloadBibInfoCache(bool const force) const
2556 // we should not need to do this for internal buffers
2560 // use the master's cache
2561 Buffer const * const tmp = masterBuffer();
2563 tmp->reloadBibInfoCache(force);
2568 checkIfBibInfoCacheIsValid();
2569 if (d->bibinfo_cache_valid_)
2573 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2574 // re-read file locations when this info changes
2575 // FIXME Is this sufficient? Or should we also force that
2576 // in some other cases? If so, then it is easy enough to
2577 // add the following line in some other places.
2578 clearBibFileCache();
2579 d->bibinfo_.clear();
2580 FileNameList checkedFiles;
2581 d->have_bibitems_ = false;
2582 collectBibKeys(checkedFiles);
2583 d->bibinfo_cache_valid_ = true;
2587 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2589 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2590 it->collectBibKeys(it, checkedFiles);
2591 if (it->lyxCode() == BIBITEM_CODE) {
2593 parent()->d->have_bibitems_ = true;
2595 d->have_bibitems_ = true;
2601 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2603 // We add the biblio info to the master buffer,
2604 // if there is one, but also to every single buffer,
2605 // in case a child is compiled alone.
2606 BiblioInfo & bi = d->bibinfo_;
2607 bi.mergeBiblioInfo(bin);
2609 if (parent() != 0) {
2610 BiblioInfo & masterbi = parent()->d->bibinfo_;
2611 masterbi.mergeBiblioInfo(bin);
2616 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2618 // We add the bibtex info to the master buffer,
2619 // if there is one, but also to every single buffer,
2620 // in case a child is compiled alone.
2621 BiblioInfo & bi = d->bibinfo_;
2624 if (parent() != 0) {
2625 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2626 masterbi[key] = bin;
2631 void Buffer::makeCitationLabels() const
2633 Buffer const * const master = masterBuffer();
2634 return d->bibinfo_.makeCitationLabels(*master);
2638 void Buffer::invalidateCiteLabels() const
2640 masterBuffer()->d->cite_labels_valid_ = false;
2643 bool Buffer::citeLabelsValid() const
2645 return masterBuffer()->d->cite_labels_valid_;
2649 void Buffer::removeBiblioTempFiles() const
2651 // We remove files that contain LaTeX commands specific to the
2652 // particular bibliographic style being used, in order to avoid
2653 // LaTeX errors when we switch style.
2654 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2655 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2656 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2657 aux_file.removeFile();
2658 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2659 bbl_file.removeFile();
2660 // Also for the parent buffer
2661 Buffer const * const pbuf = parent();
2663 pbuf->removeBiblioTempFiles();
2667 bool Buffer::isDepClean(string const & name) const
2669 DepClean::const_iterator const it = d->dep_clean.find(name);
2670 if (it == d->dep_clean.end())
2676 void Buffer::markDepClean(string const & name)
2678 d->dep_clean[name] = true;
2682 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2685 // FIXME? if there is an Buffer LFUN that can be dispatched even
2686 // if internal, put a switch '(cmd.action)' here.
2692 switch (cmd.action()) {
2694 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2695 flag.setOnOff(hasReadonlyFlag());
2698 // FIXME: There is need for a command-line import.
2699 //case LFUN_BUFFER_IMPORT:
2701 case LFUN_BUFFER_AUTO_SAVE:
2704 case LFUN_BUFFER_EXPORT_CUSTOM:
2705 // FIXME: Nothing to check here?
2708 case LFUN_BUFFER_EXPORT: {
2709 docstring const arg = cmd.argument();
2710 if (arg == "custom") {
2714 string format = (arg.empty() || arg == "default") ?
2715 params().getDefaultOutputFormat() : to_utf8(arg);
2716 size_t pos = format.find(' ');
2717 if (pos != string::npos)
2718 format = format.substr(0, pos);
2719 enable = params().isExportable(format, false);
2721 flag.message(bformat(
2722 _("Don't know how to export to format: %1$s"), arg));
2726 case LFUN_BUILD_PROGRAM:
2727 enable = params().isExportable("program", false);
2730 case LFUN_BRANCH_ACTIVATE:
2731 case LFUN_BRANCH_DEACTIVATE:
2732 case LFUN_BRANCH_MASTER_ACTIVATE:
2733 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2734 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2735 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2736 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2737 : params().branchlist();
2738 docstring const branchName = cmd.argument();
2739 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2743 case LFUN_BRANCH_ADD:
2744 case LFUN_BRANCHES_RENAME:
2745 // if no Buffer is present, then of course we won't be called!
2748 case LFUN_BUFFER_LANGUAGE:
2749 enable = !isReadonly();
2752 case LFUN_BUFFER_VIEW_CACHE:
2753 (d->preview_file_).refresh();
2754 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2757 case LFUN_CHANGES_TRACK:
2758 flag.setEnabled(true);
2759 flag.setOnOff(params().track_changes);
2762 case LFUN_CHANGES_OUTPUT:
2763 flag.setEnabled(true);
2764 flag.setOnOff(params().output_changes);
2767 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2768 flag.setOnOff(params().compressed);
2771 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2772 flag.setOnOff(params().output_sync);
2775 case LFUN_BUFFER_ANONYMIZE:
2781 flag.setEnabled(enable);
2786 void Buffer::dispatch(string const & command, DispatchResult & result)
2788 return dispatch(lyxaction.lookupFunc(command), result);
2792 // NOTE We can end up here even if we have no GUI, because we are called
2793 // by LyX::exec to handled command-line requests. So we may need to check
2794 // whether we have a GUI or not. The boolean use_gui holds this information.
2795 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2798 // FIXME? if there is an Buffer LFUN that can be dispatched even
2799 // if internal, put a switch '(cmd.action())' here.
2800 dr.dispatched(false);
2803 string const argument = to_utf8(func.argument());
2804 // We'll set this back to false if need be.
2805 bool dispatched = true;
2806 // This handles undo groups automagically
2807 UndoGroupHelper ugh(this);
2809 switch (func.action()) {
2810 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2811 if (lyxvc().inUse()) {
2812 string log = lyxvc().toggleReadOnly();
2817 setReadonly(!hasReadonlyFlag());
2820 case LFUN_BUFFER_EXPORT: {
2821 string const format = (argument.empty() || argument == "default") ?
2822 params().getDefaultOutputFormat() : argument;
2823 ExportStatus const status = doExport(format, false);
2824 dr.setError(status != ExportSuccess);
2825 if (status != ExportSuccess)
2826 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2827 from_utf8(format)));
2831 case LFUN_BUILD_PROGRAM: {
2832 ExportStatus const status = doExport("program", true);
2833 dr.setError(status != ExportSuccess);
2834 if (status != ExportSuccess)
2835 dr.setMessage(_("Error generating literate programming code."));
2839 case LFUN_BUFFER_EXPORT_CUSTOM: {
2841 string command = split(argument, format_name, ' ');
2842 Format const * format = theFormats().getFormat(format_name);
2844 lyxerr << "Format \"" << format_name
2845 << "\" not recognized!"
2850 // The name of the file created by the conversion process
2853 // Output to filename
2854 if (format->name() == "lyx") {
2855 string const latexname = latexName(false);
2856 filename = changeExtension(latexname,
2857 format->extension());
2858 filename = addName(temppath(), filename);
2860 if (!writeFile(FileName(filename)))
2864 doExport(format_name, true, filename);
2867 // Substitute $$FName for filename
2868 if (!contains(command, "$$FName"))
2869 command = "( " + command + " ) < $$FName";
2870 command = subst(command, "$$FName", filename);
2872 // Execute the command in the background
2874 call.startscript(Systemcall::DontWait, command,
2875 filePath(), layoutPos());
2879 // FIXME: There is need for a command-line import.
2881 case LFUN_BUFFER_IMPORT:
2886 case LFUN_BUFFER_AUTO_SAVE:
2888 resetAutosaveTimers();
2891 case LFUN_BRANCH_ACTIVATE:
2892 case LFUN_BRANCH_DEACTIVATE:
2893 case LFUN_BRANCH_MASTER_ACTIVATE:
2894 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2895 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2896 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2897 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2900 docstring const branch_name = func.argument();
2901 // the case without a branch name is handled elsewhere
2902 if (branch_name.empty()) {
2906 Branch * branch = buf->params().branchlist().find(branch_name);
2908 LYXERR0("Branch " << branch_name << " does not exist.");
2910 docstring const msg =
2911 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2915 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2916 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2917 if (branch->isSelected() != activate) {
2918 buf->undo().recordUndoBufferParams(CursorData());
2919 branch->setSelected(activate);
2921 dr.screenUpdate(Update::Force);
2922 dr.forceBufferUpdate();
2927 case LFUN_BRANCH_ADD: {
2928 docstring branchnames = func.argument();
2929 if (branchnames.empty()) {
2933 BranchList & branch_list = params().branchlist();
2934 vector<docstring> const branches =
2935 getVectorFromString(branchnames, branch_list.separator());
2937 for (docstring const & branch_name : branches) {
2938 Branch * branch = branch_list.find(branch_name);
2940 LYXERR0("Branch " << branch_name << " already exists.");
2944 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2946 undo().recordUndoBufferParams(CursorData());
2947 branch_list.add(branch_name);
2948 branch = branch_list.find(branch_name);
2949 string const x11hexname = X11hexname(branch->color());
2950 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2951 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2953 dr.screenUpdate(Update::Force);
2961 case LFUN_BRANCHES_RENAME: {
2962 if (func.argument().empty())
2965 docstring const oldname = from_utf8(func.getArg(0));
2966 docstring const newname = from_utf8(func.getArg(1));
2967 InsetIterator it = inset_iterator_begin(inset());
2968 InsetIterator const end = inset_iterator_end(inset());
2969 bool success = false;
2970 for (; it != end; ++it) {
2971 if (it->lyxCode() == BRANCH_CODE) {
2972 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2973 if (ins.branch() == oldname) {
2974 undo().recordUndo(CursorData(it));
2975 ins.rename(newname);
2980 if (it->lyxCode() == INCLUDE_CODE) {
2981 // get buffer of external file
2982 InsetInclude const & ins =
2983 static_cast<InsetInclude const &>(*it);
2984 Buffer * child = ins.getChildBuffer();
2987 child->dispatch(func, dr);
2992 dr.screenUpdate(Update::Force);
2993 dr.forceBufferUpdate();
2998 case LFUN_BUFFER_VIEW_CACHE:
2999 if (!theFormats().view(*this, d->preview_file_,
3000 d->preview_format_))
3001 dr.setMessage(_("Error viewing the output file."));
3004 case LFUN_CHANGES_TRACK:
3005 if (params().save_transient_properties)
3006 undo().recordUndoBufferParams(CursorData());
3007 params().track_changes = !params().track_changes;
3008 if (!params().track_changes)
3009 dr.forceChangesUpdate();
3012 case LFUN_CHANGES_OUTPUT:
3013 if (params().save_transient_properties)
3014 undo().recordUndoBufferParams(CursorData());
3015 params().output_changes = !params().output_changes;
3016 if (params().output_changes) {
3017 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3018 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3019 LaTeXFeatures::isAvailable("xcolor");
3021 if (!dvipost && !xcolorulem) {
3022 Alert::warning(_("Changes not shown in LaTeX output"),
3023 _("Changes will not be highlighted in LaTeX output, "
3024 "because neither dvipost nor xcolor/ulem are installed.\n"
3025 "Please install these packages or redefine "
3026 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3027 } else if (!xcolorulem) {
3028 Alert::warning(_("Changes not shown in LaTeX output"),
3029 _("Changes will not be highlighted in LaTeX output "
3030 "when using pdflatex, because xcolor and ulem are not installed.\n"
3031 "Please install both packages or redefine "
3032 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3037 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3038 // turn compression on/off
3039 undo().recordUndoBufferParams(CursorData());
3040 params().compressed = !params().compressed;
3043 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3044 undo().recordUndoBufferParams(CursorData());
3045 params().output_sync = !params().output_sync;
3048 case LFUN_BUFFER_ANONYMIZE: {
3049 undo().recordUndoFullBuffer(CursorData());
3050 CursorData cur(doc_iterator_begin(this));
3051 for ( ; cur ; cur.forwardPar())
3052 cur.paragraph().anonymize();
3053 dr.forceBufferUpdate();
3054 dr.screenUpdate(Update::Force);
3062 dr.dispatched(dispatched);
3066 void Buffer::changeLanguage(Language const * from, Language const * to)
3068 LASSERT(from, return);
3069 LASSERT(to, return);
3071 for_each(par_iterator_begin(),
3073 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3077 bool Buffer::isMultiLingual() const
3079 ParConstIterator end = par_iterator_end();
3080 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3081 if (it->isMultiLingual(params()))
3088 std::set<Language const *> Buffer::getLanguages() const
3090 std::set<Language const *> langs;
3091 getLanguages(langs);
3096 void Buffer::getLanguages(std::set<Language const *> & langs) const
3098 ParConstIterator end = par_iterator_end();
3099 // add the buffer language, even if it's not actively used
3100 langs.insert(language());
3101 // iterate over the paragraphs
3102 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3103 it->getLanguages(langs);
3105 ListOfBuffers clist = getDescendents();
3106 for (auto const & cit : clist)
3107 cit->getLanguages(langs);
3111 DocIterator Buffer::getParFromID(int const id) const
3113 Buffer * buf = const_cast<Buffer *>(this);
3115 // This means non-existent
3116 return doc_iterator_end(buf);
3118 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3119 if (it.paragraph().id() == id)
3122 return doc_iterator_end(buf);
3126 bool Buffer::hasParWithID(int const id) const
3128 return !getParFromID(id).atEnd();
3132 ParIterator Buffer::par_iterator_begin()
3134 return ParIterator(doc_iterator_begin(this));
3138 ParIterator Buffer::par_iterator_end()
3140 return ParIterator(doc_iterator_end(this));
3144 ParConstIterator Buffer::par_iterator_begin() const
3146 return ParConstIterator(doc_iterator_begin(this));
3150 ParConstIterator Buffer::par_iterator_end() const
3152 return ParConstIterator(doc_iterator_end(this));
3156 Language const * Buffer::language() const
3158 return params().language;
3162 docstring const Buffer::B_(string const & l10n) const
3164 return params().B_(l10n);
3168 bool Buffer::isClean() const
3170 return d->lyx_clean;
3174 bool Buffer::isChecksumModified() const
3176 LASSERT(d->filename.exists(), return false);
3177 return d->checksum_ != d->filename.checksum();
3181 void Buffer::saveCheckSum() const
3183 FileName const & file = d->filename;
3185 d->checksum_ = file.exists() ? file.checksum()
3186 : 0; // in the case of save to a new file.
3190 void Buffer::markClean() const
3192 if (!d->lyx_clean) {
3193 d->lyx_clean = true;
3196 // if the .lyx file has been saved, we don't need an
3198 d->bak_clean = true;
3199 d->undo_.markDirty();
3200 clearExternalModification();
3204 void Buffer::setUnnamed(bool flag)
3210 bool Buffer::isUnnamed() const
3217 /// Don't check unnamed, here: isInternal() is used in
3218 /// newBuffer(), where the unnamed flag has not been set by anyone
3219 /// yet. Also, for an internal buffer, there should be no need for
3220 /// retrieving fileName() nor for checking if it is unnamed or not.
3221 bool Buffer::isInternal() const
3223 return d->internal_buffer;
3227 void Buffer::setInternal(bool flag)
3229 d->internal_buffer = flag;
3233 void Buffer::markDirty()
3236 d->lyx_clean = false;
3239 d->bak_clean = false;
3241 for (auto & depit : d->dep_clean)
3242 depit.second = false;
3246 FileName Buffer::fileName() const
3252 string Buffer::absFileName() const
3254 return d->filename.absFileName();
3258 string Buffer::filePath() const
3260 string const abs = d->filename.onlyPath().absFileName();
3263 int last = abs.length() - 1;
3265 return abs[last] == '/' ? abs : abs + '/';
3269 DocFileName Buffer::getReferencedFileName(string const & fn) const
3272 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3273 result.set(fn, filePath());
3275 // filePath() ends with a path separator
3276 FileName const test(filePath() + fn);
3278 result.set(fn, filePath());
3280 result.set(fn, params().origin);
3287 string const Buffer::prepareFileNameForLaTeX(string const & name,
3288 string const & ext, bool nice) const
3290 string const fname = makeAbsPath(name, filePath()).absFileName();
3291 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3297 return to_utf8(makeRelPath(from_utf8(fname),
3298 from_utf8(masterBuffer()->filePath())));
3302 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3303 docstring_list const & bibfilelist,
3304 bool const add_extension) const
3306 // If we are processing the LaTeX file in a temp directory then
3307 // copy the .bib databases to this temp directory, mangling their
3308 // names in the process. Store this mangled name in the list of
3310 // (We need to do all this because BibTeX *really*, *really*
3311 // can't handle "files with spaces" and Windows users tend to
3312 // use such filenames.)
3313 // Otherwise, store the (maybe absolute) path to the original,
3314 // unmangled database name.
3316 vector<docstring> res;
3318 // determine the export format
3319 string const tex_format = flavor2format(runparams.flavor);
3321 // check for spaces in paths
3322 bool found_space = false;
3324 for (auto const & bit : bibfilelist) {
3325 string utf8input = to_utf8(bit);
3327 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3328 FileName try_in_file =
3329 makeAbsPath(database + ".bib", filePath());
3330 bool not_from_texmf = try_in_file.isReadableFile();
3331 // If the file has not been found, try with the real file name
3332 // (it might come from a child in a sub-directory)
3333 if (!not_from_texmf) {
3334 try_in_file = getBibfilePath(bit);
3335 if (try_in_file.isReadableFile()) {
3336 // Check if the file is in texmf
3337 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3338 not_from_texmf = kpsefile.empty()
3339 || kpsefile.absFileName() != try_in_file.absFileName();
3341 // If this exists, make path relative to the master
3344 removeExtension(prepareFileNameForLaTeX(
3345 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3346 from_utf8(filePath()))),
3347 ".bib", runparams.nice));
3351 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3353 // mangledFileName() needs the extension
3354 DocFileName const in_file = DocFileName(try_in_file);
3355 database = removeExtension(in_file.mangledFileName());
3356 FileName const out_file = makeAbsPath(database + ".bib",
3357 masterBuffer()->temppath());
3358 bool const success = in_file.copyTo(out_file);
3360 LYXERR0("Failed to copy '" << in_file
3361 << "' to '" << out_file << "'");
3363 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3364 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3365 if (!isValidLaTeXFileName(database)) {
3366 frontend::Alert::warning(_("Invalid filename"),
3367 _("The following filename will cause troubles "
3368 "when running the exported file through LaTeX: ") +
3369 from_utf8(database));
3371 if (!isValidDVIFileName(database)) {
3372 frontend::Alert::warning(_("Problematic filename for DVI"),
3373 _("The following filename can cause troubles "
3374 "when running the exported file through LaTeX "
3375 "and opening the resulting DVI: ") +
3376 from_utf8(database), true);
3384 docstring const path = from_utf8(latex_path(database));
3386 if (contains(path, ' '))
3389 if (find(res.begin(), res.end(), path) == res.end())
3390 res.push_back(path);
3393 // Check if there are spaces in the path and warn BibTeX users, if so.
3394 // (biber can cope with such paths)
3395 if (!prefixIs(runparams.bibtex_command, "biber")) {
3396 // Post this warning only once.
3397 static bool warned_about_spaces = false;
3398 if (!warned_about_spaces &&
3399 runparams.nice && found_space) {
3400 warned_about_spaces = true;
3401 Alert::warning(_("Export Warning!"),
3402 _("There are spaces in the paths to your BibTeX databases.\n"
3403 "BibTeX will be unable to find them."));
3412 string Buffer::layoutPos() const
3414 return d->layout_position;
3418 void Buffer::setLayoutPos(string const & path)
3421 d->layout_position.clear();
3425 LATTEST(FileName::isAbsolute(path));
3427 d->layout_position =
3428 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3430 if (d->layout_position.empty())
3431 d->layout_position = ".";
3435 bool Buffer::hasReadonlyFlag() const
3437 return d->read_only;
3441 bool Buffer::isReadonly() const
3443 return hasReadonlyFlag() || notifiesExternalModification();
3447 void Buffer::setParent(Buffer const * buffer)
3449 // Avoids recursive include.
3450 d->setParent(buffer == this ? 0 : buffer);
3455 Buffer const * Buffer::parent() const
3461 ListOfBuffers Buffer::allRelatives() const
3463 ListOfBuffers lb = masterBuffer()->getDescendents();
3464 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3469 Buffer const * Buffer::masterBuffer() const
3471 // FIXME Should be make sure we are not in some kind
3472 // of recursive include? A -> B -> A will crash this.
3473 Buffer const * const pbuf = d->parent();
3477 return pbuf->masterBuffer();
3481 bool Buffer::isChild(Buffer * child) const
3483 return d->children_positions.find(child) != d->children_positions.end();
3487 DocIterator Buffer::firstChildPosition(Buffer const * child)
3489 Impl::BufferPositionMap::iterator it;
3490 it = d->children_positions.find(child);
3491 if (it == d->children_positions.end())
3492 return DocIterator(this);
3497 bool Buffer::hasChildren() const
3499 return !d->children_positions.empty();
3503 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3505 // loop over children
3506 for (auto const & p : d->children_positions) {
3507 Buffer * child = const_cast<Buffer *>(p.first);
3509 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3510 if (bit != clist.end())
3512 clist.push_back(child);
3514 // there might be grandchildren
3515 child->collectChildren(clist, true);
3520 ListOfBuffers Buffer::getChildren() const
3523 collectChildren(v, false);
3524 // Make sure we have not included ourselves.
3525 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3526 if (bit != v.end()) {
3527 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3534 ListOfBuffers Buffer::getDescendents() const
3537 collectChildren(v, true);
3538 // Make sure we have not included ourselves.
3539 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3540 if (bit != v.end()) {
3541 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3548 template<typename M>
3549 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3554 typename M::const_iterator it = m.lower_bound(x);
3555 if (it == m.begin())
3563 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3564 DocIterator const & pos) const
3566 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3568 // if paragraphs have no macro context set, pos will be empty
3572 // we haven't found anything yet
3573 DocIterator bestPos = owner_->par_iterator_begin();
3574 MacroData const * bestData = 0;
3576 // find macro definitions for name
3577 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3578 if (nameIt != macros.end()) {
3579 // find last definition in front of pos or at pos itself
3580 PositionScopeMacroMap::const_iterator it
3581 = greatest_below(nameIt->second, pos);
3582 if (it != nameIt->second.end()) {
3584 // scope ends behind pos?
3585 if (pos < it->second.scope) {
3586 // Looks good, remember this. If there
3587 // is no external macro behind this,
3588 // we found the right one already.
3589 bestPos = it->first;
3590 bestData = &it->second.macro;
3594 // try previous macro if there is one
3595 if (it == nameIt->second.begin())
3602 // find macros in included files
3603 PositionScopeBufferMap::const_iterator it
3604 = greatest_below(position_to_children, pos);
3605 if (it == position_to_children.end())
3606 // no children before
3610 // do we know something better (i.e. later) already?
3611 if (it->first < bestPos )
3614 // scope ends behind pos?
3615 if (pos < it->second.scope
3616 && (cloned_buffer_ ||
3617 theBufferList().isLoaded(it->second.buffer))) {
3618 // look for macro in external file
3620 MacroData const * data
3621 = it->second.buffer->getMacro(name, false);
3624 bestPos = it->first;
3630 // try previous file if there is one
3631 if (it == position_to_children.begin())
3636 // return the best macro we have found
3641 MacroData const * Buffer::getMacro(docstring const & name,
3642 DocIterator const & pos, bool global) const
3647 // query buffer macros
3648 MacroData const * data = d->getBufferMacro(name, pos);
3652 // If there is a master buffer, query that
3653 Buffer const * const pbuf = d->parent();
3655 d->macro_lock = true;
3656 MacroData const * macro = pbuf->getMacro(
3657 name, *this, false);
3658 d->macro_lock = false;
3664 data = MacroTable::globalMacros().get(name);
3673 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3675 // set scope end behind the last paragraph
3676 DocIterator scope = par_iterator_begin();
3677 scope.pit() = scope.lastpit() + 1;
3679 return getMacro(name, scope, global);
3683 MacroData const * Buffer::getMacro(docstring const & name,
3684 Buffer const & child, bool global) const
3686 // look where the child buffer is included first
3687 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3688 if (it == d->children_positions.end())
3691 // check for macros at the inclusion position
3692 return getMacro(name, it->second, global);
3696 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3698 pit_type const lastpit = it.lastpit();
3700 // look for macros in each paragraph
3701 while (it.pit() <= lastpit) {
3702 Paragraph & par = it.paragraph();
3704 // FIXME Can this be done with the new-style iterators?
3705 // iterate over the insets of the current paragraph
3706 for (auto const & insit : par.insetList()) {
3707 it.pos() = insit.pos;
3709 // is it a nested text inset?
3710 if (insit.inset->asInsetText()) {
3711 // Inset needs its own scope?
3712 InsetText const * itext = insit.inset->asInsetText();
3713 bool newScope = itext->isMacroScope();
3715 // scope which ends just behind the inset
3716 DocIterator insetScope = it;
3719 // collect macros in inset
3720 it.push_back(CursorSlice(*insit.inset));
3721 updateMacros(it, newScope ? insetScope : scope);
3726 if (insit.inset->asInsetTabular()) {
3727 CursorSlice slice(*insit.inset);
3728 size_t const numcells = slice.nargs();
3729 for (; slice.idx() < numcells; slice.forwardIdx()) {
3730 it.push_back(slice);
3731 updateMacros(it, scope);
3737 // is it an external file?
3738 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3739 // get buffer of external file
3740 InsetInclude const & incinset =
3741 static_cast<InsetInclude const &>(*insit.inset);
3743 Buffer * child = incinset.getChildBuffer();
3748 // register its position, but only when it is
3749 // included first in the buffer
3750 if (children_positions.find(child) ==
3751 children_positions.end())
3752 children_positions[child] = it;
3754 // register child with its scope
3755 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3759 InsetMath * im = insit.inset->asInsetMath();
3760 if (doing_export && im) {
3761 InsetMathHull * hull = im->asHullInset();
3763 hull->recordLocation(it);
3766 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3770 InsetMathMacroTemplate & macroTemplate =
3771 *insit.inset->asInsetMath()->asMacroTemplate();
3772 MacroContext mc(owner_, it);
3773 macroTemplate.updateToContext(mc);
3776 bool valid = macroTemplate.validMacro();
3777 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3778 // then the BufferView's cursor will be invalid in
3779 // some cases which leads to crashes.
3784 // FIXME (Abdel), I don't understand why we pass 'it' here
3785 // instead of 'macroTemplate' defined above... is this correct?
3786 macros[macroTemplate.name()][it] =
3787 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3797 void Buffer::updateMacros() const
3802 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3804 // start with empty table
3806 d->children_positions.clear();
3807 d->position_to_children.clear();
3809 // Iterate over buffer, starting with first paragraph
3810 // The scope must be bigger than any lookup DocIterator
3811 // later. For the global lookup, lastpit+1 is used, hence
3812 // we use lastpit+2 here.
3813 DocIterator it = par_iterator_begin();
3814 DocIterator outerScope = it;
3815 outerScope.pit() = outerScope.lastpit() + 2;
3816 d->updateMacros(it, outerScope);
3820 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3822 InsetIterator it = inset_iterator_begin(inset());
3823 InsetIterator const end = inset_iterator_end(inset());
3824 for (; it != end; ++it) {
3825 if (it->lyxCode() == BRANCH_CODE) {
3826 InsetBranch & br = static_cast<InsetBranch &>(*it);
3827 docstring const name = br.branch();
3828 if (!from_master && !params().branchlist().find(name))
3829 result.push_back(name);
3830 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3831 result.push_back(name);
3834 if (it->lyxCode() == INCLUDE_CODE) {
3835 // get buffer of external file
3836 InsetInclude const & ins =
3837 static_cast<InsetInclude const &>(*it);
3838 Buffer * child = ins.getChildBuffer();
3841 child->getUsedBranches(result, true);
3844 // remove duplicates
3849 void Buffer::updateMacroInstances(UpdateType utype) const
3851 LYXERR(Debug::MACROS, "updateMacroInstances for "
3852 << d->filename.onlyFileName());
3853 DocIterator it = doc_iterator_begin(this);
3855 DocIterator const end = doc_iterator_end(this);
3856 for (; it != end; it.forwardInset()) {
3857 // look for MathData cells in InsetMathNest insets
3858 InsetMath * minset = it.nextInset()->asInsetMath();
3862 // update macro in all cells of the InsetMathNest
3863 DocIterator::idx_type n = minset->nargs();
3864 MacroContext mc = MacroContext(this, it);
3865 for (DocIterator::idx_type i = 0; i < n; ++i) {
3866 MathData & data = minset->cell(i);
3867 data.updateMacros(0, mc, utype, 0);
3873 void Buffer::listMacroNames(MacroNameSet & macros) const
3878 d->macro_lock = true;
3880 // loop over macro names
3881 for (auto const & nameit : d->macros)
3882 macros.insert(nameit.first);
3884 // loop over children
3885 for (auto const & p : d->children_positions) {
3886 Buffer * child = const_cast<Buffer *>(p.first);
3887 // The buffer might have been closed (see #10766).
3888 if (theBufferList().isLoaded(child))
3889 child->listMacroNames(macros);
3893 Buffer const * const pbuf = d->parent();
3895 pbuf->listMacroNames(macros);
3897 d->macro_lock = false;
3901 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3903 Buffer const * const pbuf = d->parent();
3908 pbuf->listMacroNames(names);
3911 for (auto const & mit : names) {
3913 MacroData const * data = pbuf->getMacro(mit, *this, false);
3915 macros.insert(data);
3917 // we cannot access the original InsetMathMacroTemplate anymore
3918 // here to calls validate method. So we do its work here manually.
3919 // FIXME: somehow make the template accessible here.
3920 if (data->optionals() > 0)
3921 features.require("xargs");
3927 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3930 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3932 RefCache::iterator it = d->ref_cache_.find(label);
3933 if (it != d->ref_cache_.end())
3936 static References const dummy_refs = References();
3937 it = d->ref_cache_.insert(
3938 make_pair(label, dummy_refs)).first;
3943 Buffer::References const & Buffer::references(docstring const & label) const
3945 return const_cast<Buffer *>(this)->getReferenceCache(label);
3949 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3951 References & refs = getReferenceCache(label);
3952 refs.push_back(make_pair(inset, it));
3956 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3960 linfo.label = label;
3962 linfo.active = active;
3963 masterBuffer()->d->label_cache_.push_back(linfo);
3967 InsetLabel const * Buffer::insetLabel(docstring const & label,
3968 bool const active) const
3970 for (auto & rc : masterBuffer()->d->label_cache_) {
3971 if (rc.label == label && (rc.active || !active))
3978 bool Buffer::activeLabel(docstring const & label) const
3980 if (!insetLabel(label, true))
3987 void Buffer::clearReferenceCache() const
3990 d->ref_cache_.clear();
3991 d->label_cache_.clear();
3996 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3998 //FIXME: This does not work for child documents yet.
3999 reloadBibInfoCache();
4001 // Check if the label 'from' appears more than once
4002 vector<docstring> labels;
4003 for (auto const & bibit : masterBibInfo())
4004 labels.push_back(bibit.first);
4006 if (count(labels.begin(), labels.end(), from) > 1)
4009 string const paramName = "key";
4010 InsetIterator it = inset_iterator_begin(inset());
4012 if (it->lyxCode() != CITE_CODE)
4014 InsetCommand * inset = it->asInsetCommand();
4015 docstring const oldValue = inset->getParam(paramName);
4016 if (oldValue == from)
4017 inset->setParam(paramName, to);
4021 // returns NULL if id-to-row conversion is unsupported
4022 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4023 pit_type par_begin, pit_type par_end,
4024 OutputWhat output, bool master) const
4026 unique_ptr<TexRow> texrow;
4027 OutputParams runparams(¶ms().encoding());
4028 runparams.nice = true;
4029 runparams.flavor = params().getOutputFlavor(format);
4030 runparams.linelen = lyxrc.plaintext_linelen;
4031 // No side effect of file copying and image conversion
4032 runparams.dryrun = true;
4034 // Some macros rely on font encoding
4035 runparams.main_fontenc = params().main_font_encoding();
4037 if (output == CurrentParagraph) {
4038 runparams.par_begin = par_begin;
4039 runparams.par_end = par_end;
4040 if (par_begin + 1 == par_end) {
4042 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4046 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4047 convert<docstring>(par_begin),
4048 convert<docstring>(par_end - 1))
4051 // output paragraphs
4052 if (runparams.flavor == OutputParams::LYX) {
4053 Paragraph const & par = text().paragraphs()[par_begin];
4055 depth_type dt = par.getDepth();
4056 par.write(ods, params(), dt);
4057 os << from_utf8(ods.str());
4058 } else if (runparams.flavor == OutputParams::HTML) {
4060 setMathFlavor(runparams);
4061 xhtmlParagraphs(text(), *this, xs, runparams);
4062 } else if (runparams.flavor == OutputParams::TEXT) {
4064 // FIXME Handles only one paragraph, unlike the others.
4065 // Probably should have some routine with a signature like them.
4066 writePlaintextParagraph(*this,
4067 text().paragraphs()[par_begin], os, runparams, dummy);
4068 } else if (params().isDocBook()) {
4069 docbookParagraphs(text(), *this, os, runparams);
4071 // If we are previewing a paragraph, even if this is the
4072 // child of some other buffer, let's cut the link here,
4073 // so that no concurring settings from the master
4074 // (e.g. branch state) interfere (see #8101).
4076 d->ignore_parent = true;
4077 // We need to validate the Buffer params' features here
4078 // in order to know if we should output polyglossia
4079 // macros (instead of babel macros)
4080 LaTeXFeatures features(*this, params(), runparams);
4082 runparams.use_polyglossia = features.usePolyglossia();
4083 // latex or literate
4086 ots.texrow().newlines(2);
4088 latexParagraphs(*this, text(), ots, runparams);
4089 texrow = ots.releaseTexRow();
4091 // Restore the parenthood
4093 d->ignore_parent = false;
4097 if (output == FullSource)
4098 os << _("Preview source code");
4099 else if (output == OnlyPreamble)
4100 os << _("Preview preamble");
4101 else if (output == OnlyBody)
4102 os << _("Preview body");
4104 if (runparams.flavor == OutputParams::LYX) {
4106 if (output == FullSource)
4108 else if (output == OnlyPreamble)
4109 params().writeFile(ods, this);
4110 else if (output == OnlyBody)
4112 os << from_utf8(ods.str());
4113 } else if (runparams.flavor == OutputParams::HTML) {
4114 writeLyXHTMLSource(os, runparams, output);
4115 } else if (runparams.flavor == OutputParams::TEXT) {
4116 if (output == OnlyPreamble) {
4117 os << "% "<< _("Plain text does not have a preamble.");
4119 writePlaintextFile(*this, os, runparams);
4120 } else if (params().isDocBook()) {
4121 writeDocBookSource(os, absFileName(), runparams, output);
4123 // latex or literate
4126 ots.texrow().newlines(2);
4128 runparams.is_child = true;
4130 writeLaTeXSource(ots, string(), runparams, output);
4131 texrow = ots.releaseTexRow();
4138 ErrorList & Buffer::errorList(string const & type) const
4140 return d->errorLists[type];
4144 void Buffer::updateTocItem(std::string const & type,
4145 DocIterator const & dit) const
4148 d->gui_->updateTocItem(type, dit);
4152 void Buffer::structureChanged() const
4155 d->gui_->structureChanged();
4159 void Buffer::errors(string const & err, bool from_master) const
4162 d->gui_->errors(err, from_master);
4166 void Buffer::message(docstring const & msg) const
4169 d->gui_->message(msg);
4173 void Buffer::setBusy(bool on) const
4176 d->gui_->setBusy(on);
4180 void Buffer::updateTitles() const
4183 d->wa_->updateTitles();
4187 void Buffer::resetAutosaveTimers() const
4190 d->gui_->resetAutosaveTimers();
4194 bool Buffer::hasGuiDelegate() const
4200 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4209 class AutoSaveBuffer : public ForkedProcess {
4212 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4213 : buffer_(buffer), fname_(fname) {}
4215 virtual shared_ptr<ForkedProcess> clone() const
4217 return make_shared<AutoSaveBuffer>(*this);
4222 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4223 from_utf8(fname_.absFileName())));
4224 return run(DontWait);
4228 virtual int generateChild();
4230 Buffer const & buffer_;
4235 int AutoSaveBuffer::generateChild()
4237 #if defined(__APPLE__)
4238 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4239 * We should use something else like threads.
4241 * Since I do not know how to determine at run time what is the OS X
4242 * version, I just disable forking altogether for now (JMarc)
4244 pid_t const pid = -1;
4246 // tmp_ret will be located (usually) in /tmp
4247 // will that be a problem?
4248 // Note that this calls ForkedCalls::fork(), so it's
4249 // ok cross-platform.
4250 pid_t const pid = fork();
4251 // If you want to debug the autosave
4252 // you should set pid to -1, and comment out the fork.
4253 if (pid != 0 && pid != -1)
4257 // pid = -1 signifies that lyx was unable
4258 // to fork. But we will do the save
4260 bool failed = false;
4261 TempFile tempfile("lyxautoXXXXXX.lyx");
4262 tempfile.setAutoRemove(false);
4263 FileName const tmp_ret = tempfile.name();
4264 if (!tmp_ret.empty()) {
4265 if (!buffer_.writeFile(tmp_ret))
4267 else if (!tmp_ret.moveTo(fname_))
4273 // failed to write/rename tmp_ret so try writing direct
4274 if (!buffer_.writeFile(fname_)) {
4275 // It is dangerous to do this in the child,
4276 // but safe in the parent, so...
4277 if (pid == -1) // emit message signal.
4278 buffer_.message(_("Autosave failed!"));
4282 if (pid == 0) // we are the child so...
4291 FileName Buffer::getEmergencyFileName() const
4293 return FileName(d->filename.absFileName() + ".emergency");
4297 FileName Buffer::getAutosaveFileName() const
4299 // if the document is unnamed try to save in the backup dir, else
4300 // in the default document path, and as a last try in the filePath,
4301 // which will most often be the temporary directory
4304 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4305 : lyxrc.backupdir_path;
4306 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4309 string const fname = "#" + d->filename.onlyFileName() + "#";
4311 return makeAbsPath(fname, fpath);
4315 void Buffer::removeAutosaveFile() const
4317 FileName const f = getAutosaveFileName();
4323 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4325 FileName const newauto = getAutosaveFileName();
4327 if (newauto != oldauto && oldauto.exists())
4328 if (!oldauto.moveTo(newauto))
4329 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4333 bool Buffer::autoSave() const
4335 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4336 if (buf->d->bak_clean || hasReadonlyFlag())
4339 message(_("Autosaving current document..."));
4340 buf->d->bak_clean = true;
4342 FileName const fname = getAutosaveFileName();
4343 LASSERT(d->cloned_buffer_, return false);
4345 // If this buffer is cloned, we assume that
4346 // we are running in a separate thread already.
4347 TempFile tempfile("lyxautoXXXXXX.lyx");
4348 tempfile.setAutoRemove(false);
4349 FileName const tmp_ret = tempfile.name();
4350 if (!tmp_ret.empty()) {
4352 // assume successful write of tmp_ret
4353 if (tmp_ret.moveTo(fname))
4356 // failed to write/rename tmp_ret so try writing direct
4357 return writeFile(fname);
4361 void Buffer::setExportStatus(bool e) const
4363 d->doing_export = e;
4364 ListOfBuffers clist = getDescendents();
4365 for (auto const & bit : clist)
4366 bit->d->doing_export = e;
4370 bool Buffer::isExporting() const
4372 return d->doing_export;
4376 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4380 return doExport(target, put_in_tempdir, result_file);
4383 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4384 string & result_file) const
4386 bool const update_unincluded =
4387 params().maintain_unincluded_children
4388 && !params().getIncludedChildren().empty();
4390 // (1) export with all included children (omit \includeonly)
4391 if (update_unincluded) {
4392 ExportStatus const status =
4393 doExport(target, put_in_tempdir, true, result_file);
4394 if (status != ExportSuccess)
4397 // (2) export with included children only
4398 return doExport(target, put_in_tempdir, false, result_file);
4402 void Buffer::setMathFlavor(OutputParams & op) const
4404 switch (params().html_math_output) {
4405 case BufferParams::MathML:
4406 op.math_flavor = OutputParams::MathAsMathML;
4408 case BufferParams::HTML:
4409 op.math_flavor = OutputParams::MathAsHTML;
4411 case BufferParams::Images:
4412 op.math_flavor = OutputParams::MathAsImages;
4414 case BufferParams::LaTeX:
4415 op.math_flavor = OutputParams::MathAsLaTeX;
4421 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4422 bool includeall, string & result_file) const
4424 LYXERR(Debug::FILES, "target=" << target);
4425 OutputParams runparams(¶ms().encoding());
4426 string format = target;
4427 string dest_filename;
4428 size_t pos = target.find(' ');
4429 if (pos != string::npos) {
4430 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4431 format = target.substr(0, pos);
4432 if (format == "default")
4433 format = params().getDefaultOutputFormat();
4434 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4435 FileName(dest_filename).onlyPath().createPath();
4436 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4438 MarkAsExporting exporting(this);
4439 string backend_format;
4440 runparams.flavor = OutputParams::LATEX;
4441 runparams.linelen = lyxrc.plaintext_linelen;
4442 runparams.includeall = includeall;
4443 vector<string> backs = params().backends();
4444 Converters converters = theConverters();
4445 bool need_nice_file = false;
4446 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4447 // Get shortest path to format
4448 converters.buildGraph();
4449 Graph::EdgePath path;
4450 for (string const & sit : backs) {
4451 Graph::EdgePath p = converters.getPath(sit, format);
4452 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4453 backend_format = sit;
4458 if (!put_in_tempdir) {
4459 // Only show this alert if this is an export to a non-temporary
4460 // file (not for previewing).
4461 Alert::error(_("Couldn't export file"), bformat(
4462 _("No information for exporting the format %1$s."),
4463 theFormats().prettyName(format)));
4465 return ExportNoPathToFormat;
4467 runparams.flavor = converters.getFlavor(path, this);
4468 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4469 for (auto const & edge : path)
4470 if (theConverters().get(edge).nice()) {
4471 need_nice_file = true;
4476 backend_format = format;
4477 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4478 // FIXME: Don't hardcode format names here, but use a flag
4479 if (backend_format == "pdflatex")
4480 runparams.flavor = OutputParams::PDFLATEX;
4481 else if (backend_format == "luatex")
4482 runparams.flavor = OutputParams::LUATEX;
4483 else if (backend_format == "dviluatex")
4484 runparams.flavor = OutputParams::DVILUATEX;
4485 else if (backend_format == "xetex")
4486 runparams.flavor = OutputParams::XETEX;
4489 string filename = latexName(false);
4490 filename = addName(temppath(), filename);
4491 filename = changeExtension(filename,
4492 theFormats().extension(backend_format));
4493 LYXERR(Debug::FILES, "filename=" << filename);
4495 // Plain text backend
4496 if (backend_format == "text") {
4497 runparams.flavor = OutputParams::TEXT;
4499 writePlaintextFile(*this, FileName(filename), runparams);
4501 catch (ConversionException const &) { return ExportCancel; }
4504 else if (backend_format == "xhtml") {
4505 runparams.flavor = OutputParams::HTML;
4506 setMathFlavor(runparams);
4507 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4508 return ExportKilled;
4509 } else if (backend_format == "lyx")
4510 writeFile(FileName(filename));
4512 else if (params().isDocBook()) {
4513 runparams.nice = !put_in_tempdir;
4514 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4515 return ExportKilled;
4518 else if (backend_format == format || need_nice_file) {
4519 runparams.nice = true;
4520 ExportStatus const retval =
4521 makeLaTeXFile(FileName(filename), string(), runparams);
4522 if (retval == ExportKilled)
4523 return ExportKilled;
4524 if (d->cloned_buffer_)
4525 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4526 if (retval != ExportSuccess)
4528 } else if (!lyxrc.tex_allows_spaces
4529 && contains(filePath(), ' ')) {
4530 Alert::error(_("File name error"),
4531 bformat(_("The directory path to the document\n%1$s\n"
4532 "contains spaces, but your TeX installation does "
4533 "not allow them. You should save the file to a directory "
4534 "whose name does not contain spaces."), from_utf8(filePath())));
4535 return ExportTexPathHasSpaces;
4537 runparams.nice = false;
4538 ExportStatus const retval =
4539 makeLaTeXFile(FileName(filename), filePath(), runparams);
4540 if (retval == ExportKilled)
4541 return ExportKilled;
4542 if (d->cloned_buffer_)
4543 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4544 if (retval != ExportSuccess)
4548 string const error_type = (format == "program")
4549 ? "Build" : params().bufferFormat();
4550 ErrorList & error_list = d->errorLists[error_type];
4551 string const ext = theFormats().extension(format);
4552 FileName const tmp_result_file(changeExtension(filename, ext));
4553 Converters::RetVal const retval =
4554 converters.convert(this, FileName(filename), tmp_result_file,
4555 FileName(absFileName()), backend_format, format, error_list);
4556 if (retval == Converters::KILLED)
4557 return ExportCancel;
4558 bool success = (retval == Converters::SUCCESS);
4560 // Emit the signal to show the error list or copy it back to the
4561 // cloned Buffer so that it can be emitted afterwards.
4562 if (format != backend_format) {
4563 if (runparams.silent)
4565 else if (d->cloned_buffer_)
4566 d->cloned_buffer_->d->errorLists[error_type] =
4567 d->errorLists[error_type];
4570 // also to the children, in case of master-buffer-view
4571 ListOfBuffers clist = getDescendents();
4572 for (auto const & bit : clist) {
4573 if (runparams.silent)
4574 bit->d->errorLists[error_type].clear();
4575 else if (d->cloned_buffer_) {
4576 // Enable reverse search by copying back the
4577 // texrow object to the cloned buffer.
4578 // FIXME: this is not thread safe.
4579 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4580 bit->d->cloned_buffer_->d->errorLists[error_type] =
4581 bit->d->errorLists[error_type];
4583 bit->errors(error_type, true);
4587 if (d->cloned_buffer_) {
4588 // Enable reverse dvi or pdf to work by copying back the texrow
4589 // object to the cloned buffer.
4590 // FIXME: There is a possibility of concurrent access to texrow
4591 // here from the main GUI thread that should be securized.
4592 d->cloned_buffer_->d->texrow = d->texrow;
4593 string const err_type = params().bufferFormat();
4594 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4598 if (put_in_tempdir) {
4599 result_file = tmp_result_file.absFileName();
4600 return success ? ExportSuccess : ExportConverterError;
4603 if (dest_filename.empty())
4604 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4606 result_file = dest_filename;
4607 // We need to copy referenced files (e. g. included graphics
4608 // if format == "dvi") to the result dir.
4609 vector<ExportedFile> const files =
4610 runparams.exportdata->externalFiles(format);
4611 string const dest = runparams.export_folder.empty() ?
4612 onlyPath(result_file) : runparams.export_folder;
4613 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4614 : force_overwrite == ALL_FILES;
4615 CopyStatus status = use_force ? FORCE : SUCCESS;
4617 for (ExportedFile const & exp : files) {
4618 if (status == CANCEL) {
4619 message(_("Document export cancelled."));
4620 return ExportCancel;
4622 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4623 string fixedName = exp.exportName;
4624 if (!runparams.export_folder.empty()) {
4625 // Relative pathnames starting with ../ will be sanitized
4626 // if exporting to a different folder
4627 while (fixedName.substr(0, 3) == "../")
4628 fixedName = fixedName.substr(3, fixedName.length() - 3);
4630 FileName fixedFileName = makeAbsPath(fixedName, dest);
4631 fixedFileName.onlyPath().createPath();
4632 status = copyFile(fmt, exp.sourceName,
4634 exp.exportName, status == FORCE,
4635 runparams.export_folder.empty());
4639 if (tmp_result_file.exists()) {
4640 // Finally copy the main file
4641 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4642 : force_overwrite != NO_FILES;
4643 if (status == SUCCESS && use_force)
4645 status = copyFile(format, tmp_result_file,
4646 FileName(result_file), result_file,
4648 if (status == CANCEL) {
4649 message(_("Document export cancelled."));
4650 return ExportCancel;
4652 message(bformat(_("Document exported as %1$s "
4654 theFormats().prettyName(format),
4655 makeDisplayPath(result_file)));
4658 // This must be a dummy converter like fax (bug 1888)
4659 message(bformat(_("Document exported as %1$s"),
4660 theFormats().prettyName(format)));
4663 return success ? ExportSuccess : ExportConverterError;
4667 Buffer::ExportStatus Buffer::preview(string const & format) const
4669 bool const update_unincluded =
4670 params().maintain_unincluded_children
4671 && !params().getIncludedChildren().empty();
4672 return preview(format, update_unincluded);
4676 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4678 MarkAsExporting exporting(this);
4680 // (1) export with all included children (omit \includeonly)
4682 ExportStatus const status = doExport(format, true, true, result_file);
4683 if (status != ExportSuccess)
4686 // (2) export with included children only
4687 ExportStatus const status = doExport(format, true, false, result_file);
4688 FileName const previewFile(result_file);
4690 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4691 theimpl->preview_file_ = previewFile;
4692 theimpl->preview_format_ = format;
4693 theimpl->preview_error_ = (status != ExportSuccess);
4695 if (status != ExportSuccess)
4698 if (previewFile.exists())
4699 return theFormats().view(*this, previewFile, format) ?
4700 PreviewSuccess : PreviewError;
4702 // Successful export but no output file?
4703 // Probably a bug in error detection.
4704 LATTEST(status != ExportSuccess);
4709 Buffer::ReadStatus Buffer::extractFromVC()
4711 bool const found = LyXVC::file_not_found_hook(d->filename);
4713 return ReadFileNotFound;
4714 if (!d->filename.isReadableFile())
4720 Buffer::ReadStatus Buffer::loadEmergency()
4722 FileName const emergencyFile = getEmergencyFileName();
4723 if (!emergencyFile.exists()
4724 || emergencyFile.lastModified() <= d->filename.lastModified())
4725 return ReadFileNotFound;
4727 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4728 docstring const text = bformat(_("An emergency save of the document "
4729 "%1$s exists.\n\nRecover emergency save?"), file);
4731 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4732 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4738 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4739 bool const success = (ret_llf == ReadSuccess);
4741 if (hasReadonlyFlag()) {
4742 Alert::warning(_("File is read-only"),
4743 bformat(_("An emergency file is successfully loaded, "
4744 "but the original file %1$s is marked read-only. "
4745 "Please make sure to save the document as a different "
4746 "file."), from_utf8(d->filename.absFileName())));
4749 lyxvc().file_found_hook(d->filename);
4750 str = _("Document was successfully recovered.");
4752 str = _("Document was NOT successfully recovered.");
4753 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4754 makeDisplayPath(emergencyFile.absFileName()));
4756 int const del_emerg =
4757 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4758 _("&Remove"), _("&Keep"));
4759 if (del_emerg == 0) {
4760 emergencyFile.removeFile();
4762 Alert::warning(_("Emergency file deleted"),
4763 _("Do not forget to save your file now!"), true);
4765 return success ? ReadSuccess : ReadEmergencyFailure;
4768 int const del_emerg =
4769 Alert::prompt(_("Delete emergency file?"),
4770 _("Remove emergency file now?"), 1, 1,
4771 _("&Remove"), _("&Keep"));
4773 emergencyFile.removeFile();
4777 string const ename = emergencyFile.absFileName();
4779 // Surely we can find one in 100 tries?
4780 for (int i = 1; i < 100; ++i) {
4781 newname.set(ename + to_string(i) + ".lyx");
4782 if (!newname.exists()) {
4788 // renameTo returns true on success. So inverting that
4789 // will give us true if we fail.
4790 noname = !emergencyFile.renameTo(newname);
4793 Alert::warning(_("Can't rename emergency file!"),
4794 _("LyX was unable to rename the emergency file. "
4795 "You should do so manually. Otherwise, you will be "
4796 "asked about it again the next time you try to load "
4797 "this file, and may over-write your own work."));
4800 return ReadOriginal;
4810 Buffer::ReadStatus Buffer::loadAutosave()
4812 // Now check if autosave file is newer.
4813 FileName const autosaveFile = getAutosaveFileName();
4814 if (!autosaveFile.exists()
4815 || autosaveFile.lastModified() <= d->filename.lastModified())
4816 return ReadFileNotFound;
4818 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4819 docstring const text = bformat(_("The backup of the document %1$s "
4820 "is newer.\n\nLoad the backup instead?"), file);
4821 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4822 _("&Load backup"), _("Load &original"), _("&Cancel"));
4827 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4828 // the file is not saved if we load the autosave file.
4829 if (ret_llf == ReadSuccess) {
4830 if (hasReadonlyFlag()) {
4831 Alert::warning(_("File is read-only"),
4832 bformat(_("A backup file is successfully loaded, "
4833 "but the original file %1$s is marked read-only. "
4834 "Please make sure to save the document as a "
4836 from_utf8(d->filename.absFileName())));
4839 lyxvc().file_found_hook(d->filename);
4842 return ReadAutosaveFailure;
4845 // Here we delete the autosave
4846 autosaveFile.removeFile();
4847 return ReadOriginal;
4855 Buffer::ReadStatus Buffer::loadLyXFile()
4857 if (!d->filename.isReadableFile()) {
4858 ReadStatus const ret_rvc = extractFromVC();
4859 if (ret_rvc != ReadSuccess)
4863 ReadStatus const ret_re = loadEmergency();
4864 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4867 ReadStatus const ret_ra = loadAutosave();
4868 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4871 return loadThisLyXFile(d->filename);
4875 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4877 return readFile(fn);
4881 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4883 for (auto const & err : terr) {
4884 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4885 int errorRow = err.error_in_line;
4886 Buffer const * buf = 0;
4888 if (err.child_name.empty())
4889 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4891 // The error occurred in a child
4892 for (Buffer const * child : getDescendents()) {
4893 string const child_name =
4894 DocFileName(changeExtension(child->absFileName(), "tex")).
4896 if (err.child_name != child_name)
4898 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4899 if (!TexRow::isNone(start)) {
4900 buf = d->cloned_buffer_
4901 ? child->d->cloned_buffer_->d->owner_
4908 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4914 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4916 LBUFERR(!text().paragraphs().empty());
4918 // Use the master text class also for child documents
4919 Buffer const * const master = masterBuffer();
4920 DocumentClass const & textclass = master->params().documentClass();
4922 docstring_list old_bibfiles;
4923 // Do this only if we are the top-level Buffer. We also need to account
4924 // for the case of a previewed child with ignored parent here.
4925 if (master == this && !d->ignore_parent) {
4926 textclass.counters().reset(from_ascii("bibitem"));
4927 reloadBibInfoCache();
4928 // we will re-read this cache as we go through, but we need
4929 // to know whether it's changed to know whether we need to
4930 // update the bibinfo cache.
4931 old_bibfiles = d->bibfiles_cache_;
4932 d->bibfiles_cache_.clear();
4935 // keep the buffers to be children in this set. If the call from the
4936 // master comes back we can see which of them were actually seen (i.e.
4937 // via an InsetInclude). The remaining ones in the set need still be updated.
4938 static std::set<Buffer const *> bufToUpdate;
4939 if (scope == UpdateMaster) {
4940 // If this is a child document start with the master
4941 if (master != this) {
4942 bufToUpdate.insert(this);
4943 master->updateBuffer(UpdateMaster, utype);
4944 // If the master buffer has no gui associated with it, then the TocModel is
4945 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4946 // (bug 5699). The same happens if the master buffer is open in a different
4947 // window. This test catches both possibilities.
4948 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4949 // There remains a problem here: If there is another child open in yet a third
4950 // window, that TOC is not updated. So some more general solution is needed at
4952 if (master->d->gui_ != d->gui_)
4955 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4956 if (bufToUpdate.find(this) == bufToUpdate.end())
4960 // start over the counters in the master
4961 textclass.counters().reset();
4964 // update will be done below for this buffer
4965 bufToUpdate.erase(this);
4967 // update all caches
4968 clearReferenceCache();
4970 setChangesPresent(false);
4972 Buffer & cbuf = const_cast<Buffer &>(*this);
4975 ParIterator parit = cbuf.par_iterator_begin();
4976 updateBuffer(parit, utype);
4978 // If this document has siblings, then update the TocBackend later. The
4979 // reason is to ensure that later siblings are up to date when e.g. the
4980 // broken or not status of references is computed. The update is called
4981 // in InsetInclude::addToToc.
4985 // if the bibfiles changed, the cache of bibinfo is invalid
4986 docstring_list new_bibfiles = d->bibfiles_cache_;
4987 // this is a trick to determine whether the two vectors have
4988 // the same elements.
4989 sort(new_bibfiles.begin(), new_bibfiles.end());
4990 sort(old_bibfiles.begin(), old_bibfiles.end());
4991 if (old_bibfiles != new_bibfiles) {
4992 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4993 invalidateBibinfoCache();
4994 reloadBibInfoCache();
4995 // We relied upon the bibinfo cache when recalculating labels. But that
4996 // cache was invalid, although we didn't find that out until now. So we
4997 // have to do it all again.
4998 // That said, the only thing we really need to do is update the citation
4999 // labels. Nothing else will have changed. So we could create a new
5000 // UpdateType that would signal that fact, if we needed to do so.
5001 parit = cbuf.par_iterator_begin();
5002 // we will be re-doing the counters and references and such.
5003 textclass.counters().reset();
5004 clearReferenceCache();
5005 // we should not need to do this again?
5007 setChangesPresent(false);
5008 updateBuffer(parit, utype);
5009 // this will already have been done by reloadBibInfoCache();
5010 // d->bibinfo_cache_valid_ = true;
5013 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5014 // this is also set to true on the other path, by reloadBibInfoCache.
5015 d->bibinfo_cache_valid_ = true;
5017 d->cite_labels_valid_ = true;
5019 cbuf.tocBackend().update(true, utype);
5020 if (scope == UpdateMaster)
5021 cbuf.structureChanged();
5025 static depth_type getDepth(DocIterator const & it)
5027 depth_type depth = 0;
5028 for (size_t i = 0 ; i < it.depth() ; ++i)
5029 if (!it[i].inset().inMathed())
5030 depth += it[i].paragraph().getDepth() + 1;
5031 // remove 1 since the outer inset does not count
5032 // we should have at least one non-math inset, so
5033 // depth should nevery be 0. but maybe it is worth
5034 // marking this, just in case.
5036 // coverity[INTEGER_OVERFLOW]
5040 static depth_type getItemDepth(ParIterator const & it)
5042 Paragraph const & par = *it;
5043 LabelType const labeltype = par.layout().labeltype;
5045 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5048 // this will hold the lowest depth encountered up to now.
5049 depth_type min_depth = getDepth(it);
5050 ParIterator prev_it = it;
5053 --prev_it.top().pit();
5055 // start of nested inset: go to outer par
5057 if (prev_it.empty()) {
5058 // start of document: nothing to do
5063 // We search for the first paragraph with same label
5064 // that is not more deeply nested.
5065 Paragraph & prev_par = *prev_it;
5066 depth_type const prev_depth = getDepth(prev_it);
5067 if (labeltype == prev_par.layout().labeltype) {
5068 if (prev_depth < min_depth)
5069 return prev_par.itemdepth + 1;
5070 if (prev_depth == min_depth)
5071 return prev_par.itemdepth;
5073 min_depth = min(min_depth, prev_depth);
5074 // small optimization: if we are at depth 0, we won't
5075 // find anything else
5076 if (prev_depth == 0)
5082 static bool needEnumCounterReset(ParIterator const & it)
5084 Paragraph const & par = *it;
5085 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5086 depth_type const cur_depth = par.getDepth();
5087 ParIterator prev_it = it;
5088 while (prev_it.pit()) {
5089 --prev_it.top().pit();
5090 Paragraph const & prev_par = *prev_it;
5091 if (prev_par.getDepth() <= cur_depth)
5092 return prev_par.layout().name() != par.layout().name();
5094 // start of nested inset: reset
5099 // set the label of a paragraph. This includes the counters.
5100 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5102 BufferParams const & bp = owner_->masterBuffer()->params();
5103 DocumentClass const & textclass = bp.documentClass();
5104 Paragraph & par = it.paragraph();
5105 Layout const & layout = par.layout();
5106 Counters & counters = textclass.counters();
5108 if (par.params().startOfAppendix()) {
5109 // We want to reset the counter corresponding to toplevel sectioning
5110 Layout const & lay = textclass.getTOCLayout();
5111 docstring const cnt = lay.counter;
5113 counters.reset(cnt);
5114 counters.appendix(true);
5116 par.params().appendix(counters.appendix());
5118 // Compute the item depth of the paragraph
5119 par.itemdepth = getItemDepth(it);
5121 if (layout.margintype == MARGIN_MANUAL) {
5122 if (par.params().labelWidthString().empty())
5123 par.params().labelWidthString(par.expandLabel(layout, bp));
5124 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5125 // we do not need to do anything here, since the empty case is
5126 // handled during export.
5128 par.params().labelWidthString(docstring());
5131 switch(layout.labeltype) {
5132 case LABEL_ITEMIZE: {
5133 // At some point of time we should do something more
5134 // clever here, like:
5135 // par.params().labelString(
5136 // bp.user_defined_bullet(par.itemdepth).getText());
5137 // for now, use a simple hardcoded label
5138 docstring itemlabel;
5139 switch (par.itemdepth) {
5141 itemlabel = char_type(0x2022);
5144 itemlabel = char_type(0x2013);
5147 itemlabel = char_type(0x2217);
5150 itemlabel = char_type(0x2219); // or 0x00b7
5153 par.params().labelString(itemlabel);
5157 case LABEL_ENUMERATE: {
5158 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5160 switch (par.itemdepth) {
5171 enumcounter += "iv";
5174 // not a valid enumdepth...
5178 if (needEnumCounterReset(it)) {
5179 // Increase the master counter?
5180 if (layout.stepmastercounter)
5181 counters.stepMaster(enumcounter, utype);
5182 // Maybe we have to reset the enumeration counter.
5183 if (!layout.resumecounter)
5184 counters.reset(enumcounter);
5186 counters.step(enumcounter, utype);
5188 string const & lang = par.getParLanguage(bp)->code();
5189 par.params().labelString(counters.theCounter(enumcounter, lang));
5194 case LABEL_SENSITIVE: {
5195 string const & type = counters.current_float();
5196 docstring full_label;
5198 full_label = owner_->B_("Senseless!!! ");
5200 docstring name = owner_->B_(textclass.floats().getType(type).name());
5201 if (counters.hasCounter(from_utf8(type))) {
5202 string const & lang = par.getParLanguage(bp)->code();
5203 counters.step(from_utf8(type), utype);
5204 full_label = bformat(from_ascii("%1$s %2$s:"),
5206 counters.theCounter(from_utf8(type), lang));
5208 full_label = bformat(from_ascii("%1$s #:"), name);
5210 par.params().labelString(full_label);
5214 case LABEL_NO_LABEL:
5215 par.params().labelString(docstring());
5219 case LABEL_CENTERED:
5220 case LABEL_STATIC: {
5221 docstring const & lcounter = layout.counter;
5222 if (!lcounter.empty()) {
5223 if (layout.toclevel <= bp.secnumdepth
5224 && (layout.latextype != LATEX_ENVIRONMENT
5225 || it.text()->isFirstInSequence(it.pit()))) {
5226 if (counters.hasCounter(lcounter))
5227 counters.step(lcounter, utype);
5228 par.params().labelString(par.expandLabel(layout, bp));
5230 par.params().labelString(docstring());
5232 par.params().labelString(par.expandLabel(layout, bp));
5238 par.params().labelString(par.expandLabel(layout, bp));
5243 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5245 // LASSERT: Is it safe to continue here, or should we just return?
5246 LASSERT(parit.pit() == 0, /**/);
5248 // Set the position of the text in the buffer to be able
5249 // to resolve macros in it.
5250 parit.text()->setMacrocontextPosition(parit);
5252 depth_type maxdepth = 0;
5253 pit_type const lastpit = parit.lastpit();
5254 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5255 // reduce depth if necessary
5256 if (parit->params().depth() > maxdepth) {
5257 /** FIXME: this function is const, but
5258 * nevertheless it modifies the buffer. To be
5259 * cleaner, one should modify the buffer in
5260 * another function, which is actually
5261 * non-const. This would however be costly in
5262 * terms of code duplication.
5264 CursorData(parit).recordUndo();
5265 parit->params().depth(maxdepth);
5267 maxdepth = parit->getMaxDepthAfter();
5269 if (utype == OutputUpdate) {
5270 // track the active counters
5271 // we have to do this for the master buffer, since the local
5272 // buffer isn't tracking anything.
5273 masterBuffer()->params().documentClass().counters().
5274 setActiveLayout(parit->layout());
5277 // set the counter for this paragraph
5278 d->setLabel(parit, utype);
5280 // update change-tracking flag
5281 parit->addChangesToBuffer(*this);
5284 for (auto const & insit : parit->insetList()) {
5285 parit.pos() = insit.pos;
5286 insit.inset->updateBuffer(parit, utype);
5292 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5293 WordLangTuple & word_lang, docstring_list & suggestions) const
5297 suggestions.clear();
5298 word_lang = WordLangTuple();
5299 bool const to_end = to.empty();
5300 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5301 // OK, we start from here.
5302 for (; from != end; from.forwardPos()) {
5303 // This skips all insets with spell check disabled.
5304 while (!from.allowSpellCheck()) {
5308 // If from is at the end of the document (which is possible
5309 // when "from" was changed above) LyX will crash later otherwise.
5310 if (from.atEnd() || (!to_end && from >= end))
5313 from.paragraph().spellCheck();
5314 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5315 if (SpellChecker::misspelled(res)) {
5319 // Do not increase progress when from == to, otherwise the word
5320 // count will be wrong.
5330 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5332 bool inword = false;
5337 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5338 if (!dit.inTexted()) {
5343 Paragraph const & par = dit.paragraph();
5344 pos_type const pos = dit.pos();
5346 // Copied and adapted from isWordSeparator() in Paragraph
5347 if (pos == dit.lastpos()) {
5350 Inset const * ins = par.getInset(pos);
5351 if (ins && skipNoOutput && !ins->producesOutput()) {
5354 // stop if end of range was skipped
5355 if (!to.atEnd() && dit >= to)
5358 } else if (!par.isDeleted(pos)) {
5359 if (par.isWordSeparator(pos))
5365 if (ins && ins->isLetter())
5367 else if (ins && ins->isSpace())
5370 char_type const c = par.getChar(pos);
5371 if (isPrintableNonspace(c))
5373 else if (isSpace(c))
5383 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5385 d->updateStatistics(from, to, skipNoOutput);
5389 int Buffer::wordCount() const
5391 return d->wordCount();
5395 int Buffer::charCount(bool with_blanks) const
5397 return d->charCount(with_blanks);
5401 Buffer::ReadStatus Buffer::reload()
5404 // c.f. bug https://www.lyx.org/trac/ticket/6587
5405 removeAutosaveFile();
5406 // e.g., read-only status could have changed due to version control
5407 d->filename.refresh();
5408 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5410 // clear parent. this will get reset if need be.
5412 ReadStatus const status = loadLyXFile();
5413 if (status == ReadSuccess) {
5418 message(bformat(_("Document %1$s reloaded."), disp_fn));
5421 message(bformat(_("Could not reload document %1$s."), disp_fn));
5431 bool Buffer::saveAs(FileName const & fn)
5433 FileName const old_name = fileName();
5434 FileName const old_auto = getAutosaveFileName();
5435 bool const old_unnamed = isUnnamed();
5436 bool success = true;
5437 d->old_position = filePath();
5444 // bring the autosave file with us, just in case.
5445 moveAutosaveFile(old_auto);
5446 // validate version control data and
5447 // correct buffer title
5448 lyxvc().file_found_hook(fileName());
5450 // the file has now been saved to the new location.
5451 // we need to check that the locations of child buffers
5453 checkChildBuffers();
5454 checkMasterBuffer();
5457 // reset the old filename and unnamed state
5458 setFileName(old_name);
5459 setUnnamed(old_unnamed);
5463 d->old_position.clear();
5468 void Buffer::checkChildBuffers()
5470 for (auto const & bit : d->children_positions) {
5471 DocIterator dit = bit.second;
5472 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5473 if (!cbuf || !theBufferList().isLoaded(cbuf))
5475 Inset * inset = dit.nextInset();
5476 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5477 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5478 docstring const & incfile = inset_inc->getParam("filename");
5479 string oldloc = cbuf->absFileName();
5480 string newloc = makeAbsPath(to_utf8(incfile),
5481 onlyPath(absFileName())).absFileName();
5482 if (oldloc == newloc)
5484 // the location of the child file is incorrect.
5486 inset_inc->setChildBuffer(0);
5488 // invalidate cache of children
5489 d->children_positions.clear();
5490 d->position_to_children.clear();
5494 // If a child has been saved under a different name/path, it might have been
5495 // orphaned. Therefore the master needs to be reset (bug 8161).
5496 void Buffer::checkMasterBuffer()
5498 Buffer const * const master = masterBuffer();
5502 // necessary to re-register the child (bug 5873)
5503 // FIXME: clean up updateMacros (here, only
5504 // child registering is needed).
5505 master->updateMacros();
5506 // (re)set master as master buffer, but only
5507 // if we are a real child
5508 if (master->isChild(this))
5515 string Buffer::includedFilePath(string const & name, string const & ext) const
5517 if (d->old_position.empty() ||
5518 equivalent(FileName(d->old_position), FileName(filePath())))
5521 bool isabsolute = FileName::isAbsolute(name);
5522 // both old_position and filePath() end with a path separator
5523 string absname = isabsolute ? name : d->old_position + name;
5525 // if old_position is set to origin, we need to do the equivalent of
5526 // getReferencedFileName() (see readDocument())
5527 if (!isabsolute && d->old_position == params().origin) {
5528 FileName const test(addExtension(filePath() + name, ext));
5530 absname = filePath() + name;
5533 if (!FileName(addExtension(absname, ext)).exists())
5537 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5539 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5540 from_utf8(filePath())));
5544 void Buffer::setChangesPresent(bool b) const
5546 d->tracked_changes_present_ = b;
5550 bool Buffer::areChangesPresent() const
5552 return d->tracked_changes_present_;
5556 void Buffer::updateChangesPresent() const
5558 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5559 setChangesPresent(false);
5560 ParConstIterator it = par_iterator_begin();
5561 ParConstIterator const end = par_iterator_end();
5562 for (; !areChangesPresent() && it != end; ++it)
5563 it->addChangesToBuffer(*this);
5567 void Buffer::Impl::refreshFileMonitor()
5569 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5570 file_monitor_->refresh();
5574 // The previous file monitor is invalid
5575 // This also destroys the previous file monitor and all its connections
5576 file_monitor_ = FileSystemWatcher::monitor(filename);
5577 // file_monitor_ will be destroyed with *this, so it is not going to call a
5578 // destroyed object method.
5579 file_monitor_->connect([this](bool exists) {
5580 fileExternallyModified(exists);
5585 void Buffer::Impl::fileExternallyModified(bool const exists)
5587 // ignore notifications after our own saving operations
5588 if (checksum_ == filename.checksum()) {
5589 LYXERR(Debug::FILES, "External modification but "
5590 "checksum unchanged: " << filename);
5593 // If the file has been deleted, only mark the file as dirty since it is
5594 // pointless to prompt for reloading. If later a file is moved into this
5595 // location, then the externally modified warning will appear then.
5597 externally_modified_ = true;
5598 // Update external modification notification.
5599 // Dirty buffers must be visible at all times.
5600 if (wa_ && wa_->unhide(owner_))
5601 wa_->updateTitles();
5603 // Unable to unhide the buffer (e.g. no GUI or not current View)
5608 bool Buffer::notifiesExternalModification() const
5610 return d->externally_modified_;
5614 void Buffer::clearExternalModification() const
5616 d->externally_modified_ = false;
5618 d->wa_->updateTitles();