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_;
406 ///Binding LaTeX lines with buffer positions.
407 //Common routine for LaTeX and Reference errors listing.
408 void traverseErrors(TeXErrors::Errors::const_iterator err,
409 TeXErrors::Errors::const_iterator end,
410 ErrorList & errorList) const;
413 /// So we can force access via the accessors.
414 mutable Buffer const * parent_buffer;
420 FileMonitorPtr file_monitor_;
424 /// Creates the per buffer temporary directory
425 static FileName createBufferTmpDir()
427 // FIXME This would be the ideal application for a TempDir class (like
428 // TempFile but for directories)
433 Mutex::Locker locker(&mutex);
434 counter = convert<string>(count++);
436 // We are in our own directory. Why bother to mangle name?
437 // In fact I wrote this code to circumvent a problematic behaviour
438 // (bug?) of EMX mkstemp().
439 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
442 if (!tmpfl.createDirectory(0777)) {
443 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
444 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
445 from_utf8(tmpfl.absFileName())));
451 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
452 Buffer const * cloned_buffer)
453 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
454 internal_buffer(false), read_only(readonly_), filename(file),
455 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
456 ignore_parent(false), toc_backend(owner), macro_lock(false),
457 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
458 cite_labels_valid_(false), have_bibitems_(false), preview_error_(false),
459 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
460 clone_list_(0), doing_export(false),
461 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
462 word_count_(0), char_count_(0), blank_count_(0)
464 refreshFileMonitor();
465 if (!cloned_buffer_) {
466 temppath = createBufferTmpDir();
467 lyxvc.setBuffer(owner_);
469 wa_ = new frontend::WorkAreaManager;
472 temppath = cloned_buffer_->d->temppath;
473 file_fully_loaded = true;
474 params = cloned_buffer_->d->params;
475 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
476 bibinfo_ = cloned_buffer_->d->bibinfo_;
477 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
478 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
479 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
480 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
481 unnamed = cloned_buffer_->d->unnamed;
482 internal_buffer = cloned_buffer_->d->internal_buffer;
483 layout_position = cloned_buffer_->d->layout_position;
484 preview_file_ = cloned_buffer_->d->preview_file_;
485 preview_format_ = cloned_buffer_->d->preview_format_;
486 preview_error_ = cloned_buffer_->d->preview_error_;
487 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
491 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
492 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
494 LYXERR(Debug::INFO, "Buffer::Buffer()");
496 d->inset = new InsetText(*cloned_buffer->d->inset);
497 d->inset->setBuffer(*this);
498 // FIXME: optimize this loop somewhat, maybe by creating a new
499 // general recursive Inset::setId().
500 DocIterator it = doc_iterator_begin(this);
501 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
502 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
503 it.paragraph().setId(cloned_it.paragraph().id());
505 d->inset = new InsetText(this);
506 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
512 LYXERR(Debug::INFO, "Buffer::~Buffer()");
513 // here the buffer should take care that it is
514 // saved properly, before it goes into the void.
516 // GuiView already destroyed
520 // No need to do additional cleanups for internal buffer.
526 // this is in case of recursive includes: we won't try to delete
527 // ourselves as a child.
528 d->clone_list_->erase(this);
529 // loop over children
530 for (auto const & p : d->children_positions) {
531 Buffer * child = const_cast<Buffer *>(p.first);
532 if (d->clone_list_->erase(child))
535 // if we're the master buffer, then we should get rid of the list
538 // If this is not empty, we have leaked something. Worse, one of the
539 // children still has a reference to this list. But we will try to
540 // continue, rather than shut down.
541 LATTEST(d->clone_list_->empty());
542 list<CloneList *>::iterator it =
543 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
544 if (it == cloned_buffers.end()) {
545 // We will leak in this case, but it is safe to continue.
548 cloned_buffers.erase(it);
549 delete d->clone_list_;
551 // FIXME Do we really need to do this right before we delete d?
552 // clear references to children in macro tables
553 d->children_positions.clear();
554 d->position_to_children.clear();
556 // loop over children
557 for (auto const & p : d->children_positions) {
558 Buffer * child = const_cast<Buffer *>(p.first);
559 if (theBufferList().isLoaded(child)) {
560 if (theBufferList().isOthersChild(this, child))
563 theBufferList().release(child);
568 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
570 msg += emergencyWrite();
572 msg += " " + _("Save failed! Document is lost.");
574 Alert::warning(_("Attempting to close changed document!"), msg);
577 // FIXME Do we really need to do this right before we delete d?
578 // clear references to children in macro tables
579 d->children_positions.clear();
580 d->position_to_children.clear();
582 if (!d->temppath.destroyDirectory()) {
583 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
584 from_utf8(d->temppath.absFileName())));
593 Buffer * Buffer::cloneWithChildren() const
596 cloned_buffers.push_back(new CloneList);
597 CloneList * clones = cloned_buffers.back();
599 cloneWithChildren(bufmap, clones);
601 // make sure we got cloned
602 BufferMap::const_iterator bit = bufmap.find(this);
603 LASSERT(bit != bufmap.end(), return 0);
604 Buffer * cloned_buffer = bit->second;
606 return cloned_buffer;
610 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
612 // have we already been cloned?
613 if (bufmap.find(this) != bufmap.end())
616 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
618 // The clone needs its own DocumentClass, since running updateBuffer() will
619 // modify it, and we would otherwise be sharing it with the original Buffer.
620 buffer_clone->params().makeDocumentClass(true);
622 cap::switchBetweenClasses(
623 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
624 static_cast<InsetText &>(buffer_clone->inset()), el);
626 bufmap[this] = buffer_clone;
627 clones->insert(buffer_clone);
628 buffer_clone->d->clone_list_ = clones;
629 buffer_clone->d->macro_lock = true;
630 buffer_clone->d->children_positions.clear();
632 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
633 // math macro caches need to be rethought and simplified.
634 // I am not sure wether we should handle Buffer cloning here or in BufferList.
635 // Right now BufferList knows nothing about buffer clones.
636 for (auto const & p : d->position_to_children) {
637 DocIterator dit = p.first.clone(buffer_clone);
638 dit.setBuffer(buffer_clone);
639 Buffer * child = const_cast<Buffer *>(p.second.buffer);
641 child->cloneWithChildren(bufmap, clones);
642 BufferMap::iterator const bit = bufmap.find(child);
643 LASSERT(bit != bufmap.end(), continue);
644 Buffer * child_clone = bit->second;
646 Inset * inset = dit.nextInset();
647 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
648 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
649 inset_inc->setChildBuffer(child_clone);
650 child_clone->d->setParent(buffer_clone);
651 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
652 buffer_clone->setChild(dit, child_clone);
654 buffer_clone->d->macro_lock = false;
659 Buffer * Buffer::cloneBufferOnly() const {
660 cloned_buffers.push_back(new CloneList);
661 CloneList * clones = cloned_buffers.back();
662 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
664 // The clone needs its own DocumentClass, since running updateBuffer() will
665 // modify it, and we would otherwise be sharing it with the original Buffer.
666 buffer_clone->params().makeDocumentClass(true);
668 cap::switchBetweenClasses(
669 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
670 static_cast<InsetText &>(buffer_clone->inset()), el);
672 clones->insert(buffer_clone);
673 buffer_clone->d->clone_list_ = clones;
675 // we won't be cloning the children
676 buffer_clone->d->children_positions.clear();
681 bool Buffer::isClone() const
683 return d->cloned_buffer_;
687 void Buffer::changed(bool update_metrics) const
690 d->wa_->redrawAll(update_metrics);
694 frontend::WorkAreaManager & Buffer::workAreaManager() const
701 Text & Buffer::text() const
703 return d->inset->text();
707 Inset & Buffer::inset() const
713 BufferParams & Buffer::params()
719 BufferParams const & Buffer::params() const
725 BufferParams const & Buffer::masterParams() const
727 if (masterBuffer() == this)
730 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
731 // Copy child authors to the params. We need those pointers.
732 for (Author const & a : params().authors())
733 mparams.authors().record(a);
738 double Buffer::fontScalingFactor() const
740 return isExporting() ? 75.0 * params().html_math_img_scale
741 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
745 ParagraphList & Buffer::paragraphs()
747 return text().paragraphs();
751 ParagraphList const & Buffer::paragraphs() const
753 return text().paragraphs();
757 LyXVC & Buffer::lyxvc()
763 LyXVC const & Buffer::lyxvc() const
769 string const Buffer::temppath() const
771 return d->temppath.absFileName();
775 TexRow & Buffer::texrow()
781 TexRow const & Buffer::texrow() const
787 TocBackend & Buffer::tocBackend() const
789 return d->toc_backend;
793 Undo & Buffer::undo()
799 void Buffer::setChild(DocIterator const & dit, Buffer * child)
801 d->children_positions[child] = dit;
805 string Buffer::latexName(bool const no_path) const
807 FileName latex_name =
808 makeLatexName(d->exportFileName());
809 return no_path ? latex_name.onlyFileName()
810 : latex_name.absFileName();
814 FileName Buffer::Impl::exportFileName() const
816 docstring const branch_suffix =
817 params.branchlist().getFileNameSuffix();
818 if (branch_suffix.empty())
821 string const name = addExtension(filename.onlyFileNameWithoutExt()
822 + to_utf8(branch_suffix), filename.extension());
823 FileName res(filename.onlyPath().absFileName() + "/" + name);
829 string Buffer::logName(LogType * type) const
831 string const filename = latexName(false);
833 if (filename.empty()) {
839 string const path = temppath();
841 FileName const fname(addName(temppath(),
842 onlyFileName(changeExtension(filename,
845 // FIXME: how do we know this is the name of the build log?
846 FileName const bname(
847 addName(path, onlyFileName(
848 changeExtension(filename,
849 theFormats().extension(params().bufferFormat()) + ".out"))));
851 // Also consider the master buffer log file
852 FileName masterfname = fname;
853 LogType mtype = latexlog;
854 if (masterBuffer() != this) {
855 string const mlogfile = masterBuffer()->logName(&mtype);
856 masterfname = FileName(mlogfile);
859 // If no Latex log or Build log is newer, show Build log
860 if (bname.exists() &&
861 ((!fname.exists() && !masterfname.exists())
862 || (fname.lastModified() < bname.lastModified()
863 && masterfname.lastModified() < bname.lastModified()))) {
864 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
867 return bname.absFileName();
868 // If we have a newer master file log or only a master log, show this
869 } else if (fname != masterfname
870 && (!fname.exists() && (masterfname.exists()
871 || fname.lastModified() < masterfname.lastModified()))) {
872 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
875 return masterfname.absFileName();
877 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
880 return fname.absFileName();
884 void Buffer::setReadonly(bool const flag)
886 if (d->read_only != flag) {
893 void Buffer::setFileName(FileName const & fname)
895 bool const changed = fname != d->filename;
897 d->refreshFileMonitor();
899 lyxvc().file_found_hook(fname);
900 setReadonly(d->filename.isReadOnly());
906 int Buffer::readHeader(Lexer & lex)
908 int unknown_tokens = 0;
910 int begin_header_line = -1;
912 // Initialize parameters that may be/go lacking in header:
913 params().branchlist().clear();
914 params().preamble.erase();
915 params().options.erase();
916 params().master.erase();
917 params().float_placement.erase();
918 params().float_alignment.erase();
919 params().paperwidth.erase();
920 params().paperheight.erase();
921 params().leftmargin.erase();
922 params().rightmargin.erase();
923 params().topmargin.erase();
924 params().bottommargin.erase();
925 params().headheight.erase();
926 params().headsep.erase();
927 params().footskip.erase();
928 params().columnsep.erase();
929 params().fonts_cjk.erase();
930 params().listings_params.clear();
931 params().clearLayoutModules();
932 params().clearRemovedModules();
933 params().clearIncludedChildren();
934 params().pdfoptions().clear();
935 params().indiceslist().clear();
936 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
937 params().isbackgroundcolor = false;
938 params().fontcolor = RGBColor(0, 0, 0);
939 params().isfontcolor = false;
940 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
941 params().boxbgcolor = RGBColor(0xFF, 0, 0);
942 params().html_latex_start.clear();
943 params().html_latex_end.clear();
944 params().html_math_img_scale = 1.0;
945 params().output_sync_macro.erase();
946 params().setLocalLayout(docstring(), false);
947 params().setLocalLayout(docstring(), true);
948 params().biblio_opts.erase();
949 params().biblatex_bibstyle.erase();
950 params().biblatex_citestyle.erase();
951 params().multibib.erase();
952 params().lineno_opts.clear();
954 for (int i = 0; i < 4; ++i) {
955 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
956 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
959 ErrorList & errorList = d->errorLists["Parse"];
968 if (token == "\\end_header")
972 if (token == "\\begin_header") {
973 begin_header_line = line;
977 LYXERR(Debug::PARSER, "Handling document header token: `"
980 string const result =
981 params().readToken(lex, token, d->filename.onlyPath());
982 if (!result.empty()) {
983 if (token == "\\textclass") {
984 d->layout_position = result;
987 docstring const s = bformat(_("Unknown token: "
991 errorList.push_back(ErrorItem(_("Document header error"), s));
995 if (begin_header_line) {
996 docstring const s = _("\\begin_header is missing");
997 errorList.push_back(ErrorItem(_("Document header error"), s));
1000 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1002 params().makeDocumentClass();
1004 return unknown_tokens;
1009 // changed to be public and have one parameter
1010 // Returns true if "\end_document" is not read (Asger)
1011 bool Buffer::readDocument(Lexer & lex)
1013 ErrorList & errorList = d->errorLists["Parse"];
1016 // remove dummy empty par
1017 paragraphs().clear();
1019 if (!lex.checkFor("\\begin_document")) {
1020 docstring const s = _("\\begin_document is missing");
1021 errorList.push_back(ErrorItem(_("Document header error"), s));
1026 if (params().output_changes) {
1027 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1028 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1029 LaTeXFeatures::isAvailable("xcolor");
1031 if (!dvipost && !xcolorulem) {
1032 Alert::warning(_("Changes not shown in LaTeX output"),
1033 _("Changes will not be highlighted in LaTeX output, "
1034 "because neither dvipost nor xcolor/ulem are installed.\n"
1035 "Please install these packages or redefine "
1036 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1037 } else if (!xcolorulem) {
1038 Alert::warning(_("Changes not shown in LaTeX output"),
1039 _("Changes will not be highlighted in LaTeX output "
1040 "when using pdflatex, because xcolor and ulem are not installed.\n"
1041 "Please install both packages or redefine "
1042 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1046 if (!parent() && !params().master.empty()) {
1047 FileName const master_file = makeAbsPath(params().master,
1048 onlyPath(absFileName()));
1049 if (isLyXFileName(master_file.absFileName())) {
1051 checkAndLoadLyXFile(master_file, true);
1053 // necessary e.g. after a reload
1054 // to re-register the child (bug 5873)
1055 // FIXME: clean up updateMacros (here, only
1056 // child registering is needed).
1057 master->updateMacros();
1058 // set master as master buffer, but only
1059 // if we are a real child
1060 if (master->isChild(this))
1062 // if the master is not fully loaded
1063 // it is probably just loading this
1064 // child. No warning needed then.
1065 else if (master->isFullyLoaded())
1066 LYXERR0("The master '"
1068 << "' assigned to this document ("
1070 << ") does not include "
1071 "this document. Ignoring the master assignment.");
1072 // If the master has just been created, un-hide it (#11162)
1073 if (!master->fileName().exists())
1074 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1075 master->absFileName()));
1080 // assure we have a default index
1081 params().indiceslist().addDefault(B_("Index"));
1084 if (FileName::isAbsolute(params().origin))
1085 d->old_position = params().origin;
1087 d->old_position = filePath();
1088 bool const res = text().read(lex, errorList, d->inset);
1089 d->old_position.clear();
1091 // inform parent buffer about local macros
1093 Buffer const * pbuf = parent();
1094 for (auto const & m : usermacros)
1095 pbuf->usermacros.insert(m);
1099 updateMacroInstances(InternalUpdate);
1104 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1106 Format const * fmt = theFormats().getFormat(format);
1109 // It is important to use the correct extension here, since some
1110 // converters create a wrong output file otherwise (e.g. html2latex)
1111 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1112 ofdocstream os(name.toFilesystemEncoding().c_str());
1113 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1114 bool const success = !(os << contents).fail();
1117 bool converted = false;
1119 params().compressed = false;
1121 // remove dummy empty par
1122 paragraphs().clear();
1124 converted = importFile(format, name, errorList);
1127 removeTempFile(name);
1132 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1134 if (!theConverters().isReachable(format, "lyx"))
1137 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1138 Converters::RetVal const retval =
1139 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1140 if (retval == Converters::SUCCESS) {
1141 bool const success = readFile(lyx) == ReadSuccess;
1142 removeTempFile(lyx);
1150 bool Buffer::readString(string const & s)
1152 params().compressed = false;
1155 istringstream is(s);
1157 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1158 FileName const fn = tempfile.name();
1161 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1163 if (success && file_format != LYX_FORMAT) {
1164 // We need to call lyx2lyx, so write the input to a file
1165 ofstream os(fn.toFilesystemEncoding().c_str());
1168 // lyxvc in readFile
1169 if (readFile(fn) != ReadSuccess)
1173 if (readDocument(lex))
1179 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1183 if (!lex.setFile(fname)) {
1184 Alert::error(_("File Not Found"),
1185 bformat(_("Unable to open file `%1$s'."),
1186 from_utf8(fn.absFileName())));
1187 return ReadFileNotFound;
1191 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1192 if (ret_plf != ReadSuccess)
1195 if (file_format != LYX_FORMAT) {
1197 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1198 if (ret_clf != ReadSuccess)
1200 ret_clf = readFile(tmpFile);
1201 if (ret_clf == ReadSuccess) {
1202 d->file_format = file_format;
1203 d->need_format_backup = true;
1208 // FIXME: InsetInfo needs to know whether the file is under VCS
1209 // during the parse process, so this has to be done before.
1210 lyxvc().file_found_hook(d->filename);
1212 if (readDocument(lex)) {
1213 Alert::error(_("Document format failure"),
1214 bformat(_("%1$s ended unexpectedly, which means"
1215 " that it is probably corrupted."),
1216 from_utf8(fn.absFileName())));
1217 return ReadDocumentFailure;
1220 d->file_fully_loaded = true;
1221 d->read_only = !d->filename.isWritable();
1222 params().compressed = theFormats().isZippedFile(d->filename);
1228 bool Buffer::isFullyLoaded() const
1230 return d->file_fully_loaded;
1234 void Buffer::setFullyLoaded(bool value)
1236 d->file_fully_loaded = value;
1240 bool Buffer::lastPreviewError() const
1242 return d->preview_error_;
1246 PreviewLoader * Buffer::loader() const
1248 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1250 if (!d->preview_loader_)
1251 d->preview_loader_ = new PreviewLoader(*this);
1252 return d->preview_loader_;
1256 void Buffer::removePreviews() const
1258 delete d->preview_loader_;
1259 d->preview_loader_ = 0;
1263 void Buffer::updatePreviews() const
1265 PreviewLoader * ploader = loader();
1269 InsetIterator it = inset_iterator_begin(*d->inset);
1270 InsetIterator const end = inset_iterator_end(*d->inset);
1271 for (; it != end; ++it)
1272 it->addPreview(it, *ploader);
1274 ploader->startLoading();
1278 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1279 FileName const & fn, int & file_format) const
1281 if(!lex.checkFor("\\lyxformat")) {
1282 Alert::error(_("Document format failure"),
1283 bformat(_("%1$s is not a readable LyX document."),
1284 from_utf8(fn.absFileName())));
1285 return ReadNoLyXFormat;
1291 // LyX formats 217 and earlier were written as 2.17. This corresponds
1292 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1293 // these cases. See also: www.lyx.org/trac/changeset/1313.
1294 size_t dot = tmp_format.find_first_of(".,");
1295 if (dot != string::npos)
1296 tmp_format.erase(dot, 1);
1298 file_format = convert<int>(tmp_format);
1303 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1304 FileName & tmpfile, int from_format)
1306 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1307 tempfile.setAutoRemove(false);
1308 tmpfile = tempfile.name();
1309 if(tmpfile.empty()) {
1310 Alert::error(_("Conversion failed"),
1311 bformat(_("%1$s is from a different"
1312 " version of LyX, but a temporary"
1313 " file for converting it could"
1314 " not be created."),
1315 from_utf8(fn.absFileName())));
1316 return LyX2LyXNoTempFile;
1319 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1320 if (lyx2lyx.empty()) {
1321 Alert::error(_("Conversion script not found"),
1322 bformat(_("%1$s is from a different"
1323 " version of LyX, but the"
1324 " conversion script lyx2lyx"
1325 " could not be found."),
1326 from_utf8(fn.absFileName())));
1327 return LyX2LyXNotFound;
1331 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1332 ostringstream command;
1333 command << os::python()
1334 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1335 << " -t " << convert<string>(LYX_FORMAT)
1336 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1337 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1338 string const command_str = command.str();
1340 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1342 cmd_ret const ret = runCommand(command_str);
1343 if (ret.first != 0) {
1344 if (from_format < LYX_FORMAT) {
1345 Alert::error(_("Conversion script failed"),
1346 bformat(_("%1$s is from an older version"
1347 " of LyX and the lyx2lyx script"
1348 " failed to convert it."),
1349 from_utf8(fn.absFileName())));
1350 return LyX2LyXOlderFormat;
1352 Alert::error(_("Conversion script failed"),
1353 bformat(_("%1$s is from a newer version"
1354 " of LyX and the lyx2lyx script"
1355 " failed to convert it."),
1356 from_utf8(fn.absFileName())));
1357 return LyX2LyXNewerFormat;
1364 FileName Buffer::getBackupName() const {
1365 map<int, string> const file_formats = {
1382 FileName const & fn = fileName();
1383 string const fname = fn.onlyFileNameWithoutExt();
1384 string const fext = fn.extension() + "~";
1385 string const fpath = lyxrc.backupdir_path.empty() ?
1386 fn.onlyPath().absFileName() :
1387 lyxrc.backupdir_path;
1388 string backup_suffix;
1389 // If file format is from a stable series use version instead of file format
1390 auto const it = file_formats.find(d->file_format);
1391 if (it != file_formats.end())
1392 backup_suffix = "-lyx" + it->second;
1394 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1395 string const backname = fname + backup_suffix;
1396 FileName backup(addName(fpath, addExtension(backname, fext)));
1398 // limit recursion, just in case
1400 unsigned long orig_checksum = 0;
1401 while (backup.exists() && v < 100) {
1402 if (orig_checksum == 0)
1403 orig_checksum = fn.checksum();
1404 unsigned long new_checksum = backup.checksum();
1405 if (orig_checksum == new_checksum) {
1406 LYXERR(Debug::FILES, "Not backing up " << fn <<
1407 "since " << backup << "has the same checksum.");
1408 // a bit of a hack, but we have to check this anyway
1409 // below, and setting this is simpler than introducing
1410 // a special boolean for this purpose.
1414 string const newbackname = backname + "-" + convert<string>(v);
1415 backup.set(addName(fpath, addExtension(newbackname, fext)));
1418 return v < 100 ? backup : FileName();
1422 // Should probably be moved to somewhere else: BufferView? GuiView?
1423 bool Buffer::save() const
1425 docstring const file = makeDisplayPath(absFileName(), 20);
1426 d->filename.refresh();
1428 // check the read-only status before moving the file as a backup
1429 if (d->filename.exists()) {
1430 bool const read_only = !d->filename.isWritable();
1432 Alert::warning(_("File is read-only"),
1433 bformat(_("The file %1$s cannot be written because it "
1434 "is marked as read-only."), file));
1439 // ask if the disk file has been externally modified (use checksum method)
1440 if (fileName().exists() && isChecksumModified()) {
1442 bformat(_("Document %1$s has been externally modified. "
1443 "Are you sure you want to overwrite this file?"), file);
1444 int const ret = Alert::prompt(_("Overwrite modified file?"),
1445 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1450 // We don't need autosaves in the immediate future. (Asger)
1451 resetAutosaveTimers();
1453 // if the file does not yet exist, none of the backup activity
1454 // that follows is necessary
1455 if (!fileName().exists()) {
1456 if (!writeFile(fileName()))
1462 // we first write the file to a new name, then move it to its
1463 // proper location once that has been done successfully. that
1464 // way we preserve the original file if something goes wrong.
1465 string const justname = fileName().onlyFileNameWithoutExt();
1466 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1467 justname + "-XXXXXX.lyx");
1468 bool const symlink = fileName().isSymLink();
1470 tempfile->setAutoRemove(false);
1472 FileName savefile(tempfile->name());
1473 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1474 if (!savefile.clonePermissions(fileName()))
1475 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1477 if (!writeFile(savefile))
1480 // we will set this to false if we fail
1481 bool made_backup = true;
1483 FileName backupName;
1484 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1486 if (d->need_format_backup)
1487 backupName = getBackupName();
1489 // If we for some reason failed to find a backup name in case of
1490 // a format change, this will still set one. It's the best we can
1492 if (backupName.empty()) {
1493 backupName.set(fileName().absFileName() + "~");
1494 if (!lyxrc.backupdir_path.empty()) {
1495 string const mangledName =
1496 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1497 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1501 LYXERR(Debug::FILES, "Backing up original file to " <<
1502 backupName.absFileName());
1503 // Except file is symlink do not copy because of #6587.
1504 // Hard links have bad luck.
1505 made_backup = symlink ?
1506 fileName().copyTo(backupName):
1507 fileName().moveTo(backupName);
1510 Alert::error(_("Backup failure"),
1511 bformat(_("Cannot create backup file %1$s.\n"
1512 "Please check whether the directory exists and is writable."),
1513 from_utf8(backupName.absFileName())));
1514 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1515 } else if (d->need_format_backup) {
1516 // the original file has been backed up successfully, so we
1517 // will not need to do that again
1518 d->need_format_backup = false;
1522 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1523 // Only do this if tempfile is not in autoremove mode
1526 // If we have no symlink, we can simply rename the temp file.
1527 // Otherwise, we need to copy it so the symlink stays intact.
1528 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1529 savefile.moveTo(fileName()))
1531 // saveCheckSum() was already called by writeFile(), but the
1532 // time stamp is invalidated by copying/moving
1535 if (d->file_format != LYX_FORMAT)
1536 // the file associated with this buffer is now in the current format
1537 d->file_format = LYX_FORMAT;
1540 // else we saved the file, but failed to move it to the right location.
1542 if (needBackup && made_backup && !symlink) {
1543 // the original file was moved to some new location, so it will look
1544 // to the user as if it was deleted. (see bug #9234.) we could try
1545 // to restore it, but that would basically mean trying to do again
1546 // what we just failed to do. better to leave things as they are.
1547 Alert::error(_("Write failure"),
1548 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1549 "But LyX could not move it to:\n %2$s.\n"
1550 "Your original file has been backed up to:\n %3$s"),
1551 from_utf8(savefile.absFileName()),
1552 from_utf8(fileName().absFileName()),
1553 from_utf8(backupName.absFileName())));
1555 // either we did not try to make a backup, or else we tried and failed,
1556 // or else the original file was a symlink, in which case it was copied,
1557 // not moved. so the original file is intact.
1558 Alert::error(_("Write failure"),
1559 bformat(_("Cannot move saved file to:\n %1$s.\n"
1560 "But the file has successfully been saved as:\n %2$s."),
1561 from_utf8(fileName().absFileName()),
1562 from_utf8(savefile.absFileName())));
1568 bool Buffer::writeFile(FileName const & fname) const
1570 if (d->read_only && fname == d->filename)
1573 bool retval = false;
1575 docstring const str = bformat(_("Saving document %1$s..."),
1576 makeDisplayPath(fname.absFileName()));
1579 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1581 if (params().compressed) {
1582 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1583 retval = ofs && write(ofs);
1585 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1586 retval = ofs && write(ofs);
1590 message(str + _(" could not write file!"));
1595 // removeAutosaveFile();
1598 message(str + _(" done."));
1604 docstring Buffer::emergencyWrite()
1606 // No need to save if the buffer has not changed.
1610 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1612 docstring user_message = bformat(
1613 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1615 // We try to save three places:
1616 // 1) Same place as document. Unless it is an unnamed doc.
1618 string s = absFileName();
1621 if (writeFile(FileName(s))) {
1623 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1624 return user_message;
1626 user_message += " " + _("Save failed! Trying again...\n");
1630 // 2) In HOME directory.
1631 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1633 lyxerr << ' ' << s << endl;
1634 if (writeFile(FileName(s))) {
1636 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1637 return user_message;
1640 user_message += " " + _("Save failed! Trying yet again...\n");
1642 // 3) In "/tmp" directory.
1643 // MakeAbsPath to prepend the current
1644 // drive letter on OS/2
1645 s = addName(package().temp_dir().absFileName(), absFileName());
1647 lyxerr << ' ' << s << endl;
1648 if (writeFile(FileName(s))) {
1650 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1651 return user_message;
1654 user_message += " " + _("Save failed! Document is lost.");
1657 return user_message;
1661 bool Buffer::write(ostream & ofs) const
1664 // Use the standard "C" locale for file output.
1665 ofs.imbue(locale::classic());
1668 // The top of the file should not be written by params().
1670 // write out a comment in the top of the file
1671 // Important: Keep the version formatting in sync with lyx2lyx and
1672 // tex2lyx (bug 7951)
1673 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1674 << " created this file. For more info see https://www.lyx.org/\n"
1675 << "\\lyxformat " << LYX_FORMAT << "\n"
1676 << "\\begin_document\n";
1678 /// For each author, set 'used' to true if there is a change
1679 /// by this author in the document; otherwise set it to 'false'.
1680 for (Author const & a : params().authors())
1683 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1684 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1685 for ( ; it != end; ++it)
1686 it->checkAuthors(params().authors());
1688 // now write out the buffer parameters.
1689 ofs << "\\begin_header\n";
1690 params().writeFile(ofs, this);
1691 ofs << "\\end_header\n";
1694 ofs << "\n\\begin_body\n";
1696 ofs << "\n\\end_body\n";
1698 // Write marker that shows file is complete
1699 ofs << "\\end_document" << endl;
1701 // Shouldn't really be needed....
1704 // how to check if close went ok?
1705 // Following is an attempt... (BE 20001011)
1707 // good() returns false if any error occurred, including some
1708 // formatting error.
1709 // bad() returns true if something bad happened in the buffer,
1710 // which should include file system full errors.
1715 lyxerr << "File was not closed properly." << endl;
1722 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1723 string const & original_path,
1724 OutputParams const & runparams_in,
1725 OutputWhat output) const
1727 OutputParams runparams = runparams_in;
1729 string const encoding = runparams.encoding->iconvName();
1730 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1733 try { ofs.reset(encoding); }
1734 catch (iconv_codecvt_facet_exception const & e) {
1735 lyxerr << "Caught iconv exception: " << e.what() << endl;
1736 Alert::error(_("Iconv software exception Detected"),
1737 bformat(_("Please verify that the `iconv' support software is"
1738 " properly installed and supports the selected encoding"
1739 " (%1$s), or change the encoding in"
1740 " Document>Settings>Language."), from_ascii(encoding)));
1743 if (!openFileWrite(ofs, fname))
1746 ErrorList & errorList = d->errorLists["Export"];
1748 ExportStatus status = ExportSuccess;
1751 // make sure we are ready to export
1752 // this needs to be done before we validate
1753 // FIXME Do we need to do this all the time? I.e., in children
1754 // of a master we are exporting?
1756 updateMacroInstances(OutputUpdate);
1758 ExportStatus retval;
1760 retval = writeLaTeXSource(os, original_path, runparams, output);
1761 if (retval == ExportKilled)
1762 return ExportKilled;
1764 catch (EncodingException const & e) {
1765 docstring const failed(1, e.failed_char);
1767 oss << "0x" << hex << e.failed_char << dec;
1768 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1769 docstring msg = bformat(_("Uncodable character '%1$s'"
1770 " (code point %2$s)"),
1771 failed, from_utf8(oss.str()));
1772 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1773 "representable in specific verbatim contexts.\n"
1774 "Changing the document encoding to utf8 could help."),
1775 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1777 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1778 " (code point %2$s)"),
1779 failed, from_utf8(oss.str()));
1780 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1781 "representable in the chosen encoding.\n"
1782 "Changing the document encoding to utf8 could help."),
1783 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1785 status = ExportError;
1787 catch (iconv_codecvt_facet_exception const & e) {
1788 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1790 status = ExportError;
1792 catch (exception const & e) {
1793 errorList.push_back(ErrorItem(_("conversion failed"),
1795 lyxerr << e.what() << endl;
1796 status = ExportError;
1799 lyxerr << "Caught some really weird exception..." << endl;
1803 d->texrow = move(os.texrow());
1807 status = ExportError;
1808 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1811 if (runparams_in.silent)
1819 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1820 string const & original_path,
1821 OutputParams const & runparams_in,
1822 OutputWhat output) const
1824 // The child documents, if any, shall be already loaded at this point.
1826 OutputParams runparams = runparams_in;
1828 // Some macros rely on font encoding
1829 runparams.main_fontenc = params().main_font_encoding();
1831 // If we are compiling a file standalone, even if this is the
1832 // child of some other buffer, let's cut the link here, so the
1833 // file is really independent and no concurring settings from
1834 // the master (e.g. branch state) interfere (see #8100).
1835 if (!runparams.is_child)
1836 d->ignore_parent = true;
1838 // Classify the unicode characters appearing in math insets
1839 BufferEncodings::initUnicodeMath(*this);
1841 // validate the buffer.
1842 LYXERR(Debug::LATEX, " Validating buffer...");
1843 LaTeXFeatures features(*this, params(), runparams);
1845 // This is only set once per document (in master)
1846 if (!runparams.is_child) {
1847 runparams.use_polyglossia = features.usePolyglossia();
1848 runparams.use_CJK = features.mustProvide("CJK");
1850 LYXERR(Debug::LATEX, " Buffer validation done.");
1852 bool const output_preamble =
1853 output == FullSource || output == OnlyPreamble;
1854 bool const output_body =
1855 output == FullSource || output == OnlyBody;
1857 // The starting paragraph of the coming rows is the
1858 // first paragraph of the document. (Asger)
1859 if (output_preamble && runparams.nice) {
1860 os << "%% LyX " << lyx_version << " created this file. "
1861 "For more info, see https://www.lyx.org/.\n"
1862 "%% Do not edit unless you really know what "
1865 LYXERR(Debug::INFO, "lyx document header finished");
1867 // There are a few differences between nice LaTeX and usual files:
1868 // usual files have \batchmode and special input@path to allow
1869 // inclusion of figures specified by an explicitly relative path
1870 // (i.e., a path starting with './' or '../') with either \input or
1871 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1872 // input@path is set when the actual parameter original_path is set.
1873 // This is done for usual tex-file, but not for nice-latex-file.
1874 // (Matthias 250696)
1875 // Note that input@path is only needed for something the user does
1876 // in the preamble, included .tex files or ERT, files included by
1877 // LyX work without it.
1878 if (output_preamble) {
1879 if (!runparams.nice) {
1880 // code for usual, NOT nice-latex-file
1881 os << "\\batchmode\n"; // changed from \nonstopmode
1883 if (!original_path.empty()) {
1885 // We don't know the encoding of inputpath
1886 docstring const inputpath = from_utf8(original_path);
1887 docstring uncodable_glyphs;
1888 Encoding const * const enc = runparams.encoding;
1890 for (size_t n = 0; n < inputpath.size(); ++n) {
1891 if (!enc->encodable(inputpath[n])) {
1892 docstring const glyph(1, inputpath[n]);
1893 LYXERR0("Uncodable character '"
1895 << "' in input path!");
1896 uncodable_glyphs += glyph;
1901 // warn user if we found uncodable glyphs.
1902 if (!uncodable_glyphs.empty()) {
1903 frontend::Alert::warning(
1904 _("Uncodable character in file path"),
1906 _("The path of your document\n"
1908 "contains glyphs that are unknown "
1909 "in the current document encoding "
1910 "(namely %2$s). This may result in "
1911 "incomplete output, unless "
1912 "TEXINPUTS contains the document "
1913 "directory and you don't use "
1914 "explicitly relative paths (i.e., "
1915 "paths starting with './' or "
1916 "'../') in the preamble or in ERT."
1917 "\n\nIn case of problems, choose "
1918 "an appropriate document encoding\n"
1919 "(such as utf8) or change the "
1921 inputpath, uncodable_glyphs));
1923 string docdir = os::latex_path(original_path);
1924 if (contains(docdir, '#')) {
1925 docdir = subst(docdir, "#", "\\#");
1926 os << "\\catcode`\\#=11"
1927 "\\def\\#{#}\\catcode`\\#=6\n";
1929 if (contains(docdir, '%')) {
1930 docdir = subst(docdir, "%", "\\%");
1931 os << "\\catcode`\\%=11"
1932 "\\def\\%{%}\\catcode`\\%=14\n";
1934 bool const detokenize = !isAscii(from_utf8(docdir))
1935 || contains(docdir, '~');
1936 bool const quote = contains(docdir, ' ');
1937 os << "\\makeatletter\n"
1938 << "\\def\\input@path{{";
1940 os << "\\detokenize{";
1949 << "\\makeatother\n";
1953 // get parent macros (if this buffer has a parent) which will be
1954 // written at the document begin further down.
1955 MacroSet parentMacros;
1956 listParentMacros(parentMacros, features);
1958 // Write the preamble
1959 runparams.use_babel = params().writeLaTeX(os, features,
1960 d->filename.onlyPath());
1962 // Biblatex bibliographies are loaded here
1963 if (params().useBiblatex()) {
1964 vector<pair<docstring, string>> const bibfiles =
1965 prepareBibFilePaths(runparams, getBibfiles(), true);
1966 for (pair<docstring, string> const & file: bibfiles) {
1967 os << "\\addbibresource";
1968 if (!file.second.empty())
1969 os << "[bibencoding=" << file.second << "]";
1970 os << "{" << file.first << "}\n";
1974 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1975 && !features.hasOnlyPolyglossiaLanguages()) {
1978 vector<string> bll = features.getBabelExclusiveLanguages();
1979 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1982 for (string const & sit : bll) {
1987 blangs = bll.size() > 1 ?
1988 bformat(_("The languages %1$s are only supported by Babel."), langs)
1989 : bformat(_("The language %1$s is only supported by Babel."), langs);
1993 for (string const & pit : pll) {
1998 plangs = pll.size() > 1 ?
1999 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2000 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2001 if (!blangs.empty())
2005 frontend::Alert::warning(
2006 _("Incompatible Languages!"),
2008 _("You cannot use the following languages "
2009 "together in one LaTeX document because "
2010 "they require conflicting language packages:\n"
2015 // Japanese might be required only in some children of a document,
2016 // but once required, we must keep use_japanese true.
2017 runparams.use_japanese |= features.isRequired("japanese");
2020 // Restore the parenthood if needed
2021 if (!runparams.is_child)
2022 d->ignore_parent = false;
2023 return ExportSuccess;
2027 // mark the beginning of the body to separate it from InPreamble insets
2028 os.texrow().start(TexRow::beginDocument());
2029 os << "\\begin{document}\n";
2031 // mark the start of a new paragraph by simulating a newline,
2032 // so that os.afterParbreak() returns true at document start
2035 // output the parent macros
2036 for (auto const & mac : parentMacros) {
2037 int num_lines = mac->write(os.os(), true);
2038 os.texrow().newlines(num_lines);
2041 } // output_preamble
2043 LYXERR(Debug::INFO, "preamble finished, now the body.");
2047 latexParagraphs(*this, text(), os, runparams);
2049 catch (ConversionException const &) { return ExportKilled; }
2051 // Restore the parenthood if needed
2052 if (!runparams.is_child)
2053 d->ignore_parent = false;
2055 // add this just in case after all the paragraphs
2058 if (output_preamble) {
2059 os << "\\end{document}\n";
2060 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2062 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2064 runparams_in.encoding = runparams.encoding;
2066 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2067 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2068 return ExportSuccess;
2072 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2073 OutputParams const & runparams,
2074 OutputWhat output) const
2076 LYXERR(Debug::LATEX, "makeDocBookFile...");
2079 if (!openFileWrite(ofs, fname))
2082 // make sure we are ready to export
2083 // this needs to be done before we validate
2085 updateMacroInstances(OutputUpdate);
2087 ExportStatus const retval =
2088 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2089 if (retval == ExportKilled)
2090 return ExportKilled;
2094 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2095 return ExportSuccess;
2099 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2100 OutputParams const & runparams,
2101 OutputWhat output) const
2103 LaTeXFeatures features(*this, params(), runparams);
2108 DocumentClass const & tclass = params().documentClass();
2109 string const & top_element = tclass.latexname();
2111 bool const output_preamble =
2112 output == FullSource || output == OnlyPreamble;
2113 bool const output_body =
2114 output == FullSource || output == OnlyBody;
2116 if (output_preamble) {
2117 if (runparams.flavor == OutputParams::XML)
2118 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2121 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2124 if (! tclass.class_header().empty())
2125 os << from_ascii(tclass.class_header());
2126 else if (runparams.flavor == OutputParams::XML)
2127 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2128 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2130 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2132 docstring preamble = params().preamble;
2133 if (runparams.flavor != OutputParams::XML ) {
2134 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2135 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2136 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2137 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2140 string const name = runparams.nice
2141 ? changeExtension(absFileName(), ".sgml") : fname;
2142 preamble += features.getIncludedFiles(name);
2143 preamble += features.getLyXSGMLEntities();
2145 if (!preamble.empty()) {
2146 os << "\n [ " << preamble << " ]";
2152 string top = top_element;
2154 if (runparams.flavor == OutputParams::XML)
2155 top += params().language->code();
2157 top += params().language->code().substr(0, 2);
2160 if (!params().options.empty()) {
2162 top += params().options;
2165 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2166 << " file was created by LyX " << lyx_version
2167 << "\n See https://www.lyx.org/ for more information -->\n";
2169 params().documentClass().counters().reset();
2171 sgml::openTag(os, top);
2174 docbookParagraphs(text(), *this, os, runparams);
2176 catch (ConversionException const &) { return ExportKilled; }
2177 sgml::closeTag(os, top_element);
2179 return ExportSuccess;
2183 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2184 OutputParams const & runparams) const
2186 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2189 if (!openFileWrite(ofs, fname))
2192 // make sure we are ready to export
2193 // this has to be done before we validate
2194 updateBuffer(UpdateMaster, OutputUpdate);
2195 updateMacroInstances(OutputUpdate);
2197 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2198 if (retval == ExportKilled)
2203 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2208 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2209 OutputParams const & runparams,
2210 OutputWhat output) const
2212 LaTeXFeatures features(*this, params(), runparams);
2214 d->bibinfo_.makeCitationLabels(*this);
2216 bool const output_preamble =
2217 output == FullSource || output == OnlyPreamble;
2218 bool const output_body =
2219 output == FullSource || output == OnlyBody || output == IncludedFile;
2221 if (output_preamble) {
2222 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2223 << "<!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"
2224 // FIXME Language should be set properly.
2225 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2227 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2228 // FIXME Presumably need to set this right
2229 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2231 docstring const & doctitle = features.htmlTitle();
2233 << (doctitle.empty() ?
2234 from_ascii("LyX Document") :
2235 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2238 docstring styles = features.getTClassHTMLPreamble();
2239 if (!styles.empty())
2240 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2242 styles = features.getPreambleSnippets().str;
2243 if (!styles.empty())
2244 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2246 // we will collect CSS information in a stream, and then output it
2247 // either here, as part of the header, or else in a separate file.
2248 odocstringstream css;
2249 styles = features.getCSSSnippets();
2250 if (!styles.empty())
2251 css << "/* LyX Provided Styles */\n" << styles << '\n';
2253 styles = features.getTClassHTMLStyles();
2254 if (!styles.empty())
2255 css << "/* Layout-provided Styles */\n" << styles << '\n';
2257 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2258 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2259 if (needfg || needbg) {
2260 css << "\nbody {\n";
2263 << from_ascii(X11hexname(params().fontcolor))
2266 css << " background-color: "
2267 << from_ascii(X11hexname(params().backgroundcolor))
2272 docstring const dstyles = css.str();
2273 if (!dstyles.empty()) {
2274 bool written = false;
2275 if (params().html_css_as_file) {
2276 // open a file for CSS info
2278 string const fcssname = addName(temppath(), "docstyle.css");
2279 FileName const fcssfile = FileName(fcssname);
2280 if (openFileWrite(ocss, fcssfile)) {
2284 // write link to header
2285 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2287 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2290 // we are here if the CSS is supposed to be written to the header
2291 // or if we failed to write it to an external file.
2293 os << "<style type='text/css'>\n"
2302 bool const output_body_tag = (output != IncludedFile);
2303 if (output_body_tag)
2304 os << "<body dir=\"auto\">\n";
2306 if (output != IncludedFile)
2307 // if we're an included file, the counters are in the master.
2308 params().documentClass().counters().reset();
2310 xhtmlParagraphs(text(), *this, xs, runparams);
2312 catch (ConversionException const &) { return ExportKilled; }
2313 if (output_body_tag)
2317 if (output_preamble)
2320 return ExportSuccess;
2324 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2325 // Other flags: -wall -v0 -x
2326 int Buffer::runChktex()
2330 // get LaTeX-Filename
2331 FileName const path(temppath());
2332 string const name = addName(path.absFileName(), latexName());
2333 string const org_path = filePath();
2335 PathChanger p(path); // path to LaTeX file
2336 message(_("Running chktex..."));
2338 // Generate the LaTeX file if neccessary
2339 OutputParams runparams(¶ms().encoding());
2340 runparams.flavor = OutputParams::LATEX;
2341 runparams.nice = false;
2342 runparams.linelen = lyxrc.plaintext_linelen;
2343 ExportStatus const retval =
2344 makeLaTeXFile(FileName(name), org_path, runparams);
2345 if (retval != ExportSuccess) {
2346 // error code on failure
2351 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2352 int const res = chktex.run(terr); // run chktex
2355 Alert::error(_("chktex failure"),
2356 _("Could not run chktex successfully."));
2358 ErrorList & errlist = d->errorLists["ChkTeX"];
2360 bufferErrors(terr, errlist);
2365 if (runparams.silent)
2366 d->errorLists["ChkTeX"].clear();
2374 void Buffer::validate(LaTeXFeatures & features) const
2376 // Validate the buffer params, but not for included
2377 // files, since they also use the parent buffer's
2379 if (!features.runparams().is_child)
2380 params().validate(features);
2382 for (Paragraph const & p : paragraphs())
2383 p.validate(features);
2385 if (lyxerr.debugging(Debug::LATEX)) {
2386 features.showStruct();
2391 void Buffer::getLabelList(vector<docstring> & list) const
2393 // If this is a child document, use the master's list instead.
2395 masterBuffer()->getLabelList(list);
2400 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2401 for (auto const & tocit : *toc) {
2402 if (tocit.depth() == 0)
2403 list.push_back(tocit.str());
2408 void Buffer::invalidateBibinfoCache() const
2410 d->bibinfo_cache_valid_ = false;
2411 d->cite_labels_valid_ = false;
2412 removeBiblioTempFiles();
2413 // also invalidate the cache for the parent buffer
2414 Buffer const * const pbuf = d->parent();
2416 pbuf->invalidateBibinfoCache();
2420 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2422 // FIXME This is probably unnecessary, given where we call this.
2423 // If this is a child document, use the master instead.
2424 Buffer const * const pbuf = masterBuffer();
2425 if (pbuf != this && scope != UpdateChildOnly)
2426 return pbuf->getBibfiles();
2428 // In 2.3.x, we have:
2429 //if (!d->bibfile_cache_valid_)
2430 // this->updateBibfilesCache(scope);
2431 // I think that is a leftover, but there have been so many back-
2432 // and-forths with this, due to Windows issues, that I am not sure.
2434 return d->bibfiles_cache_;
2438 BiblioInfo const & Buffer::masterBibInfo() const
2440 Buffer const * const tmp = masterBuffer();
2442 return tmp->masterBibInfo();
2447 BiblioInfo const & Buffer::bibInfo() const
2453 void Buffer::registerBibfiles(const docstring_list & bf) const
2455 // We register the bib files in the master buffer,
2456 // if there is one, but also in every single buffer,
2457 // in case a child is compiled alone.
2458 Buffer const * const tmp = masterBuffer();
2460 tmp->registerBibfiles(bf);
2462 for (auto const & p : bf) {
2463 docstring_list::const_iterator temp =
2464 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2465 if (temp == d->bibfiles_cache_.end())
2466 d->bibfiles_cache_.push_back(p);
2471 static map<docstring, FileName> bibfileCache;
2473 FileName Buffer::getBibfilePath(docstring const & bibid) const
2475 map<docstring, FileName>::const_iterator it =
2476 bibfileCache.find(bibid);
2477 if (it != bibfileCache.end()) {
2478 // i.e., return bibfileCache[bibid];
2482 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2483 string const texfile = changeExtension(to_utf8(bibid), "bib");
2484 // we need to check first if this file exists where it's said to be.
2485 // there's a weird bug that occurs otherwise: if the file is in the
2486 // Buffer's directory but has the same name as some file that would be
2487 // found by kpsewhich, then we find the latter, not the former.
2488 FileName const local_file = makeAbsPath(texfile, filePath());
2489 FileName file = local_file;
2490 if (!file.exists()) {
2491 // there's no need now to check whether the file can be found
2493 file = findtexfile(texfile, "bib", true);
2497 LYXERR(Debug::FILES, "Found at: " << file);
2499 bibfileCache[bibid] = file;
2500 return bibfileCache[bibid];
2504 void Buffer::checkIfBibInfoCacheIsValid() const
2506 // use the master's cache
2507 Buffer const * const tmp = masterBuffer();
2509 tmp->checkIfBibInfoCacheIsValid();
2513 // If we already know the cache is invalid, stop here.
2514 // This is important in the case when the bibliography
2515 // environment (rather than Bib[la]TeX) is used.
2516 // In that case, the timestamp check below gives no
2517 // sensible result. Rather than that, the cache will
2518 // be invalidated explicitly via invalidateBibInfoCache()
2519 // by the Bibitem inset.
2520 // Same applies for bib encoding changes, which trigger
2521 // invalidateBibInfoCache() by InsetBibtex.
2522 if (!d->bibinfo_cache_valid_)
2525 if (d->have_bibitems_) {
2526 // We have a bibliography environment.
2527 // Invalidate the bibinfo cache unconditionally.
2528 // Cite labels will get invalidated by the inset if needed.
2529 d->bibinfo_cache_valid_ = false;
2533 // OK. This is with Bib(la)tex. We'll assume the cache
2534 // is valid and change this if we find changes in the bibs.
2535 d->bibinfo_cache_valid_ = true;
2536 d->cite_labels_valid_ = true;
2538 // compare the cached timestamps with the actual ones.
2539 docstring_list const & bibfiles_cache = getBibfiles();
2540 for (auto const & bf : bibfiles_cache) {
2541 FileName const fn = getBibfilePath(bf);
2542 time_t lastw = fn.lastModified();
2543 time_t prevw = d->bibfile_status_[fn];
2544 if (lastw != prevw) {
2545 d->bibinfo_cache_valid_ = false;
2546 d->cite_labels_valid_ = false;
2547 d->bibfile_status_[fn] = lastw;
2553 void Buffer::clearBibFileCache() const
2555 bibfileCache.clear();
2559 void Buffer::reloadBibInfoCache(bool const force) const
2561 // we should not need to do this for internal buffers
2565 // use the master's cache
2566 Buffer const * const tmp = masterBuffer();
2568 tmp->reloadBibInfoCache(force);
2573 checkIfBibInfoCacheIsValid();
2574 if (d->bibinfo_cache_valid_)
2578 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2579 // re-read file locations when this info changes
2580 // FIXME Is this sufficient? Or should we also force that
2581 // in some other cases? If so, then it is easy enough to
2582 // add the following line in some other places.
2583 clearBibFileCache();
2584 d->bibinfo_.clear();
2585 FileNameList checkedFiles;
2586 d->have_bibitems_ = false;
2587 collectBibKeys(checkedFiles);
2588 d->bibinfo_cache_valid_ = true;
2592 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2594 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2595 it->collectBibKeys(it, checkedFiles);
2596 if (it->lyxCode() == BIBITEM_CODE) {
2598 parent()->d->have_bibitems_ = true;
2600 d->have_bibitems_ = true;
2606 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2608 // We add the biblio info to the master buffer,
2609 // if there is one, but also to every single buffer,
2610 // in case a child is compiled alone.
2611 BiblioInfo & bi = d->bibinfo_;
2612 bi.mergeBiblioInfo(bin);
2614 if (parent() != 0) {
2615 BiblioInfo & masterbi = parent()->d->bibinfo_;
2616 masterbi.mergeBiblioInfo(bin);
2621 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2623 // We add the bibtex info to the master buffer,
2624 // if there is one, but also to every single buffer,
2625 // in case a child is compiled alone.
2626 BiblioInfo & bi = d->bibinfo_;
2629 if (parent() != 0) {
2630 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2631 masterbi[key] = bin;
2636 void Buffer::makeCitationLabels() const
2638 Buffer const * const master = masterBuffer();
2639 return d->bibinfo_.makeCitationLabels(*master);
2643 void Buffer::invalidateCiteLabels() const
2645 masterBuffer()->d->cite_labels_valid_ = false;
2648 bool Buffer::citeLabelsValid() const
2650 return masterBuffer()->d->cite_labels_valid_;
2654 void Buffer::removeBiblioTempFiles() const
2656 // We remove files that contain LaTeX commands specific to the
2657 // particular bibliographic style being used, in order to avoid
2658 // LaTeX errors when we switch style.
2659 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2660 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2661 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2662 aux_file.removeFile();
2663 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2664 bbl_file.removeFile();
2665 // Also for the parent buffer
2666 Buffer const * const pbuf = parent();
2668 pbuf->removeBiblioTempFiles();
2672 bool Buffer::isDepClean(string const & name) const
2674 DepClean::const_iterator const it = d->dep_clean.find(name);
2675 if (it == d->dep_clean.end())
2681 void Buffer::markDepClean(string const & name)
2683 d->dep_clean[name] = true;
2687 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2690 // FIXME? if there is an Buffer LFUN that can be dispatched even
2691 // if internal, put a switch '(cmd.action)' here.
2697 switch (cmd.action()) {
2699 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2700 flag.setOnOff(hasReadonlyFlag());
2703 // FIXME: There is need for a command-line import.
2704 //case LFUN_BUFFER_IMPORT:
2706 case LFUN_BUFFER_AUTO_SAVE:
2709 case LFUN_BUFFER_EXPORT_CUSTOM:
2710 // FIXME: Nothing to check here?
2713 case LFUN_BUFFER_EXPORT: {
2714 docstring const arg = cmd.argument();
2715 if (arg == "custom") {
2719 string format = (arg.empty() || arg == "default") ?
2720 params().getDefaultOutputFormat() : to_utf8(arg);
2721 size_t pos = format.find(' ');
2722 if (pos != string::npos)
2723 format = format.substr(0, pos);
2724 enable = params().isExportable(format, false);
2726 flag.message(bformat(
2727 _("Don't know how to export to format: %1$s"), arg));
2731 case LFUN_BUILD_PROGRAM:
2732 enable = params().isExportable("program", false);
2735 case LFUN_BRANCH_ACTIVATE:
2736 case LFUN_BRANCH_DEACTIVATE:
2737 case LFUN_BRANCH_MASTER_ACTIVATE:
2738 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2739 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2740 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2741 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2742 : params().branchlist();
2743 docstring const branchName = cmd.argument();
2744 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2748 case LFUN_BRANCH_ADD:
2749 case LFUN_BRANCHES_RENAME:
2750 // if no Buffer is present, then of course we won't be called!
2753 case LFUN_BUFFER_LANGUAGE:
2754 enable = !isReadonly();
2757 case LFUN_BUFFER_VIEW_CACHE:
2758 (d->preview_file_).refresh();
2759 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2762 case LFUN_CHANGES_TRACK:
2763 flag.setEnabled(true);
2764 flag.setOnOff(params().track_changes);
2767 case LFUN_CHANGES_OUTPUT:
2768 flag.setEnabled(true);
2769 flag.setOnOff(params().output_changes);
2772 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2773 flag.setOnOff(params().compressed);
2776 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2777 flag.setOnOff(params().output_sync);
2780 case LFUN_BUFFER_ANONYMIZE:
2786 flag.setEnabled(enable);
2791 void Buffer::dispatch(string const & command, DispatchResult & result)
2793 return dispatch(lyxaction.lookupFunc(command), result);
2797 // NOTE We can end up here even if we have no GUI, because we are called
2798 // by LyX::exec to handled command-line requests. So we may need to check
2799 // whether we have a GUI or not. The boolean use_gui holds this information.
2800 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2803 // FIXME? if there is an Buffer LFUN that can be dispatched even
2804 // if internal, put a switch '(cmd.action())' here.
2805 dr.dispatched(false);
2808 string const argument = to_utf8(func.argument());
2809 // We'll set this back to false if need be.
2810 bool dispatched = true;
2811 // This handles undo groups automagically
2812 UndoGroupHelper ugh(this);
2814 switch (func.action()) {
2815 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2816 if (lyxvc().inUse()) {
2817 string log = lyxvc().toggleReadOnly();
2822 setReadonly(!hasReadonlyFlag());
2825 case LFUN_BUFFER_EXPORT: {
2826 string const format = (argument.empty() || argument == "default") ?
2827 params().getDefaultOutputFormat() : argument;
2828 ExportStatus const status = doExport(format, false);
2829 dr.setError(status != ExportSuccess);
2830 if (status != ExportSuccess)
2831 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2832 from_utf8(format)));
2836 case LFUN_BUILD_PROGRAM: {
2837 ExportStatus const status = doExport("program", true);
2838 dr.setError(status != ExportSuccess);
2839 if (status != ExportSuccess)
2840 dr.setMessage(_("Error generating literate programming code."));
2844 case LFUN_BUFFER_EXPORT_CUSTOM: {
2846 string command = split(argument, format_name, ' ');
2847 Format const * format = theFormats().getFormat(format_name);
2849 lyxerr << "Format \"" << format_name
2850 << "\" not recognized!"
2855 // The name of the file created by the conversion process
2858 // Output to filename
2859 if (format->name() == "lyx") {
2860 string const latexname = latexName(false);
2861 filename = changeExtension(latexname,
2862 format->extension());
2863 filename = addName(temppath(), filename);
2865 if (!writeFile(FileName(filename)))
2869 doExport(format_name, true, filename);
2872 // Substitute $$FName for filename
2873 if (!contains(command, "$$FName"))
2874 command = "( " + command + " ) < $$FName";
2875 command = subst(command, "$$FName", filename);
2877 // Execute the command in the background
2879 call.startscript(Systemcall::DontWait, command,
2880 filePath(), layoutPos());
2884 // FIXME: There is need for a command-line import.
2886 case LFUN_BUFFER_IMPORT:
2891 case LFUN_BUFFER_AUTO_SAVE:
2893 resetAutosaveTimers();
2896 case LFUN_BRANCH_ACTIVATE:
2897 case LFUN_BRANCH_DEACTIVATE:
2898 case LFUN_BRANCH_MASTER_ACTIVATE:
2899 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2900 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2901 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2902 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2905 docstring const branch_name = func.argument();
2906 // the case without a branch name is handled elsewhere
2907 if (branch_name.empty()) {
2911 Branch * branch = buf->params().branchlist().find(branch_name);
2913 LYXERR0("Branch " << branch_name << " does not exist.");
2915 docstring const msg =
2916 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2920 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2921 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2922 if (branch->isSelected() != activate) {
2923 buf->undo().recordUndoBufferParams(CursorData());
2924 branch->setSelected(activate);
2926 dr.screenUpdate(Update::Force);
2927 dr.forceBufferUpdate();
2932 case LFUN_BRANCH_ADD: {
2933 docstring branchnames = func.argument();
2934 if (branchnames.empty()) {
2938 BranchList & branch_list = params().branchlist();
2939 vector<docstring> const branches =
2940 getVectorFromString(branchnames, branch_list.separator());
2942 for (docstring const & branch_name : branches) {
2943 Branch * branch = branch_list.find(branch_name);
2945 LYXERR0("Branch " << branch_name << " already exists.");
2949 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2951 undo().recordUndoBufferParams(CursorData());
2952 branch_list.add(branch_name);
2953 branch = branch_list.find(branch_name);
2954 string const x11hexname = X11hexname(branch->color());
2955 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2956 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2958 dr.screenUpdate(Update::Force);
2966 case LFUN_BRANCHES_RENAME: {
2967 if (func.argument().empty())
2970 docstring const oldname = from_utf8(func.getArg(0));
2971 docstring const newname = from_utf8(func.getArg(1));
2972 InsetIterator it = inset_iterator_begin(inset());
2973 InsetIterator const end = inset_iterator_end(inset());
2974 bool success = false;
2975 for (; it != end; ++it) {
2976 if (it->lyxCode() == BRANCH_CODE) {
2977 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2978 if (ins.branch() == oldname) {
2979 undo().recordUndo(CursorData(it));
2980 ins.rename(newname);
2985 if (it->lyxCode() == INCLUDE_CODE) {
2986 // get buffer of external file
2987 InsetInclude const & ins =
2988 static_cast<InsetInclude const &>(*it);
2989 Buffer * child = ins.getChildBuffer();
2992 child->dispatch(func, dr);
2997 dr.screenUpdate(Update::Force);
2998 dr.forceBufferUpdate();
3003 case LFUN_BUFFER_VIEW_CACHE:
3004 if (!theFormats().view(*this, d->preview_file_,
3005 d->preview_format_))
3006 dr.setMessage(_("Error viewing the output file."));
3009 case LFUN_CHANGES_TRACK:
3010 if (params().save_transient_properties)
3011 undo().recordUndoBufferParams(CursorData());
3012 params().track_changes = !params().track_changes;
3013 if (!params().track_changes)
3014 dr.forceChangesUpdate();
3017 case LFUN_CHANGES_OUTPUT:
3018 if (params().save_transient_properties)
3019 undo().recordUndoBufferParams(CursorData());
3020 params().output_changes = !params().output_changes;
3021 if (params().output_changes) {
3022 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3023 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3024 LaTeXFeatures::isAvailable("xcolor");
3026 if (!dvipost && !xcolorulem) {
3027 Alert::warning(_("Changes not shown in LaTeX output"),
3028 _("Changes will not be highlighted in LaTeX output, "
3029 "because neither dvipost nor xcolor/ulem are installed.\n"
3030 "Please install these packages or redefine "
3031 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3032 } else if (!xcolorulem) {
3033 Alert::warning(_("Changes not shown in LaTeX output"),
3034 _("Changes will not be highlighted in LaTeX output "
3035 "when using pdflatex, because xcolor and ulem are not installed.\n"
3036 "Please install both packages or redefine "
3037 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3042 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3043 // turn compression on/off
3044 undo().recordUndoBufferParams(CursorData());
3045 params().compressed = !params().compressed;
3048 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3049 undo().recordUndoBufferParams(CursorData());
3050 params().output_sync = !params().output_sync;
3053 case LFUN_BUFFER_ANONYMIZE: {
3054 undo().recordUndoFullBuffer(CursorData());
3055 CursorData cur(doc_iterator_begin(this));
3056 for ( ; cur ; cur.forwardPar())
3057 cur.paragraph().anonymize();
3058 dr.forceBufferUpdate();
3059 dr.screenUpdate(Update::Force);
3067 dr.dispatched(dispatched);
3071 void Buffer::changeLanguage(Language const * from, Language const * to)
3073 LASSERT(from, return);
3074 LASSERT(to, return);
3076 for_each(par_iterator_begin(),
3078 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3082 bool Buffer::isMultiLingual() const
3084 ParConstIterator end = par_iterator_end();
3085 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3086 if (it->isMultiLingual(params()))
3093 std::set<Language const *> Buffer::getLanguages() const
3095 std::set<Language const *> langs;
3096 getLanguages(langs);
3101 void Buffer::getLanguages(std::set<Language const *> & langs) const
3103 ParConstIterator end = par_iterator_end();
3104 // add the buffer language, even if it's not actively used
3105 langs.insert(language());
3106 // iterate over the paragraphs
3107 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3108 it->getLanguages(langs);
3110 ListOfBuffers clist = getDescendents();
3111 for (auto const & cit : clist)
3112 cit->getLanguages(langs);
3116 DocIterator Buffer::getParFromID(int const id) const
3118 Buffer * buf = const_cast<Buffer *>(this);
3120 // This means non-existent
3121 return doc_iterator_end(buf);
3123 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3124 if (it.paragraph().id() == id)
3127 return doc_iterator_end(buf);
3131 bool Buffer::hasParWithID(int const id) const
3133 return !getParFromID(id).atEnd();
3137 ParIterator Buffer::par_iterator_begin()
3139 return ParIterator(doc_iterator_begin(this));
3143 ParIterator Buffer::par_iterator_end()
3145 return ParIterator(doc_iterator_end(this));
3149 ParConstIterator Buffer::par_iterator_begin() const
3151 return ParConstIterator(doc_iterator_begin(this));
3155 ParConstIterator Buffer::par_iterator_end() const
3157 return ParConstIterator(doc_iterator_end(this));
3161 Language const * Buffer::language() const
3163 return params().language;
3167 docstring const Buffer::B_(string const & l10n) const
3169 return params().B_(l10n);
3173 bool Buffer::isClean() const
3175 return d->lyx_clean;
3179 bool Buffer::isChecksumModified() const
3181 LASSERT(d->filename.exists(), return false);
3182 return d->checksum_ != d->filename.checksum();
3186 void Buffer::saveCheckSum() const
3188 FileName const & file = d->filename;
3190 d->checksum_ = file.exists() ? file.checksum()
3191 : 0; // in the case of save to a new file.
3195 void Buffer::markClean() const
3197 if (!d->lyx_clean) {
3198 d->lyx_clean = true;
3201 // if the .lyx file has been saved, we don't need an
3203 d->bak_clean = true;
3204 d->undo_.markDirty();
3205 clearExternalModification();
3209 void Buffer::setUnnamed(bool flag)
3215 bool Buffer::isUnnamed() const
3222 /// Don't check unnamed, here: isInternal() is used in
3223 /// newBuffer(), where the unnamed flag has not been set by anyone
3224 /// yet. Also, for an internal buffer, there should be no need for
3225 /// retrieving fileName() nor for checking if it is unnamed or not.
3226 bool Buffer::isInternal() const
3228 return d->internal_buffer;
3232 void Buffer::setInternal(bool flag)
3234 d->internal_buffer = flag;
3238 void Buffer::markDirty()
3241 d->lyx_clean = false;
3244 d->bak_clean = false;
3246 for (auto & depit : d->dep_clean)
3247 depit.second = false;
3251 FileName Buffer::fileName() const
3257 string Buffer::absFileName() const
3259 return d->filename.absFileName();
3263 string Buffer::filePath() const
3265 string const abs = d->filename.onlyPath().absFileName();
3268 int last = abs.length() - 1;
3270 return abs[last] == '/' ? abs : abs + '/';
3274 DocFileName Buffer::getReferencedFileName(string const & fn) const
3277 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3278 result.set(fn, filePath());
3280 // filePath() ends with a path separator
3281 FileName const test(filePath() + fn);
3283 result.set(fn, filePath());
3285 result.set(fn, params().origin);
3292 string const Buffer::prepareFileNameForLaTeX(string const & name,
3293 string const & ext, bool nice) const
3295 string const fname = makeAbsPath(name, filePath()).absFileName();
3296 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3302 return to_utf8(makeRelPath(from_utf8(fname),
3303 from_utf8(masterBuffer()->filePath())));
3307 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3308 docstring_list const & bibfilelist,
3309 bool const add_extension) const
3311 // If we are processing the LaTeX file in a temp directory then
3312 // copy the .bib databases to this temp directory, mangling their
3313 // names in the process. Store this mangled name in the list of
3315 // (We need to do all this because BibTeX *really*, *really*
3316 // can't handle "files with spaces" and Windows users tend to
3317 // use such filenames.)
3318 // Otherwise, store the (maybe absolute) path to the original,
3319 // unmangled database name.
3321 vector<pair<docstring, string>> res;
3323 // determine the export format
3324 string const tex_format = flavor2format(runparams.flavor);
3326 // check for spaces in paths
3327 bool found_space = false;
3329 for (auto const & bit : bibfilelist) {
3330 string utf8input = to_utf8(bit);
3332 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3333 FileName try_in_file =
3334 makeAbsPath(database + ".bib", filePath());
3335 bool not_from_texmf = try_in_file.isReadableFile();
3336 // If the file has not been found, try with the real file name
3337 // (it might come from a child in a sub-directory)
3338 if (!not_from_texmf) {
3339 try_in_file = getBibfilePath(bit);
3340 if (try_in_file.isReadableFile()) {
3341 // Check if the file is in texmf
3342 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3343 not_from_texmf = kpsefile.empty()
3344 || kpsefile.absFileName() != try_in_file.absFileName();
3346 // If this exists, make path relative to the master
3349 removeExtension(prepareFileNameForLaTeX(
3350 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3351 from_utf8(filePath()))),
3352 ".bib", runparams.nice));
3356 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3358 // mangledFileName() needs the extension
3359 DocFileName const in_file = DocFileName(try_in_file);
3360 database = removeExtension(in_file.mangledFileName());
3361 FileName const out_file = makeAbsPath(database + ".bib",
3362 masterBuffer()->temppath());
3363 bool const success = in_file.copyTo(out_file);
3365 LYXERR0("Failed to copy '" << in_file
3366 << "' to '" << out_file << "'");
3368 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3369 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3370 if (!isValidLaTeXFileName(database)) {
3371 frontend::Alert::warning(_("Invalid filename"),
3372 _("The following filename will cause troubles "
3373 "when running the exported file through LaTeX: ") +
3374 from_utf8(database));
3376 if (!isValidDVIFileName(database)) {
3377 frontend::Alert::warning(_("Problematic filename for DVI"),
3378 _("The following filename can cause troubles "
3379 "when running the exported file through LaTeX "
3380 "and opening the resulting DVI: ") +
3381 from_utf8(database), true);
3389 docstring const path = from_utf8(latex_path(database));
3391 if (contains(path, ' '))
3394 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3395 enc = params().bibFileEncoding(utf8input);
3397 bool recorded = false;
3398 for (pair<docstring, string> pe : res) {
3399 if (pe.first == path) {
3406 res.push_back(make_pair(path, enc));
3409 // Check if there are spaces in the path and warn BibTeX users, if so.
3410 // (biber can cope with such paths)
3411 if (!prefixIs(runparams.bibtex_command, "biber")) {
3412 // Post this warning only once.
3413 static bool warned_about_spaces = false;
3414 if (!warned_about_spaces &&
3415 runparams.nice && found_space) {
3416 warned_about_spaces = true;
3417 Alert::warning(_("Export Warning!"),
3418 _("There are spaces in the paths to your BibTeX databases.\n"
3419 "BibTeX will be unable to find them."));
3428 string Buffer::layoutPos() const
3430 return d->layout_position;
3434 void Buffer::setLayoutPos(string const & path)
3437 d->layout_position.clear();
3441 LATTEST(FileName::isAbsolute(path));
3443 d->layout_position =
3444 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3446 if (d->layout_position.empty())
3447 d->layout_position = ".";
3451 bool Buffer::hasReadonlyFlag() const
3453 return d->read_only;
3457 bool Buffer::isReadonly() const
3459 return hasReadonlyFlag() || notifiesExternalModification();
3463 void Buffer::setParent(Buffer const * buffer)
3465 // Avoids recursive include.
3466 d->setParent(buffer == this ? 0 : buffer);
3471 Buffer const * Buffer::parent() const
3477 ListOfBuffers Buffer::allRelatives() const
3479 ListOfBuffers lb = masterBuffer()->getDescendents();
3480 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3485 Buffer const * Buffer::masterBuffer() const
3487 // FIXME Should be make sure we are not in some kind
3488 // of recursive include? A -> B -> A will crash this.
3489 Buffer const * const pbuf = d->parent();
3493 return pbuf->masterBuffer();
3497 bool Buffer::isChild(Buffer * child) const
3499 return d->children_positions.find(child) != d->children_positions.end();
3503 DocIterator Buffer::firstChildPosition(Buffer const * child)
3505 Impl::BufferPositionMap::iterator it;
3506 it = d->children_positions.find(child);
3507 if (it == d->children_positions.end())
3508 return DocIterator(this);
3513 bool Buffer::hasChildren() const
3515 return !d->children_positions.empty();
3519 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3521 // loop over children
3522 for (auto const & p : d->children_positions) {
3523 Buffer * child = const_cast<Buffer *>(p.first);
3525 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3526 if (bit != clist.end())
3528 clist.push_back(child);
3530 // there might be grandchildren
3531 child->collectChildren(clist, true);
3536 ListOfBuffers Buffer::getChildren() const
3539 collectChildren(v, false);
3540 // Make sure we have not included ourselves.
3541 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3542 if (bit != v.end()) {
3543 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3550 ListOfBuffers Buffer::getDescendents() const
3553 collectChildren(v, true);
3554 // Make sure we have not included ourselves.
3555 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3556 if (bit != v.end()) {
3557 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3564 template<typename M>
3565 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3570 typename M::const_iterator it = m.lower_bound(x);
3571 if (it == m.begin())
3579 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3580 DocIterator const & pos) const
3582 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3584 // if paragraphs have no macro context set, pos will be empty
3588 // we haven't found anything yet
3589 DocIterator bestPos = owner_->par_iterator_begin();
3590 MacroData const * bestData = 0;
3592 // find macro definitions for name
3593 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3594 if (nameIt != macros.end()) {
3595 // find last definition in front of pos or at pos itself
3596 PositionScopeMacroMap::const_iterator it
3597 = greatest_below(nameIt->second, pos);
3598 if (it != nameIt->second.end()) {
3600 // scope ends behind pos?
3601 if (pos < it->second.scope) {
3602 // Looks good, remember this. If there
3603 // is no external macro behind this,
3604 // we found the right one already.
3605 bestPos = it->first;
3606 bestData = &it->second.macro;
3610 // try previous macro if there is one
3611 if (it == nameIt->second.begin())
3618 // find macros in included files
3619 PositionScopeBufferMap::const_iterator it
3620 = greatest_below(position_to_children, pos);
3621 if (it == position_to_children.end())
3622 // no children before
3626 // do we know something better (i.e. later) already?
3627 if (it->first < bestPos )
3630 // scope ends behind pos?
3631 if (pos < it->second.scope
3632 && (cloned_buffer_ ||
3633 theBufferList().isLoaded(it->second.buffer))) {
3634 // look for macro in external file
3636 MacroData const * data
3637 = it->second.buffer->getMacro(name, false);
3640 bestPos = it->first;
3646 // try previous file if there is one
3647 if (it == position_to_children.begin())
3652 // return the best macro we have found
3657 MacroData const * Buffer::getMacro(docstring const & name,
3658 DocIterator const & pos, bool global) const
3663 // query buffer macros
3664 MacroData const * data = d->getBufferMacro(name, pos);
3668 // If there is a master buffer, query that
3669 Buffer const * const pbuf = d->parent();
3671 d->macro_lock = true;
3672 MacroData const * macro = pbuf->getMacro(
3673 name, *this, false);
3674 d->macro_lock = false;
3680 data = MacroTable::globalMacros().get(name);
3689 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3691 // set scope end behind the last paragraph
3692 DocIterator scope = par_iterator_begin();
3693 scope.pit() = scope.lastpit() + 1;
3695 return getMacro(name, scope, global);
3699 MacroData const * Buffer::getMacro(docstring const & name,
3700 Buffer const & child, bool global) const
3702 // look where the child buffer is included first
3703 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3704 if (it == d->children_positions.end())
3707 // check for macros at the inclusion position
3708 return getMacro(name, it->second, global);
3712 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3714 pit_type const lastpit = it.lastpit();
3716 // look for macros in each paragraph
3717 while (it.pit() <= lastpit) {
3718 Paragraph & par = it.paragraph();
3720 // FIXME Can this be done with the new-style iterators?
3721 // iterate over the insets of the current paragraph
3722 for (auto const & insit : par.insetList()) {
3723 it.pos() = insit.pos;
3725 // is it a nested text inset?
3726 if (insit.inset->asInsetText()) {
3727 // Inset needs its own scope?
3728 InsetText const * itext = insit.inset->asInsetText();
3729 bool newScope = itext->isMacroScope();
3731 // scope which ends just behind the inset
3732 DocIterator insetScope = it;
3735 // collect macros in inset
3736 it.push_back(CursorSlice(*insit.inset));
3737 updateMacros(it, newScope ? insetScope : scope);
3742 if (insit.inset->asInsetTabular()) {
3743 CursorSlice slice(*insit.inset);
3744 size_t const numcells = slice.nargs();
3745 for (; slice.idx() < numcells; slice.forwardIdx()) {
3746 it.push_back(slice);
3747 updateMacros(it, scope);
3753 // is it an external file?
3754 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3755 // get buffer of external file
3756 InsetInclude const & incinset =
3757 static_cast<InsetInclude const &>(*insit.inset);
3759 Buffer * child = incinset.getChildBuffer();
3764 // register its position, but only when it is
3765 // included first in the buffer
3766 if (children_positions.find(child) ==
3767 children_positions.end())
3768 children_positions[child] = it;
3770 // register child with its scope
3771 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3775 InsetMath * im = insit.inset->asInsetMath();
3776 if (doing_export && im) {
3777 InsetMathHull * hull = im->asHullInset();
3779 hull->recordLocation(it);
3782 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3786 InsetMathMacroTemplate & macroTemplate =
3787 *insit.inset->asInsetMath()->asMacroTemplate();
3788 MacroContext mc(owner_, it);
3789 macroTemplate.updateToContext(mc);
3792 bool valid = macroTemplate.validMacro();
3793 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3794 // then the BufferView's cursor will be invalid in
3795 // some cases which leads to crashes.
3800 // FIXME (Abdel), I don't understand why we pass 'it' here
3801 // instead of 'macroTemplate' defined above... is this correct?
3802 macros[macroTemplate.name()][it] =
3803 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3813 void Buffer::updateMacros() const
3818 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3820 // start with empty table
3822 d->children_positions.clear();
3823 d->position_to_children.clear();
3825 // Iterate over buffer, starting with first paragraph
3826 // The scope must be bigger than any lookup DocIterator
3827 // later. For the global lookup, lastpit+1 is used, hence
3828 // we use lastpit+2 here.
3829 DocIterator it = par_iterator_begin();
3830 DocIterator outerScope = it;
3831 outerScope.pit() = outerScope.lastpit() + 2;
3832 d->updateMacros(it, outerScope);
3836 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3838 InsetIterator it = inset_iterator_begin(inset());
3839 InsetIterator const end = inset_iterator_end(inset());
3840 for (; it != end; ++it) {
3841 if (it->lyxCode() == BRANCH_CODE) {
3842 InsetBranch & br = static_cast<InsetBranch &>(*it);
3843 docstring const name = br.branch();
3844 if (!from_master && !params().branchlist().find(name))
3845 result.push_back(name);
3846 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3847 result.push_back(name);
3850 if (it->lyxCode() == INCLUDE_CODE) {
3851 // get buffer of external file
3852 InsetInclude const & ins =
3853 static_cast<InsetInclude const &>(*it);
3854 Buffer * child = ins.getChildBuffer();
3857 child->getUsedBranches(result, true);
3860 // remove duplicates
3865 void Buffer::updateMacroInstances(UpdateType utype) const
3867 LYXERR(Debug::MACROS, "updateMacroInstances for "
3868 << d->filename.onlyFileName());
3869 DocIterator it = doc_iterator_begin(this);
3871 DocIterator const end = doc_iterator_end(this);
3872 for (; it != end; it.forwardInset()) {
3873 // look for MathData cells in InsetMathNest insets
3874 InsetMath * minset = it.nextInset()->asInsetMath();
3878 // update macro in all cells of the InsetMathNest
3879 DocIterator::idx_type n = minset->nargs();
3880 MacroContext mc = MacroContext(this, it);
3881 for (DocIterator::idx_type i = 0; i < n; ++i) {
3882 MathData & data = minset->cell(i);
3883 data.updateMacros(0, mc, utype, 0);
3889 void Buffer::listMacroNames(MacroNameSet & macros) const
3894 d->macro_lock = true;
3896 // loop over macro names
3897 for (auto const & nameit : d->macros)
3898 macros.insert(nameit.first);
3900 // loop over children
3901 for (auto const & p : d->children_positions) {
3902 Buffer * child = const_cast<Buffer *>(p.first);
3903 // The buffer might have been closed (see #10766).
3904 if (theBufferList().isLoaded(child))
3905 child->listMacroNames(macros);
3909 Buffer const * const pbuf = d->parent();
3911 pbuf->listMacroNames(macros);
3913 d->macro_lock = false;
3917 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3919 Buffer const * const pbuf = d->parent();
3924 pbuf->listMacroNames(names);
3927 for (auto const & mit : names) {
3929 MacroData const * data = pbuf->getMacro(mit, *this, false);
3931 macros.insert(data);
3933 // we cannot access the original InsetMathMacroTemplate anymore
3934 // here to calls validate method. So we do its work here manually.
3935 // FIXME: somehow make the template accessible here.
3936 if (data->optionals() > 0)
3937 features.require("xargs");
3943 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3946 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3948 RefCache::iterator it = d->ref_cache_.find(label);
3949 if (it != d->ref_cache_.end())
3952 static References const dummy_refs = References();
3953 it = d->ref_cache_.insert(
3954 make_pair(label, dummy_refs)).first;
3959 Buffer::References const & Buffer::references(docstring const & label) const
3961 return const_cast<Buffer *>(this)->getReferenceCache(label);
3965 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3967 References & refs = getReferenceCache(label);
3968 refs.push_back(make_pair(inset, it));
3972 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3976 linfo.label = label;
3978 linfo.active = active;
3979 masterBuffer()->d->label_cache_.push_back(linfo);
3983 InsetLabel const * Buffer::insetLabel(docstring const & label,
3984 bool const active) const
3986 for (auto & rc : masterBuffer()->d->label_cache_) {
3987 if (rc.label == label && (rc.active || !active))
3994 bool Buffer::activeLabel(docstring const & label) const
3996 if (!insetLabel(label, true))
4003 void Buffer::clearReferenceCache() const
4006 d->ref_cache_.clear();
4007 d->label_cache_.clear();
4012 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4014 //FIXME: This does not work for child documents yet.
4015 reloadBibInfoCache();
4017 // Check if the label 'from' appears more than once
4018 vector<docstring> labels;
4019 for (auto const & bibit : masterBibInfo())
4020 labels.push_back(bibit.first);
4022 if (count(labels.begin(), labels.end(), from) > 1)
4025 string const paramName = "key";
4026 InsetIterator it = inset_iterator_begin(inset());
4028 if (it->lyxCode() != CITE_CODE)
4030 InsetCommand * inset = it->asInsetCommand();
4031 docstring const oldValue = inset->getParam(paramName);
4032 if (oldValue == from)
4033 inset->setParam(paramName, to);
4037 // returns NULL if id-to-row conversion is unsupported
4038 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4039 pit_type par_begin, pit_type par_end,
4040 OutputWhat output, bool master) const
4042 unique_ptr<TexRow> texrow;
4043 OutputParams runparams(¶ms().encoding());
4044 runparams.nice = true;
4045 runparams.flavor = params().getOutputFlavor(format);
4046 runparams.linelen = lyxrc.plaintext_linelen;
4047 // No side effect of file copying and image conversion
4048 runparams.dryrun = true;
4050 // Some macros rely on font encoding
4051 runparams.main_fontenc = params().main_font_encoding();
4053 if (output == CurrentParagraph) {
4054 runparams.par_begin = par_begin;
4055 runparams.par_end = par_end;
4056 if (par_begin + 1 == par_end) {
4058 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4062 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4063 convert<docstring>(par_begin),
4064 convert<docstring>(par_end - 1))
4067 // output paragraphs
4068 if (runparams.flavor == OutputParams::LYX) {
4069 Paragraph const & par = text().paragraphs()[par_begin];
4071 depth_type dt = par.getDepth();
4072 par.write(ods, params(), dt);
4073 os << from_utf8(ods.str());
4074 } else if (runparams.flavor == OutputParams::HTML) {
4076 setMathFlavor(runparams);
4077 xhtmlParagraphs(text(), *this, xs, runparams);
4078 } else if (runparams.flavor == OutputParams::TEXT) {
4080 // FIXME Handles only one paragraph, unlike the others.
4081 // Probably should have some routine with a signature like them.
4082 writePlaintextParagraph(*this,
4083 text().paragraphs()[par_begin], os, runparams, dummy);
4084 } else if (params().isDocBook()) {
4085 docbookParagraphs(text(), *this, os, runparams);
4087 // If we are previewing a paragraph, even if this is the
4088 // child of some other buffer, let's cut the link here,
4089 // so that no concurring settings from the master
4090 // (e.g. branch state) interfere (see #8101).
4092 d->ignore_parent = true;
4093 // We need to validate the Buffer params' features here
4094 // in order to know if we should output polyglossia
4095 // macros (instead of babel macros)
4096 LaTeXFeatures features(*this, params(), runparams);
4098 runparams.use_polyglossia = features.usePolyglossia();
4099 // latex or literate
4102 ots.texrow().newlines(2);
4104 latexParagraphs(*this, text(), ots, runparams);
4105 texrow = ots.releaseTexRow();
4107 // Restore the parenthood
4109 d->ignore_parent = false;
4113 if (output == FullSource)
4114 os << _("Preview source code");
4115 else if (output == OnlyPreamble)
4116 os << _("Preview preamble");
4117 else if (output == OnlyBody)
4118 os << _("Preview body");
4120 if (runparams.flavor == OutputParams::LYX) {
4122 if (output == FullSource)
4124 else if (output == OnlyPreamble)
4125 params().writeFile(ods, this);
4126 else if (output == OnlyBody)
4128 os << from_utf8(ods.str());
4129 } else if (runparams.flavor == OutputParams::HTML) {
4130 writeLyXHTMLSource(os, runparams, output);
4131 } else if (runparams.flavor == OutputParams::TEXT) {
4132 if (output == OnlyPreamble) {
4133 os << "% "<< _("Plain text does not have a preamble.");
4135 writePlaintextFile(*this, os, runparams);
4136 } else if (params().isDocBook()) {
4137 writeDocBookSource(os, absFileName(), runparams, output);
4139 // latex or literate
4142 ots.texrow().newlines(2);
4144 runparams.is_child = true;
4146 writeLaTeXSource(ots, string(), runparams, output);
4147 texrow = ots.releaseTexRow();
4154 ErrorList & Buffer::errorList(string const & type) const
4156 return d->errorLists[type];
4160 void Buffer::updateTocItem(std::string const & type,
4161 DocIterator const & dit) const
4164 d->gui_->updateTocItem(type, dit);
4168 void Buffer::structureChanged() const
4171 d->gui_->structureChanged();
4175 void Buffer::errors(string const & err, bool from_master) const
4178 d->gui_->errors(err, from_master);
4182 void Buffer::message(docstring const & msg) const
4185 d->gui_->message(msg);
4189 void Buffer::setBusy(bool on) const
4192 d->gui_->setBusy(on);
4196 void Buffer::updateTitles() const
4199 d->wa_->updateTitles();
4203 void Buffer::resetAutosaveTimers() const
4206 d->gui_->resetAutosaveTimers();
4210 bool Buffer::hasGuiDelegate() const
4216 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4225 class AutoSaveBuffer : public ForkedProcess {
4228 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4229 : buffer_(buffer), fname_(fname) {}
4231 virtual shared_ptr<ForkedProcess> clone() const
4233 return make_shared<AutoSaveBuffer>(*this);
4238 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4239 from_utf8(fname_.absFileName())));
4240 return run(DontWait);
4244 virtual int generateChild();
4246 Buffer const & buffer_;
4251 int AutoSaveBuffer::generateChild()
4253 #if defined(__APPLE__)
4254 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4255 * We should use something else like threads.
4257 * Since I do not know how to determine at run time what is the OS X
4258 * version, I just disable forking altogether for now (JMarc)
4260 pid_t const pid = -1;
4262 // tmp_ret will be located (usually) in /tmp
4263 // will that be a problem?
4264 // Note that this calls ForkedCalls::fork(), so it's
4265 // ok cross-platform.
4266 pid_t const pid = fork();
4267 // If you want to debug the autosave
4268 // you should set pid to -1, and comment out the fork.
4269 if (pid != 0 && pid != -1)
4273 // pid = -1 signifies that lyx was unable
4274 // to fork. But we will do the save
4276 bool failed = false;
4277 TempFile tempfile("lyxautoXXXXXX.lyx");
4278 tempfile.setAutoRemove(false);
4279 FileName const tmp_ret = tempfile.name();
4280 if (!tmp_ret.empty()) {
4281 if (!buffer_.writeFile(tmp_ret))
4283 else if (!tmp_ret.moveTo(fname_))
4289 // failed to write/rename tmp_ret so try writing direct
4290 if (!buffer_.writeFile(fname_)) {
4291 // It is dangerous to do this in the child,
4292 // but safe in the parent, so...
4293 if (pid == -1) // emit message signal.
4294 buffer_.message(_("Autosave failed!"));
4298 if (pid == 0) // we are the child so...
4307 FileName Buffer::getEmergencyFileName() const
4309 return FileName(d->filename.absFileName() + ".emergency");
4313 FileName Buffer::getAutosaveFileName() const
4315 // if the document is unnamed try to save in the backup dir, else
4316 // in the default document path, and as a last try in the filePath,
4317 // which will most often be the temporary directory
4320 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4321 : lyxrc.backupdir_path;
4322 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4325 string const fname = "#" + d->filename.onlyFileName() + "#";
4327 return makeAbsPath(fname, fpath);
4331 void Buffer::removeAutosaveFile() const
4333 FileName const f = getAutosaveFileName();
4339 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4341 FileName const newauto = getAutosaveFileName();
4343 if (newauto != oldauto && oldauto.exists())
4344 if (!oldauto.moveTo(newauto))
4345 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4349 bool Buffer::autoSave() const
4351 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4352 if (buf->d->bak_clean || hasReadonlyFlag())
4355 message(_("Autosaving current document..."));
4356 buf->d->bak_clean = true;
4358 FileName const fname = getAutosaveFileName();
4359 LASSERT(d->cloned_buffer_, return false);
4361 // If this buffer is cloned, we assume that
4362 // we are running in a separate thread already.
4363 TempFile tempfile("lyxautoXXXXXX.lyx");
4364 tempfile.setAutoRemove(false);
4365 FileName const tmp_ret = tempfile.name();
4366 if (!tmp_ret.empty()) {
4368 // assume successful write of tmp_ret
4369 if (tmp_ret.moveTo(fname))
4372 // failed to write/rename tmp_ret so try writing direct
4373 return writeFile(fname);
4377 void Buffer::setExportStatus(bool e) const
4379 d->doing_export = e;
4380 ListOfBuffers clist = getDescendents();
4381 for (auto const & bit : clist)
4382 bit->d->doing_export = e;
4386 bool Buffer::isExporting() const
4388 return d->doing_export;
4392 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4396 return doExport(target, put_in_tempdir, result_file);
4399 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4400 string & result_file) const
4402 bool const update_unincluded =
4403 params().maintain_unincluded_children
4404 && !params().getIncludedChildren().empty();
4406 // (1) export with all included children (omit \includeonly)
4407 if (update_unincluded) {
4408 ExportStatus const status =
4409 doExport(target, put_in_tempdir, true, result_file);
4410 if (status != ExportSuccess)
4413 // (2) export with included children only
4414 return doExport(target, put_in_tempdir, false, result_file);
4418 void Buffer::setMathFlavor(OutputParams & op) const
4420 switch (params().html_math_output) {
4421 case BufferParams::MathML:
4422 op.math_flavor = OutputParams::MathAsMathML;
4424 case BufferParams::HTML:
4425 op.math_flavor = OutputParams::MathAsHTML;
4427 case BufferParams::Images:
4428 op.math_flavor = OutputParams::MathAsImages;
4430 case BufferParams::LaTeX:
4431 op.math_flavor = OutputParams::MathAsLaTeX;
4437 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4438 bool includeall, string & result_file) const
4440 LYXERR(Debug::FILES, "target=" << target);
4441 OutputParams runparams(¶ms().encoding());
4442 string format = target;
4443 string dest_filename;
4444 size_t pos = target.find(' ');
4445 if (pos != string::npos) {
4446 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4447 format = target.substr(0, pos);
4448 if (format == "default")
4449 format = params().getDefaultOutputFormat();
4450 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4451 FileName(dest_filename).onlyPath().createPath();
4452 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4454 MarkAsExporting exporting(this);
4455 string backend_format;
4456 runparams.flavor = OutputParams::LATEX;
4457 runparams.linelen = lyxrc.plaintext_linelen;
4458 runparams.includeall = includeall;
4459 vector<string> backs = params().backends();
4460 Converters converters = theConverters();
4461 bool need_nice_file = false;
4462 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4463 // Get shortest path to format
4464 converters.buildGraph();
4465 Graph::EdgePath path;
4466 for (string const & sit : backs) {
4467 Graph::EdgePath p = converters.getPath(sit, format);
4468 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4469 backend_format = sit;
4474 if (!put_in_tempdir) {
4475 // Only show this alert if this is an export to a non-temporary
4476 // file (not for previewing).
4477 docstring s = bformat(_("No information for exporting the format %1$s."),
4478 theFormats().prettyName(format));
4479 if (format == "pdf4")
4481 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4482 " to '%1$s' or '%2$s'"),
4483 from_utf8(encodings.fromLyXName("utf8")->guiName()),
4484 from_utf8(encodings.fromLyXName("ascii")->guiName()));
4485 Alert::error(_("Couldn't export file"), s);
4487 return ExportNoPathToFormat;
4489 runparams.flavor = converters.getFlavor(path, this);
4490 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4491 for (auto const & edge : path)
4492 if (theConverters().get(edge).nice()) {
4493 need_nice_file = true;
4498 backend_format = format;
4499 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4500 // FIXME: Don't hardcode format names here, but use a flag
4501 if (backend_format == "pdflatex")
4502 runparams.flavor = OutputParams::PDFLATEX;
4503 else if (backend_format == "luatex")
4504 runparams.flavor = OutputParams::LUATEX;
4505 else if (backend_format == "dviluatex")
4506 runparams.flavor = OutputParams::DVILUATEX;
4507 else if (backend_format == "xetex")
4508 runparams.flavor = OutputParams::XETEX;
4511 string filename = latexName(false);
4512 filename = addName(temppath(), filename);
4513 filename = changeExtension(filename,
4514 theFormats().extension(backend_format));
4515 LYXERR(Debug::FILES, "filename=" << filename);
4517 // Plain text backend
4518 if (backend_format == "text") {
4519 runparams.flavor = OutputParams::TEXT;
4521 writePlaintextFile(*this, FileName(filename), runparams);
4523 catch (ConversionException const &) { return ExportCancel; }
4526 else if (backend_format == "xhtml") {
4527 runparams.flavor = OutputParams::HTML;
4528 setMathFlavor(runparams);
4529 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4530 return ExportKilled;
4531 } else if (backend_format == "lyx")
4532 writeFile(FileName(filename));
4534 else if (params().isDocBook()) {
4535 runparams.nice = !put_in_tempdir;
4536 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4537 return ExportKilled;
4540 else if (backend_format == format || need_nice_file) {
4541 runparams.nice = true;
4542 ExportStatus const retval =
4543 makeLaTeXFile(FileName(filename), string(), runparams);
4544 if (retval == ExportKilled)
4545 return ExportKilled;
4546 if (d->cloned_buffer_)
4547 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4548 if (retval != ExportSuccess)
4550 } else if (!lyxrc.tex_allows_spaces
4551 && contains(filePath(), ' ')) {
4552 Alert::error(_("File name error"),
4553 bformat(_("The directory path to the document\n%1$s\n"
4554 "contains spaces, but your TeX installation does "
4555 "not allow them. You should save the file to a directory "
4556 "whose name does not contain spaces."), from_utf8(filePath())));
4557 return ExportTexPathHasSpaces;
4559 runparams.nice = false;
4560 ExportStatus const retval =
4561 makeLaTeXFile(FileName(filename), filePath(), runparams);
4562 if (retval == ExportKilled)
4563 return ExportKilled;
4564 if (d->cloned_buffer_)
4565 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4566 if (retval != ExportSuccess)
4570 string const error_type = (format == "program")
4571 ? "Build" : params().bufferFormat();
4572 ErrorList & error_list = d->errorLists[error_type];
4573 string const ext = theFormats().extension(format);
4574 FileName const tmp_result_file(changeExtension(filename, ext));
4575 Converters::RetVal const retval =
4576 converters.convert(this, FileName(filename), tmp_result_file,
4577 FileName(absFileName()), backend_format, format, error_list);
4578 if (retval == Converters::KILLED)
4579 return ExportCancel;
4580 bool success = (retval == Converters::SUCCESS);
4582 // Emit the signal to show the error list or copy it back to the
4583 // cloned Buffer so that it can be emitted afterwards.
4584 if (format != backend_format) {
4585 if (runparams.silent)
4587 else if (d->cloned_buffer_)
4588 d->cloned_buffer_->d->errorLists[error_type] =
4589 d->errorLists[error_type];
4592 // also to the children, in case of master-buffer-view
4593 ListOfBuffers clist = getDescendents();
4594 for (auto const & bit : clist) {
4595 if (runparams.silent)
4596 bit->d->errorLists[error_type].clear();
4597 else if (d->cloned_buffer_) {
4598 // Enable reverse search by copying back the
4599 // texrow object to the cloned buffer.
4600 // FIXME: this is not thread safe.
4601 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4602 bit->d->cloned_buffer_->d->errorLists[error_type] =
4603 bit->d->errorLists[error_type];
4605 bit->errors(error_type, true);
4609 if (d->cloned_buffer_) {
4610 // Enable reverse dvi or pdf to work by copying back the texrow
4611 // object to the cloned buffer.
4612 // FIXME: There is a possibility of concurrent access to texrow
4613 // here from the main GUI thread that should be securized.
4614 d->cloned_buffer_->d->texrow = d->texrow;
4615 string const err_type = params().bufferFormat();
4616 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4620 if (put_in_tempdir) {
4621 result_file = tmp_result_file.absFileName();
4622 return success ? ExportSuccess : ExportConverterError;
4625 if (dest_filename.empty())
4626 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4628 result_file = dest_filename;
4629 // We need to copy referenced files (e. g. included graphics
4630 // if format == "dvi") to the result dir.
4631 vector<ExportedFile> const files =
4632 runparams.exportdata->externalFiles(format);
4633 string const dest = runparams.export_folder.empty() ?
4634 onlyPath(result_file) : runparams.export_folder;
4635 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4636 : force_overwrite == ALL_FILES;
4637 CopyStatus status = use_force ? FORCE : SUCCESS;
4639 for (ExportedFile const & exp : files) {
4640 if (status == CANCEL) {
4641 message(_("Document export cancelled."));
4642 return ExportCancel;
4644 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4645 string fixedName = exp.exportName;
4646 if (!runparams.export_folder.empty()) {
4647 // Relative pathnames starting with ../ will be sanitized
4648 // if exporting to a different folder
4649 while (fixedName.substr(0, 3) == "../")
4650 fixedName = fixedName.substr(3, fixedName.length() - 3);
4652 FileName fixedFileName = makeAbsPath(fixedName, dest);
4653 fixedFileName.onlyPath().createPath();
4654 status = copyFile(fmt, exp.sourceName,
4656 exp.exportName, status == FORCE,
4657 runparams.export_folder.empty());
4661 if (tmp_result_file.exists()) {
4662 // Finally copy the main file
4663 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4664 : force_overwrite != NO_FILES;
4665 if (status == SUCCESS && use_force)
4667 status = copyFile(format, tmp_result_file,
4668 FileName(result_file), result_file,
4670 if (status == CANCEL) {
4671 message(_("Document export cancelled."));
4672 return ExportCancel;
4674 message(bformat(_("Document exported as %1$s "
4676 theFormats().prettyName(format),
4677 makeDisplayPath(result_file)));
4680 // This must be a dummy converter like fax (bug 1888)
4681 message(bformat(_("Document exported as %1$s"),
4682 theFormats().prettyName(format)));
4685 return success ? ExportSuccess : ExportConverterError;
4689 Buffer::ExportStatus Buffer::preview(string const & format) const
4691 bool const update_unincluded =
4692 params().maintain_unincluded_children
4693 && !params().getIncludedChildren().empty();
4694 return preview(format, update_unincluded);
4698 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4700 MarkAsExporting exporting(this);
4702 // (1) export with all included children (omit \includeonly)
4704 ExportStatus const status = doExport(format, true, true, result_file);
4705 if (status != ExportSuccess)
4708 // (2) export with included children only
4709 ExportStatus const status = doExport(format, true, false, result_file);
4710 FileName const previewFile(result_file);
4712 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4713 theimpl->preview_file_ = previewFile;
4714 theimpl->preview_format_ = format;
4715 theimpl->preview_error_ = (status != ExportSuccess);
4717 if (status != ExportSuccess)
4720 if (previewFile.exists())
4721 return theFormats().view(*this, previewFile, format) ?
4722 PreviewSuccess : PreviewError;
4724 // Successful export but no output file?
4725 // Probably a bug in error detection.
4726 LATTEST(status != ExportSuccess);
4731 Buffer::ReadStatus Buffer::extractFromVC()
4733 bool const found = LyXVC::file_not_found_hook(d->filename);
4735 return ReadFileNotFound;
4736 if (!d->filename.isReadableFile())
4742 Buffer::ReadStatus Buffer::loadEmergency()
4744 FileName const emergencyFile = getEmergencyFileName();
4745 if (!emergencyFile.exists()
4746 || emergencyFile.lastModified() <= d->filename.lastModified())
4747 return ReadFileNotFound;
4749 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4750 docstring const text = bformat(_("An emergency save of the document "
4751 "%1$s exists.\n\nRecover emergency save?"), file);
4753 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4754 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4760 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4761 bool const success = (ret_llf == ReadSuccess);
4763 if (hasReadonlyFlag()) {
4764 Alert::warning(_("File is read-only"),
4765 bformat(_("An emergency file is successfully loaded, "
4766 "but the original file %1$s is marked read-only. "
4767 "Please make sure to save the document as a different "
4768 "file."), from_utf8(d->filename.absFileName())));
4771 lyxvc().file_found_hook(d->filename);
4772 str = _("Document was successfully recovered.");
4774 str = _("Document was NOT successfully recovered.");
4775 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4776 makeDisplayPath(emergencyFile.absFileName()));
4778 int const del_emerg =
4779 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4780 _("&Remove"), _("&Keep"));
4781 if (del_emerg == 0) {
4782 emergencyFile.removeFile();
4784 Alert::warning(_("Emergency file deleted"),
4785 _("Do not forget to save your file now!"), true);
4787 return success ? ReadSuccess : ReadEmergencyFailure;
4790 int const del_emerg =
4791 Alert::prompt(_("Delete emergency file?"),
4792 _("Remove emergency file now?"), 1, 1,
4793 _("&Remove"), _("&Keep"));
4795 emergencyFile.removeFile();
4799 string const ename = emergencyFile.absFileName();
4801 // Surely we can find one in 100 tries?
4802 for (int i = 1; i < 100; ++i) {
4803 newname.set(ename + to_string(i) + ".lyx");
4804 if (!newname.exists()) {
4810 // renameTo returns true on success. So inverting that
4811 // will give us true if we fail.
4812 noname = !emergencyFile.renameTo(newname);
4815 Alert::warning(_("Can't rename emergency file!"),
4816 _("LyX was unable to rename the emergency file. "
4817 "You should do so manually. Otherwise, you will be "
4818 "asked about it again the next time you try to load "
4819 "this file, and may over-write your own work."));
4821 Alert::warning(_("Emergency File Renames"),
4822 bformat(_("Emergency file renamed as:\n %1$s"),
4823 from_utf8(newname.onlyFileName())));
4826 return ReadOriginal;
4836 Buffer::ReadStatus Buffer::loadAutosave()
4838 // Now check if autosave file is newer.
4839 FileName const autosaveFile = getAutosaveFileName();
4840 if (!autosaveFile.exists()
4841 || autosaveFile.lastModified() <= d->filename.lastModified())
4842 return ReadFileNotFound;
4844 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4845 docstring const text = bformat(_("The backup of the document %1$s "
4846 "is newer.\n\nLoad the backup instead?"), file);
4847 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4848 _("&Load backup"), _("Load &original"), _("&Cancel"));
4853 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4854 // the file is not saved if we load the autosave file.
4855 if (ret_llf == ReadSuccess) {
4856 if (hasReadonlyFlag()) {
4857 Alert::warning(_("File is read-only"),
4858 bformat(_("A backup file is successfully loaded, "
4859 "but the original file %1$s is marked read-only. "
4860 "Please make sure to save the document as a "
4862 from_utf8(d->filename.absFileName())));
4865 lyxvc().file_found_hook(d->filename);
4868 return ReadAutosaveFailure;
4871 // Here we delete the autosave
4872 autosaveFile.removeFile();
4873 return ReadOriginal;
4881 Buffer::ReadStatus Buffer::loadLyXFile()
4883 if (!d->filename.isReadableFile()) {
4884 ReadStatus const ret_rvc = extractFromVC();
4885 if (ret_rvc != ReadSuccess)
4889 ReadStatus const ret_re = loadEmergency();
4890 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4893 ReadStatus const ret_ra = loadAutosave();
4894 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4897 return loadThisLyXFile(d->filename);
4901 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4903 return readFile(fn);
4907 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4909 for (; err != end; ++err) {
4910 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4911 int errorRow = err->error_in_line;
4912 Buffer const * buf = 0;
4913 Impl const * p = this;
4914 if (err->child_name.empty())
4915 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4917 // The error occurred in a child
4918 for (Buffer const * child : owner_->getDescendents()) {
4919 string const child_name =
4920 DocFileName(changeExtension(child->absFileName(), "tex")).
4922 if (err->child_name != child_name)
4924 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4925 if (!TexRow::isNone(start)) {
4926 buf = this->cloned_buffer_
4927 ? child->d->cloned_buffer_->d->owner_
4934 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4940 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4942 TeXErrors::Errors::const_iterator err = terr.begin();
4943 TeXErrors::Errors::const_iterator end = terr.end();
4945 d->traverseErrors(err, end, errorList);
4949 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4951 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4952 TeXErrors::Errors::const_iterator end = terr.end_ref();
4954 d->traverseErrors(err, end, errorList);
4958 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4960 LBUFERR(!text().paragraphs().empty());
4962 // Use the master text class also for child documents
4963 Buffer const * const master = masterBuffer();
4964 DocumentClass const & textclass = master->params().documentClass();
4966 docstring_list old_bibfiles;
4967 // Do this only if we are the top-level Buffer. We also need to account
4968 // for the case of a previewed child with ignored parent here.
4969 if (master == this && !d->ignore_parent) {
4970 textclass.counters().reset(from_ascii("bibitem"));
4971 reloadBibInfoCache();
4972 // we will re-read this cache as we go through, but we need
4973 // to know whether it's changed to know whether we need to
4974 // update the bibinfo cache.
4975 old_bibfiles = d->bibfiles_cache_;
4976 d->bibfiles_cache_.clear();
4979 // keep the buffers to be children in this set. If the call from the
4980 // master comes back we can see which of them were actually seen (i.e.
4981 // via an InsetInclude). The remaining ones in the set need still be updated.
4982 static std::set<Buffer const *> bufToUpdate;
4983 if (scope == UpdateMaster) {
4984 // If this is a child document start with the master
4985 if (master != this) {
4986 bufToUpdate.insert(this);
4987 master->updateBuffer(UpdateMaster, utype);
4988 // If the master buffer has no gui associated with it, then the TocModel is
4989 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4990 // (bug 5699). The same happens if the master buffer is open in a different
4991 // window. This test catches both possibilities.
4992 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4993 // There remains a problem here: If there is another child open in yet a third
4994 // window, that TOC is not updated. So some more general solution is needed at
4996 if (master->d->gui_ != d->gui_)
4999 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5000 if (bufToUpdate.find(this) == bufToUpdate.end())
5004 // start over the counters in the master
5005 textclass.counters().reset();
5008 // update will be done below for this buffer
5009 bufToUpdate.erase(this);
5011 // update all caches
5012 clearReferenceCache();
5014 setChangesPresent(false);
5016 Buffer & cbuf = const_cast<Buffer &>(*this);
5017 // if we are reloading, then we could have a dangling TOC,
5018 // in effect. so we need to go ahead and reset, even though
5019 // we will do so again when we rebuild the TOC later.
5020 cbuf.tocBackend().reset();
5023 ParIterator parit = cbuf.par_iterator_begin();
5024 updateBuffer(parit, utype);
5026 // If this document has siblings, then update the TocBackend later. The
5027 // reason is to ensure that later siblings are up to date when e.g. the
5028 // broken or not status of references is computed. The update is called
5029 // in InsetInclude::addToToc.
5033 // if the bibfiles changed, the cache of bibinfo is invalid
5034 docstring_list new_bibfiles = d->bibfiles_cache_;
5035 // this is a trick to determine whether the two vectors have
5036 // the same elements.
5037 sort(new_bibfiles.begin(), new_bibfiles.end());
5038 sort(old_bibfiles.begin(), old_bibfiles.end());
5039 if (old_bibfiles != new_bibfiles) {
5040 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5041 invalidateBibinfoCache();
5042 reloadBibInfoCache();
5043 // We relied upon the bibinfo cache when recalculating labels. But that
5044 // cache was invalid, although we didn't find that out until now. So we
5045 // have to do it all again.
5046 // That said, the only thing we really need to do is update the citation
5047 // labels. Nothing else will have changed. So we could create a new
5048 // UpdateType that would signal that fact, if we needed to do so.
5049 parit = cbuf.par_iterator_begin();
5050 // we will be re-doing the counters and references and such.
5051 textclass.counters().reset();
5052 clearReferenceCache();
5053 // we should not need to do this again?
5055 setChangesPresent(false);
5056 updateBuffer(parit, utype);
5057 // this will already have been done by reloadBibInfoCache();
5058 // d->bibinfo_cache_valid_ = true;
5061 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5062 // this is also set to true on the other path, by reloadBibInfoCache.
5063 d->bibinfo_cache_valid_ = true;
5065 d->cite_labels_valid_ = true;
5067 cbuf.tocBackend().update(true, utype);
5068 if (scope == UpdateMaster)
5069 cbuf.structureChanged();
5073 static depth_type getDepth(DocIterator const & it)
5075 depth_type depth = 0;
5076 for (size_t i = 0 ; i < it.depth() ; ++i)
5077 if (!it[i].inset().inMathed())
5078 depth += it[i].paragraph().getDepth() + 1;
5079 // remove 1 since the outer inset does not count
5080 // we should have at least one non-math inset, so
5081 // depth should nevery be 0. but maybe it is worth
5082 // marking this, just in case.
5084 // coverity[INTEGER_OVERFLOW]
5088 static depth_type getItemDepth(ParIterator const & it)
5090 Paragraph const & par = *it;
5091 LabelType const labeltype = par.layout().labeltype;
5093 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5096 // this will hold the lowest depth encountered up to now.
5097 depth_type min_depth = getDepth(it);
5098 ParIterator prev_it = it;
5101 --prev_it.top().pit();
5103 // start of nested inset: go to outer par
5105 if (prev_it.empty()) {
5106 // start of document: nothing to do
5111 // We search for the first paragraph with same label
5112 // that is not more deeply nested.
5113 Paragraph & prev_par = *prev_it;
5114 depth_type const prev_depth = getDepth(prev_it);
5115 if (labeltype == prev_par.layout().labeltype) {
5116 if (prev_depth < min_depth)
5117 return prev_par.itemdepth + 1;
5118 if (prev_depth == min_depth)
5119 return prev_par.itemdepth;
5121 min_depth = min(min_depth, prev_depth);
5122 // small optimization: if we are at depth 0, we won't
5123 // find anything else
5124 if (prev_depth == 0)
5130 static bool needEnumCounterReset(ParIterator const & it)
5132 Paragraph const & par = *it;
5133 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5134 depth_type const cur_depth = par.getDepth();
5135 ParIterator prev_it = it;
5136 while (prev_it.pit()) {
5137 --prev_it.top().pit();
5138 Paragraph const & prev_par = *prev_it;
5139 if (prev_par.getDepth() <= cur_depth)
5140 return prev_par.layout().name() != par.layout().name();
5142 // start of nested inset: reset
5147 // set the label of a paragraph. This includes the counters.
5148 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5150 BufferParams const & bp = owner_->masterBuffer()->params();
5151 DocumentClass const & textclass = bp.documentClass();
5152 Paragraph & par = it.paragraph();
5153 Layout const & layout = par.layout();
5154 Counters & counters = textclass.counters();
5156 if (par.params().startOfAppendix()) {
5157 // We want to reset the counter corresponding to toplevel sectioning
5158 Layout const & lay = textclass.getTOCLayout();
5159 docstring const cnt = lay.counter;
5161 counters.reset(cnt);
5162 counters.appendix(true);
5164 par.params().appendix(counters.appendix());
5166 // Compute the item depth of the paragraph
5167 par.itemdepth = getItemDepth(it);
5169 if (layout.margintype == MARGIN_MANUAL) {
5170 if (par.params().labelWidthString().empty())
5171 par.params().labelWidthString(par.expandLabel(layout, bp));
5172 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5173 // we do not need to do anything here, since the empty case is
5174 // handled during export.
5176 par.params().labelWidthString(docstring());
5179 switch(layout.labeltype) {
5180 case LABEL_ITEMIZE: {
5181 // At some point of time we should do something more
5182 // clever here, like:
5183 // par.params().labelString(
5184 // bp.user_defined_bullet(par.itemdepth).getText());
5185 // for now, use a simple hardcoded label
5186 docstring itemlabel;
5187 switch (par.itemdepth) {
5190 itemlabel = char_type(0x2022);
5194 itemlabel = char_type(0x2013);
5197 // ∗ U+2217 ASTERISK OPERATOR
5198 itemlabel = char_type(0x2217);
5201 // · U+00B7 MIDDLE DOT
5202 itemlabel = char_type(0x00b7);
5205 par.params().labelString(itemlabel);
5209 case LABEL_ENUMERATE: {
5210 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5212 switch (par.itemdepth) {
5223 enumcounter += "iv";
5226 // not a valid enumdepth...
5230 if (needEnumCounterReset(it)) {
5231 // Increase the master counter?
5232 if (layout.stepmastercounter)
5233 counters.stepMaster(enumcounter, utype);
5234 // Maybe we have to reset the enumeration counter.
5235 if (!layout.resumecounter)
5236 counters.reset(enumcounter);
5238 counters.step(enumcounter, utype);
5240 string const & lang = par.getParLanguage(bp)->code();
5241 par.params().labelString(counters.theCounter(enumcounter, lang));
5246 case LABEL_SENSITIVE: {
5247 string const & type = counters.current_float();
5248 docstring full_label;
5250 full_label = owner_->B_("Senseless!!! ");
5252 docstring name = owner_->B_(textclass.floats().getType(type).name());
5253 if (counters.hasCounter(from_utf8(type))) {
5254 string const & lang = par.getParLanguage(bp)->code();
5255 counters.step(from_utf8(type), utype);
5256 full_label = bformat(from_ascii("%1$s %2$s:"),
5258 counters.theCounter(from_utf8(type), lang));
5260 full_label = bformat(from_ascii("%1$s #:"), name);
5262 par.params().labelString(full_label);
5266 case LABEL_NO_LABEL:
5267 par.params().labelString(docstring());
5271 case LABEL_CENTERED:
5272 case LABEL_STATIC: {
5273 docstring const & lcounter = layout.counter;
5274 if (!lcounter.empty()) {
5275 if (layout.toclevel <= bp.secnumdepth
5276 && (layout.latextype != LATEX_ENVIRONMENT
5277 || it.text()->isFirstInSequence(it.pit()))) {
5278 if (counters.hasCounter(lcounter))
5279 counters.step(lcounter, utype);
5280 par.params().labelString(par.expandLabel(layout, bp));
5282 par.params().labelString(docstring());
5284 par.params().labelString(par.expandLabel(layout, bp));
5290 par.params().labelString(par.expandLabel(layout, bp));
5295 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5297 // LASSERT: Is it safe to continue here, or should we just return?
5298 LASSERT(parit.pit() == 0, /**/);
5300 // Set the position of the text in the buffer to be able
5301 // to resolve macros in it.
5302 parit.text()->setMacrocontextPosition(parit);
5304 // Reset bibitem counter in master (#8499)
5305 Buffer const * const master = masterBuffer();
5306 if (master == this && !d->ignore_parent)
5307 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5309 depth_type maxdepth = 0;
5310 pit_type const lastpit = parit.lastpit();
5311 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5312 // reduce depth if necessary
5313 if (parit->params().depth() > maxdepth) {
5314 /** FIXME: this function is const, but
5315 * nevertheless it modifies the buffer. To be
5316 * cleaner, one should modify the buffer in
5317 * another function, which is actually
5318 * non-const. This would however be costly in
5319 * terms of code duplication.
5321 CursorData(parit).recordUndo();
5322 parit->params().depth(maxdepth);
5324 maxdepth = parit->getMaxDepthAfter();
5326 if (utype == OutputUpdate) {
5327 // track the active counters
5328 // we have to do this for the master buffer, since the local
5329 // buffer isn't tracking anything.
5330 masterBuffer()->params().documentClass().counters().
5331 setActiveLayout(parit->layout());
5334 // set the counter for this paragraph
5335 d->setLabel(parit, utype);
5337 // update change-tracking flag
5338 parit->addChangesToBuffer(*this);
5341 for (auto const & insit : parit->insetList()) {
5342 parit.pos() = insit.pos;
5343 insit.inset->updateBuffer(parit, utype);
5349 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5350 WordLangTuple & word_lang, docstring_list & suggestions) const
5354 suggestions.clear();
5355 word_lang = WordLangTuple();
5356 bool const to_end = to.empty();
5357 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5358 // OK, we start from here.
5359 for (; from != end; from.forwardPos()) {
5360 // This skips all insets with spell check disabled.
5361 while (!from.allowSpellCheck()) {
5365 // If from is at the end of the document (which is possible
5366 // when "from" was changed above) LyX will crash later otherwise.
5367 if (from.atEnd() || (!to_end && from >= end))
5370 from.paragraph().spellCheck();
5371 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5372 if (SpellChecker::misspelled(res)) {
5376 // Do not increase progress when from == to, otherwise the word
5377 // count will be wrong.
5387 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5389 bool inword = false;
5394 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5395 if (!dit.inTexted()) {
5400 Paragraph const & par = dit.paragraph();
5401 pos_type const pos = dit.pos();
5403 // Copied and adapted from isWordSeparator() in Paragraph
5404 if (pos == dit.lastpos()) {
5407 Inset const * ins = par.getInset(pos);
5408 if (ins && skipNoOutput && !ins->producesOutput()) {
5411 // stop if end of range was skipped
5412 if (!to.atEnd() && dit >= to)
5415 } else if (!par.isDeleted(pos)) {
5416 if (par.isWordSeparator(pos))
5422 if (ins && ins->isLetter())
5424 else if (ins && ins->isSpace())
5427 char_type const c = par.getChar(pos);
5428 if (isPrintableNonspace(c))
5430 else if (isSpace(c))
5440 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5442 d->updateStatistics(from, to, skipNoOutput);
5446 int Buffer::wordCount() const
5448 return d->wordCount();
5452 int Buffer::charCount(bool with_blanks) const
5454 return d->charCount(with_blanks);
5458 Buffer::ReadStatus Buffer::reload()
5461 // c.f. bug https://www.lyx.org/trac/ticket/6587
5462 removeAutosaveFile();
5463 // e.g., read-only status could have changed due to version control
5464 d->filename.refresh();
5465 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5467 // clear parent. this will get reset if need be.
5469 ReadStatus const status = loadLyXFile();
5470 if (status == ReadSuccess) {
5475 message(bformat(_("Document %1$s reloaded."), disp_fn));
5478 message(bformat(_("Could not reload document %1$s."), disp_fn));
5488 bool Buffer::saveAs(FileName const & fn)
5490 FileName const old_name = fileName();
5491 FileName const old_auto = getAutosaveFileName();
5492 bool const old_unnamed = isUnnamed();
5493 bool success = true;
5494 d->old_position = filePath();
5501 // bring the autosave file with us, just in case.
5502 moveAutosaveFile(old_auto);
5503 // validate version control data and
5504 // correct buffer title
5505 lyxvc().file_found_hook(fileName());
5507 // the file has now been saved to the new location.
5508 // we need to check that the locations of child buffers
5510 checkChildBuffers();
5511 checkMasterBuffer();
5514 // reset the old filename and unnamed state
5515 setFileName(old_name);
5516 setUnnamed(old_unnamed);
5520 d->old_position.clear();
5525 void Buffer::checkChildBuffers()
5527 for (auto const & bit : d->children_positions) {
5528 DocIterator dit = bit.second;
5529 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5530 if (!cbuf || !theBufferList().isLoaded(cbuf))
5532 Inset * inset = dit.nextInset();
5533 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5534 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5535 docstring const & incfile = inset_inc->getParam("filename");
5536 string oldloc = cbuf->absFileName();
5537 string newloc = makeAbsPath(to_utf8(incfile),
5538 onlyPath(absFileName())).absFileName();
5539 if (oldloc == newloc)
5541 // the location of the child file is incorrect.
5543 inset_inc->setChildBuffer(0);
5545 // invalidate cache of children
5546 d->children_positions.clear();
5547 d->position_to_children.clear();
5551 // If a child has been saved under a different name/path, it might have been
5552 // orphaned. Therefore the master needs to be reset (bug 8161).
5553 void Buffer::checkMasterBuffer()
5555 Buffer const * const master = masterBuffer();
5559 // necessary to re-register the child (bug 5873)
5560 // FIXME: clean up updateMacros (here, only
5561 // child registering is needed).
5562 master->updateMacros();
5563 // (re)set master as master buffer, but only
5564 // if we are a real child
5565 if (master->isChild(this))
5572 string Buffer::includedFilePath(string const & name, string const & ext) const
5574 if (d->old_position.empty() ||
5575 equivalent(FileName(d->old_position), FileName(filePath())))
5578 bool isabsolute = FileName::isAbsolute(name);
5579 // both old_position and filePath() end with a path separator
5580 string absname = isabsolute ? name : d->old_position + name;
5582 // if old_position is set to origin, we need to do the equivalent of
5583 // getReferencedFileName() (see readDocument())
5584 if (!isabsolute && d->old_position == params().origin) {
5585 FileName const test(addExtension(filePath() + name, ext));
5587 absname = filePath() + name;
5590 if (!FileName(addExtension(absname, ext)).exists())
5594 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5596 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5597 from_utf8(filePath())));
5601 void Buffer::setChangesPresent(bool b) const
5603 d->tracked_changes_present_ = b;
5607 bool Buffer::areChangesPresent() const
5609 return d->tracked_changes_present_;
5613 void Buffer::updateChangesPresent() const
5615 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5616 setChangesPresent(false);
5617 ParConstIterator it = par_iterator_begin();
5618 ParConstIterator const end = par_iterator_end();
5619 for (; !areChangesPresent() && it != end; ++it)
5620 it->addChangesToBuffer(*this);
5624 void Buffer::Impl::refreshFileMonitor()
5626 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5627 file_monitor_->refresh();
5631 // The previous file monitor is invalid
5632 // This also destroys the previous file monitor and all its connections
5633 file_monitor_ = FileSystemWatcher::monitor(filename);
5634 // file_monitor_ will be destroyed with *this, so it is not going to call a
5635 // destroyed object method.
5636 file_monitor_->connect([this](bool exists) {
5637 fileExternallyModified(exists);
5642 void Buffer::Impl::fileExternallyModified(bool const exists)
5644 // ignore notifications after our own saving operations
5645 if (checksum_ == filename.checksum()) {
5646 LYXERR(Debug::FILES, "External modification but "
5647 "checksum unchanged: " << filename);
5650 // If the file has been deleted, only mark the file as dirty since it is
5651 // pointless to prompt for reloading. If later a file is moved into this
5652 // location, then the externally modified warning will appear then.
5654 externally_modified_ = true;
5655 // Update external modification notification.
5656 // Dirty buffers must be visible at all times.
5657 if (wa_ && wa_->unhide(owner_))
5658 wa_->updateTitles();
5660 // Unable to unhide the buffer (e.g. no GUI or not current View)
5665 bool Buffer::notifiesExternalModification() const
5667 return d->externally_modified_;
5671 void Buffer::clearExternalModification() const
5673 d->externally_modified_ = false;
5675 d->wa_->updateTitles();