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 = filename.onlyFileNameWithoutExt()
816 + to_utf8(branch_suffix);
817 FileName res(filename.onlyPath().absFileName() + "/" + name);
818 res.changeExtension(filename.extension());
824 string Buffer::logName(LogType * type) const
826 string const filename = latexName(false);
828 if (filename.empty()) {
834 string const path = temppath();
836 FileName const fname(addName(temppath(),
837 onlyFileName(changeExtension(filename,
840 // FIXME: how do we know this is the name of the build log?
841 FileName const bname(
842 addName(path, onlyFileName(
843 changeExtension(filename,
844 theFormats().extension(params().bufferFormat()) + ".out"))));
846 // Also consider the master buffer log file
847 FileName masterfname = fname;
848 LogType mtype = latexlog;
849 if (masterBuffer() != this) {
850 string const mlogfile = masterBuffer()->logName(&mtype);
851 masterfname = FileName(mlogfile);
854 // If no Latex log or Build log is newer, show Build log
855 if (bname.exists() &&
856 ((!fname.exists() && !masterfname.exists())
857 || (fname.lastModified() < bname.lastModified()
858 && masterfname.lastModified() < bname.lastModified()))) {
859 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
862 return bname.absFileName();
863 // If we have a newer master file log or only a master log, show this
864 } else if (fname != masterfname
865 && (!fname.exists() && (masterfname.exists()
866 || fname.lastModified() < masterfname.lastModified()))) {
867 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
870 return masterfname.absFileName();
872 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
875 return fname.absFileName();
879 void Buffer::setReadonly(bool const flag)
881 if (d->read_only != flag) {
888 void Buffer::setFileName(FileName const & fname)
890 bool const changed = fname != d->filename;
892 d->refreshFileMonitor();
894 lyxvc().file_found_hook(fname);
895 setReadonly(d->filename.isReadOnly());
901 int Buffer::readHeader(Lexer & lex)
903 int unknown_tokens = 0;
905 int begin_header_line = -1;
907 // Initialize parameters that may be/go lacking in header:
908 params().branchlist().clear();
909 params().preamble.erase();
910 params().options.erase();
911 params().master.erase();
912 params().float_placement.erase();
913 params().float_alignment.erase();
914 params().paperwidth.erase();
915 params().paperheight.erase();
916 params().leftmargin.erase();
917 params().rightmargin.erase();
918 params().topmargin.erase();
919 params().bottommargin.erase();
920 params().headheight.erase();
921 params().headsep.erase();
922 params().footskip.erase();
923 params().columnsep.erase();
924 params().fonts_cjk.erase();
925 params().listings_params.clear();
926 params().clearLayoutModules();
927 params().clearRemovedModules();
928 params().clearIncludedChildren();
929 params().pdfoptions().clear();
930 params().indiceslist().clear();
931 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
932 params().isbackgroundcolor = false;
933 params().fontcolor = RGBColor(0, 0, 0);
934 params().isfontcolor = false;
935 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
936 params().boxbgcolor = RGBColor(0xFF, 0, 0);
937 params().html_latex_start.clear();
938 params().html_latex_end.clear();
939 params().html_math_img_scale = 1.0;
940 params().output_sync_macro.erase();
941 params().setLocalLayout(docstring(), false);
942 params().setLocalLayout(docstring(), true);
943 params().biblio_opts.erase();
944 params().biblatex_bibstyle.erase();
945 params().biblatex_citestyle.erase();
946 params().multibib.erase();
948 for (int i = 0; i < 4; ++i) {
949 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
950 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
953 ErrorList & errorList = d->errorLists["Parse"];
962 if (token == "\\end_header")
966 if (token == "\\begin_header") {
967 begin_header_line = line;
971 LYXERR(Debug::PARSER, "Handling document header token: `"
974 string const result =
975 params().readToken(lex, token, d->filename.onlyPath());
976 if (!result.empty()) {
977 if (token == "\\textclass") {
978 d->layout_position = result;
981 docstring const s = bformat(_("Unknown token: "
985 errorList.push_back(ErrorItem(_("Document header error"), s));
989 if (begin_header_line) {
990 docstring const s = _("\\begin_header is missing");
991 errorList.push_back(ErrorItem(_("Document header error"), s));
994 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
996 params().makeDocumentClass();
998 return unknown_tokens;
1003 // changed to be public and have one parameter
1004 // Returns true if "\end_document" is not read (Asger)
1005 bool Buffer::readDocument(Lexer & lex)
1007 ErrorList & errorList = d->errorLists["Parse"];
1010 // remove dummy empty par
1011 paragraphs().clear();
1013 if (!lex.checkFor("\\begin_document")) {
1014 docstring const s = _("\\begin_document is missing");
1015 errorList.push_back(ErrorItem(_("Document header error"), s));
1020 if (params().output_changes) {
1021 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1022 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1023 LaTeXFeatures::isAvailable("xcolor");
1025 if (!dvipost && !xcolorulem) {
1026 Alert::warning(_("Changes not shown in LaTeX output"),
1027 _("Changes will not be highlighted in LaTeX output, "
1028 "because neither dvipost nor xcolor/ulem are installed.\n"
1029 "Please install these packages or redefine "
1030 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1031 } else if (!xcolorulem) {
1032 Alert::warning(_("Changes not shown in LaTeX output"),
1033 _("Changes will not be highlighted in LaTeX output "
1034 "when using pdflatex, because xcolor and ulem are not installed.\n"
1035 "Please install both packages or redefine "
1036 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1040 if (!parent() && !params().master.empty()) {
1041 FileName const master_file = makeAbsPath(params().master,
1042 onlyPath(absFileName()));
1043 if (isLyXFileName(master_file.absFileName())) {
1045 checkAndLoadLyXFile(master_file, true);
1047 // necessary e.g. after a reload
1048 // to re-register the child (bug 5873)
1049 // FIXME: clean up updateMacros (here, only
1050 // child registering is needed).
1051 master->updateMacros();
1052 // set master as master buffer, but only
1053 // if we are a real child
1054 if (master->isChild(this))
1056 // if the master is not fully loaded
1057 // it is probably just loading this
1058 // child. No warning needed then.
1059 else if (master->isFullyLoaded())
1060 LYXERR0("The master '"
1062 << "' assigned to this document ("
1064 << ") does not include "
1065 "this document. Ignoring the master assignment.");
1066 // If the master has just been created, un-hide it (#11162)
1067 if (!master->fileName().exists())
1068 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1069 master->absFileName()));
1074 // assure we have a default index
1075 params().indiceslist().addDefault(B_("Index"));
1078 if (FileName::isAbsolute(params().origin))
1079 d->old_position = params().origin;
1081 d->old_position = filePath();
1082 bool const res = text().read(lex, errorList, d->inset);
1083 d->old_position.clear();
1085 // inform parent buffer about local macros
1087 Buffer const * pbuf = parent();
1088 for (auto const & m : usermacros)
1089 pbuf->usermacros.insert(m);
1093 updateMacroInstances(InternalUpdate);
1098 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1100 Format const * fmt = theFormats().getFormat(format);
1103 // It is important to use the correct extension here, since some
1104 // converters create a wrong output file otherwise (e.g. html2latex)
1105 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1106 ofdocstream os(name.toFilesystemEncoding().c_str());
1107 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1108 bool const success = !(os << contents).fail();
1111 bool converted = false;
1113 params().compressed = false;
1115 // remove dummy empty par
1116 paragraphs().clear();
1118 converted = importFile(format, name, errorList);
1121 removeTempFile(name);
1126 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1128 if (!theConverters().isReachable(format, "lyx"))
1131 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1132 Converters::RetVal const retval =
1133 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1134 if (retval == Converters::SUCCESS) {
1135 bool const success = readFile(lyx) == ReadSuccess;
1136 removeTempFile(lyx);
1144 bool Buffer::readString(string const & s)
1146 params().compressed = false;
1149 istringstream is(s);
1151 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1152 FileName const fn = tempfile.name();
1155 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1157 if (success && file_format != LYX_FORMAT) {
1158 // We need to call lyx2lyx, so write the input to a file
1159 ofstream os(fn.toFilesystemEncoding().c_str());
1162 // lyxvc in readFile
1163 if (readFile(fn) != ReadSuccess)
1167 if (readDocument(lex))
1173 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1177 if (!lex.setFile(fname)) {
1178 Alert::error(_("File Not Found"),
1179 bformat(_("Unable to open file `%1$s'."),
1180 from_utf8(fn.absFileName())));
1181 return ReadFileNotFound;
1185 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1186 if (ret_plf != ReadSuccess)
1189 if (file_format != LYX_FORMAT) {
1191 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1192 if (ret_clf != ReadSuccess)
1194 ret_clf = readFile(tmpFile);
1195 if (ret_clf == ReadSuccess) {
1196 d->file_format = file_format;
1197 d->need_format_backup = true;
1202 // FIXME: InsetInfo needs to know whether the file is under VCS
1203 // during the parse process, so this has to be done before.
1204 lyxvc().file_found_hook(d->filename);
1206 if (readDocument(lex)) {
1207 Alert::error(_("Document format failure"),
1208 bformat(_("%1$s ended unexpectedly, which means"
1209 " that it is probably corrupted."),
1210 from_utf8(fn.absFileName())));
1211 return ReadDocumentFailure;
1214 d->file_fully_loaded = true;
1215 d->read_only = !d->filename.isWritable();
1216 params().compressed = theFormats().isZippedFile(d->filename);
1222 bool Buffer::isFullyLoaded() const
1224 return d->file_fully_loaded;
1228 void Buffer::setFullyLoaded(bool value)
1230 d->file_fully_loaded = value;
1234 bool Buffer::lastPreviewError() const
1236 return d->preview_error_;
1240 PreviewLoader * Buffer::loader() const
1242 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1244 if (!d->preview_loader_)
1245 d->preview_loader_ = new PreviewLoader(*this);
1246 return d->preview_loader_;
1250 void Buffer::removePreviews() const
1252 delete d->preview_loader_;
1253 d->preview_loader_ = 0;
1257 void Buffer::updatePreviews() const
1259 PreviewLoader * ploader = loader();
1263 InsetIterator it = inset_iterator_begin(*d->inset);
1264 InsetIterator const end = inset_iterator_end(*d->inset);
1265 for (; it != end; ++it)
1266 it->addPreview(it, *ploader);
1268 ploader->startLoading();
1272 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1273 FileName const & fn, int & file_format) const
1275 if(!lex.checkFor("\\lyxformat")) {
1276 Alert::error(_("Document format failure"),
1277 bformat(_("%1$s is not a readable LyX document."),
1278 from_utf8(fn.absFileName())));
1279 return ReadNoLyXFormat;
1285 // LyX formats 217 and earlier were written as 2.17. This corresponds
1286 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1287 // these cases. See also: www.lyx.org/trac/changeset/1313.
1288 size_t dot = tmp_format.find_first_of(".,");
1289 if (dot != string::npos)
1290 tmp_format.erase(dot, 1);
1292 file_format = convert<int>(tmp_format);
1297 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1298 FileName & tmpfile, int from_format)
1300 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1301 tempfile.setAutoRemove(false);
1302 tmpfile = tempfile.name();
1303 if(tmpfile.empty()) {
1304 Alert::error(_("Conversion failed"),
1305 bformat(_("%1$s is from a different"
1306 " version of LyX, but a temporary"
1307 " file for converting it could"
1308 " not be created."),
1309 from_utf8(fn.absFileName())));
1310 return LyX2LyXNoTempFile;
1313 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1314 if (lyx2lyx.empty()) {
1315 Alert::error(_("Conversion script not found"),
1316 bformat(_("%1$s is from a different"
1317 " version of LyX, but the"
1318 " conversion script lyx2lyx"
1319 " could not be found."),
1320 from_utf8(fn.absFileName())));
1321 return LyX2LyXNotFound;
1325 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1326 ostringstream command;
1327 command << os::python()
1328 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1329 << " -t " << convert<string>(LYX_FORMAT)
1330 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1331 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1332 string const command_str = command.str();
1334 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1336 cmd_ret const ret = runCommand(command_str);
1337 if (ret.first != 0) {
1338 if (from_format < LYX_FORMAT) {
1339 Alert::error(_("Conversion script failed"),
1340 bformat(_("%1$s is from an older version"
1341 " of LyX and the lyx2lyx script"
1342 " failed to convert it."),
1343 from_utf8(fn.absFileName())));
1344 return LyX2LyXOlderFormat;
1346 Alert::error(_("Conversion script failed"),
1347 bformat(_("%1$s is from a newer version"
1348 " of LyX and the lyx2lyx script"
1349 " failed to convert it."),
1350 from_utf8(fn.absFileName())));
1351 return LyX2LyXNewerFormat;
1358 FileName Buffer::getBackupName() const {
1359 map<int, string> const file_formats = {
1376 FileName const & fn = fileName();
1377 string const fname = fn.onlyFileNameWithoutExt();
1378 string const fext = fn.extension() + "~";
1379 string const fpath = lyxrc.backupdir_path.empty() ?
1380 fn.onlyPath().absFileName() :
1381 lyxrc.backupdir_path;
1382 string backup_suffix;
1383 // If file format is from a stable series use version instead of file format
1384 auto const it = file_formats.find(d->file_format);
1385 if (it != file_formats.end())
1386 backup_suffix = "-lyx" + it->second;
1388 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1389 string const backname = fname + backup_suffix;
1390 FileName backup(addName(fpath, addExtension(backname, fext)));
1392 // limit recursion, just in case
1394 unsigned long orig_checksum = 0;
1395 while (backup.exists() && v < 100) {
1396 if (orig_checksum == 0)
1397 orig_checksum = fn.checksum();
1398 unsigned long new_checksum = backup.checksum();
1399 if (orig_checksum == new_checksum) {
1400 LYXERR(Debug::FILES, "Not backing up " << fn <<
1401 "since " << backup << "has the same checksum.");
1402 // a bit of a hack, but we have to check this anyway
1403 // below, and setting this is simpler than introducing
1404 // a special boolean for this purpose.
1408 string const newbackname = backname + "-" + convert<string>(v);
1409 backup.set(addName(fpath, addExtension(newbackname, fext)));
1412 return v < 100 ? backup : FileName();
1416 // Should probably be moved to somewhere else: BufferView? GuiView?
1417 bool Buffer::save() const
1419 docstring const file = makeDisplayPath(absFileName(), 20);
1420 d->filename.refresh();
1422 // check the read-only status before moving the file as a backup
1423 if (d->filename.exists()) {
1424 bool const read_only = !d->filename.isWritable();
1426 Alert::warning(_("File is read-only"),
1427 bformat(_("The file %1$s cannot be written because it "
1428 "is marked as read-only."), file));
1433 // ask if the disk file has been externally modified (use checksum method)
1434 if (fileName().exists() && isChecksumModified()) {
1436 bformat(_("Document %1$s has been externally modified. "
1437 "Are you sure you want to overwrite this file?"), file);
1438 int const ret = Alert::prompt(_("Overwrite modified file?"),
1439 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1444 // We don't need autosaves in the immediate future. (Asger)
1445 resetAutosaveTimers();
1447 // if the file does not yet exist, none of the backup activity
1448 // that follows is necessary
1449 if (!fileName().exists()) {
1450 if (!writeFile(fileName()))
1456 // we first write the file to a new name, then move it to its
1457 // proper location once that has been done successfully. that
1458 // way we preserve the original file if something goes wrong.
1459 string const justname = fileName().onlyFileNameWithoutExt();
1460 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1461 justname + "-XXXXXX.lyx");
1462 bool const symlink = fileName().isSymLink();
1464 tempfile->setAutoRemove(false);
1466 FileName savefile(tempfile->name());
1467 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1468 if (!savefile.clonePermissions(fileName()))
1469 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1471 if (!writeFile(savefile))
1474 // we will set this to false if we fail
1475 bool made_backup = true;
1477 FileName backupName;
1478 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1480 if (d->need_format_backup)
1481 backupName = getBackupName();
1483 // If we for some reason failed to find a backup name in case of
1484 // a format change, this will still set one. It's the best we can
1486 if (backupName.empty()) {
1487 backupName.set(fileName().absFileName() + "~");
1488 if (!lyxrc.backupdir_path.empty()) {
1489 string const mangledName =
1490 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1491 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1495 LYXERR(Debug::FILES, "Backing up original file to " <<
1496 backupName.absFileName());
1497 // Except file is symlink do not copy because of #6587.
1498 // Hard links have bad luck.
1499 made_backup = symlink ?
1500 fileName().copyTo(backupName):
1501 fileName().moveTo(backupName);
1504 Alert::error(_("Backup failure"),
1505 bformat(_("Cannot create backup file %1$s.\n"
1506 "Please check whether the directory exists and is writable."),
1507 from_utf8(backupName.absFileName())));
1508 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1509 } else if (d->need_format_backup) {
1510 // the original file has been backed up successfully, so we
1511 // will not need to do that again
1512 d->need_format_backup = false;
1516 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1517 // Only do this if tempfile is not in autoremove mode
1520 // If we have no symlink, we can simply rename the temp file.
1521 // Otherwise, we need to copy it so the symlink stays intact.
1522 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1523 savefile.moveTo(fileName()))
1525 // saveCheckSum() was already called by writeFile(), but the
1526 // time stamp is invalidated by copying/moving
1529 if (d->file_format != LYX_FORMAT)
1530 // the file associated with this buffer is now in the current format
1531 d->file_format = LYX_FORMAT;
1534 // else we saved the file, but failed to move it to the right location.
1536 if (needBackup && made_backup && !symlink) {
1537 // the original file was moved to some new location, so it will look
1538 // to the user as if it was deleted. (see bug #9234.) we could try
1539 // to restore it, but that would basically mean trying to do again
1540 // what we just failed to do. better to leave things as they are.
1541 Alert::error(_("Write failure"),
1542 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1543 "But LyX could not move it to:\n %2$s.\n"
1544 "Your original file has been backed up to:\n %3$s"),
1545 from_utf8(savefile.absFileName()),
1546 from_utf8(fileName().absFileName()),
1547 from_utf8(backupName.absFileName())));
1549 // either we did not try to make a backup, or else we tried and failed,
1550 // or else the original file was a symlink, in which case it was copied,
1551 // not moved. so the original file is intact.
1552 Alert::error(_("Write failure"),
1553 bformat(_("Cannot move saved file to:\n %1$s.\n"
1554 "But the file has successfully been saved as:\n %2$s."),
1555 from_utf8(fileName().absFileName()),
1556 from_utf8(savefile.absFileName())));
1562 bool Buffer::writeFile(FileName const & fname) const
1564 if (d->read_only && fname == d->filename)
1567 bool retval = false;
1569 docstring const str = bformat(_("Saving document %1$s..."),
1570 makeDisplayPath(fname.absFileName()));
1573 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1575 if (params().compressed) {
1576 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1577 retval = ofs && write(ofs);
1579 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1580 retval = ofs && write(ofs);
1584 message(str + _(" could not write file!"));
1589 // removeAutosaveFile();
1592 message(str + _(" done."));
1598 docstring Buffer::emergencyWrite()
1600 // No need to save if the buffer has not changed.
1604 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1606 docstring user_message = bformat(
1607 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1609 // We try to save three places:
1610 // 1) Same place as document. Unless it is an unnamed doc.
1612 string s = absFileName();
1615 if (writeFile(FileName(s))) {
1617 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1618 return user_message;
1620 user_message += " " + _("Save failed! Trying again...\n");
1624 // 2) In HOME directory.
1625 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1627 lyxerr << ' ' << s << endl;
1628 if (writeFile(FileName(s))) {
1630 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1631 return user_message;
1634 user_message += " " + _("Save failed! Trying yet again...\n");
1636 // 3) In "/tmp" directory.
1637 // MakeAbsPath to prepend the current
1638 // drive letter on OS/2
1639 s = addName(package().temp_dir().absFileName(), absFileName());
1641 lyxerr << ' ' << s << endl;
1642 if (writeFile(FileName(s))) {
1644 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1645 return user_message;
1648 user_message += " " + _("Save failed! Document is lost.");
1651 return user_message;
1655 bool Buffer::write(ostream & ofs) const
1658 // Use the standard "C" locale for file output.
1659 ofs.imbue(locale::classic());
1662 // The top of the file should not be written by params().
1664 // write out a comment in the top of the file
1665 // Important: Keep the version formatting in sync with lyx2lyx and
1666 // tex2lyx (bug 7951)
1667 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1668 << " created this file. For more info see https://www.lyx.org/\n"
1669 << "\\lyxformat " << LYX_FORMAT << "\n"
1670 << "\\begin_document\n";
1672 /// For each author, set 'used' to true if there is a change
1673 /// by this author in the document; otherwise set it to 'false'.
1674 for (Author const & a : params().authors())
1677 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1678 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1679 for ( ; it != end; ++it)
1680 it->checkAuthors(params().authors());
1682 // now write out the buffer parameters.
1683 ofs << "\\begin_header\n";
1684 params().writeFile(ofs, this);
1685 ofs << "\\end_header\n";
1688 ofs << "\n\\begin_body\n";
1690 ofs << "\n\\end_body\n";
1692 // Write marker that shows file is complete
1693 ofs << "\\end_document" << endl;
1695 // Shouldn't really be needed....
1698 // how to check if close went ok?
1699 // Following is an attempt... (BE 20001011)
1701 // good() returns false if any error occurred, including some
1702 // formatting error.
1703 // bad() returns true if something bad happened in the buffer,
1704 // which should include file system full errors.
1709 lyxerr << "File was not closed properly." << endl;
1716 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1717 string const & original_path,
1718 OutputParams const & runparams_in,
1719 OutputWhat output) const
1721 OutputParams runparams = runparams_in;
1723 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1724 // Check here, because the "flavor" is not known in BufferParams::encoding()
1725 // (power users can override this safety measure selecting "utf8-plain").
1726 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1727 && (runparams.encoding->name() != "utf8-plain"))
1728 runparams.encoding = encodings.fromLyXName("ascii");
1730 string const encoding = runparams.encoding->iconvName();
1731 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1734 try { ofs.reset(encoding); }
1735 catch (iconv_codecvt_facet_exception const & e) {
1736 lyxerr << "Caught iconv exception: " << e.what() << endl;
1737 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1738 "verify that the support software for your encoding (%1$s) is "
1739 "properly installed"), from_ascii(encoding)));
1742 if (!openFileWrite(ofs, fname))
1745 ErrorList & errorList = d->errorLists["Export"];
1747 ExportStatus status = ExportSuccess;
1750 // make sure we are ready to export
1751 // this needs to be done before we validate
1752 // FIXME Do we need to do this all the time? I.e., in children
1753 // of a master we are exporting?
1755 updateMacroInstances(OutputUpdate);
1757 ExportStatus retval;
1759 retval = writeLaTeXSource(os, original_path, runparams, output);
1760 if (retval == ExportKilled)
1761 return ExportKilled;
1763 catch (EncodingException const & e) {
1764 docstring const failed(1, e.failed_char);
1766 oss << "0x" << hex << e.failed_char << dec;
1767 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1768 docstring msg = bformat(_("Uncodable character '%1$s'"
1769 " (code point %2$s)"),
1770 failed, from_utf8(oss.str()));
1771 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1772 "representable in specific verbatim contexts.\n"
1773 "Changing the document encoding to utf8 could help."),
1774 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1776 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1777 " (code point %2$s)"),
1778 failed, from_utf8(oss.str()));
1779 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1780 "representable in the chosen encoding.\n"
1781 "Changing the document encoding to utf8 could help."),
1782 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1784 status = ExportError;
1786 catch (iconv_codecvt_facet_exception const & e) {
1787 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1789 status = ExportError;
1791 catch (exception const & e) {
1792 errorList.push_back(ErrorItem(_("conversion failed"),
1794 lyxerr << e.what() << endl;
1795 status = ExportError;
1798 lyxerr << "Caught some really weird exception..." << endl;
1802 d->texrow = move(os.texrow());
1806 status = ExportError;
1807 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1810 if (runparams_in.silent)
1818 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1819 string const & original_path,
1820 OutputParams const & runparams_in,
1821 OutputWhat output) const
1823 // The child documents, if any, shall be already loaded at this point.
1825 OutputParams runparams = runparams_in;
1827 // XeTeX with TeX fonts is only safe with ASCII encoding,
1828 // Check here, because the "flavor" is not known in BufferParams::encoding()
1829 // (power users can override this safety measure selecting "utf8-plain").
1830 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1831 && (runparams.encoding->name() != "utf8-plain"))
1832 runparams.encoding = encodings.fromLyXName("ascii");
1833 // FIXME: when only the current paragraph is shown, this is ignored
1834 // (or not reached) and characters encodable in the current
1835 // encoding are not converted to ASCII-representation.
1837 // Some macros rely on font encoding
1838 runparams.main_fontenc = params().main_font_encoding();
1840 // If we are compiling a file standalone, even if this is the
1841 // child of some other buffer, let's cut the link here, so the
1842 // file is really independent and no concurring settings from
1843 // the master (e.g. branch state) interfere (see #8100).
1844 if (!runparams.is_child)
1845 d->ignore_parent = true;
1847 // Classify the unicode characters appearing in math insets
1848 BufferEncodings::initUnicodeMath(*this);
1850 // validate the buffer.
1851 LYXERR(Debug::LATEX, " Validating buffer...");
1852 LaTeXFeatures features(*this, params(), runparams);
1854 // This is only set once per document (in master)
1855 if (!runparams.is_child)
1856 runparams.use_polyglossia = features.usePolyglossia();
1857 LYXERR(Debug::LATEX, " Buffer validation done.");
1859 bool const output_preamble =
1860 output == FullSource || output == OnlyPreamble;
1861 bool const output_body =
1862 output == FullSource || output == OnlyBody;
1864 // The starting paragraph of the coming rows is the
1865 // first paragraph of the document. (Asger)
1866 if (output_preamble && runparams.nice) {
1867 os << "%% LyX " << lyx_version << " created this file. "
1868 "For more info, see https://www.lyx.org/.\n"
1869 "%% Do not edit unless you really know what "
1872 LYXERR(Debug::INFO, "lyx document header finished");
1874 // There are a few differences between nice LaTeX and usual files:
1875 // usual files have \batchmode and special input@path to allow
1876 // inclusion of figures specified by an explicitly relative path
1877 // (i.e., a path starting with './' or '../') with either \input or
1878 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1879 // input@path is set when the actual parameter original_path is set.
1880 // This is done for usual tex-file, but not for nice-latex-file.
1881 // (Matthias 250696)
1882 // Note that input@path is only needed for something the user does
1883 // in the preamble, included .tex files or ERT, files included by
1884 // LyX work without it.
1885 if (output_preamble) {
1886 if (!runparams.nice) {
1887 // code for usual, NOT nice-latex-file
1888 os << "\\batchmode\n"; // changed from \nonstopmode
1890 if (!original_path.empty()) {
1892 // We don't know the encoding of inputpath
1893 docstring const inputpath = from_utf8(original_path);
1894 docstring uncodable_glyphs;
1895 Encoding const * const enc = runparams.encoding;
1897 for (size_t n = 0; n < inputpath.size(); ++n) {
1898 if (!enc->encodable(inputpath[n])) {
1899 docstring const glyph(1, inputpath[n]);
1900 LYXERR0("Uncodable character '"
1902 << "' in input path!");
1903 uncodable_glyphs += glyph;
1908 // warn user if we found uncodable glyphs.
1909 if (!uncodable_glyphs.empty()) {
1910 frontend::Alert::warning(
1911 _("Uncodable character in file path"),
1913 _("The path of your document\n"
1915 "contains glyphs that are unknown "
1916 "in the current document encoding "
1917 "(namely %2$s). This may result in "
1918 "incomplete output, unless "
1919 "TEXINPUTS contains the document "
1920 "directory and you don't use "
1921 "explicitly relative paths (i.e., "
1922 "paths starting with './' or "
1923 "'../') in the preamble or in ERT."
1924 "\n\nIn case of problems, choose "
1925 "an appropriate document encoding\n"
1926 "(such as utf8) or change the "
1928 inputpath, uncodable_glyphs));
1930 string docdir = os::latex_path(original_path);
1931 if (contains(docdir, '#')) {
1932 docdir = subst(docdir, "#", "\\#");
1933 os << "\\catcode`\\#=11"
1934 "\\def\\#{#}\\catcode`\\#=6\n";
1936 if (contains(docdir, '%')) {
1937 docdir = subst(docdir, "%", "\\%");
1938 os << "\\catcode`\\%=11"
1939 "\\def\\%{%}\\catcode`\\%=14\n";
1941 bool const detokenize = !isAscii(from_utf8(docdir));
1942 bool const quote = contains(docdir, ' ');
1943 os << "\\makeatletter\n"
1944 << "\\def\\input@path{{";
1946 os << "\\detokenize{";
1955 << "\\makeatother\n";
1959 // get parent macros (if this buffer has a parent) which will be
1960 // written at the document begin further down.
1961 MacroSet parentMacros;
1962 listParentMacros(parentMacros, features);
1964 // Write the preamble
1965 runparams.use_babel = params().writeLaTeX(os, features,
1966 d->filename.onlyPath());
1968 // Biblatex bibliographies are loaded here
1969 if (params().useBiblatex()) {
1970 vector<docstring> const bibfiles =
1971 prepareBibFilePaths(runparams, getBibfiles(), true);
1972 for (docstring const & file: bibfiles)
1973 os << "\\addbibresource{" << file << "}\n";
1976 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1977 && !features.hasOnlyPolyglossiaLanguages()) {
1980 vector<string> bll = features.getBabelExclusiveLanguages();
1981 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1984 for (string const & sit : bll) {
1989 blangs = bll.size() > 1 ?
1990 bformat(_("The languages %1$s are only supported by Babel."), langs)
1991 : bformat(_("The language %1$s is only supported by Babel."), langs);
1995 for (string const & pit : pll) {
2000 plangs = pll.size() > 1 ?
2001 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2002 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2003 if (!blangs.empty())
2007 frontend::Alert::warning(
2008 _("Incompatible Languages!"),
2010 _("You cannot use the following languages "
2011 "together in one LaTeX document because "
2012 "they require conflicting language packages:\n"
2017 // Japanese might be required only in some children of a document,
2018 // but once required, we must keep use_japanese true.
2019 runparams.use_japanese |= features.isRequired("japanese");
2022 // Restore the parenthood if needed
2023 if (!runparams.is_child)
2024 d->ignore_parent = false;
2025 return ExportSuccess;
2029 // mark the beginning of the body to separate it from InPreamble insets
2030 os.texrow().start(TexRow::beginDocument());
2031 os << "\\begin{document}\n";
2033 // mark the start of a new paragraph by simulating a newline,
2034 // so that os.afterParbreak() returns true at document start
2037 // output the parent macros
2038 for (auto const & mac : parentMacros) {
2039 int num_lines = mac->write(os.os(), true);
2040 os.texrow().newlines(num_lines);
2043 } // output_preamble
2045 LYXERR(Debug::INFO, "preamble finished, now the body.");
2049 latexParagraphs(*this, text(), os, runparams);
2051 catch (ConversionException const &) { return ExportKilled; }
2053 // Restore the parenthood if needed
2054 if (!runparams.is_child)
2055 d->ignore_parent = false;
2057 // add this just in case after all the paragraphs
2060 if (output_preamble) {
2061 os << "\\end{document}\n";
2062 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2064 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2066 runparams_in.encoding = runparams.encoding;
2068 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2069 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2070 return ExportSuccess;
2074 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2075 OutputParams const & runparams,
2076 OutputWhat output) const
2078 LYXERR(Debug::LATEX, "makeDocBookFile...");
2081 if (!openFileWrite(ofs, fname))
2084 // make sure we are ready to export
2085 // this needs to be done before we validate
2087 updateMacroInstances(OutputUpdate);
2089 ExportStatus const retval =
2090 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2091 if (retval == ExportKilled)
2092 return ExportKilled;
2096 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2097 return ExportSuccess;
2101 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2102 OutputParams const & runparams,
2103 OutputWhat output) const
2105 LaTeXFeatures features(*this, params(), runparams);
2110 DocumentClass const & tclass = params().documentClass();
2111 string const & top_element = tclass.latexname();
2113 bool const output_preamble =
2114 output == FullSource || output == OnlyPreamble;
2115 bool const output_body =
2116 output == FullSource || output == OnlyBody;
2118 if (output_preamble) {
2119 if (runparams.flavor == OutputParams::XML)
2120 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2123 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2126 if (! tclass.class_header().empty())
2127 os << from_ascii(tclass.class_header());
2128 else if (runparams.flavor == OutputParams::XML)
2129 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2130 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2132 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2134 docstring preamble = params().preamble;
2135 if (runparams.flavor != OutputParams::XML ) {
2136 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2137 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2138 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2139 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2142 string const name = runparams.nice
2143 ? changeExtension(absFileName(), ".sgml") : fname;
2144 preamble += features.getIncludedFiles(name);
2145 preamble += features.getLyXSGMLEntities();
2147 if (!preamble.empty()) {
2148 os << "\n [ " << preamble << " ]";
2154 string top = top_element;
2156 if (runparams.flavor == OutputParams::XML)
2157 top += params().language->code();
2159 top += params().language->code().substr(0, 2);
2162 if (!params().options.empty()) {
2164 top += params().options;
2167 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2168 << " file was created by LyX " << lyx_version
2169 << "\n See https://www.lyx.org/ for more information -->\n";
2171 params().documentClass().counters().reset();
2173 sgml::openTag(os, top);
2176 docbookParagraphs(text(), *this, os, runparams);
2178 catch (ConversionException const &) { return ExportKilled; }
2179 sgml::closeTag(os, top_element);
2181 return ExportSuccess;
2185 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2186 OutputParams const & runparams) const
2188 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2191 if (!openFileWrite(ofs, fname))
2194 // make sure we are ready to export
2195 // this has to be done before we validate
2196 updateBuffer(UpdateMaster, OutputUpdate);
2197 updateMacroInstances(OutputUpdate);
2199 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2200 if (retval == ExportKilled)
2205 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2210 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2211 OutputParams const & runparams,
2212 OutputWhat output) const
2214 LaTeXFeatures features(*this, params(), runparams);
2216 d->bibinfo_.makeCitationLabels(*this);
2218 bool const output_preamble =
2219 output == FullSource || output == OnlyPreamble;
2220 bool const output_body =
2221 output == FullSource || output == OnlyBody || output == IncludedFile;
2223 if (output_preamble) {
2224 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2225 << "<!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"
2226 // FIXME Language should be set properly.
2227 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2229 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2230 // FIXME Presumably need to set this right
2231 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2233 docstring const & doctitle = features.htmlTitle();
2235 << (doctitle.empty() ?
2236 from_ascii("LyX Document") :
2237 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2240 docstring styles = features.getTClassHTMLPreamble();
2241 if (!styles.empty())
2242 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2244 styles = features.getPreambleSnippets().str;
2245 if (!styles.empty())
2246 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2248 // we will collect CSS information in a stream, and then output it
2249 // either here, as part of the header, or else in a separate file.
2250 odocstringstream css;
2251 styles = features.getCSSSnippets();
2252 if (!styles.empty())
2253 css << "/* LyX Provided Styles */\n" << styles << '\n';
2255 styles = features.getTClassHTMLStyles();
2256 if (!styles.empty())
2257 css << "/* Layout-provided Styles */\n" << styles << '\n';
2259 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2260 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2261 if (needfg || needbg) {
2262 css << "\nbody {\n";
2265 << from_ascii(X11hexname(params().fontcolor))
2268 css << " background-color: "
2269 << from_ascii(X11hexname(params().backgroundcolor))
2274 docstring const dstyles = css.str();
2275 if (!dstyles.empty()) {
2276 bool written = false;
2277 if (params().html_css_as_file) {
2278 // open a file for CSS info
2280 string const fcssname = addName(temppath(), "docstyle.css");
2281 FileName const fcssfile = FileName(fcssname);
2282 if (openFileWrite(ocss, fcssfile)) {
2286 // write link to header
2287 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2289 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2292 // we are here if the CSS is supposed to be written to the header
2293 // or if we failed to write it to an external file.
2295 os << "<style type='text/css'>\n"
2304 bool const output_body_tag = (output != IncludedFile);
2305 if (output_body_tag)
2306 os << "<body dir=\"auto\">\n";
2308 if (output != IncludedFile)
2309 // if we're an included file, the counters are in the master.
2310 params().documentClass().counters().reset();
2312 xhtmlParagraphs(text(), *this, xs, runparams);
2314 catch (ConversionException const &) { return ExportKilled; }
2315 if (output_body_tag)
2319 if (output_preamble)
2322 return ExportSuccess;
2326 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2327 // Other flags: -wall -v0 -x
2328 int Buffer::runChktex()
2332 // get LaTeX-Filename
2333 FileName const path(temppath());
2334 string const name = addName(path.absFileName(), latexName());
2335 string const org_path = filePath();
2337 PathChanger p(path); // path to LaTeX file
2338 message(_("Running chktex..."));
2340 // Generate the LaTeX file if neccessary
2341 OutputParams runparams(¶ms().encoding());
2342 runparams.flavor = OutputParams::LATEX;
2343 runparams.nice = false;
2344 runparams.linelen = lyxrc.plaintext_linelen;
2345 ExportStatus const retval =
2346 makeLaTeXFile(FileName(name), org_path, runparams);
2347 if (retval != ExportSuccess) {
2348 // error code on failure
2353 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2354 int const res = chktex.run(terr); // run chktex
2357 Alert::error(_("chktex failure"),
2358 _("Could not run chktex successfully."));
2360 ErrorList & errlist = d->errorLists["ChkTeX"];
2362 bufferErrors(terr, errlist);
2367 if (runparams.silent)
2368 d->errorLists["ChkTeX"].clear();
2376 void Buffer::validate(LaTeXFeatures & features) const
2378 // Validate the buffer params, but not for included
2379 // files, since they also use the parent buffer's
2381 if (!features.runparams().is_child)
2382 params().validate(features);
2384 for (Paragraph const & p : paragraphs())
2385 p.validate(features);
2387 if (lyxerr.debugging(Debug::LATEX)) {
2388 features.showStruct();
2393 void Buffer::getLabelList(vector<docstring> & list) const
2395 // If this is a child document, use the master's list instead.
2397 masterBuffer()->getLabelList(list);
2402 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2403 for (auto const & tocit : *toc) {
2404 if (tocit.depth() == 0)
2405 list.push_back(tocit.str());
2410 void Buffer::invalidateBibinfoCache() const
2412 d->bibinfo_cache_valid_ = false;
2413 d->cite_labels_valid_ = false;
2414 removeBiblioTempFiles();
2415 // also invalidate the cache for the parent buffer
2416 Buffer const * const pbuf = d->parent();
2418 pbuf->invalidateBibinfoCache();
2422 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2424 // FIXME This is probably unnecessary, given where we call this.
2425 // If this is a child document, use the master instead.
2426 Buffer const * const pbuf = masterBuffer();
2427 if (pbuf != this && scope != UpdateChildOnly)
2428 return pbuf->getBibfiles();
2430 // In 2.3.x, we have:
2431 //if (!d->bibfile_cache_valid_)
2432 // this->updateBibfilesCache(scope);
2433 // I think that is a leftover, but there have been so many back-
2434 // and-forths with this, due to Windows issues, that I am not sure.
2436 return d->bibfiles_cache_;
2440 BiblioInfo const & Buffer::masterBibInfo() const
2442 Buffer const * const tmp = masterBuffer();
2444 return tmp->masterBibInfo();
2449 BiblioInfo const & Buffer::bibInfo() const
2455 void Buffer::registerBibfiles(const docstring_list & bf) const
2457 // We register the bib files in the master buffer,
2458 // if there is one, but also in every single buffer,
2459 // in case a child is compiled alone.
2460 Buffer const * const tmp = masterBuffer();
2462 tmp->registerBibfiles(bf);
2464 for (auto const & p : bf) {
2465 docstring_list::const_iterator temp =
2466 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2467 if (temp == d->bibfiles_cache_.end())
2468 d->bibfiles_cache_.push_back(p);
2473 static map<docstring, FileName> bibfileCache;
2475 FileName Buffer::getBibfilePath(docstring const & bibid) const
2477 map<docstring, FileName>::const_iterator it =
2478 bibfileCache.find(bibid);
2479 if (it != bibfileCache.end()) {
2480 // i.e., bibfileCache[bibid]
2484 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2485 string texfile = changeExtension(to_utf8(bibid), "bib");
2486 // note that, if the filename can be found directly from the path,
2487 // findtexfile will just return a FileName object for that path.
2488 FileName file(findtexfile(texfile, "bib"));
2490 file = FileName(makeAbsPath(texfile, filePath()));
2491 LYXERR(Debug::FILES, "Found at: " << file);
2493 bibfileCache[bibid] = file;
2494 return bibfileCache[bibid];
2498 void Buffer::checkIfBibInfoCacheIsValid() const
2500 // use the master's cache
2501 Buffer const * const tmp = masterBuffer();
2503 tmp->checkIfBibInfoCacheIsValid();
2507 // If we already know the cache is invalid, stop here.
2508 // This is important in the case when the bibliography
2509 // environment (rather than Bib[la]TeX) is used.
2510 // In that case, the timestamp check below gives no
2511 // sensible result. Rather than that, the cache will
2512 // be invalidated explicitly via invalidateBibInfoCache()
2513 // by the Bibitem inset.
2514 // Same applies for bib encoding changes, which trigger
2515 // invalidateBibInfoCache() by InsetBibtex.
2516 if (!d->bibinfo_cache_valid_)
2519 if (d->have_bibitems_) {
2520 // We have a bibliography environment.
2521 // Invalidate the bibinfo cache unconditionally.
2522 // Cite labels will get invalidated by the inset if needed.
2523 d->bibinfo_cache_valid_ = false;
2527 // OK. This is with Bib(la)tex. We'll assume the cache
2528 // is valid and change this if we find changes in the bibs.
2529 d->bibinfo_cache_valid_ = true;
2530 d->cite_labels_valid_ = true;
2532 // compare the cached timestamps with the actual ones.
2533 docstring_list const & bibfiles_cache = getBibfiles();
2534 for (auto const & bf : bibfiles_cache) {
2535 FileName const fn = getBibfilePath(bf);
2536 time_t lastw = fn.lastModified();
2537 time_t prevw = d->bibfile_status_[fn];
2538 if (lastw != prevw) {
2539 d->bibinfo_cache_valid_ = false;
2540 d->cite_labels_valid_ = false;
2541 d->bibfile_status_[fn] = lastw;
2547 void Buffer::clearBibFileCache() const
2549 bibfileCache.clear();
2553 void Buffer::reloadBibInfoCache(bool const force) const
2555 // we should not need to do this for internal buffers
2559 // use the master's cache
2560 Buffer const * const tmp = masterBuffer();
2562 tmp->reloadBibInfoCache(force);
2567 checkIfBibInfoCacheIsValid();
2568 if (d->bibinfo_cache_valid_)
2572 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2573 // re-read file locations when this info changes
2574 // FIXME Is this sufficient? Or should we also force that
2575 // in some other cases? If so, then it is easy enough to
2576 // add the following line in some other places.
2577 clearBibFileCache();
2578 d->bibinfo_.clear();
2579 FileNameList checkedFiles;
2580 d->have_bibitems_ = false;
2581 collectBibKeys(checkedFiles);
2582 d->bibinfo_cache_valid_ = true;
2586 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2588 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2589 it->collectBibKeys(it, checkedFiles);
2590 if (it->lyxCode() == BIBITEM_CODE) {
2592 parent()->d->have_bibitems_ = true;
2594 d->have_bibitems_ = true;
2600 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2602 // We add the biblio info to the master buffer,
2603 // if there is one, but also to every single buffer,
2604 // in case a child is compiled alone.
2605 BiblioInfo & bi = d->bibinfo_;
2606 bi.mergeBiblioInfo(bin);
2608 if (parent() != 0) {
2609 BiblioInfo & masterbi = parent()->d->bibinfo_;
2610 masterbi.mergeBiblioInfo(bin);
2615 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2617 // We add the bibtex info to the master buffer,
2618 // if there is one, but also to every single buffer,
2619 // in case a child is compiled alone.
2620 BiblioInfo & bi = d->bibinfo_;
2623 if (parent() != 0) {
2624 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2625 masterbi[key] = bin;
2630 void Buffer::makeCitationLabels() const
2632 Buffer const * const master = masterBuffer();
2633 return d->bibinfo_.makeCitationLabels(*master);
2637 void Buffer::invalidateCiteLabels() const
2639 masterBuffer()->d->cite_labels_valid_ = false;
2642 bool Buffer::citeLabelsValid() const
2644 return masterBuffer()->d->cite_labels_valid_;
2648 void Buffer::removeBiblioTempFiles() const
2650 // We remove files that contain LaTeX commands specific to the
2651 // particular bibliographic style being used, in order to avoid
2652 // LaTeX errors when we switch style.
2653 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2654 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2655 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2656 aux_file.removeFile();
2657 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2658 bbl_file.removeFile();
2659 // Also for the parent buffer
2660 Buffer const * const pbuf = parent();
2662 pbuf->removeBiblioTempFiles();
2666 bool Buffer::isDepClean(string const & name) const
2668 DepClean::const_iterator const it = d->dep_clean.find(name);
2669 if (it == d->dep_clean.end())
2675 void Buffer::markDepClean(string const & name)
2677 d->dep_clean[name] = true;
2681 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2684 // FIXME? if there is an Buffer LFUN that can be dispatched even
2685 // if internal, put a switch '(cmd.action)' here.
2691 switch (cmd.action()) {
2693 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2694 flag.setOnOff(hasReadonlyFlag());
2697 // FIXME: There is need for a command-line import.
2698 //case LFUN_BUFFER_IMPORT:
2700 case LFUN_BUFFER_AUTO_SAVE:
2703 case LFUN_BUFFER_EXPORT_CUSTOM:
2704 // FIXME: Nothing to check here?
2707 case LFUN_BUFFER_EXPORT: {
2708 docstring const arg = cmd.argument();
2709 if (arg == "custom") {
2713 string format = (arg.empty() || arg == "default") ?
2714 params().getDefaultOutputFormat() : to_utf8(arg);
2715 size_t pos = format.find(' ');
2716 if (pos != string::npos)
2717 format = format.substr(0, pos);
2718 enable = params().isExportable(format, false);
2720 flag.message(bformat(
2721 _("Don't know how to export to format: %1$s"), arg));
2725 case LFUN_BUILD_PROGRAM:
2726 enable = params().isExportable("program", false);
2729 case LFUN_BRANCH_ACTIVATE:
2730 case LFUN_BRANCH_DEACTIVATE:
2731 case LFUN_BRANCH_MASTER_ACTIVATE:
2732 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2733 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2734 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2735 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2736 : params().branchlist();
2737 docstring const branchName = cmd.argument();
2738 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2742 case LFUN_BRANCH_ADD:
2743 case LFUN_BRANCHES_RENAME:
2744 // if no Buffer is present, then of course we won't be called!
2747 case LFUN_BUFFER_LANGUAGE:
2748 enable = !isReadonly();
2751 case LFUN_BUFFER_VIEW_CACHE:
2752 (d->preview_file_).refresh();
2753 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2756 case LFUN_CHANGES_TRACK:
2757 flag.setEnabled(true);
2758 flag.setOnOff(params().track_changes);
2761 case LFUN_CHANGES_OUTPUT:
2762 flag.setEnabled(true);
2763 flag.setOnOff(params().output_changes);
2766 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2767 flag.setOnOff(params().compressed);
2770 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2771 flag.setOnOff(params().output_sync);
2774 case LFUN_BUFFER_ANONYMIZE:
2780 flag.setEnabled(enable);
2785 void Buffer::dispatch(string const & command, DispatchResult & result)
2787 return dispatch(lyxaction.lookupFunc(command), result);
2791 // NOTE We can end up here even if we have no GUI, because we are called
2792 // by LyX::exec to handled command-line requests. So we may need to check
2793 // whether we have a GUI or not. The boolean use_gui holds this information.
2794 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2797 // FIXME? if there is an Buffer LFUN that can be dispatched even
2798 // if internal, put a switch '(cmd.action())' here.
2799 dr.dispatched(false);
2802 string const argument = to_utf8(func.argument());
2803 // We'll set this back to false if need be.
2804 bool dispatched = true;
2805 // This handles undo groups automagically
2806 UndoGroupHelper ugh(this);
2808 switch (func.action()) {
2809 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2810 if (lyxvc().inUse()) {
2811 string log = lyxvc().toggleReadOnly();
2816 setReadonly(!hasReadonlyFlag());
2819 case LFUN_BUFFER_EXPORT: {
2820 string const format = (argument.empty() || argument == "default") ?
2821 params().getDefaultOutputFormat() : argument;
2822 ExportStatus const status = doExport(format, false);
2823 dr.setError(status != ExportSuccess);
2824 if (status != ExportSuccess)
2825 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2826 from_utf8(format)));
2830 case LFUN_BUILD_PROGRAM: {
2831 ExportStatus const status = doExport("program", true);
2832 dr.setError(status != ExportSuccess);
2833 if (status != ExportSuccess)
2834 dr.setMessage(_("Error generating literate programming code."));
2838 case LFUN_BUFFER_EXPORT_CUSTOM: {
2840 string command = split(argument, format_name, ' ');
2841 Format const * format = theFormats().getFormat(format_name);
2843 lyxerr << "Format \"" << format_name
2844 << "\" not recognized!"
2849 // The name of the file created by the conversion process
2852 // Output to filename
2853 if (format->name() == "lyx") {
2854 string const latexname = latexName(false);
2855 filename = changeExtension(latexname,
2856 format->extension());
2857 filename = addName(temppath(), filename);
2859 if (!writeFile(FileName(filename)))
2863 doExport(format_name, true, filename);
2866 // Substitute $$FName for filename
2867 if (!contains(command, "$$FName"))
2868 command = "( " + command + " ) < $$FName";
2869 command = subst(command, "$$FName", filename);
2871 // Execute the command in the background
2873 call.startscript(Systemcall::DontWait, command,
2874 filePath(), layoutPos());
2878 // FIXME: There is need for a command-line import.
2880 case LFUN_BUFFER_IMPORT:
2885 case LFUN_BUFFER_AUTO_SAVE:
2887 resetAutosaveTimers();
2890 case LFUN_BRANCH_ACTIVATE:
2891 case LFUN_BRANCH_DEACTIVATE:
2892 case LFUN_BRANCH_MASTER_ACTIVATE:
2893 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2894 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2895 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2896 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2899 docstring const branch_name = func.argument();
2900 // the case without a branch name is handled elsewhere
2901 if (branch_name.empty()) {
2905 Branch * branch = buf->params().branchlist().find(branch_name);
2907 LYXERR0("Branch " << branch_name << " does not exist.");
2909 docstring const msg =
2910 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2914 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2915 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2916 if (branch->isSelected() != activate) {
2917 buf->undo().recordUndoBufferParams(CursorData());
2918 branch->setSelected(activate);
2920 dr.screenUpdate(Update::Force);
2921 dr.forceBufferUpdate();
2926 case LFUN_BRANCH_ADD: {
2927 docstring branchnames = func.argument();
2928 if (branchnames.empty()) {
2932 BranchList & branch_list = params().branchlist();
2933 vector<docstring> const branches =
2934 getVectorFromString(branchnames, branch_list.separator());
2936 for (docstring const & branch_name : branches) {
2937 Branch * branch = branch_list.find(branch_name);
2939 LYXERR0("Branch " << branch_name << " already exists.");
2943 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2945 undo().recordUndoBufferParams(CursorData());
2946 branch_list.add(branch_name);
2947 branch = branch_list.find(branch_name);
2948 string const x11hexname = X11hexname(branch->color());
2949 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2950 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2952 dr.screenUpdate(Update::Force);
2960 case LFUN_BRANCHES_RENAME: {
2961 if (func.argument().empty())
2964 docstring const oldname = from_utf8(func.getArg(0));
2965 docstring const newname = from_utf8(func.getArg(1));
2966 InsetIterator it = inset_iterator_begin(inset());
2967 InsetIterator const end = inset_iterator_end(inset());
2968 bool success = false;
2969 for (; it != end; ++it) {
2970 if (it->lyxCode() == BRANCH_CODE) {
2971 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2972 if (ins.branch() == oldname) {
2973 undo().recordUndo(CursorData(it));
2974 ins.rename(newname);
2979 if (it->lyxCode() == INCLUDE_CODE) {
2980 // get buffer of external file
2981 InsetInclude const & ins =
2982 static_cast<InsetInclude const &>(*it);
2983 Buffer * child = ins.getChildBuffer();
2986 child->dispatch(func, dr);
2991 dr.screenUpdate(Update::Force);
2992 dr.forceBufferUpdate();
2997 case LFUN_BUFFER_VIEW_CACHE:
2998 if (!theFormats().view(*this, d->preview_file_,
2999 d->preview_format_))
3000 dr.setMessage(_("Error viewing the output file."));
3003 case LFUN_CHANGES_TRACK:
3004 if (params().save_transient_properties)
3005 undo().recordUndoBufferParams(CursorData());
3006 params().track_changes = !params().track_changes;
3007 if (!params().track_changes)
3008 dr.forceChangesUpdate();
3011 case LFUN_CHANGES_OUTPUT:
3012 if (params().save_transient_properties)
3013 undo().recordUndoBufferParams(CursorData());
3014 params().output_changes = !params().output_changes;
3015 if (params().output_changes) {
3016 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3017 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3018 LaTeXFeatures::isAvailable("xcolor");
3020 if (!dvipost && !xcolorulem) {
3021 Alert::warning(_("Changes not shown in LaTeX output"),
3022 _("Changes will not be highlighted in LaTeX output, "
3023 "because neither dvipost nor xcolor/ulem are installed.\n"
3024 "Please install these packages or redefine "
3025 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3026 } else if (!xcolorulem) {
3027 Alert::warning(_("Changes not shown in LaTeX output"),
3028 _("Changes will not be highlighted in LaTeX output "
3029 "when using pdflatex, because xcolor and ulem are not installed.\n"
3030 "Please install both packages or redefine "
3031 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3036 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3037 // turn compression on/off
3038 undo().recordUndoBufferParams(CursorData());
3039 params().compressed = !params().compressed;
3042 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3043 undo().recordUndoBufferParams(CursorData());
3044 params().output_sync = !params().output_sync;
3047 case LFUN_BUFFER_ANONYMIZE: {
3048 undo().recordUndoFullBuffer(CursorData());
3049 CursorData cur(doc_iterator_begin(this));
3050 for ( ; cur ; cur.forwardPar())
3051 cur.paragraph().anonymize();
3052 dr.forceBufferUpdate();
3053 dr.screenUpdate(Update::Force);
3061 dr.dispatched(dispatched);
3065 void Buffer::changeLanguage(Language const * from, Language const * to)
3067 LASSERT(from, return);
3068 LASSERT(to, return);
3070 for_each(par_iterator_begin(),
3072 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3076 bool Buffer::isMultiLingual() const
3078 ParConstIterator end = par_iterator_end();
3079 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3080 if (it->isMultiLingual(params()))
3087 std::set<Language const *> Buffer::getLanguages() const
3089 std::set<Language const *> langs;
3090 getLanguages(langs);
3095 void Buffer::getLanguages(std::set<Language const *> & langs) const
3097 ParConstIterator end = par_iterator_end();
3098 // add the buffer language, even if it's not actively used
3099 langs.insert(language());
3100 // iterate over the paragraphs
3101 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3102 it->getLanguages(langs);
3104 ListOfBuffers clist = getDescendents();
3105 for (auto const & cit : clist)
3106 cit->getLanguages(langs);
3110 DocIterator Buffer::getParFromID(int const id) const
3112 Buffer * buf = const_cast<Buffer *>(this);
3114 // This means non-existent
3115 return doc_iterator_end(buf);
3117 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3118 if (it.paragraph().id() == id)
3121 return doc_iterator_end(buf);
3125 bool Buffer::hasParWithID(int const id) const
3127 return !getParFromID(id).atEnd();
3131 ParIterator Buffer::par_iterator_begin()
3133 return ParIterator(doc_iterator_begin(this));
3137 ParIterator Buffer::par_iterator_end()
3139 return ParIterator(doc_iterator_end(this));
3143 ParConstIterator Buffer::par_iterator_begin() const
3145 return ParConstIterator(doc_iterator_begin(this));
3149 ParConstIterator Buffer::par_iterator_end() const
3151 return ParConstIterator(doc_iterator_end(this));
3155 Language const * Buffer::language() const
3157 return params().language;
3161 docstring const Buffer::B_(string const & l10n) const
3163 return params().B_(l10n);
3167 bool Buffer::isClean() const
3169 return d->lyx_clean;
3173 bool Buffer::isChecksumModified() const
3175 LASSERT(d->filename.exists(), return false);
3176 return d->checksum_ != d->filename.checksum();
3180 void Buffer::saveCheckSum() const
3182 FileName const & file = d->filename;
3184 d->checksum_ = file.exists() ? file.checksum()
3185 : 0; // in the case of save to a new file.
3189 void Buffer::markClean() const
3191 if (!d->lyx_clean) {
3192 d->lyx_clean = true;
3195 // if the .lyx file has been saved, we don't need an
3197 d->bak_clean = true;
3198 d->undo_.markDirty();
3199 clearExternalModification();
3203 void Buffer::setUnnamed(bool flag)
3209 bool Buffer::isUnnamed() const
3216 /// Don't check unnamed, here: isInternal() is used in
3217 /// newBuffer(), where the unnamed flag has not been set by anyone
3218 /// yet. Also, for an internal buffer, there should be no need for
3219 /// retrieving fileName() nor for checking if it is unnamed or not.
3220 bool Buffer::isInternal() const
3222 return d->internal_buffer;
3226 void Buffer::setInternal(bool flag)
3228 d->internal_buffer = flag;
3232 void Buffer::markDirty()
3235 d->lyx_clean = false;
3238 d->bak_clean = false;
3240 for (auto & depit : d->dep_clean)
3241 depit.second = false;
3245 FileName Buffer::fileName() const
3251 string Buffer::absFileName() const
3253 return d->filename.absFileName();
3257 string Buffer::filePath() const
3259 string const abs = d->filename.onlyPath().absFileName();
3262 int last = abs.length() - 1;
3264 return abs[last] == '/' ? abs : abs + '/';
3268 DocFileName Buffer::getReferencedFileName(string const & fn) const
3271 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3272 result.set(fn, filePath());
3274 // filePath() ends with a path separator
3275 FileName const test(filePath() + fn);
3277 result.set(fn, filePath());
3279 result.set(fn, params().origin);
3286 string const Buffer::prepareFileNameForLaTeX(string const & name,
3287 string const & ext, bool nice) const
3289 string const fname = makeAbsPath(name, filePath()).absFileName();
3290 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3296 return to_utf8(makeRelPath(from_utf8(fname),
3297 from_utf8(masterBuffer()->filePath())));
3301 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3302 docstring_list const & bibfilelist,
3303 bool const add_extension) const
3305 // If we are processing the LaTeX file in a temp directory then
3306 // copy the .bib databases to this temp directory, mangling their
3307 // names in the process. Store this mangled name in the list of
3309 // (We need to do all this because BibTeX *really*, *really*
3310 // can't handle "files with spaces" and Windows users tend to
3311 // use such filenames.)
3312 // Otherwise, store the (maybe absolute) path to the original,
3313 // unmangled database name.
3315 vector<docstring> res;
3317 // determine the export format
3318 string const tex_format = flavor2format(runparams.flavor);
3320 // check for spaces in paths
3321 bool found_space = false;
3323 for (auto const & bit : bibfilelist) {
3324 string utf8input = to_utf8(bit);
3326 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3327 FileName try_in_file =
3328 makeAbsPath(database + ".bib", filePath());
3329 bool not_from_texmf = try_in_file.isReadableFile();
3330 // If the file has not been found, try with the real file name
3331 // (it might come from a child in a sub-directory)
3332 if (!not_from_texmf) {
3333 try_in_file = getBibfilePath(bit);
3334 if (try_in_file.isReadableFile()) {
3335 // Check if the file is in texmf
3336 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3337 not_from_texmf = kpsefile.empty()
3338 || kpsefile.absFileName() != try_in_file.absFileName();
3340 // If this exists, make path relative to the master
3343 removeExtension(prepareFileNameForLaTeX(
3344 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3345 from_utf8(filePath()))),
3346 ".bib", runparams.nice));
3350 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3352 // mangledFileName() needs the extension
3353 DocFileName const in_file = DocFileName(try_in_file);
3354 database = removeExtension(in_file.mangledFileName());
3355 FileName const out_file = makeAbsPath(database + ".bib",
3356 masterBuffer()->temppath());
3357 bool const success = in_file.copyTo(out_file);
3359 LYXERR0("Failed to copy '" << in_file
3360 << "' to '" << out_file << "'");
3362 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3363 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3364 if (!isValidLaTeXFileName(database)) {
3365 frontend::Alert::warning(_("Invalid filename"),
3366 _("The following filename will cause troubles "
3367 "when running the exported file through LaTeX: ") +
3368 from_utf8(database));
3370 if (!isValidDVIFileName(database)) {
3371 frontend::Alert::warning(_("Problematic filename for DVI"),
3372 _("The following filename can cause troubles "
3373 "when running the exported file through LaTeX "
3374 "and opening the resulting DVI: ") +
3375 from_utf8(database), true);
3383 docstring const path = from_utf8(latex_path(database));
3385 if (contains(path, ' '))
3388 if (find(res.begin(), res.end(), path) == res.end())
3389 res.push_back(path);
3392 // Check if there are spaces in the path and warn BibTeX users, if so.
3393 // (biber can cope with such paths)
3394 if (!prefixIs(runparams.bibtex_command, "biber")) {
3395 // Post this warning only once.
3396 static bool warned_about_spaces = false;
3397 if (!warned_about_spaces &&
3398 runparams.nice && found_space) {
3399 warned_about_spaces = true;
3400 Alert::warning(_("Export Warning!"),
3401 _("There are spaces in the paths to your BibTeX databases.\n"
3402 "BibTeX will be unable to find them."));
3411 string Buffer::layoutPos() const
3413 return d->layout_position;
3417 void Buffer::setLayoutPos(string const & path)
3420 d->layout_position.clear();
3424 LATTEST(FileName::isAbsolute(path));
3426 d->layout_position =
3427 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3429 if (d->layout_position.empty())
3430 d->layout_position = ".";
3434 bool Buffer::hasReadonlyFlag() const
3436 return d->read_only;
3440 bool Buffer::isReadonly() const
3442 return hasReadonlyFlag() || notifiesExternalModification();
3446 void Buffer::setParent(Buffer const * buffer)
3448 // Avoids recursive include.
3449 d->setParent(buffer == this ? 0 : buffer);
3454 Buffer const * Buffer::parent() const
3460 ListOfBuffers Buffer::allRelatives() const
3462 ListOfBuffers lb = masterBuffer()->getDescendents();
3463 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3468 Buffer const * Buffer::masterBuffer() const
3470 // FIXME Should be make sure we are not in some kind
3471 // of recursive include? A -> B -> A will crash this.
3472 Buffer const * const pbuf = d->parent();
3476 return pbuf->masterBuffer();
3480 bool Buffer::isChild(Buffer * child) const
3482 return d->children_positions.find(child) != d->children_positions.end();
3486 DocIterator Buffer::firstChildPosition(Buffer const * child)
3488 Impl::BufferPositionMap::iterator it;
3489 it = d->children_positions.find(child);
3490 if (it == d->children_positions.end())
3491 return DocIterator(this);
3496 bool Buffer::hasChildren() const
3498 return !d->children_positions.empty();
3502 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3504 // loop over children
3505 for (auto const & p : d->children_positions) {
3506 Buffer * child = const_cast<Buffer *>(p.first);
3508 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3509 if (bit != clist.end())
3511 clist.push_back(child);
3513 // there might be grandchildren
3514 child->collectChildren(clist, true);
3519 ListOfBuffers Buffer::getChildren() const
3522 collectChildren(v, false);
3523 // Make sure we have not included ourselves.
3524 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3525 if (bit != v.end()) {
3526 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3533 ListOfBuffers Buffer::getDescendents() const
3536 collectChildren(v, true);
3537 // Make sure we have not included ourselves.
3538 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3539 if (bit != v.end()) {
3540 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3547 template<typename M>
3548 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3553 typename M::const_iterator it = m.lower_bound(x);
3554 if (it == m.begin())
3562 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3563 DocIterator const & pos) const
3565 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3567 // if paragraphs have no macro context set, pos will be empty
3571 // we haven't found anything yet
3572 DocIterator bestPos = owner_->par_iterator_begin();
3573 MacroData const * bestData = 0;
3575 // find macro definitions for name
3576 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3577 if (nameIt != macros.end()) {
3578 // find last definition in front of pos or at pos itself
3579 PositionScopeMacroMap::const_iterator it
3580 = greatest_below(nameIt->second, pos);
3581 if (it != nameIt->second.end()) {
3583 // scope ends behind pos?
3584 if (pos < it->second.scope) {
3585 // Looks good, remember this. If there
3586 // is no external macro behind this,
3587 // we found the right one already.
3588 bestPos = it->first;
3589 bestData = &it->second.macro;
3593 // try previous macro if there is one
3594 if (it == nameIt->second.begin())
3601 // find macros in included files
3602 PositionScopeBufferMap::const_iterator it
3603 = greatest_below(position_to_children, pos);
3604 if (it == position_to_children.end())
3605 // no children before
3609 // do we know something better (i.e. later) already?
3610 if (it->first < bestPos )
3613 // scope ends behind pos?
3614 if (pos < it->second.scope
3615 && (cloned_buffer_ ||
3616 theBufferList().isLoaded(it->second.buffer))) {
3617 // look for macro in external file
3619 MacroData const * data
3620 = it->second.buffer->getMacro(name, false);
3623 bestPos = it->first;
3629 // try previous file if there is one
3630 if (it == position_to_children.begin())
3635 // return the best macro we have found
3640 MacroData const * Buffer::getMacro(docstring const & name,
3641 DocIterator const & pos, bool global) const
3646 // query buffer macros
3647 MacroData const * data = d->getBufferMacro(name, pos);
3651 // If there is a master buffer, query that
3652 Buffer const * const pbuf = d->parent();
3654 d->macro_lock = true;
3655 MacroData const * macro = pbuf->getMacro(
3656 name, *this, false);
3657 d->macro_lock = false;
3663 data = MacroTable::globalMacros().get(name);
3672 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3674 // set scope end behind the last paragraph
3675 DocIterator scope = par_iterator_begin();
3676 scope.pit() = scope.lastpit() + 1;
3678 return getMacro(name, scope, global);
3682 MacroData const * Buffer::getMacro(docstring const & name,
3683 Buffer const & child, bool global) const
3685 // look where the child buffer is included first
3686 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3687 if (it == d->children_positions.end())
3690 // check for macros at the inclusion position
3691 return getMacro(name, it->second, global);
3695 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3697 pit_type const lastpit = it.lastpit();
3699 // look for macros in each paragraph
3700 while (it.pit() <= lastpit) {
3701 Paragraph & par = it.paragraph();
3703 // FIXME Can this be done with the new-style iterators?
3704 // iterate over the insets of the current paragraph
3705 for (auto const & insit : par.insetList()) {
3706 it.pos() = insit.pos;
3708 // is it a nested text inset?
3709 if (insit.inset->asInsetText()) {
3710 // Inset needs its own scope?
3711 InsetText const * itext = insit.inset->asInsetText();
3712 bool newScope = itext->isMacroScope();
3714 // scope which ends just behind the inset
3715 DocIterator insetScope = it;
3718 // collect macros in inset
3719 it.push_back(CursorSlice(*insit.inset));
3720 updateMacros(it, newScope ? insetScope : scope);
3725 if (insit.inset->asInsetTabular()) {
3726 CursorSlice slice(*insit.inset);
3727 size_t const numcells = slice.nargs();
3728 for (; slice.idx() < numcells; slice.forwardIdx()) {
3729 it.push_back(slice);
3730 updateMacros(it, scope);
3736 // is it an external file?
3737 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3738 // get buffer of external file
3739 InsetInclude const & incinset =
3740 static_cast<InsetInclude const &>(*insit.inset);
3742 Buffer * child = incinset.getChildBuffer();
3747 // register its position, but only when it is
3748 // included first in the buffer
3749 if (children_positions.find(child) ==
3750 children_positions.end())
3751 children_positions[child] = it;
3753 // register child with its scope
3754 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3758 InsetMath * im = insit.inset->asInsetMath();
3759 if (doing_export && im) {
3760 InsetMathHull * hull = im->asHullInset();
3762 hull->recordLocation(it);
3765 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3769 InsetMathMacroTemplate & macroTemplate =
3770 *insit.inset->asInsetMath()->asMacroTemplate();
3771 MacroContext mc(owner_, it);
3772 macroTemplate.updateToContext(mc);
3775 bool valid = macroTemplate.validMacro();
3776 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3777 // then the BufferView's cursor will be invalid in
3778 // some cases which leads to crashes.
3783 // FIXME (Abdel), I don't understand why we pass 'it' here
3784 // instead of 'macroTemplate' defined above... is this correct?
3785 macros[macroTemplate.name()][it] =
3786 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3796 void Buffer::updateMacros() const
3801 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3803 // start with empty table
3805 d->children_positions.clear();
3806 d->position_to_children.clear();
3808 // Iterate over buffer, starting with first paragraph
3809 // The scope must be bigger than any lookup DocIterator
3810 // later. For the global lookup, lastpit+1 is used, hence
3811 // we use lastpit+2 here.
3812 DocIterator it = par_iterator_begin();
3813 DocIterator outerScope = it;
3814 outerScope.pit() = outerScope.lastpit() + 2;
3815 d->updateMacros(it, outerScope);
3819 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3821 InsetIterator it = inset_iterator_begin(inset());
3822 InsetIterator const end = inset_iterator_end(inset());
3823 for (; it != end; ++it) {
3824 if (it->lyxCode() == BRANCH_CODE) {
3825 InsetBranch & br = static_cast<InsetBranch &>(*it);
3826 docstring const name = br.branch();
3827 if (!from_master && !params().branchlist().find(name))
3828 result.push_back(name);
3829 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3830 result.push_back(name);
3833 if (it->lyxCode() == INCLUDE_CODE) {
3834 // get buffer of external file
3835 InsetInclude const & ins =
3836 static_cast<InsetInclude const &>(*it);
3837 Buffer * child = ins.getChildBuffer();
3840 child->getUsedBranches(result, true);
3843 // remove duplicates
3848 void Buffer::updateMacroInstances(UpdateType utype) const
3850 LYXERR(Debug::MACROS, "updateMacroInstances for "
3851 << d->filename.onlyFileName());
3852 DocIterator it = doc_iterator_begin(this);
3854 DocIterator const end = doc_iterator_end(this);
3855 for (; it != end; it.forwardInset()) {
3856 // look for MathData cells in InsetMathNest insets
3857 InsetMath * minset = it.nextInset()->asInsetMath();
3861 // update macro in all cells of the InsetMathNest
3862 DocIterator::idx_type n = minset->nargs();
3863 MacroContext mc = MacroContext(this, it);
3864 for (DocIterator::idx_type i = 0; i < n; ++i) {
3865 MathData & data = minset->cell(i);
3866 data.updateMacros(0, mc, utype, 0);
3872 void Buffer::listMacroNames(MacroNameSet & macros) const
3877 d->macro_lock = true;
3879 // loop over macro names
3880 for (auto const & nameit : d->macros)
3881 macros.insert(nameit.first);
3883 // loop over children
3884 for (auto const & p : d->children_positions) {
3885 Buffer * child = const_cast<Buffer *>(p.first);
3886 // The buffer might have been closed (see #10766).
3887 if (theBufferList().isLoaded(child))
3888 child->listMacroNames(macros);
3892 Buffer const * const pbuf = d->parent();
3894 pbuf->listMacroNames(macros);
3896 d->macro_lock = false;
3900 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3902 Buffer const * const pbuf = d->parent();
3907 pbuf->listMacroNames(names);
3910 for (auto const & mit : names) {
3912 MacroData const * data = pbuf->getMacro(mit, *this, false);
3914 macros.insert(data);
3916 // we cannot access the original InsetMathMacroTemplate anymore
3917 // here to calls validate method. So we do its work here manually.
3918 // FIXME: somehow make the template accessible here.
3919 if (data->optionals() > 0)
3920 features.require("xargs");
3926 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3929 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3931 RefCache::iterator it = d->ref_cache_.find(label);
3932 if (it != d->ref_cache_.end())
3935 static References const dummy_refs = References();
3936 it = d->ref_cache_.insert(
3937 make_pair(label, dummy_refs)).first;
3942 Buffer::References const & Buffer::references(docstring const & label) const
3944 return const_cast<Buffer *>(this)->getReferenceCache(label);
3948 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3950 References & refs = getReferenceCache(label);
3951 refs.push_back(make_pair(inset, it));
3955 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3959 linfo.label = label;
3961 linfo.active = active;
3962 masterBuffer()->d->label_cache_.push_back(linfo);
3966 InsetLabel const * Buffer::insetLabel(docstring const & label,
3967 bool const active) const
3969 for (auto & rc : masterBuffer()->d->label_cache_) {
3970 if (rc.label == label && (rc.active || !active))
3977 bool Buffer::activeLabel(docstring const & label) const
3979 if (!insetLabel(label, true))
3986 void Buffer::clearReferenceCache() const
3989 d->ref_cache_.clear();
3990 d->label_cache_.clear();
3995 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3997 //FIXME: This does not work for child documents yet.
3998 reloadBibInfoCache();
4000 // Check if the label 'from' appears more than once
4001 vector<docstring> labels;
4002 for (auto const & bibit : masterBibInfo())
4003 labels.push_back(bibit.first);
4005 if (count(labels.begin(), labels.end(), from) > 1)
4008 string const paramName = "key";
4009 InsetIterator it = inset_iterator_begin(inset());
4011 if (it->lyxCode() != CITE_CODE)
4013 InsetCommand * inset = it->asInsetCommand();
4014 docstring const oldValue = inset->getParam(paramName);
4015 if (oldValue == from)
4016 inset->setParam(paramName, to);
4020 // returns NULL if id-to-row conversion is unsupported
4021 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4022 pit_type par_begin, pit_type par_end,
4023 OutputWhat output, bool master) const
4025 unique_ptr<TexRow> texrow;
4026 OutputParams runparams(¶ms().encoding());
4027 runparams.nice = true;
4028 runparams.flavor = params().getOutputFlavor(format);
4029 runparams.linelen = lyxrc.plaintext_linelen;
4030 // No side effect of file copying and image conversion
4031 runparams.dryrun = true;
4033 // Some macros rely on font encoding
4034 runparams.main_fontenc = params().main_font_encoding();
4036 if (output == CurrentParagraph) {
4037 runparams.par_begin = par_begin;
4038 runparams.par_end = par_end;
4039 if (par_begin + 1 == par_end) {
4041 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4045 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4046 convert<docstring>(par_begin),
4047 convert<docstring>(par_end - 1))
4050 // output paragraphs
4051 if (runparams.flavor == OutputParams::LYX) {
4052 Paragraph const & par = text().paragraphs()[par_begin];
4054 depth_type dt = par.getDepth();
4055 par.write(ods, params(), dt);
4056 os << from_utf8(ods.str());
4057 } else if (runparams.flavor == OutputParams::HTML) {
4059 setMathFlavor(runparams);
4060 xhtmlParagraphs(text(), *this, xs, runparams);
4061 } else if (runparams.flavor == OutputParams::TEXT) {
4063 // FIXME Handles only one paragraph, unlike the others.
4064 // Probably should have some routine with a signature like them.
4065 writePlaintextParagraph(*this,
4066 text().paragraphs()[par_begin], os, runparams, dummy);
4067 } else if (params().isDocBook()) {
4068 docbookParagraphs(text(), *this, os, runparams);
4070 // If we are previewing a paragraph, even if this is the
4071 // child of some other buffer, let's cut the link here,
4072 // so that no concurring settings from the master
4073 // (e.g. branch state) interfere (see #8101).
4075 d->ignore_parent = true;
4076 // We need to validate the Buffer params' features here
4077 // in order to know if we should output polyglossia
4078 // macros (instead of babel macros)
4079 LaTeXFeatures features(*this, params(), runparams);
4081 runparams.use_polyglossia = features.usePolyglossia();
4082 // latex or literate
4085 ots.texrow().newlines(2);
4087 latexParagraphs(*this, text(), ots, runparams);
4088 texrow = ots.releaseTexRow();
4090 // Restore the parenthood
4092 d->ignore_parent = false;
4096 if (output == FullSource)
4097 os << _("Preview source code");
4098 else if (output == OnlyPreamble)
4099 os << _("Preview preamble");
4100 else if (output == OnlyBody)
4101 os << _("Preview body");
4103 if (runparams.flavor == OutputParams::LYX) {
4105 if (output == FullSource)
4107 else if (output == OnlyPreamble)
4108 params().writeFile(ods, this);
4109 else if (output == OnlyBody)
4111 os << from_utf8(ods.str());
4112 } else if (runparams.flavor == OutputParams::HTML) {
4113 writeLyXHTMLSource(os, runparams, output);
4114 } else if (runparams.flavor == OutputParams::TEXT) {
4115 if (output == OnlyPreamble) {
4116 os << "% "<< _("Plain text does not have a preamble.");
4118 writePlaintextFile(*this, os, runparams);
4119 } else if (params().isDocBook()) {
4120 writeDocBookSource(os, absFileName(), runparams, output);
4122 // latex or literate
4125 ots.texrow().newlines(2);
4127 runparams.is_child = true;
4129 writeLaTeXSource(ots, string(), runparams, output);
4130 texrow = ots.releaseTexRow();
4137 ErrorList & Buffer::errorList(string const & type) const
4139 return d->errorLists[type];
4143 void Buffer::updateTocItem(std::string const & type,
4144 DocIterator const & dit) const
4147 d->gui_->updateTocItem(type, dit);
4151 void Buffer::structureChanged() const
4154 d->gui_->structureChanged();
4158 void Buffer::errors(string const & err, bool from_master) const
4161 d->gui_->errors(err, from_master);
4165 void Buffer::message(docstring const & msg) const
4168 d->gui_->message(msg);
4172 void Buffer::setBusy(bool on) const
4175 d->gui_->setBusy(on);
4179 void Buffer::updateTitles() const
4182 d->wa_->updateTitles();
4186 void Buffer::resetAutosaveTimers() const
4189 d->gui_->resetAutosaveTimers();
4193 bool Buffer::hasGuiDelegate() const
4199 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4208 class AutoSaveBuffer : public ForkedProcess {
4211 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4212 : buffer_(buffer), fname_(fname) {}
4214 virtual shared_ptr<ForkedProcess> clone() const
4216 return make_shared<AutoSaveBuffer>(*this);
4221 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4222 from_utf8(fname_.absFileName())));
4223 return run(DontWait);
4227 virtual int generateChild();
4229 Buffer const & buffer_;
4234 int AutoSaveBuffer::generateChild()
4236 #if defined(__APPLE__)
4237 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4238 * We should use something else like threads.
4240 * Since I do not know how to determine at run time what is the OS X
4241 * version, I just disable forking altogether for now (JMarc)
4243 pid_t const pid = -1;
4245 // tmp_ret will be located (usually) in /tmp
4246 // will that be a problem?
4247 // Note that this calls ForkedCalls::fork(), so it's
4248 // ok cross-platform.
4249 pid_t const pid = fork();
4250 // If you want to debug the autosave
4251 // you should set pid to -1, and comment out the fork.
4252 if (pid != 0 && pid != -1)
4256 // pid = -1 signifies that lyx was unable
4257 // to fork. But we will do the save
4259 bool failed = false;
4260 TempFile tempfile("lyxautoXXXXXX.lyx");
4261 tempfile.setAutoRemove(false);
4262 FileName const tmp_ret = tempfile.name();
4263 if (!tmp_ret.empty()) {
4264 if (!buffer_.writeFile(tmp_ret))
4266 else if (!tmp_ret.moveTo(fname_))
4272 // failed to write/rename tmp_ret so try writing direct
4273 if (!buffer_.writeFile(fname_)) {
4274 // It is dangerous to do this in the child,
4275 // but safe in the parent, so...
4276 if (pid == -1) // emit message signal.
4277 buffer_.message(_("Autosave failed!"));
4281 if (pid == 0) // we are the child so...
4290 FileName Buffer::getEmergencyFileName() const
4292 return FileName(d->filename.absFileName() + ".emergency");
4296 FileName Buffer::getAutosaveFileName() const
4298 // if the document is unnamed try to save in the backup dir, else
4299 // in the default document path, and as a last try in the filePath,
4300 // which will most often be the temporary directory
4303 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4304 : lyxrc.backupdir_path;
4305 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4308 string const fname = "#" + d->filename.onlyFileName() + "#";
4310 return makeAbsPath(fname, fpath);
4314 void Buffer::removeAutosaveFile() const
4316 FileName const f = getAutosaveFileName();
4322 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4324 FileName const newauto = getAutosaveFileName();
4326 if (newauto != oldauto && oldauto.exists())
4327 if (!oldauto.moveTo(newauto))
4328 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4332 bool Buffer::autoSave() const
4334 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4335 if (buf->d->bak_clean || hasReadonlyFlag())
4338 message(_("Autosaving current document..."));
4339 buf->d->bak_clean = true;
4341 FileName const fname = getAutosaveFileName();
4342 LASSERT(d->cloned_buffer_, return false);
4344 // If this buffer is cloned, we assume that
4345 // we are running in a separate thread already.
4346 TempFile tempfile("lyxautoXXXXXX.lyx");
4347 tempfile.setAutoRemove(false);
4348 FileName const tmp_ret = tempfile.name();
4349 if (!tmp_ret.empty()) {
4351 // assume successful write of tmp_ret
4352 if (tmp_ret.moveTo(fname))
4355 // failed to write/rename tmp_ret so try writing direct
4356 return writeFile(fname);
4360 void Buffer::setExportStatus(bool e) const
4362 d->doing_export = e;
4363 ListOfBuffers clist = getDescendents();
4364 for (auto const & bit : clist)
4365 bit->d->doing_export = e;
4369 bool Buffer::isExporting() const
4371 return d->doing_export;
4375 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4379 return doExport(target, put_in_tempdir, result_file);
4382 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4383 string & result_file) const
4385 bool const update_unincluded =
4386 params().maintain_unincluded_children
4387 && !params().getIncludedChildren().empty();
4389 // (1) export with all included children (omit \includeonly)
4390 if (update_unincluded) {
4391 ExportStatus const status =
4392 doExport(target, put_in_tempdir, true, result_file);
4393 if (status != ExportSuccess)
4396 // (2) export with included children only
4397 return doExport(target, put_in_tempdir, false, result_file);
4401 void Buffer::setMathFlavor(OutputParams & op) const
4403 switch (params().html_math_output) {
4404 case BufferParams::MathML:
4405 op.math_flavor = OutputParams::MathAsMathML;
4407 case BufferParams::HTML:
4408 op.math_flavor = OutputParams::MathAsHTML;
4410 case BufferParams::Images:
4411 op.math_flavor = OutputParams::MathAsImages;
4413 case BufferParams::LaTeX:
4414 op.math_flavor = OutputParams::MathAsLaTeX;
4420 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4421 bool includeall, string & result_file) const
4423 LYXERR(Debug::FILES, "target=" << target);
4424 OutputParams runparams(¶ms().encoding());
4425 string format = target;
4426 string dest_filename;
4427 size_t pos = target.find(' ');
4428 if (pos != string::npos) {
4429 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4430 format = target.substr(0, pos);
4431 if (format == "default")
4432 format = params().getDefaultOutputFormat();
4433 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4434 FileName(dest_filename).onlyPath().createPath();
4435 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4437 MarkAsExporting exporting(this);
4438 string backend_format;
4439 runparams.flavor = OutputParams::LATEX;
4440 runparams.linelen = lyxrc.plaintext_linelen;
4441 runparams.includeall = includeall;
4442 vector<string> backs = params().backends();
4443 Converters converters = theConverters();
4444 bool need_nice_file = false;
4445 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4446 // Get shortest path to format
4447 converters.buildGraph();
4448 Graph::EdgePath path;
4449 for (string const & sit : backs) {
4450 Graph::EdgePath p = converters.getPath(sit, format);
4451 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4452 backend_format = sit;
4457 if (!put_in_tempdir) {
4458 // Only show this alert if this is an export to a non-temporary
4459 // file (not for previewing).
4460 Alert::error(_("Couldn't export file"), bformat(
4461 _("No information for exporting the format %1$s."),
4462 theFormats().prettyName(format)));
4464 return ExportNoPathToFormat;
4466 runparams.flavor = converters.getFlavor(path, this);
4467 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4468 for (auto const & edge : path)
4469 if (theConverters().get(edge).nice()) {
4470 need_nice_file = true;
4475 backend_format = format;
4476 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4477 // FIXME: Don't hardcode format names here, but use a flag
4478 if (backend_format == "pdflatex")
4479 runparams.flavor = OutputParams::PDFLATEX;
4480 else if (backend_format == "luatex")
4481 runparams.flavor = OutputParams::LUATEX;
4482 else if (backend_format == "dviluatex")
4483 runparams.flavor = OutputParams::DVILUATEX;
4484 else if (backend_format == "xetex")
4485 runparams.flavor = OutputParams::XETEX;
4488 string filename = latexName(false);
4489 filename = addName(temppath(), filename);
4490 filename = changeExtension(filename,
4491 theFormats().extension(backend_format));
4492 LYXERR(Debug::FILES, "filename=" << filename);
4494 // Plain text backend
4495 if (backend_format == "text") {
4496 runparams.flavor = OutputParams::TEXT;
4498 writePlaintextFile(*this, FileName(filename), runparams);
4500 catch (ConversionException const &) { return ExportCancel; }
4503 else if (backend_format == "xhtml") {
4504 runparams.flavor = OutputParams::HTML;
4505 setMathFlavor(runparams);
4506 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4507 return ExportKilled;
4508 } else if (backend_format == "lyx")
4509 writeFile(FileName(filename));
4511 else if (params().isDocBook()) {
4512 runparams.nice = !put_in_tempdir;
4513 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4514 return ExportKilled;
4517 else if (backend_format == format || need_nice_file) {
4518 runparams.nice = true;
4519 ExportStatus const retval =
4520 makeLaTeXFile(FileName(filename), string(), runparams);
4521 if (retval == ExportKilled)
4522 return ExportKilled;
4523 if (d->cloned_buffer_)
4524 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4525 if (retval != ExportSuccess)
4527 } else if (!lyxrc.tex_allows_spaces
4528 && contains(filePath(), ' ')) {
4529 Alert::error(_("File name error"),
4530 bformat(_("The directory path to the document\n%1$s\n"
4531 "contains spaces, but your TeX installation does "
4532 "not allow them. You should save the file to a directory "
4533 "whose name does not contain spaces."), from_ascii(filePath())));
4534 return ExportTexPathHasSpaces;
4536 runparams.nice = false;
4537 ExportStatus const retval =
4538 makeLaTeXFile(FileName(filename), filePath(), runparams);
4539 if (retval == ExportKilled)
4540 return ExportKilled;
4541 if (d->cloned_buffer_)
4542 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4543 if (retval != ExportSuccess)
4547 string const error_type = (format == "program")
4548 ? "Build" : params().bufferFormat();
4549 ErrorList & error_list = d->errorLists[error_type];
4550 string const ext = theFormats().extension(format);
4551 FileName const tmp_result_file(changeExtension(filename, ext));
4552 Converters::RetVal const retval =
4553 converters.convert(this, FileName(filename), tmp_result_file,
4554 FileName(absFileName()), backend_format, format, error_list);
4555 if (retval == Converters::KILLED)
4556 return ExportCancel;
4557 bool success = (retval == Converters::SUCCESS);
4559 // Emit the signal to show the error list or copy it back to the
4560 // cloned Buffer so that it can be emitted afterwards.
4561 if (format != backend_format) {
4562 if (runparams.silent)
4564 else if (d->cloned_buffer_)
4565 d->cloned_buffer_->d->errorLists[error_type] =
4566 d->errorLists[error_type];
4569 // also to the children, in case of master-buffer-view
4570 ListOfBuffers clist = getDescendents();
4571 for (auto const & bit : clist) {
4572 if (runparams.silent)
4573 bit->d->errorLists[error_type].clear();
4574 else if (d->cloned_buffer_) {
4575 // Enable reverse search by copying back the
4576 // texrow object to the cloned buffer.
4577 // FIXME: this is not thread safe.
4578 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4579 bit->d->cloned_buffer_->d->errorLists[error_type] =
4580 bit->d->errorLists[error_type];
4582 bit->errors(error_type, true);
4586 if (d->cloned_buffer_) {
4587 // Enable reverse dvi or pdf to work by copying back the texrow
4588 // object to the cloned buffer.
4589 // FIXME: There is a possibility of concurrent access to texrow
4590 // here from the main GUI thread that should be securized.
4591 d->cloned_buffer_->d->texrow = d->texrow;
4592 string const err_type = params().bufferFormat();
4593 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4597 if (put_in_tempdir) {
4598 result_file = tmp_result_file.absFileName();
4599 return success ? ExportSuccess : ExportConverterError;
4602 if (dest_filename.empty())
4603 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4605 result_file = dest_filename;
4606 // We need to copy referenced files (e. g. included graphics
4607 // if format == "dvi") to the result dir.
4608 vector<ExportedFile> const files =
4609 runparams.exportdata->externalFiles(format);
4610 string const dest = runparams.export_folder.empty() ?
4611 onlyPath(result_file) : runparams.export_folder;
4612 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4613 : force_overwrite == ALL_FILES;
4614 CopyStatus status = use_force ? FORCE : SUCCESS;
4616 for (ExportedFile const & exp : files) {
4617 if (status == CANCEL) {
4618 message(_("Document export cancelled."));
4619 return ExportCancel;
4621 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4622 string fixedName = exp.exportName;
4623 if (!runparams.export_folder.empty()) {
4624 // Relative pathnames starting with ../ will be sanitized
4625 // if exporting to a different folder
4626 while (fixedName.substr(0, 3) == "../")
4627 fixedName = fixedName.substr(3, fixedName.length() - 3);
4629 FileName fixedFileName = makeAbsPath(fixedName, dest);
4630 fixedFileName.onlyPath().createPath();
4631 status = copyFile(fmt, exp.sourceName,
4633 exp.exportName, status == FORCE,
4634 runparams.export_folder.empty());
4638 if (tmp_result_file.exists()) {
4639 // Finally copy the main file
4640 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4641 : force_overwrite != NO_FILES;
4642 if (status == SUCCESS && use_force)
4644 status = copyFile(format, tmp_result_file,
4645 FileName(result_file), result_file,
4647 if (status == CANCEL) {
4648 message(_("Document export cancelled."));
4649 return ExportCancel;
4651 message(bformat(_("Document exported as %1$s "
4653 theFormats().prettyName(format),
4654 makeDisplayPath(result_file)));
4657 // This must be a dummy converter like fax (bug 1888)
4658 message(bformat(_("Document exported as %1$s"),
4659 theFormats().prettyName(format)));
4662 return success ? ExportSuccess : ExportConverterError;
4666 Buffer::ExportStatus Buffer::preview(string const & format) const
4668 bool const update_unincluded =
4669 params().maintain_unincluded_children
4670 && !params().getIncludedChildren().empty();
4671 return preview(format, update_unincluded);
4675 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4677 MarkAsExporting exporting(this);
4679 // (1) export with all included children (omit \includeonly)
4681 ExportStatus const status = doExport(format, true, true, result_file);
4682 if (status != ExportSuccess)
4685 // (2) export with included children only
4686 ExportStatus const status = doExport(format, true, false, result_file);
4687 FileName const previewFile(result_file);
4689 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4690 theimpl->preview_file_ = previewFile;
4691 theimpl->preview_format_ = format;
4692 theimpl->preview_error_ = (status != ExportSuccess);
4694 if (status != ExportSuccess)
4697 if (previewFile.exists())
4698 return theFormats().view(*this, previewFile, format) ?
4699 PreviewSuccess : PreviewError;
4701 // Successful export but no output file?
4702 // Probably a bug in error detection.
4703 LATTEST(status != ExportSuccess);
4708 Buffer::ReadStatus Buffer::extractFromVC()
4710 bool const found = LyXVC::file_not_found_hook(d->filename);
4712 return ReadFileNotFound;
4713 if (!d->filename.isReadableFile())
4719 Buffer::ReadStatus Buffer::loadEmergency()
4721 FileName const emergencyFile = getEmergencyFileName();
4722 if (!emergencyFile.exists()
4723 || emergencyFile.lastModified() <= d->filename.lastModified())
4724 return ReadFileNotFound;
4726 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4727 docstring const text = bformat(_("An emergency save of the document "
4728 "%1$s exists.\n\nRecover emergency save?"), file);
4730 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4731 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4737 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4738 bool const success = (ret_llf == ReadSuccess);
4740 if (hasReadonlyFlag()) {
4741 Alert::warning(_("File is read-only"),
4742 bformat(_("An emergency file is successfully loaded, "
4743 "but the original file %1$s is marked read-only. "
4744 "Please make sure to save the document as a different "
4745 "file."), from_utf8(d->filename.absFileName())));
4748 lyxvc().file_found_hook(d->filename);
4749 str = _("Document was successfully recovered.");
4751 str = _("Document was NOT successfully recovered.");
4752 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4753 makeDisplayPath(emergencyFile.absFileName()));
4755 int const del_emerg =
4756 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4757 _("&Remove"), _("&Keep"));
4758 if (del_emerg == 0) {
4759 emergencyFile.removeFile();
4761 Alert::warning(_("Emergency file deleted"),
4762 _("Do not forget to save your file now!"), true);
4764 return success ? ReadSuccess : ReadEmergencyFailure;
4767 int const del_emerg =
4768 Alert::prompt(_("Delete emergency file?"),
4769 _("Remove emergency file now?"), 1, 1,
4770 _("&Remove"), _("&Keep"));
4772 emergencyFile.removeFile();
4776 string const ename = emergencyFile.absFileName();
4778 // Surely we can find one in 100 tries?
4779 for (int i = 1; i < 100; ++i) {
4780 newname.set(ename + to_string(i) + ".lyx");
4781 if (!newname.exists()) {
4787 // renameTo returns true on success. So inverting that
4788 // will give us true if we fail.
4789 noname = !emergencyFile.renameTo(newname);
4792 Alert::warning(_("Can't rename emergency file!"),
4793 _("LyX was unable to rename the emergency file. "
4794 "You should do so manually. Otherwise, you will be "
4795 "asked about it again the next time you try to load "
4796 "this file, and may over-write your own work."));
4799 return ReadOriginal;
4809 Buffer::ReadStatus Buffer::loadAutosave()
4811 // Now check if autosave file is newer.
4812 FileName const autosaveFile = getAutosaveFileName();
4813 if (!autosaveFile.exists()
4814 || autosaveFile.lastModified() <= d->filename.lastModified())
4815 return ReadFileNotFound;
4817 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4818 docstring const text = bformat(_("The backup of the document %1$s "
4819 "is newer.\n\nLoad the backup instead?"), file);
4820 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4821 _("&Load backup"), _("Load &original"), _("&Cancel"));
4826 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4827 // the file is not saved if we load the autosave file.
4828 if (ret_llf == ReadSuccess) {
4829 if (hasReadonlyFlag()) {
4830 Alert::warning(_("File is read-only"),
4831 bformat(_("A backup file is successfully loaded, "
4832 "but the original file %1$s is marked read-only. "
4833 "Please make sure to save the document as a "
4835 from_utf8(d->filename.absFileName())));
4838 lyxvc().file_found_hook(d->filename);
4841 return ReadAutosaveFailure;
4844 // Here we delete the autosave
4845 autosaveFile.removeFile();
4846 return ReadOriginal;
4854 Buffer::ReadStatus Buffer::loadLyXFile()
4856 if (!d->filename.isReadableFile()) {
4857 ReadStatus const ret_rvc = extractFromVC();
4858 if (ret_rvc != ReadSuccess)
4862 ReadStatus const ret_re = loadEmergency();
4863 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4866 ReadStatus const ret_ra = loadAutosave();
4867 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4870 return loadThisLyXFile(d->filename);
4874 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4876 return readFile(fn);
4880 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4882 for (auto const & err : terr) {
4883 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4884 int errorRow = err.error_in_line;
4885 Buffer const * buf = 0;
4887 if (err.child_name.empty())
4888 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4890 // The error occurred in a child
4891 for (Buffer const * child : getDescendents()) {
4892 string const child_name =
4893 DocFileName(changeExtension(child->absFileName(), "tex")).
4895 if (err.child_name != child_name)
4897 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4898 if (!TexRow::isNone(start)) {
4899 buf = d->cloned_buffer_
4900 ? child->d->cloned_buffer_->d->owner_
4907 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4913 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4915 LBUFERR(!text().paragraphs().empty());
4917 // Use the master text class also for child documents
4918 Buffer const * const master = masterBuffer();
4919 DocumentClass const & textclass = master->params().documentClass();
4921 docstring_list old_bibfiles;
4922 // Do this only if we are the top-level Buffer. We also need to account
4923 // for the case of a previewed child with ignored parent here.
4924 if (master == this && !d->ignore_parent) {
4925 textclass.counters().reset(from_ascii("bibitem"));
4926 reloadBibInfoCache();
4927 // we will re-read this cache as we go through, but we need
4928 // to know whether it's changed to know whether we need to
4929 // update the bibinfo cache.
4930 old_bibfiles = d->bibfiles_cache_;
4931 d->bibfiles_cache_.clear();
4934 // keep the buffers to be children in this set. If the call from the
4935 // master comes back we can see which of them were actually seen (i.e.
4936 // via an InsetInclude). The remaining ones in the set need still be updated.
4937 static std::set<Buffer const *> bufToUpdate;
4938 if (scope == UpdateMaster) {
4939 // If this is a child document start with the master
4940 if (master != this) {
4941 bufToUpdate.insert(this);
4942 master->updateBuffer(UpdateMaster, utype);
4943 // If the master buffer has no gui associated with it, then the TocModel is
4944 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4945 // (bug 5699). The same happens if the master buffer is open in a different
4946 // window. This test catches both possibilities.
4947 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4948 // There remains a problem here: If there is another child open in yet a third
4949 // window, that TOC is not updated. So some more general solution is needed at
4951 if (master->d->gui_ != d->gui_)
4954 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4955 if (bufToUpdate.find(this) == bufToUpdate.end())
4959 // start over the counters in the master
4960 textclass.counters().reset();
4963 // update will be done below for this buffer
4964 bufToUpdate.erase(this);
4966 // update all caches
4967 clearReferenceCache();
4969 setChangesPresent(false);
4971 Buffer & cbuf = const_cast<Buffer &>(*this);
4974 ParIterator parit = cbuf.par_iterator_begin();
4975 updateBuffer(parit, utype);
4977 // If this document has siblings, then update the TocBackend later. The
4978 // reason is to ensure that later siblings are up to date when e.g. the
4979 // broken or not status of references is computed. The update is called
4980 // in InsetInclude::addToToc.
4984 // if the bibfiles changed, the cache of bibinfo is invalid
4985 docstring_list new_bibfiles = d->bibfiles_cache_;
4986 // this is a trick to determine whether the two vectors have
4987 // the same elements.
4988 sort(new_bibfiles.begin(), new_bibfiles.end());
4989 sort(old_bibfiles.begin(), old_bibfiles.end());
4990 if (old_bibfiles != new_bibfiles) {
4991 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4992 invalidateBibinfoCache();
4993 reloadBibInfoCache();
4994 // We relied upon the bibinfo cache when recalculating labels. But that
4995 // cache was invalid, although we didn't find that out until now. So we
4996 // have to do it all again.
4997 // That said, the only thing we really need to do is update the citation
4998 // labels. Nothing else will have changed. So we could create a new
4999 // UpdateType that would signal that fact, if we needed to do so.
5000 parit = cbuf.par_iterator_begin();
5001 // we will be re-doing the counters and references and such.
5002 textclass.counters().reset();
5003 clearReferenceCache();
5004 // we should not need to do this again?
5006 setChangesPresent(false);
5007 updateBuffer(parit, utype);
5008 // this will already have been done by reloadBibInfoCache();
5009 // d->bibinfo_cache_valid_ = true;
5012 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5013 // this is also set to true on the other path, by reloadBibInfoCache.
5014 d->bibinfo_cache_valid_ = true;
5016 d->cite_labels_valid_ = true;
5018 cbuf.tocBackend().update(true, utype);
5019 if (scope == UpdateMaster)
5020 cbuf.structureChanged();
5024 static depth_type getDepth(DocIterator const & it)
5026 depth_type depth = 0;
5027 for (size_t i = 0 ; i < it.depth() ; ++i)
5028 if (!it[i].inset().inMathed())
5029 depth += it[i].paragraph().getDepth() + 1;
5030 // remove 1 since the outer inset does not count
5031 // we should have at least one non-math inset, so
5032 // depth should nevery be 0. but maybe it is worth
5033 // marking this, just in case.
5035 // coverity[INTEGER_OVERFLOW]
5039 static depth_type getItemDepth(ParIterator const & it)
5041 Paragraph const & par = *it;
5042 LabelType const labeltype = par.layout().labeltype;
5044 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5047 // this will hold the lowest depth encountered up to now.
5048 depth_type min_depth = getDepth(it);
5049 ParIterator prev_it = it;
5052 --prev_it.top().pit();
5054 // start of nested inset: go to outer par
5056 if (prev_it.empty()) {
5057 // start of document: nothing to do
5062 // We search for the first paragraph with same label
5063 // that is not more deeply nested.
5064 Paragraph & prev_par = *prev_it;
5065 depth_type const prev_depth = getDepth(prev_it);
5066 if (labeltype == prev_par.layout().labeltype) {
5067 if (prev_depth < min_depth)
5068 return prev_par.itemdepth + 1;
5069 if (prev_depth == min_depth)
5070 return prev_par.itemdepth;
5072 min_depth = min(min_depth, prev_depth);
5073 // small optimization: if we are at depth 0, we won't
5074 // find anything else
5075 if (prev_depth == 0)
5081 static bool needEnumCounterReset(ParIterator const & it)
5083 Paragraph const & par = *it;
5084 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5085 depth_type const cur_depth = par.getDepth();
5086 ParIterator prev_it = it;
5087 while (prev_it.pit()) {
5088 --prev_it.top().pit();
5089 Paragraph const & prev_par = *prev_it;
5090 if (prev_par.getDepth() <= cur_depth)
5091 return prev_par.layout().name() != par.layout().name();
5093 // start of nested inset: reset
5098 // set the label of a paragraph. This includes the counters.
5099 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5101 BufferParams const & bp = owner_->masterBuffer()->params();
5102 DocumentClass const & textclass = bp.documentClass();
5103 Paragraph & par = it.paragraph();
5104 Layout const & layout = par.layout();
5105 Counters & counters = textclass.counters();
5107 if (par.params().startOfAppendix()) {
5108 // We want to reset the counter corresponding to toplevel sectioning
5109 Layout const & lay = textclass.getTOCLayout();
5110 docstring const cnt = lay.counter;
5112 counters.reset(cnt);
5113 counters.appendix(true);
5115 par.params().appendix(counters.appendix());
5117 // Compute the item depth of the paragraph
5118 par.itemdepth = getItemDepth(it);
5120 if (layout.margintype == MARGIN_MANUAL) {
5121 if (par.params().labelWidthString().empty())
5122 par.params().labelWidthString(par.expandLabel(layout, bp));
5123 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5124 // we do not need to do anything here, since the empty case is
5125 // handled during export.
5127 par.params().labelWidthString(docstring());
5130 switch(layout.labeltype) {
5131 case LABEL_ITEMIZE: {
5132 // At some point of time we should do something more
5133 // clever here, like:
5134 // par.params().labelString(
5135 // bp.user_defined_bullet(par.itemdepth).getText());
5136 // for now, use a simple hardcoded label
5137 docstring itemlabel;
5138 switch (par.itemdepth) {
5140 itemlabel = char_type(0x2022);
5143 itemlabel = char_type(0x2013);
5146 itemlabel = char_type(0x2217);
5149 itemlabel = char_type(0x2219); // or 0x00b7
5152 par.params().labelString(itemlabel);
5156 case LABEL_ENUMERATE: {
5157 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5159 switch (par.itemdepth) {
5170 enumcounter += "iv";
5173 // not a valid enumdepth...
5177 if (needEnumCounterReset(it)) {
5178 // Increase the master counter?
5179 if (layout.stepmastercounter)
5180 counters.stepMaster(enumcounter, utype);
5181 // Maybe we have to reset the enumeration counter.
5182 if (!layout.resumecounter)
5183 counters.reset(enumcounter);
5185 counters.step(enumcounter, utype);
5187 string const & lang = par.getParLanguage(bp)->code();
5188 par.params().labelString(counters.theCounter(enumcounter, lang));
5193 case LABEL_SENSITIVE: {
5194 string const & type = counters.current_float();
5195 docstring full_label;
5197 full_label = owner_->B_("Senseless!!! ");
5199 docstring name = owner_->B_(textclass.floats().getType(type).name());
5200 if (counters.hasCounter(from_utf8(type))) {
5201 string const & lang = par.getParLanguage(bp)->code();
5202 counters.step(from_utf8(type), utype);
5203 full_label = bformat(from_ascii("%1$s %2$s:"),
5205 counters.theCounter(from_utf8(type), lang));
5207 full_label = bformat(from_ascii("%1$s #:"), name);
5209 par.params().labelString(full_label);
5213 case LABEL_NO_LABEL:
5214 par.params().labelString(docstring());
5218 case LABEL_CENTERED:
5219 case LABEL_STATIC: {
5220 docstring const & lcounter = layout.counter;
5221 if (!lcounter.empty()) {
5222 if (layout.toclevel <= bp.secnumdepth
5223 && (layout.latextype != LATEX_ENVIRONMENT
5224 || it.text()->isFirstInSequence(it.pit()))) {
5225 if (counters.hasCounter(lcounter))
5226 counters.step(lcounter, utype);
5227 par.params().labelString(par.expandLabel(layout, bp));
5229 par.params().labelString(docstring());
5231 par.params().labelString(par.expandLabel(layout, bp));
5237 par.params().labelString(par.expandLabel(layout, bp));
5242 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5244 // LASSERT: Is it safe to continue here, or should we just return?
5245 LASSERT(parit.pit() == 0, /**/);
5247 // Set the position of the text in the buffer to be able
5248 // to resolve macros in it.
5249 parit.text()->setMacrocontextPosition(parit);
5251 depth_type maxdepth = 0;
5252 pit_type const lastpit = parit.lastpit();
5253 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5254 // reduce depth if necessary
5255 if (parit->params().depth() > maxdepth) {
5256 /** FIXME: this function is const, but
5257 * nevertheless it modifies the buffer. To be
5258 * cleaner, one should modify the buffer in
5259 * another function, which is actually
5260 * non-const. This would however be costly in
5261 * terms of code duplication.
5263 CursorData(parit).recordUndo();
5264 parit->params().depth(maxdepth);
5266 maxdepth = parit->getMaxDepthAfter();
5268 if (utype == OutputUpdate) {
5269 // track the active counters
5270 // we have to do this for the master buffer, since the local
5271 // buffer isn't tracking anything.
5272 masterBuffer()->params().documentClass().counters().
5273 setActiveLayout(parit->layout());
5276 // set the counter for this paragraph
5277 d->setLabel(parit, utype);
5279 // update change-tracking flag
5280 parit->addChangesToBuffer(*this);
5283 for (auto const & insit : parit->insetList()) {
5284 parit.pos() = insit.pos;
5285 insit.inset->updateBuffer(parit, utype);
5291 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5292 WordLangTuple & word_lang, docstring_list & suggestions) const
5296 suggestions.clear();
5297 word_lang = WordLangTuple();
5298 bool const to_end = to.empty();
5299 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5300 // OK, we start from here.
5301 for (; from != end; from.forwardPos()) {
5302 // This skips all insets with spell check disabled.
5303 while (!from.allowSpellCheck()) {
5307 // If from is at the end of the document (which is possible
5308 // when "from" was changed above) LyX will crash later otherwise.
5309 if (from.atEnd() || (!to_end && from >= end))
5312 from.paragraph().spellCheck();
5313 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5314 if (SpellChecker::misspelled(res)) {
5318 // Do not increase progress when from == to, otherwise the word
5319 // count will be wrong.
5329 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5331 bool inword = false;
5336 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5337 if (!dit.inTexted()) {
5342 Paragraph const & par = dit.paragraph();
5343 pos_type const pos = dit.pos();
5345 // Copied and adapted from isWordSeparator() in Paragraph
5346 if (pos == dit.lastpos()) {
5349 Inset const * ins = par.getInset(pos);
5350 if (ins && skipNoOutput && !ins->producesOutput()) {
5353 // stop if end of range was skipped
5354 if (!to.atEnd() && dit >= to)
5357 } else if (!par.isDeleted(pos)) {
5358 if (par.isWordSeparator(pos))
5364 if (ins && ins->isLetter())
5366 else if (ins && ins->isSpace())
5369 char_type const c = par.getChar(pos);
5370 if (isPrintableNonspace(c))
5372 else if (isSpace(c))
5382 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5384 d->updateStatistics(from, to, skipNoOutput);
5388 int Buffer::wordCount() const
5390 return d->wordCount();
5394 int Buffer::charCount(bool with_blanks) const
5396 return d->charCount(with_blanks);
5400 Buffer::ReadStatus Buffer::reload()
5403 // c.f. bug https://www.lyx.org/trac/ticket/6587
5404 removeAutosaveFile();
5405 // e.g., read-only status could have changed due to version control
5406 d->filename.refresh();
5407 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5409 // clear parent. this will get reset if need be.
5411 ReadStatus const status = loadLyXFile();
5412 if (status == ReadSuccess) {
5417 message(bformat(_("Document %1$s reloaded."), disp_fn));
5420 message(bformat(_("Could not reload document %1$s."), disp_fn));
5430 bool Buffer::saveAs(FileName const & fn)
5432 FileName const old_name = fileName();
5433 FileName const old_auto = getAutosaveFileName();
5434 bool const old_unnamed = isUnnamed();
5435 bool success = true;
5436 d->old_position = filePath();
5443 // bring the autosave file with us, just in case.
5444 moveAutosaveFile(old_auto);
5445 // validate version control data and
5446 // correct buffer title
5447 lyxvc().file_found_hook(fileName());
5449 // the file has now been saved to the new location.
5450 // we need to check that the locations of child buffers
5452 checkChildBuffers();
5453 checkMasterBuffer();
5456 // reset the old filename and unnamed state
5457 setFileName(old_name);
5458 setUnnamed(old_unnamed);
5462 d->old_position.clear();
5467 void Buffer::checkChildBuffers()
5469 for (auto const & bit : d->children_positions) {
5470 DocIterator dit = bit.second;
5471 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5472 if (!cbuf || !theBufferList().isLoaded(cbuf))
5474 Inset * inset = dit.nextInset();
5475 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5476 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5477 docstring const & incfile = inset_inc->getParam("filename");
5478 string oldloc = cbuf->absFileName();
5479 string newloc = makeAbsPath(to_utf8(incfile),
5480 onlyPath(absFileName())).absFileName();
5481 if (oldloc == newloc)
5483 // the location of the child file is incorrect.
5485 inset_inc->setChildBuffer(0);
5487 // invalidate cache of children
5488 d->children_positions.clear();
5489 d->position_to_children.clear();
5493 // If a child has been saved under a different name/path, it might have been
5494 // orphaned. Therefore the master needs to be reset (bug 8161).
5495 void Buffer::checkMasterBuffer()
5497 Buffer const * const master = masterBuffer();
5501 // necessary to re-register the child (bug 5873)
5502 // FIXME: clean up updateMacros (here, only
5503 // child registering is needed).
5504 master->updateMacros();
5505 // (re)set master as master buffer, but only
5506 // if we are a real child
5507 if (master->isChild(this))
5514 string Buffer::includedFilePath(string const & name, string const & ext) const
5516 if (d->old_position.empty() ||
5517 equivalent(FileName(d->old_position), FileName(filePath())))
5520 bool isabsolute = FileName::isAbsolute(name);
5521 // both old_position and filePath() end with a path separator
5522 string absname = isabsolute ? name : d->old_position + name;
5524 // if old_position is set to origin, we need to do the equivalent of
5525 // getReferencedFileName() (see readDocument())
5526 if (!isabsolute && d->old_position == params().origin) {
5527 FileName const test(addExtension(filePath() + name, ext));
5529 absname = filePath() + name;
5532 if (!FileName(addExtension(absname, ext)).exists())
5536 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5538 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5539 from_utf8(filePath())));
5543 void Buffer::setChangesPresent(bool b) const
5545 d->tracked_changes_present_ = b;
5549 bool Buffer::areChangesPresent() const
5551 return d->tracked_changes_present_;
5555 void Buffer::updateChangesPresent() const
5557 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5558 setChangesPresent(false);
5559 ParConstIterator it = par_iterator_begin();
5560 ParConstIterator const end = par_iterator_end();
5561 for (; !areChangesPresent() && it != end; ++it)
5562 it->addChangesToBuffer(*this);
5566 void Buffer::Impl::refreshFileMonitor()
5568 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5569 file_monitor_->refresh();
5573 // The previous file monitor is invalid
5574 // This also destroys the previous file monitor and all its connections
5575 file_monitor_ = FileSystemWatcher::monitor(filename);
5576 // file_monitor_ will be destroyed with *this, so it is not going to call a
5577 // destroyed object method.
5578 file_monitor_->connect([this](bool exists) {
5579 fileExternallyModified(exists);
5584 void Buffer::Impl::fileExternallyModified(bool const exists)
5586 // ignore notifications after our own saving operations
5587 if (checksum_ == filename.checksum()) {
5588 LYXERR(Debug::FILES, "External modification but "
5589 "checksum unchanged: " << filename);
5592 // If the file has been deleted, only mark the file as dirty since it is
5593 // pointless to prompt for reloading. If later a file is moved into this
5594 // location, then the externally modified warning will appear then.
5596 externally_modified_ = true;
5597 // Update external modification notification.
5598 // Dirty buffers must be visible at all times.
5599 if (wa_ && wa_->unhide(owner_))
5600 wa_->updateTitles();
5602 // Unable to unhide the buffer (e.g. no GUI or not current View)
5607 bool Buffer::notifiesExternalModification() const
5609 return d->externally_modified_;
5613 void Buffer::clearExternalModification() const
5615 d->externally_modified_ = false;
5617 d->wa_->updateTitles();