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 bool const quote = contains(docdir, ' ');
1936 os << "\\makeatletter\n"
1937 << "\\def\\input@path{{";
1939 os << "\\detokenize{";
1948 << "\\makeatother\n";
1952 // get parent macros (if this buffer has a parent) which will be
1953 // written at the document begin further down.
1954 MacroSet parentMacros;
1955 listParentMacros(parentMacros, features);
1957 // Write the preamble
1958 runparams.use_babel = params().writeLaTeX(os, features,
1959 d->filename.onlyPath());
1961 // Biblatex bibliographies are loaded here
1962 if (params().useBiblatex()) {
1963 vector<pair<docstring, string>> const bibfiles =
1964 prepareBibFilePaths(runparams, getBibfiles(), true);
1965 for (pair<docstring, string> const & file: bibfiles) {
1966 os << "\\addbibresource";
1967 if (!file.second.empty())
1968 os << "[bibencoding=" << file.second << "]";
1969 os << "{" << file.first << "}\n";
1973 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1974 && !features.hasOnlyPolyglossiaLanguages()) {
1977 vector<string> bll = features.getBabelExclusiveLanguages();
1978 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1981 for (string const & sit : bll) {
1986 blangs = bll.size() > 1 ?
1987 bformat(_("The languages %1$s are only supported by Babel."), langs)
1988 : bformat(_("The language %1$s is only supported by Babel."), langs);
1992 for (string const & pit : pll) {
1997 plangs = pll.size() > 1 ?
1998 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
1999 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2000 if (!blangs.empty())
2004 frontend::Alert::warning(
2005 _("Incompatible Languages!"),
2007 _("You cannot use the following languages "
2008 "together in one LaTeX document because "
2009 "they require conflicting language packages:\n"
2014 // Japanese might be required only in some children of a document,
2015 // but once required, we must keep use_japanese true.
2016 runparams.use_japanese |= features.isRequired("japanese");
2019 // Restore the parenthood if needed
2020 if (!runparams.is_child)
2021 d->ignore_parent = false;
2022 return ExportSuccess;
2026 // mark the beginning of the body to separate it from InPreamble insets
2027 os.texrow().start(TexRow::beginDocument());
2028 os << "\\begin{document}\n";
2030 // mark the start of a new paragraph by simulating a newline,
2031 // so that os.afterParbreak() returns true at document start
2034 // output the parent macros
2035 for (auto const & mac : parentMacros) {
2036 int num_lines = mac->write(os.os(), true);
2037 os.texrow().newlines(num_lines);
2040 } // output_preamble
2042 LYXERR(Debug::INFO, "preamble finished, now the body.");
2046 latexParagraphs(*this, text(), os, runparams);
2048 catch (ConversionException const &) { return ExportKilled; }
2050 // Restore the parenthood if needed
2051 if (!runparams.is_child)
2052 d->ignore_parent = false;
2054 // add this just in case after all the paragraphs
2057 if (output_preamble) {
2058 os << "\\end{document}\n";
2059 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2061 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2063 runparams_in.encoding = runparams.encoding;
2065 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2066 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2067 return ExportSuccess;
2071 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2072 OutputParams const & runparams,
2073 OutputWhat output) const
2075 LYXERR(Debug::LATEX, "makeDocBookFile...");
2078 if (!openFileWrite(ofs, fname))
2081 // make sure we are ready to export
2082 // this needs to be done before we validate
2084 updateMacroInstances(OutputUpdate);
2086 ExportStatus const retval =
2087 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2088 if (retval == ExportKilled)
2089 return ExportKilled;
2093 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2094 return ExportSuccess;
2098 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2099 OutputParams const & runparams,
2100 OutputWhat output) const
2102 LaTeXFeatures features(*this, params(), runparams);
2107 DocumentClass const & tclass = params().documentClass();
2108 string const & top_element = tclass.latexname();
2110 bool const output_preamble =
2111 output == FullSource || output == OnlyPreamble;
2112 bool const output_body =
2113 output == FullSource || output == OnlyBody;
2115 if (output_preamble) {
2116 if (runparams.flavor == OutputParams::XML)
2117 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2120 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2123 if (! tclass.class_header().empty())
2124 os << from_ascii(tclass.class_header());
2125 else if (runparams.flavor == OutputParams::XML)
2126 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2127 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2129 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2131 docstring preamble = params().preamble;
2132 if (runparams.flavor != OutputParams::XML ) {
2133 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2134 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2135 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2136 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2139 string const name = runparams.nice
2140 ? changeExtension(absFileName(), ".sgml") : fname;
2141 preamble += features.getIncludedFiles(name);
2142 preamble += features.getLyXSGMLEntities();
2144 if (!preamble.empty()) {
2145 os << "\n [ " << preamble << " ]";
2151 string top = top_element;
2153 if (runparams.flavor == OutputParams::XML)
2154 top += params().language->code();
2156 top += params().language->code().substr(0, 2);
2159 if (!params().options.empty()) {
2161 top += params().options;
2164 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2165 << " file was created by LyX " << lyx_version
2166 << "\n See https://www.lyx.org/ for more information -->\n";
2168 params().documentClass().counters().reset();
2170 sgml::openTag(os, top);
2173 docbookParagraphs(text(), *this, os, runparams);
2175 catch (ConversionException const &) { return ExportKilled; }
2176 sgml::closeTag(os, top_element);
2178 return ExportSuccess;
2182 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2183 OutputParams const & runparams) const
2185 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2188 if (!openFileWrite(ofs, fname))
2191 // make sure we are ready to export
2192 // this has to be done before we validate
2193 updateBuffer(UpdateMaster, OutputUpdate);
2194 updateMacroInstances(OutputUpdate);
2196 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2197 if (retval == ExportKilled)
2202 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2207 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2208 OutputParams const & runparams,
2209 OutputWhat output) const
2211 LaTeXFeatures features(*this, params(), runparams);
2213 d->bibinfo_.makeCitationLabels(*this);
2215 bool const output_preamble =
2216 output == FullSource || output == OnlyPreamble;
2217 bool const output_body =
2218 output == FullSource || output == OnlyBody || output == IncludedFile;
2220 if (output_preamble) {
2221 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2222 << "<!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"
2223 // FIXME Language should be set properly.
2224 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2226 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2227 // FIXME Presumably need to set this right
2228 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2230 docstring const & doctitle = features.htmlTitle();
2232 << (doctitle.empty() ?
2233 from_ascii("LyX Document") :
2234 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2237 docstring styles = features.getTClassHTMLPreamble();
2238 if (!styles.empty())
2239 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2241 styles = features.getPreambleSnippets().str;
2242 if (!styles.empty())
2243 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2245 // we will collect CSS information in a stream, and then output it
2246 // either here, as part of the header, or else in a separate file.
2247 odocstringstream css;
2248 styles = features.getCSSSnippets();
2249 if (!styles.empty())
2250 css << "/* LyX Provided Styles */\n" << styles << '\n';
2252 styles = features.getTClassHTMLStyles();
2253 if (!styles.empty())
2254 css << "/* Layout-provided Styles */\n" << styles << '\n';
2256 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2257 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2258 if (needfg || needbg) {
2259 css << "\nbody {\n";
2262 << from_ascii(X11hexname(params().fontcolor))
2265 css << " background-color: "
2266 << from_ascii(X11hexname(params().backgroundcolor))
2271 docstring const dstyles = css.str();
2272 if (!dstyles.empty()) {
2273 bool written = false;
2274 if (params().html_css_as_file) {
2275 // open a file for CSS info
2277 string const fcssname = addName(temppath(), "docstyle.css");
2278 FileName const fcssfile = FileName(fcssname);
2279 if (openFileWrite(ocss, fcssfile)) {
2283 // write link to header
2284 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2286 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2289 // we are here if the CSS is supposed to be written to the header
2290 // or if we failed to write it to an external file.
2292 os << "<style type='text/css'>\n"
2301 bool const output_body_tag = (output != IncludedFile);
2302 if (output_body_tag)
2303 os << "<body dir=\"auto\">\n";
2305 if (output != IncludedFile)
2306 // if we're an included file, the counters are in the master.
2307 params().documentClass().counters().reset();
2309 xhtmlParagraphs(text(), *this, xs, runparams);
2311 catch (ConversionException const &) { return ExportKilled; }
2312 if (output_body_tag)
2316 if (output_preamble)
2319 return ExportSuccess;
2323 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2324 // Other flags: -wall -v0 -x
2325 int Buffer::runChktex()
2329 // get LaTeX-Filename
2330 FileName const path(temppath());
2331 string const name = addName(path.absFileName(), latexName());
2332 string const org_path = filePath();
2334 PathChanger p(path); // path to LaTeX file
2335 message(_("Running chktex..."));
2337 // Generate the LaTeX file if neccessary
2338 OutputParams runparams(¶ms().encoding());
2339 runparams.flavor = OutputParams::LATEX;
2340 runparams.nice = false;
2341 runparams.linelen = lyxrc.plaintext_linelen;
2342 ExportStatus const retval =
2343 makeLaTeXFile(FileName(name), org_path, runparams);
2344 if (retval != ExportSuccess) {
2345 // error code on failure
2350 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2351 int const res = chktex.run(terr); // run chktex
2354 Alert::error(_("chktex failure"),
2355 _("Could not run chktex successfully."));
2357 ErrorList & errlist = d->errorLists["ChkTeX"];
2359 bufferErrors(terr, errlist);
2364 if (runparams.silent)
2365 d->errorLists["ChkTeX"].clear();
2373 void Buffer::validate(LaTeXFeatures & features) const
2375 // Validate the buffer params, but not for included
2376 // files, since they also use the parent buffer's
2378 if (!features.runparams().is_child)
2379 params().validate(features);
2381 for (Paragraph const & p : paragraphs())
2382 p.validate(features);
2384 if (lyxerr.debugging(Debug::LATEX)) {
2385 features.showStruct();
2390 void Buffer::getLabelList(vector<docstring> & list) const
2392 // If this is a child document, use the master's list instead.
2394 masterBuffer()->getLabelList(list);
2399 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2400 for (auto const & tocit : *toc) {
2401 if (tocit.depth() == 0)
2402 list.push_back(tocit.str());
2407 void Buffer::invalidateBibinfoCache() const
2409 d->bibinfo_cache_valid_ = false;
2410 d->cite_labels_valid_ = false;
2411 removeBiblioTempFiles();
2412 // also invalidate the cache for the parent buffer
2413 Buffer const * const pbuf = d->parent();
2415 pbuf->invalidateBibinfoCache();
2419 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2421 // FIXME This is probably unnecessary, given where we call this.
2422 // If this is a child document, use the master instead.
2423 Buffer const * const pbuf = masterBuffer();
2424 if (pbuf != this && scope != UpdateChildOnly)
2425 return pbuf->getBibfiles();
2427 // In 2.3.x, we have:
2428 //if (!d->bibfile_cache_valid_)
2429 // this->updateBibfilesCache(scope);
2430 // I think that is a leftover, but there have been so many back-
2431 // and-forths with this, due to Windows issues, that I am not sure.
2433 return d->bibfiles_cache_;
2437 BiblioInfo const & Buffer::masterBibInfo() const
2439 Buffer const * const tmp = masterBuffer();
2441 return tmp->masterBibInfo();
2446 BiblioInfo const & Buffer::bibInfo() const
2452 void Buffer::registerBibfiles(const docstring_list & bf) const
2454 // We register the bib files in the master buffer,
2455 // if there is one, but also in every single buffer,
2456 // in case a child is compiled alone.
2457 Buffer const * const tmp = masterBuffer();
2459 tmp->registerBibfiles(bf);
2461 for (auto const & p : bf) {
2462 docstring_list::const_iterator temp =
2463 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2464 if (temp == d->bibfiles_cache_.end())
2465 d->bibfiles_cache_.push_back(p);
2470 static map<docstring, FileName> bibfileCache;
2472 FileName Buffer::getBibfilePath(docstring const & bibid) const
2474 map<docstring, FileName>::const_iterator it =
2475 bibfileCache.find(bibid);
2476 if (it != bibfileCache.end()) {
2477 // i.e., return bibfileCache[bibid];
2481 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2482 string const texfile = changeExtension(to_utf8(bibid), "bib");
2483 // we need to check first if this file exists where it's said to be.
2484 // there's a weird bug that occurs otherwise: if the file is in the
2485 // Buffer's directory but has the same name as some file that would be
2486 // found by kpsewhich, then we find the latter, not the former.
2487 FileName const local_file = makeAbsPath(texfile, filePath());
2488 FileName file = local_file;
2489 if (!file.exists()) {
2490 // there's no need now to check whether the file can be found
2492 file = findtexfile(texfile, "bib", true);
2496 LYXERR(Debug::FILES, "Found at: " << file);
2498 bibfileCache[bibid] = file;
2499 return bibfileCache[bibid];
2503 void Buffer::checkIfBibInfoCacheIsValid() const
2505 // use the master's cache
2506 Buffer const * const tmp = masterBuffer();
2508 tmp->checkIfBibInfoCacheIsValid();
2512 // If we already know the cache is invalid, stop here.
2513 // This is important in the case when the bibliography
2514 // environment (rather than Bib[la]TeX) is used.
2515 // In that case, the timestamp check below gives no
2516 // sensible result. Rather than that, the cache will
2517 // be invalidated explicitly via invalidateBibInfoCache()
2518 // by the Bibitem inset.
2519 // Same applies for bib encoding changes, which trigger
2520 // invalidateBibInfoCache() by InsetBibtex.
2521 if (!d->bibinfo_cache_valid_)
2524 if (d->have_bibitems_) {
2525 // We have a bibliography environment.
2526 // Invalidate the bibinfo cache unconditionally.
2527 // Cite labels will get invalidated by the inset if needed.
2528 d->bibinfo_cache_valid_ = false;
2532 // OK. This is with Bib(la)tex. We'll assume the cache
2533 // is valid and change this if we find changes in the bibs.
2534 d->bibinfo_cache_valid_ = true;
2535 d->cite_labels_valid_ = true;
2537 // compare the cached timestamps with the actual ones.
2538 docstring_list const & bibfiles_cache = getBibfiles();
2539 for (auto const & bf : bibfiles_cache) {
2540 FileName const fn = getBibfilePath(bf);
2541 time_t lastw = fn.lastModified();
2542 time_t prevw = d->bibfile_status_[fn];
2543 if (lastw != prevw) {
2544 d->bibinfo_cache_valid_ = false;
2545 d->cite_labels_valid_ = false;
2546 d->bibfile_status_[fn] = lastw;
2552 void Buffer::clearBibFileCache() const
2554 bibfileCache.clear();
2558 void Buffer::reloadBibInfoCache(bool const force) const
2560 // we should not need to do this for internal buffers
2564 // use the master's cache
2565 Buffer const * const tmp = masterBuffer();
2567 tmp->reloadBibInfoCache(force);
2572 checkIfBibInfoCacheIsValid();
2573 if (d->bibinfo_cache_valid_)
2577 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2578 // re-read file locations when this info changes
2579 // FIXME Is this sufficient? Or should we also force that
2580 // in some other cases? If so, then it is easy enough to
2581 // add the following line in some other places.
2582 clearBibFileCache();
2583 d->bibinfo_.clear();
2584 FileNameList checkedFiles;
2585 d->have_bibitems_ = false;
2586 collectBibKeys(checkedFiles);
2587 d->bibinfo_cache_valid_ = true;
2591 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2593 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2594 it->collectBibKeys(it, checkedFiles);
2595 if (it->lyxCode() == BIBITEM_CODE) {
2597 parent()->d->have_bibitems_ = true;
2599 d->have_bibitems_ = true;
2605 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2607 // We add the biblio info to the master buffer,
2608 // if there is one, but also to every single buffer,
2609 // in case a child is compiled alone.
2610 BiblioInfo & bi = d->bibinfo_;
2611 bi.mergeBiblioInfo(bin);
2613 if (parent() != 0) {
2614 BiblioInfo & masterbi = parent()->d->bibinfo_;
2615 masterbi.mergeBiblioInfo(bin);
2620 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2622 // We add the bibtex info to the master buffer,
2623 // if there is one, but also to every single buffer,
2624 // in case a child is compiled alone.
2625 BiblioInfo & bi = d->bibinfo_;
2628 if (parent() != 0) {
2629 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2630 masterbi[key] = bin;
2635 void Buffer::makeCitationLabels() const
2637 Buffer const * const master = masterBuffer();
2638 return d->bibinfo_.makeCitationLabels(*master);
2642 void Buffer::invalidateCiteLabels() const
2644 masterBuffer()->d->cite_labels_valid_ = false;
2647 bool Buffer::citeLabelsValid() const
2649 return masterBuffer()->d->cite_labels_valid_;
2653 void Buffer::removeBiblioTempFiles() const
2655 // We remove files that contain LaTeX commands specific to the
2656 // particular bibliographic style being used, in order to avoid
2657 // LaTeX errors when we switch style.
2658 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2659 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2660 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2661 aux_file.removeFile();
2662 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2663 bbl_file.removeFile();
2664 // Also for the parent buffer
2665 Buffer const * const pbuf = parent();
2667 pbuf->removeBiblioTempFiles();
2671 bool Buffer::isDepClean(string const & name) const
2673 DepClean::const_iterator const it = d->dep_clean.find(name);
2674 if (it == d->dep_clean.end())
2680 void Buffer::markDepClean(string const & name)
2682 d->dep_clean[name] = true;
2686 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2689 // FIXME? if there is an Buffer LFUN that can be dispatched even
2690 // if internal, put a switch '(cmd.action)' here.
2696 switch (cmd.action()) {
2698 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2699 flag.setOnOff(hasReadonlyFlag());
2702 // FIXME: There is need for a command-line import.
2703 //case LFUN_BUFFER_IMPORT:
2705 case LFUN_BUFFER_AUTO_SAVE:
2708 case LFUN_BUFFER_EXPORT_CUSTOM:
2709 // FIXME: Nothing to check here?
2712 case LFUN_BUFFER_EXPORT: {
2713 docstring const arg = cmd.argument();
2714 if (arg == "custom") {
2718 string format = (arg.empty() || arg == "default") ?
2719 params().getDefaultOutputFormat() : to_utf8(arg);
2720 size_t pos = format.find(' ');
2721 if (pos != string::npos)
2722 format = format.substr(0, pos);
2723 enable = params().isExportable(format, false);
2725 flag.message(bformat(
2726 _("Don't know how to export to format: %1$s"), arg));
2730 case LFUN_BUILD_PROGRAM:
2731 enable = params().isExportable("program", false);
2734 case LFUN_BRANCH_ACTIVATE:
2735 case LFUN_BRANCH_DEACTIVATE:
2736 case LFUN_BRANCH_MASTER_ACTIVATE:
2737 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2738 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2739 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2740 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2741 : params().branchlist();
2742 docstring const branchName = cmd.argument();
2743 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2747 case LFUN_BRANCH_ADD:
2748 case LFUN_BRANCHES_RENAME:
2749 // if no Buffer is present, then of course we won't be called!
2752 case LFUN_BUFFER_LANGUAGE:
2753 enable = !isReadonly();
2756 case LFUN_BUFFER_VIEW_CACHE:
2757 (d->preview_file_).refresh();
2758 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2761 case LFUN_CHANGES_TRACK:
2762 flag.setEnabled(true);
2763 flag.setOnOff(params().track_changes);
2766 case LFUN_CHANGES_OUTPUT:
2767 flag.setEnabled(true);
2768 flag.setOnOff(params().output_changes);
2771 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2772 flag.setOnOff(params().compressed);
2775 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2776 flag.setOnOff(params().output_sync);
2779 case LFUN_BUFFER_ANONYMIZE:
2785 flag.setEnabled(enable);
2790 void Buffer::dispatch(string const & command, DispatchResult & result)
2792 return dispatch(lyxaction.lookupFunc(command), result);
2796 // NOTE We can end up here even if we have no GUI, because we are called
2797 // by LyX::exec to handled command-line requests. So we may need to check
2798 // whether we have a GUI or not. The boolean use_gui holds this information.
2799 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2802 // FIXME? if there is an Buffer LFUN that can be dispatched even
2803 // if internal, put a switch '(cmd.action())' here.
2804 dr.dispatched(false);
2807 string const argument = to_utf8(func.argument());
2808 // We'll set this back to false if need be.
2809 bool dispatched = true;
2810 // This handles undo groups automagically
2811 UndoGroupHelper ugh(this);
2813 switch (func.action()) {
2814 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2815 if (lyxvc().inUse()) {
2816 string log = lyxvc().toggleReadOnly();
2821 setReadonly(!hasReadonlyFlag());
2824 case LFUN_BUFFER_EXPORT: {
2825 string const format = (argument.empty() || argument == "default") ?
2826 params().getDefaultOutputFormat() : argument;
2827 ExportStatus const status = doExport(format, false);
2828 dr.setError(status != ExportSuccess);
2829 if (status != ExportSuccess)
2830 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2831 from_utf8(format)));
2835 case LFUN_BUILD_PROGRAM: {
2836 ExportStatus const status = doExport("program", true);
2837 dr.setError(status != ExportSuccess);
2838 if (status != ExportSuccess)
2839 dr.setMessage(_("Error generating literate programming code."));
2843 case LFUN_BUFFER_EXPORT_CUSTOM: {
2845 string command = split(argument, format_name, ' ');
2846 Format const * format = theFormats().getFormat(format_name);
2848 lyxerr << "Format \"" << format_name
2849 << "\" not recognized!"
2854 // The name of the file created by the conversion process
2857 // Output to filename
2858 if (format->name() == "lyx") {
2859 string const latexname = latexName(false);
2860 filename = changeExtension(latexname,
2861 format->extension());
2862 filename = addName(temppath(), filename);
2864 if (!writeFile(FileName(filename)))
2868 doExport(format_name, true, filename);
2871 // Substitute $$FName for filename
2872 if (!contains(command, "$$FName"))
2873 command = "( " + command + " ) < $$FName";
2874 command = subst(command, "$$FName", filename);
2876 // Execute the command in the background
2878 call.startscript(Systemcall::DontWait, command,
2879 filePath(), layoutPos());
2883 // FIXME: There is need for a command-line import.
2885 case LFUN_BUFFER_IMPORT:
2890 case LFUN_BUFFER_AUTO_SAVE:
2892 resetAutosaveTimers();
2895 case LFUN_BRANCH_ACTIVATE:
2896 case LFUN_BRANCH_DEACTIVATE:
2897 case LFUN_BRANCH_MASTER_ACTIVATE:
2898 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2899 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2900 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2901 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2904 docstring const branch_name = func.argument();
2905 // the case without a branch name is handled elsewhere
2906 if (branch_name.empty()) {
2910 Branch * branch = buf->params().branchlist().find(branch_name);
2912 LYXERR0("Branch " << branch_name << " does not exist.");
2914 docstring const msg =
2915 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2919 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2920 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2921 if (branch->isSelected() != activate) {
2922 buf->undo().recordUndoBufferParams(CursorData());
2923 branch->setSelected(activate);
2925 dr.screenUpdate(Update::Force);
2926 dr.forceBufferUpdate();
2931 case LFUN_BRANCH_ADD: {
2932 docstring branchnames = func.argument();
2933 if (branchnames.empty()) {
2937 BranchList & branch_list = params().branchlist();
2938 vector<docstring> const branches =
2939 getVectorFromString(branchnames, branch_list.separator());
2941 for (docstring const & branch_name : branches) {
2942 Branch * branch = branch_list.find(branch_name);
2944 LYXERR0("Branch " << branch_name << " already exists.");
2948 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2950 undo().recordUndoBufferParams(CursorData());
2951 branch_list.add(branch_name);
2952 branch = branch_list.find(branch_name);
2953 string const x11hexname = X11hexname(branch->color());
2954 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2955 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2957 dr.screenUpdate(Update::Force);
2965 case LFUN_BRANCHES_RENAME: {
2966 if (func.argument().empty())
2969 docstring const oldname = from_utf8(func.getArg(0));
2970 docstring const newname = from_utf8(func.getArg(1));
2971 InsetIterator it = inset_iterator_begin(inset());
2972 InsetIterator const end = inset_iterator_end(inset());
2973 bool success = false;
2974 for (; it != end; ++it) {
2975 if (it->lyxCode() == BRANCH_CODE) {
2976 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2977 if (ins.branch() == oldname) {
2978 undo().recordUndo(CursorData(it));
2979 ins.rename(newname);
2984 if (it->lyxCode() == INCLUDE_CODE) {
2985 // get buffer of external file
2986 InsetInclude const & ins =
2987 static_cast<InsetInclude const &>(*it);
2988 Buffer * child = ins.getChildBuffer();
2991 child->dispatch(func, dr);
2996 dr.screenUpdate(Update::Force);
2997 dr.forceBufferUpdate();
3002 case LFUN_BUFFER_VIEW_CACHE:
3003 if (!theFormats().view(*this, d->preview_file_,
3004 d->preview_format_))
3005 dr.setMessage(_("Error viewing the output file."));
3008 case LFUN_CHANGES_TRACK:
3009 if (params().save_transient_properties)
3010 undo().recordUndoBufferParams(CursorData());
3011 params().track_changes = !params().track_changes;
3012 if (!params().track_changes)
3013 dr.forceChangesUpdate();
3016 case LFUN_CHANGES_OUTPUT:
3017 if (params().save_transient_properties)
3018 undo().recordUndoBufferParams(CursorData());
3019 params().output_changes = !params().output_changes;
3020 if (params().output_changes) {
3021 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3022 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3023 LaTeXFeatures::isAvailable("xcolor");
3025 if (!dvipost && !xcolorulem) {
3026 Alert::warning(_("Changes not shown in LaTeX output"),
3027 _("Changes will not be highlighted in LaTeX output, "
3028 "because neither dvipost nor xcolor/ulem are installed.\n"
3029 "Please install these packages or redefine "
3030 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3031 } else if (!xcolorulem) {
3032 Alert::warning(_("Changes not shown in LaTeX output"),
3033 _("Changes will not be highlighted in LaTeX output "
3034 "when using pdflatex, because xcolor and ulem are not installed.\n"
3035 "Please install both packages or redefine "
3036 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3041 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3042 // turn compression on/off
3043 undo().recordUndoBufferParams(CursorData());
3044 params().compressed = !params().compressed;
3047 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3048 undo().recordUndoBufferParams(CursorData());
3049 params().output_sync = !params().output_sync;
3052 case LFUN_BUFFER_ANONYMIZE: {
3053 undo().recordUndoFullBuffer(CursorData());
3054 CursorData cur(doc_iterator_begin(this));
3055 for ( ; cur ; cur.forwardPar())
3056 cur.paragraph().anonymize();
3057 dr.forceBufferUpdate();
3058 dr.screenUpdate(Update::Force);
3066 dr.dispatched(dispatched);
3070 void Buffer::changeLanguage(Language const * from, Language const * to)
3072 LASSERT(from, return);
3073 LASSERT(to, return);
3075 for_each(par_iterator_begin(),
3077 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3081 bool Buffer::isMultiLingual() const
3083 ParConstIterator end = par_iterator_end();
3084 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3085 if (it->isMultiLingual(params()))
3092 std::set<Language const *> Buffer::getLanguages() const
3094 std::set<Language const *> langs;
3095 getLanguages(langs);
3100 void Buffer::getLanguages(std::set<Language const *> & langs) const
3102 ParConstIterator end = par_iterator_end();
3103 // add the buffer language, even if it's not actively used
3104 langs.insert(language());
3105 // iterate over the paragraphs
3106 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3107 it->getLanguages(langs);
3109 ListOfBuffers clist = getDescendents();
3110 for (auto const & cit : clist)
3111 cit->getLanguages(langs);
3115 DocIterator Buffer::getParFromID(int const id) const
3117 Buffer * buf = const_cast<Buffer *>(this);
3119 // This means non-existent
3120 return doc_iterator_end(buf);
3122 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3123 if (it.paragraph().id() == id)
3126 return doc_iterator_end(buf);
3130 bool Buffer::hasParWithID(int const id) const
3132 return !getParFromID(id).atEnd();
3136 ParIterator Buffer::par_iterator_begin()
3138 return ParIterator(doc_iterator_begin(this));
3142 ParIterator Buffer::par_iterator_end()
3144 return ParIterator(doc_iterator_end(this));
3148 ParConstIterator Buffer::par_iterator_begin() const
3150 return ParConstIterator(doc_iterator_begin(this));
3154 ParConstIterator Buffer::par_iterator_end() const
3156 return ParConstIterator(doc_iterator_end(this));
3160 Language const * Buffer::language() const
3162 return params().language;
3166 docstring const Buffer::B_(string const & l10n) const
3168 return params().B_(l10n);
3172 bool Buffer::isClean() const
3174 return d->lyx_clean;
3178 bool Buffer::isChecksumModified() const
3180 LASSERT(d->filename.exists(), return false);
3181 return d->checksum_ != d->filename.checksum();
3185 void Buffer::saveCheckSum() const
3187 FileName const & file = d->filename;
3189 d->checksum_ = file.exists() ? file.checksum()
3190 : 0; // in the case of save to a new file.
3194 void Buffer::markClean() const
3196 if (!d->lyx_clean) {
3197 d->lyx_clean = true;
3200 // if the .lyx file has been saved, we don't need an
3202 d->bak_clean = true;
3203 d->undo_.markDirty();
3204 clearExternalModification();
3208 void Buffer::setUnnamed(bool flag)
3214 bool Buffer::isUnnamed() const
3221 /// Don't check unnamed, here: isInternal() is used in
3222 /// newBuffer(), where the unnamed flag has not been set by anyone
3223 /// yet. Also, for an internal buffer, there should be no need for
3224 /// retrieving fileName() nor for checking if it is unnamed or not.
3225 bool Buffer::isInternal() const
3227 return d->internal_buffer;
3231 void Buffer::setInternal(bool flag)
3233 d->internal_buffer = flag;
3237 void Buffer::markDirty()
3240 d->lyx_clean = false;
3243 d->bak_clean = false;
3245 for (auto & depit : d->dep_clean)
3246 depit.second = false;
3250 FileName Buffer::fileName() const
3256 string Buffer::absFileName() const
3258 return d->filename.absFileName();
3262 string Buffer::filePath() const
3264 string const abs = d->filename.onlyPath().absFileName();
3267 int last = abs.length() - 1;
3269 return abs[last] == '/' ? abs : abs + '/';
3273 DocFileName Buffer::getReferencedFileName(string const & fn) const
3276 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3277 result.set(fn, filePath());
3279 // filePath() ends with a path separator
3280 FileName const test(filePath() + fn);
3282 result.set(fn, filePath());
3284 result.set(fn, params().origin);
3291 string const Buffer::prepareFileNameForLaTeX(string const & name,
3292 string const & ext, bool nice) const
3294 string const fname = makeAbsPath(name, filePath()).absFileName();
3295 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3301 return to_utf8(makeRelPath(from_utf8(fname),
3302 from_utf8(masterBuffer()->filePath())));
3306 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3307 docstring_list const & bibfilelist,
3308 bool const add_extension) const
3310 // If we are processing the LaTeX file in a temp directory then
3311 // copy the .bib databases to this temp directory, mangling their
3312 // names in the process. Store this mangled name in the list of
3314 // (We need to do all this because BibTeX *really*, *really*
3315 // can't handle "files with spaces" and Windows users tend to
3316 // use such filenames.)
3317 // Otherwise, store the (maybe absolute) path to the original,
3318 // unmangled database name.
3320 vector<pair<docstring, string>> res;
3322 // determine the export format
3323 string const tex_format = flavor2format(runparams.flavor);
3325 // check for spaces in paths
3326 bool found_space = false;
3328 for (auto const & bit : bibfilelist) {
3329 string utf8input = to_utf8(bit);
3331 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3332 FileName try_in_file =
3333 makeAbsPath(database + ".bib", filePath());
3334 bool not_from_texmf = try_in_file.isReadableFile();
3335 // If the file has not been found, try with the real file name
3336 // (it might come from a child in a sub-directory)
3337 if (!not_from_texmf) {
3338 try_in_file = getBibfilePath(bit);
3339 if (try_in_file.isReadableFile()) {
3340 // Check if the file is in texmf
3341 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3342 not_from_texmf = kpsefile.empty()
3343 || kpsefile.absFileName() != try_in_file.absFileName();
3345 // If this exists, make path relative to the master
3348 removeExtension(prepareFileNameForLaTeX(
3349 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3350 from_utf8(filePath()))),
3351 ".bib", runparams.nice));
3355 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3357 // mangledFileName() needs the extension
3358 DocFileName const in_file = DocFileName(try_in_file);
3359 database = removeExtension(in_file.mangledFileName());
3360 FileName const out_file = makeAbsPath(database + ".bib",
3361 masterBuffer()->temppath());
3362 bool const success = in_file.copyTo(out_file);
3364 LYXERR0("Failed to copy '" << in_file
3365 << "' to '" << out_file << "'");
3367 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3368 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3369 if (!isValidLaTeXFileName(database)) {
3370 frontend::Alert::warning(_("Invalid filename"),
3371 _("The following filename will cause troubles "
3372 "when running the exported file through LaTeX: ") +
3373 from_utf8(database));
3375 if (!isValidDVIFileName(database)) {
3376 frontend::Alert::warning(_("Problematic filename for DVI"),
3377 _("The following filename can cause troubles "
3378 "when running the exported file through LaTeX "
3379 "and opening the resulting DVI: ") +
3380 from_utf8(database), true);
3388 docstring const path = from_utf8(latex_path(database));
3390 if (contains(path, ' '))
3393 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3394 enc = params().bibFileEncoding(utf8input);
3396 bool recorded = false;
3397 for (pair<docstring, string> pe : res) {
3398 if (pe.first == path) {
3405 res.push_back(make_pair(path, enc));
3408 // Check if there are spaces in the path and warn BibTeX users, if so.
3409 // (biber can cope with such paths)
3410 if (!prefixIs(runparams.bibtex_command, "biber")) {
3411 // Post this warning only once.
3412 static bool warned_about_spaces = false;
3413 if (!warned_about_spaces &&
3414 runparams.nice && found_space) {
3415 warned_about_spaces = true;
3416 Alert::warning(_("Export Warning!"),
3417 _("There are spaces in the paths to your BibTeX databases.\n"
3418 "BibTeX will be unable to find them."));
3427 string Buffer::layoutPos() const
3429 return d->layout_position;
3433 void Buffer::setLayoutPos(string const & path)
3436 d->layout_position.clear();
3440 LATTEST(FileName::isAbsolute(path));
3442 d->layout_position =
3443 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3445 if (d->layout_position.empty())
3446 d->layout_position = ".";
3450 bool Buffer::hasReadonlyFlag() const
3452 return d->read_only;
3456 bool Buffer::isReadonly() const
3458 return hasReadonlyFlag() || notifiesExternalModification();
3462 void Buffer::setParent(Buffer const * buffer)
3464 // Avoids recursive include.
3465 d->setParent(buffer == this ? 0 : buffer);
3470 Buffer const * Buffer::parent() const
3476 ListOfBuffers Buffer::allRelatives() const
3478 ListOfBuffers lb = masterBuffer()->getDescendents();
3479 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3484 Buffer const * Buffer::masterBuffer() const
3486 // FIXME Should be make sure we are not in some kind
3487 // of recursive include? A -> B -> A will crash this.
3488 Buffer const * const pbuf = d->parent();
3492 return pbuf->masterBuffer();
3496 bool Buffer::isChild(Buffer * child) const
3498 return d->children_positions.find(child) != d->children_positions.end();
3502 DocIterator Buffer::firstChildPosition(Buffer const * child)
3504 Impl::BufferPositionMap::iterator it;
3505 it = d->children_positions.find(child);
3506 if (it == d->children_positions.end())
3507 return DocIterator(this);
3512 bool Buffer::hasChildren() const
3514 return !d->children_positions.empty();
3518 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3520 // loop over children
3521 for (auto const & p : d->children_positions) {
3522 Buffer * child = const_cast<Buffer *>(p.first);
3524 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3525 if (bit != clist.end())
3527 clist.push_back(child);
3529 // there might be grandchildren
3530 child->collectChildren(clist, true);
3535 ListOfBuffers Buffer::getChildren() const
3538 collectChildren(v, false);
3539 // Make sure we have not included ourselves.
3540 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3541 if (bit != v.end()) {
3542 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3549 ListOfBuffers Buffer::getDescendents() const
3552 collectChildren(v, true);
3553 // Make sure we have not included ourselves.
3554 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3555 if (bit != v.end()) {
3556 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3563 template<typename M>
3564 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3569 typename M::const_iterator it = m.lower_bound(x);
3570 if (it == m.begin())
3578 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3579 DocIterator const & pos) const
3581 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3583 // if paragraphs have no macro context set, pos will be empty
3587 // we haven't found anything yet
3588 DocIterator bestPos = owner_->par_iterator_begin();
3589 MacroData const * bestData = 0;
3591 // find macro definitions for name
3592 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3593 if (nameIt != macros.end()) {
3594 // find last definition in front of pos or at pos itself
3595 PositionScopeMacroMap::const_iterator it
3596 = greatest_below(nameIt->second, pos);
3597 if (it != nameIt->second.end()) {
3599 // scope ends behind pos?
3600 if (pos < it->second.scope) {
3601 // Looks good, remember this. If there
3602 // is no external macro behind this,
3603 // we found the right one already.
3604 bestPos = it->first;
3605 bestData = &it->second.macro;
3609 // try previous macro if there is one
3610 if (it == nameIt->second.begin())
3617 // find macros in included files
3618 PositionScopeBufferMap::const_iterator it
3619 = greatest_below(position_to_children, pos);
3620 if (it == position_to_children.end())
3621 // no children before
3625 // do we know something better (i.e. later) already?
3626 if (it->first < bestPos )
3629 // scope ends behind pos?
3630 if (pos < it->second.scope
3631 && (cloned_buffer_ ||
3632 theBufferList().isLoaded(it->second.buffer))) {
3633 // look for macro in external file
3635 MacroData const * data
3636 = it->second.buffer->getMacro(name, false);
3639 bestPos = it->first;
3645 // try previous file if there is one
3646 if (it == position_to_children.begin())
3651 // return the best macro we have found
3656 MacroData const * Buffer::getMacro(docstring const & name,
3657 DocIterator const & pos, bool global) const
3662 // query buffer macros
3663 MacroData const * data = d->getBufferMacro(name, pos);
3667 // If there is a master buffer, query that
3668 Buffer const * const pbuf = d->parent();
3670 d->macro_lock = true;
3671 MacroData const * macro = pbuf->getMacro(
3672 name, *this, false);
3673 d->macro_lock = false;
3679 data = MacroTable::globalMacros().get(name);
3688 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3690 // set scope end behind the last paragraph
3691 DocIterator scope = par_iterator_begin();
3692 scope.pit() = scope.lastpit() + 1;
3694 return getMacro(name, scope, global);
3698 MacroData const * Buffer::getMacro(docstring const & name,
3699 Buffer const & child, bool global) const
3701 // look where the child buffer is included first
3702 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3703 if (it == d->children_positions.end())
3706 // check for macros at the inclusion position
3707 return getMacro(name, it->second, global);
3711 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3713 pit_type const lastpit = it.lastpit();
3715 // look for macros in each paragraph
3716 while (it.pit() <= lastpit) {
3717 Paragraph & par = it.paragraph();
3719 // FIXME Can this be done with the new-style iterators?
3720 // iterate over the insets of the current paragraph
3721 for (auto const & insit : par.insetList()) {
3722 it.pos() = insit.pos;
3724 // is it a nested text inset?
3725 if (insit.inset->asInsetText()) {
3726 // Inset needs its own scope?
3727 InsetText const * itext = insit.inset->asInsetText();
3728 bool newScope = itext->isMacroScope();
3730 // scope which ends just behind the inset
3731 DocIterator insetScope = it;
3734 // collect macros in inset
3735 it.push_back(CursorSlice(*insit.inset));
3736 updateMacros(it, newScope ? insetScope : scope);
3741 if (insit.inset->asInsetTabular()) {
3742 CursorSlice slice(*insit.inset);
3743 size_t const numcells = slice.nargs();
3744 for (; slice.idx() < numcells; slice.forwardIdx()) {
3745 it.push_back(slice);
3746 updateMacros(it, scope);
3752 // is it an external file?
3753 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3754 // get buffer of external file
3755 InsetInclude const & incinset =
3756 static_cast<InsetInclude const &>(*insit.inset);
3758 Buffer * child = incinset.getChildBuffer();
3763 // register its position, but only when it is
3764 // included first in the buffer
3765 if (children_positions.find(child) ==
3766 children_positions.end())
3767 children_positions[child] = it;
3769 // register child with its scope
3770 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3774 InsetMath * im = insit.inset->asInsetMath();
3775 if (doing_export && im) {
3776 InsetMathHull * hull = im->asHullInset();
3778 hull->recordLocation(it);
3781 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3785 InsetMathMacroTemplate & macroTemplate =
3786 *insit.inset->asInsetMath()->asMacroTemplate();
3787 MacroContext mc(owner_, it);
3788 macroTemplate.updateToContext(mc);
3791 bool valid = macroTemplate.validMacro();
3792 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3793 // then the BufferView's cursor will be invalid in
3794 // some cases which leads to crashes.
3799 // FIXME (Abdel), I don't understand why we pass 'it' here
3800 // instead of 'macroTemplate' defined above... is this correct?
3801 macros[macroTemplate.name()][it] =
3802 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3812 void Buffer::updateMacros() const
3817 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3819 // start with empty table
3821 d->children_positions.clear();
3822 d->position_to_children.clear();
3824 // Iterate over buffer, starting with first paragraph
3825 // The scope must be bigger than any lookup DocIterator
3826 // later. For the global lookup, lastpit+1 is used, hence
3827 // we use lastpit+2 here.
3828 DocIterator it = par_iterator_begin();
3829 DocIterator outerScope = it;
3830 outerScope.pit() = outerScope.lastpit() + 2;
3831 d->updateMacros(it, outerScope);
3835 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3837 InsetIterator it = inset_iterator_begin(inset());
3838 InsetIterator const end = inset_iterator_end(inset());
3839 for (; it != end; ++it) {
3840 if (it->lyxCode() == BRANCH_CODE) {
3841 InsetBranch & br = static_cast<InsetBranch &>(*it);
3842 docstring const name = br.branch();
3843 if (!from_master && !params().branchlist().find(name))
3844 result.push_back(name);
3845 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3846 result.push_back(name);
3849 if (it->lyxCode() == INCLUDE_CODE) {
3850 // get buffer of external file
3851 InsetInclude const & ins =
3852 static_cast<InsetInclude const &>(*it);
3853 Buffer * child = ins.getChildBuffer();
3856 child->getUsedBranches(result, true);
3859 // remove duplicates
3864 void Buffer::updateMacroInstances(UpdateType utype) const
3866 LYXERR(Debug::MACROS, "updateMacroInstances for "
3867 << d->filename.onlyFileName());
3868 DocIterator it = doc_iterator_begin(this);
3870 DocIterator const end = doc_iterator_end(this);
3871 for (; it != end; it.forwardInset()) {
3872 // look for MathData cells in InsetMathNest insets
3873 InsetMath * minset = it.nextInset()->asInsetMath();
3877 // update macro in all cells of the InsetMathNest
3878 DocIterator::idx_type n = minset->nargs();
3879 MacroContext mc = MacroContext(this, it);
3880 for (DocIterator::idx_type i = 0; i < n; ++i) {
3881 MathData & data = minset->cell(i);
3882 data.updateMacros(0, mc, utype, 0);
3888 void Buffer::listMacroNames(MacroNameSet & macros) const
3893 d->macro_lock = true;
3895 // loop over macro names
3896 for (auto const & nameit : d->macros)
3897 macros.insert(nameit.first);
3899 // loop over children
3900 for (auto const & p : d->children_positions) {
3901 Buffer * child = const_cast<Buffer *>(p.first);
3902 // The buffer might have been closed (see #10766).
3903 if (theBufferList().isLoaded(child))
3904 child->listMacroNames(macros);
3908 Buffer const * const pbuf = d->parent();
3910 pbuf->listMacroNames(macros);
3912 d->macro_lock = false;
3916 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3918 Buffer const * const pbuf = d->parent();
3923 pbuf->listMacroNames(names);
3926 for (auto const & mit : names) {
3928 MacroData const * data = pbuf->getMacro(mit, *this, false);
3930 macros.insert(data);
3932 // we cannot access the original InsetMathMacroTemplate anymore
3933 // here to calls validate method. So we do its work here manually.
3934 // FIXME: somehow make the template accessible here.
3935 if (data->optionals() > 0)
3936 features.require("xargs");
3942 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3945 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3947 RefCache::iterator it = d->ref_cache_.find(label);
3948 if (it != d->ref_cache_.end())
3951 static References const dummy_refs = References();
3952 it = d->ref_cache_.insert(
3953 make_pair(label, dummy_refs)).first;
3958 Buffer::References const & Buffer::references(docstring const & label) const
3960 return const_cast<Buffer *>(this)->getReferenceCache(label);
3964 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3966 References & refs = getReferenceCache(label);
3967 refs.push_back(make_pair(inset, it));
3971 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3975 linfo.label = label;
3977 linfo.active = active;
3978 masterBuffer()->d->label_cache_.push_back(linfo);
3982 InsetLabel const * Buffer::insetLabel(docstring const & label,
3983 bool const active) const
3985 for (auto & rc : masterBuffer()->d->label_cache_) {
3986 if (rc.label == label && (rc.active || !active))
3993 bool Buffer::activeLabel(docstring const & label) const
3995 if (!insetLabel(label, true))
4002 void Buffer::clearReferenceCache() const
4005 d->ref_cache_.clear();
4006 d->label_cache_.clear();
4011 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4013 //FIXME: This does not work for child documents yet.
4014 reloadBibInfoCache();
4016 // Check if the label 'from' appears more than once
4017 vector<docstring> labels;
4018 for (auto const & bibit : masterBibInfo())
4019 labels.push_back(bibit.first);
4021 if (count(labels.begin(), labels.end(), from) > 1)
4024 string const paramName = "key";
4025 InsetIterator it = inset_iterator_begin(inset());
4027 if (it->lyxCode() != CITE_CODE)
4029 InsetCommand * inset = it->asInsetCommand();
4030 docstring const oldValue = inset->getParam(paramName);
4031 if (oldValue == from)
4032 inset->setParam(paramName, to);
4036 // returns NULL if id-to-row conversion is unsupported
4037 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4038 pit_type par_begin, pit_type par_end,
4039 OutputWhat output, bool master) const
4041 unique_ptr<TexRow> texrow;
4042 OutputParams runparams(¶ms().encoding());
4043 runparams.nice = true;
4044 runparams.flavor = params().getOutputFlavor(format);
4045 runparams.linelen = lyxrc.plaintext_linelen;
4046 // No side effect of file copying and image conversion
4047 runparams.dryrun = true;
4049 // Some macros rely on font encoding
4050 runparams.main_fontenc = params().main_font_encoding();
4052 if (output == CurrentParagraph) {
4053 runparams.par_begin = par_begin;
4054 runparams.par_end = par_end;
4055 if (par_begin + 1 == par_end) {
4057 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4061 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4062 convert<docstring>(par_begin),
4063 convert<docstring>(par_end - 1))
4066 // output paragraphs
4067 if (runparams.flavor == OutputParams::LYX) {
4068 Paragraph const & par = text().paragraphs()[par_begin];
4070 depth_type dt = par.getDepth();
4071 par.write(ods, params(), dt);
4072 os << from_utf8(ods.str());
4073 } else if (runparams.flavor == OutputParams::HTML) {
4075 setMathFlavor(runparams);
4076 xhtmlParagraphs(text(), *this, xs, runparams);
4077 } else if (runparams.flavor == OutputParams::TEXT) {
4079 // FIXME Handles only one paragraph, unlike the others.
4080 // Probably should have some routine with a signature like them.
4081 writePlaintextParagraph(*this,
4082 text().paragraphs()[par_begin], os, runparams, dummy);
4083 } else if (params().isDocBook()) {
4084 docbookParagraphs(text(), *this, os, runparams);
4086 // If we are previewing a paragraph, even if this is the
4087 // child of some other buffer, let's cut the link here,
4088 // so that no concurring settings from the master
4089 // (e.g. branch state) interfere (see #8101).
4091 d->ignore_parent = true;
4092 // We need to validate the Buffer params' features here
4093 // in order to know if we should output polyglossia
4094 // macros (instead of babel macros)
4095 LaTeXFeatures features(*this, params(), runparams);
4097 runparams.use_polyglossia = features.usePolyglossia();
4098 // latex or literate
4101 ots.texrow().newlines(2);
4103 latexParagraphs(*this, text(), ots, runparams);
4104 texrow = ots.releaseTexRow();
4106 // Restore the parenthood
4108 d->ignore_parent = false;
4112 if (output == FullSource)
4113 os << _("Preview source code");
4114 else if (output == OnlyPreamble)
4115 os << _("Preview preamble");
4116 else if (output == OnlyBody)
4117 os << _("Preview body");
4119 if (runparams.flavor == OutputParams::LYX) {
4121 if (output == FullSource)
4123 else if (output == OnlyPreamble)
4124 params().writeFile(ods, this);
4125 else if (output == OnlyBody)
4127 os << from_utf8(ods.str());
4128 } else if (runparams.flavor == OutputParams::HTML) {
4129 writeLyXHTMLSource(os, runparams, output);
4130 } else if (runparams.flavor == OutputParams::TEXT) {
4131 if (output == OnlyPreamble) {
4132 os << "% "<< _("Plain text does not have a preamble.");
4134 writePlaintextFile(*this, os, runparams);
4135 } else if (params().isDocBook()) {
4136 writeDocBookSource(os, absFileName(), runparams, output);
4138 // latex or literate
4141 ots.texrow().newlines(2);
4143 runparams.is_child = true;
4145 writeLaTeXSource(ots, string(), runparams, output);
4146 texrow = ots.releaseTexRow();
4153 ErrorList & Buffer::errorList(string const & type) const
4155 return d->errorLists[type];
4159 void Buffer::updateTocItem(std::string const & type,
4160 DocIterator const & dit) const
4163 d->gui_->updateTocItem(type, dit);
4167 void Buffer::structureChanged() const
4170 d->gui_->structureChanged();
4174 void Buffer::errors(string const & err, bool from_master) const
4177 d->gui_->errors(err, from_master);
4181 void Buffer::message(docstring const & msg) const
4184 d->gui_->message(msg);
4188 void Buffer::setBusy(bool on) const
4191 d->gui_->setBusy(on);
4195 void Buffer::updateTitles() const
4198 d->wa_->updateTitles();
4202 void Buffer::resetAutosaveTimers() const
4205 d->gui_->resetAutosaveTimers();
4209 bool Buffer::hasGuiDelegate() const
4215 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4224 class AutoSaveBuffer : public ForkedProcess {
4227 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4228 : buffer_(buffer), fname_(fname) {}
4230 virtual shared_ptr<ForkedProcess> clone() const
4232 return make_shared<AutoSaveBuffer>(*this);
4237 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4238 from_utf8(fname_.absFileName())));
4239 return run(DontWait);
4243 virtual int generateChild();
4245 Buffer const & buffer_;
4250 int AutoSaveBuffer::generateChild()
4252 #if defined(__APPLE__)
4253 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4254 * We should use something else like threads.
4256 * Since I do not know how to determine at run time what is the OS X
4257 * version, I just disable forking altogether for now (JMarc)
4259 pid_t const pid = -1;
4261 // tmp_ret will be located (usually) in /tmp
4262 // will that be a problem?
4263 // Note that this calls ForkedCalls::fork(), so it's
4264 // ok cross-platform.
4265 pid_t const pid = fork();
4266 // If you want to debug the autosave
4267 // you should set pid to -1, and comment out the fork.
4268 if (pid != 0 && pid != -1)
4272 // pid = -1 signifies that lyx was unable
4273 // to fork. But we will do the save
4275 bool failed = false;
4276 TempFile tempfile("lyxautoXXXXXX.lyx");
4277 tempfile.setAutoRemove(false);
4278 FileName const tmp_ret = tempfile.name();
4279 if (!tmp_ret.empty()) {
4280 if (!buffer_.writeFile(tmp_ret))
4282 else if (!tmp_ret.moveTo(fname_))
4288 // failed to write/rename tmp_ret so try writing direct
4289 if (!buffer_.writeFile(fname_)) {
4290 // It is dangerous to do this in the child,
4291 // but safe in the parent, so...
4292 if (pid == -1) // emit message signal.
4293 buffer_.message(_("Autosave failed!"));
4297 if (pid == 0) // we are the child so...
4306 FileName Buffer::getEmergencyFileName() const
4308 return FileName(d->filename.absFileName() + ".emergency");
4312 FileName Buffer::getAutosaveFileName() const
4314 // if the document is unnamed try to save in the backup dir, else
4315 // in the default document path, and as a last try in the filePath,
4316 // which will most often be the temporary directory
4319 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4320 : lyxrc.backupdir_path;
4321 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4324 string const fname = "#" + d->filename.onlyFileName() + "#";
4326 return makeAbsPath(fname, fpath);
4330 void Buffer::removeAutosaveFile() const
4332 FileName const f = getAutosaveFileName();
4338 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4340 FileName const newauto = getAutosaveFileName();
4342 if (newauto != oldauto && oldauto.exists())
4343 if (!oldauto.moveTo(newauto))
4344 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4348 bool Buffer::autoSave() const
4350 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4351 if (buf->d->bak_clean || hasReadonlyFlag())
4354 message(_("Autosaving current document..."));
4355 buf->d->bak_clean = true;
4357 FileName const fname = getAutosaveFileName();
4358 LASSERT(d->cloned_buffer_, return false);
4360 // If this buffer is cloned, we assume that
4361 // we are running in a separate thread already.
4362 TempFile tempfile("lyxautoXXXXXX.lyx");
4363 tempfile.setAutoRemove(false);
4364 FileName const tmp_ret = tempfile.name();
4365 if (!tmp_ret.empty()) {
4367 // assume successful write of tmp_ret
4368 if (tmp_ret.moveTo(fname))
4371 // failed to write/rename tmp_ret so try writing direct
4372 return writeFile(fname);
4376 void Buffer::setExportStatus(bool e) const
4378 d->doing_export = e;
4379 ListOfBuffers clist = getDescendents();
4380 for (auto const & bit : clist)
4381 bit->d->doing_export = e;
4385 bool Buffer::isExporting() const
4387 return d->doing_export;
4391 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4395 return doExport(target, put_in_tempdir, result_file);
4398 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4399 string & result_file) const
4401 bool const update_unincluded =
4402 params().maintain_unincluded_children
4403 && !params().getIncludedChildren().empty();
4405 // (1) export with all included children (omit \includeonly)
4406 if (update_unincluded) {
4407 ExportStatus const status =
4408 doExport(target, put_in_tempdir, true, result_file);
4409 if (status != ExportSuccess)
4412 // (2) export with included children only
4413 return doExport(target, put_in_tempdir, false, result_file);
4417 void Buffer::setMathFlavor(OutputParams & op) const
4419 switch (params().html_math_output) {
4420 case BufferParams::MathML:
4421 op.math_flavor = OutputParams::MathAsMathML;
4423 case BufferParams::HTML:
4424 op.math_flavor = OutputParams::MathAsHTML;
4426 case BufferParams::Images:
4427 op.math_flavor = OutputParams::MathAsImages;
4429 case BufferParams::LaTeX:
4430 op.math_flavor = OutputParams::MathAsLaTeX;
4436 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4437 bool includeall, string & result_file) const
4439 LYXERR(Debug::FILES, "target=" << target);
4440 OutputParams runparams(¶ms().encoding());
4441 string format = target;
4442 string dest_filename;
4443 size_t pos = target.find(' ');
4444 if (pos != string::npos) {
4445 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4446 format = target.substr(0, pos);
4447 if (format == "default")
4448 format = params().getDefaultOutputFormat();
4449 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4450 FileName(dest_filename).onlyPath().createPath();
4451 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4453 MarkAsExporting exporting(this);
4454 string backend_format;
4455 runparams.flavor = OutputParams::LATEX;
4456 runparams.linelen = lyxrc.plaintext_linelen;
4457 runparams.includeall = includeall;
4458 vector<string> backs = params().backends();
4459 Converters converters = theConverters();
4460 bool need_nice_file = false;
4461 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4462 // Get shortest path to format
4463 converters.buildGraph();
4464 Graph::EdgePath path;
4465 for (string const & sit : backs) {
4466 Graph::EdgePath p = converters.getPath(sit, format);
4467 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4468 backend_format = sit;
4473 if (!put_in_tempdir) {
4474 // Only show this alert if this is an export to a non-temporary
4475 // file (not for previewing).
4476 docstring s = bformat(_("No information for exporting the format %1$s."),
4477 theFormats().prettyName(format));
4478 if (format == "pdf4")
4480 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4481 " to '%1$s' or '%2$s'"),
4482 from_utf8(encodings.fromLyXName("utf8")->guiName()),
4483 from_utf8(encodings.fromLyXName("ascii")->guiName()));
4484 Alert::error(_("Couldn't export file"), s);
4486 return ExportNoPathToFormat;
4488 runparams.flavor = converters.getFlavor(path, this);
4489 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4490 for (auto const & edge : path)
4491 if (theConverters().get(edge).nice()) {
4492 need_nice_file = true;
4497 backend_format = format;
4498 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4499 // FIXME: Don't hardcode format names here, but use a flag
4500 if (backend_format == "pdflatex")
4501 runparams.flavor = OutputParams::PDFLATEX;
4502 else if (backend_format == "luatex")
4503 runparams.flavor = OutputParams::LUATEX;
4504 else if (backend_format == "dviluatex")
4505 runparams.flavor = OutputParams::DVILUATEX;
4506 else if (backend_format == "xetex")
4507 runparams.flavor = OutputParams::XETEX;
4510 string filename = latexName(false);
4511 filename = addName(temppath(), filename);
4512 filename = changeExtension(filename,
4513 theFormats().extension(backend_format));
4514 LYXERR(Debug::FILES, "filename=" << filename);
4516 // Plain text backend
4517 if (backend_format == "text") {
4518 runparams.flavor = OutputParams::TEXT;
4520 writePlaintextFile(*this, FileName(filename), runparams);
4522 catch (ConversionException const &) { return ExportCancel; }
4525 else if (backend_format == "xhtml") {
4526 runparams.flavor = OutputParams::HTML;
4527 setMathFlavor(runparams);
4528 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4529 return ExportKilled;
4530 } else if (backend_format == "lyx")
4531 writeFile(FileName(filename));
4533 else if (params().isDocBook()) {
4534 runparams.nice = !put_in_tempdir;
4535 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4536 return ExportKilled;
4539 else if (backend_format == format || need_nice_file) {
4540 runparams.nice = true;
4541 ExportStatus const retval =
4542 makeLaTeXFile(FileName(filename), string(), runparams);
4543 if (retval == ExportKilled)
4544 return ExportKilled;
4545 if (d->cloned_buffer_)
4546 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4547 if (retval != ExportSuccess)
4549 } else if (!lyxrc.tex_allows_spaces
4550 && contains(filePath(), ' ')) {
4551 Alert::error(_("File name error"),
4552 bformat(_("The directory path to the document\n%1$s\n"
4553 "contains spaces, but your TeX installation does "
4554 "not allow them. You should save the file to a directory "
4555 "whose name does not contain spaces."), from_utf8(filePath())));
4556 return ExportTexPathHasSpaces;
4558 runparams.nice = false;
4559 ExportStatus const retval =
4560 makeLaTeXFile(FileName(filename), filePath(), runparams);
4561 if (retval == ExportKilled)
4562 return ExportKilled;
4563 if (d->cloned_buffer_)
4564 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4565 if (retval != ExportSuccess)
4569 string const error_type = (format == "program")
4570 ? "Build" : params().bufferFormat();
4571 ErrorList & error_list = d->errorLists[error_type];
4572 string const ext = theFormats().extension(format);
4573 FileName const tmp_result_file(changeExtension(filename, ext));
4574 Converters::RetVal const retval =
4575 converters.convert(this, FileName(filename), tmp_result_file,
4576 FileName(absFileName()), backend_format, format, error_list);
4577 if (retval == Converters::KILLED)
4578 return ExportCancel;
4579 bool success = (retval == Converters::SUCCESS);
4581 // Emit the signal to show the error list or copy it back to the
4582 // cloned Buffer so that it can be emitted afterwards.
4583 if (format != backend_format) {
4584 if (runparams.silent)
4586 else if (d->cloned_buffer_)
4587 d->cloned_buffer_->d->errorLists[error_type] =
4588 d->errorLists[error_type];
4591 // also to the children, in case of master-buffer-view
4592 ListOfBuffers clist = getDescendents();
4593 for (auto const & bit : clist) {
4594 if (runparams.silent)
4595 bit->d->errorLists[error_type].clear();
4596 else if (d->cloned_buffer_) {
4597 // Enable reverse search by copying back the
4598 // texrow object to the cloned buffer.
4599 // FIXME: this is not thread safe.
4600 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4601 bit->d->cloned_buffer_->d->errorLists[error_type] =
4602 bit->d->errorLists[error_type];
4604 bit->errors(error_type, true);
4608 if (d->cloned_buffer_) {
4609 // Enable reverse dvi or pdf to work by copying back the texrow
4610 // object to the cloned buffer.
4611 // FIXME: There is a possibility of concurrent access to texrow
4612 // here from the main GUI thread that should be securized.
4613 d->cloned_buffer_->d->texrow = d->texrow;
4614 string const err_type = params().bufferFormat();
4615 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4619 if (put_in_tempdir) {
4620 result_file = tmp_result_file.absFileName();
4621 return success ? ExportSuccess : ExportConverterError;
4624 if (dest_filename.empty())
4625 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4627 result_file = dest_filename;
4628 // We need to copy referenced files (e. g. included graphics
4629 // if format == "dvi") to the result dir.
4630 vector<ExportedFile> const files =
4631 runparams.exportdata->externalFiles(format);
4632 string const dest = runparams.export_folder.empty() ?
4633 onlyPath(result_file) : runparams.export_folder;
4634 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4635 : force_overwrite == ALL_FILES;
4636 CopyStatus status = use_force ? FORCE : SUCCESS;
4638 for (ExportedFile const & exp : files) {
4639 if (status == CANCEL) {
4640 message(_("Document export cancelled."));
4641 return ExportCancel;
4643 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4644 string fixedName = exp.exportName;
4645 if (!runparams.export_folder.empty()) {
4646 // Relative pathnames starting with ../ will be sanitized
4647 // if exporting to a different folder
4648 while (fixedName.substr(0, 3) == "../")
4649 fixedName = fixedName.substr(3, fixedName.length() - 3);
4651 FileName fixedFileName = makeAbsPath(fixedName, dest);
4652 fixedFileName.onlyPath().createPath();
4653 status = copyFile(fmt, exp.sourceName,
4655 exp.exportName, status == FORCE,
4656 runparams.export_folder.empty());
4660 if (tmp_result_file.exists()) {
4661 // Finally copy the main file
4662 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4663 : force_overwrite != NO_FILES;
4664 if (status == SUCCESS && use_force)
4666 status = copyFile(format, tmp_result_file,
4667 FileName(result_file), result_file,
4669 if (status == CANCEL) {
4670 message(_("Document export cancelled."));
4671 return ExportCancel;
4673 message(bformat(_("Document exported as %1$s "
4675 theFormats().prettyName(format),
4676 makeDisplayPath(result_file)));
4679 // This must be a dummy converter like fax (bug 1888)
4680 message(bformat(_("Document exported as %1$s"),
4681 theFormats().prettyName(format)));
4684 return success ? ExportSuccess : ExportConverterError;
4688 Buffer::ExportStatus Buffer::preview(string const & format) const
4690 bool const update_unincluded =
4691 params().maintain_unincluded_children
4692 && !params().getIncludedChildren().empty();
4693 return preview(format, update_unincluded);
4697 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4699 MarkAsExporting exporting(this);
4701 // (1) export with all included children (omit \includeonly)
4703 ExportStatus const status = doExport(format, true, true, result_file);
4704 if (status != ExportSuccess)
4707 // (2) export with included children only
4708 ExportStatus const status = doExport(format, true, false, result_file);
4709 FileName const previewFile(result_file);
4711 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4712 theimpl->preview_file_ = previewFile;
4713 theimpl->preview_format_ = format;
4714 theimpl->preview_error_ = (status != ExportSuccess);
4716 if (status != ExportSuccess)
4719 if (previewFile.exists())
4720 return theFormats().view(*this, previewFile, format) ?
4721 PreviewSuccess : PreviewError;
4723 // Successful export but no output file?
4724 // Probably a bug in error detection.
4725 LATTEST(status != ExportSuccess);
4730 Buffer::ReadStatus Buffer::extractFromVC()
4732 bool const found = LyXVC::file_not_found_hook(d->filename);
4734 return ReadFileNotFound;
4735 if (!d->filename.isReadableFile())
4741 Buffer::ReadStatus Buffer::loadEmergency()
4743 FileName const emergencyFile = getEmergencyFileName();
4744 if (!emergencyFile.exists()
4745 || emergencyFile.lastModified() <= d->filename.lastModified())
4746 return ReadFileNotFound;
4748 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4749 docstring const text = bformat(_("An emergency save of the document "
4750 "%1$s exists.\n\nRecover emergency save?"), file);
4752 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4753 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4759 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4760 bool const success = (ret_llf == ReadSuccess);
4762 if (hasReadonlyFlag()) {
4763 Alert::warning(_("File is read-only"),
4764 bformat(_("An emergency file is successfully loaded, "
4765 "but the original file %1$s is marked read-only. "
4766 "Please make sure to save the document as a different "
4767 "file."), from_utf8(d->filename.absFileName())));
4770 lyxvc().file_found_hook(d->filename);
4771 str = _("Document was successfully recovered.");
4773 str = _("Document was NOT successfully recovered.");
4774 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4775 makeDisplayPath(emergencyFile.absFileName()));
4777 int const del_emerg =
4778 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4779 _("&Remove"), _("&Keep"));
4780 if (del_emerg == 0) {
4781 emergencyFile.removeFile();
4783 Alert::warning(_("Emergency file deleted"),
4784 _("Do not forget to save your file now!"), true);
4786 return success ? ReadSuccess : ReadEmergencyFailure;
4789 int const del_emerg =
4790 Alert::prompt(_("Delete emergency file?"),
4791 _("Remove emergency file now?"), 1, 1,
4792 _("&Remove"), _("&Keep"));
4794 emergencyFile.removeFile();
4798 string const ename = emergencyFile.absFileName();
4800 // Surely we can find one in 100 tries?
4801 for (int i = 1; i < 100; ++i) {
4802 newname.set(ename + to_string(i) + ".lyx");
4803 if (!newname.exists()) {
4809 // renameTo returns true on success. So inverting that
4810 // will give us true if we fail.
4811 noname = !emergencyFile.renameTo(newname);
4814 Alert::warning(_("Can't rename emergency file!"),
4815 _("LyX was unable to rename the emergency file. "
4816 "You should do so manually. Otherwise, you will be "
4817 "asked about it again the next time you try to load "
4818 "this file, and may over-write your own work."));
4820 Alert::warning(_("Emergency File Renames"),
4821 bformat(_("Emergency file renamed as:\n %1$s"),
4822 from_utf8(newname.onlyFileName())));
4825 return ReadOriginal;
4835 Buffer::ReadStatus Buffer::loadAutosave()
4837 // Now check if autosave file is newer.
4838 FileName const autosaveFile = getAutosaveFileName();
4839 if (!autosaveFile.exists()
4840 || autosaveFile.lastModified() <= d->filename.lastModified())
4841 return ReadFileNotFound;
4843 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4844 docstring const text = bformat(_("The backup of the document %1$s "
4845 "is newer.\n\nLoad the backup instead?"), file);
4846 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4847 _("&Load backup"), _("Load &original"), _("&Cancel"));
4852 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4853 // the file is not saved if we load the autosave file.
4854 if (ret_llf == ReadSuccess) {
4855 if (hasReadonlyFlag()) {
4856 Alert::warning(_("File is read-only"),
4857 bformat(_("A backup file is successfully loaded, "
4858 "but the original file %1$s is marked read-only. "
4859 "Please make sure to save the document as a "
4861 from_utf8(d->filename.absFileName())));
4864 lyxvc().file_found_hook(d->filename);
4867 return ReadAutosaveFailure;
4870 // Here we delete the autosave
4871 autosaveFile.removeFile();
4872 return ReadOriginal;
4880 Buffer::ReadStatus Buffer::loadLyXFile()
4882 if (!d->filename.isReadableFile()) {
4883 ReadStatus const ret_rvc = extractFromVC();
4884 if (ret_rvc != ReadSuccess)
4888 ReadStatus const ret_re = loadEmergency();
4889 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4892 ReadStatus const ret_ra = loadAutosave();
4893 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4896 return loadThisLyXFile(d->filename);
4900 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4902 return readFile(fn);
4906 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4908 for (; err != end; ++err) {
4909 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4910 int errorRow = err->error_in_line;
4911 Buffer const * buf = 0;
4912 Impl const * p = this;
4913 if (err->child_name.empty())
4914 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4916 // The error occurred in a child
4917 for (Buffer const * child : owner_->getDescendents()) {
4918 string const child_name =
4919 DocFileName(changeExtension(child->absFileName(), "tex")).
4921 if (err->child_name != child_name)
4923 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4924 if (!TexRow::isNone(start)) {
4925 buf = this->cloned_buffer_
4926 ? child->d->cloned_buffer_->d->owner_
4933 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4939 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4941 TeXErrors::Errors::const_iterator err = terr.begin();
4942 TeXErrors::Errors::const_iterator end = terr.end();
4944 d->traverseErrors(err, end, errorList);
4948 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4950 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4951 TeXErrors::Errors::const_iterator end = terr.end_ref();
4953 d->traverseErrors(err, end, errorList);
4957 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4959 LBUFERR(!text().paragraphs().empty());
4961 // Use the master text class also for child documents
4962 Buffer const * const master = masterBuffer();
4963 DocumentClass const & textclass = master->params().documentClass();
4965 docstring_list old_bibfiles;
4966 // Do this only if we are the top-level Buffer. We also need to account
4967 // for the case of a previewed child with ignored parent here.
4968 if (master == this && !d->ignore_parent) {
4969 textclass.counters().reset(from_ascii("bibitem"));
4970 reloadBibInfoCache();
4971 // we will re-read this cache as we go through, but we need
4972 // to know whether it's changed to know whether we need to
4973 // update the bibinfo cache.
4974 old_bibfiles = d->bibfiles_cache_;
4975 d->bibfiles_cache_.clear();
4978 // keep the buffers to be children in this set. If the call from the
4979 // master comes back we can see which of them were actually seen (i.e.
4980 // via an InsetInclude). The remaining ones in the set need still be updated.
4981 static std::set<Buffer const *> bufToUpdate;
4982 if (scope == UpdateMaster) {
4983 // If this is a child document start with the master
4984 if (master != this) {
4985 bufToUpdate.insert(this);
4986 master->updateBuffer(UpdateMaster, utype);
4987 // If the master buffer has no gui associated with it, then the TocModel is
4988 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4989 // (bug 5699). The same happens if the master buffer is open in a different
4990 // window. This test catches both possibilities.
4991 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4992 // There remains a problem here: If there is another child open in yet a third
4993 // window, that TOC is not updated. So some more general solution is needed at
4995 if (master->d->gui_ != d->gui_)
4998 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4999 if (bufToUpdate.find(this) == bufToUpdate.end())
5003 // start over the counters in the master
5004 textclass.counters().reset();
5007 // update will be done below for this buffer
5008 bufToUpdate.erase(this);
5010 // update all caches
5011 clearReferenceCache();
5013 setChangesPresent(false);
5015 Buffer & cbuf = const_cast<Buffer &>(*this);
5016 // if we are reloading, then we could have a dangling TOC,
5017 // in effect. so we need to go ahead and reset, even though
5018 // we will do so again when we rebuild the TOC later.
5019 cbuf.tocBackend().reset();
5022 ParIterator parit = cbuf.par_iterator_begin();
5023 updateBuffer(parit, utype);
5025 // If this document has siblings, then update the TocBackend later. The
5026 // reason is to ensure that later siblings are up to date when e.g. the
5027 // broken or not status of references is computed. The update is called
5028 // in InsetInclude::addToToc.
5032 // if the bibfiles changed, the cache of bibinfo is invalid
5033 docstring_list new_bibfiles = d->bibfiles_cache_;
5034 // this is a trick to determine whether the two vectors have
5035 // the same elements.
5036 sort(new_bibfiles.begin(), new_bibfiles.end());
5037 sort(old_bibfiles.begin(), old_bibfiles.end());
5038 if (old_bibfiles != new_bibfiles) {
5039 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5040 invalidateBibinfoCache();
5041 reloadBibInfoCache();
5042 // We relied upon the bibinfo cache when recalculating labels. But that
5043 // cache was invalid, although we didn't find that out until now. So we
5044 // have to do it all again.
5045 // That said, the only thing we really need to do is update the citation
5046 // labels. Nothing else will have changed. So we could create a new
5047 // UpdateType that would signal that fact, if we needed to do so.
5048 parit = cbuf.par_iterator_begin();
5049 // we will be re-doing the counters and references and such.
5050 textclass.counters().reset();
5051 clearReferenceCache();
5052 // we should not need to do this again?
5054 setChangesPresent(false);
5055 updateBuffer(parit, utype);
5056 // this will already have been done by reloadBibInfoCache();
5057 // d->bibinfo_cache_valid_ = true;
5060 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5061 // this is also set to true on the other path, by reloadBibInfoCache.
5062 d->bibinfo_cache_valid_ = true;
5064 d->cite_labels_valid_ = true;
5066 cbuf.tocBackend().update(true, utype);
5067 if (scope == UpdateMaster)
5068 cbuf.structureChanged();
5072 static depth_type getDepth(DocIterator const & it)
5074 depth_type depth = 0;
5075 for (size_t i = 0 ; i < it.depth() ; ++i)
5076 if (!it[i].inset().inMathed())
5077 depth += it[i].paragraph().getDepth() + 1;
5078 // remove 1 since the outer inset does not count
5079 // we should have at least one non-math inset, so
5080 // depth should nevery be 0. but maybe it is worth
5081 // marking this, just in case.
5083 // coverity[INTEGER_OVERFLOW]
5087 static depth_type getItemDepth(ParIterator const & it)
5089 Paragraph const & par = *it;
5090 LabelType const labeltype = par.layout().labeltype;
5092 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5095 // this will hold the lowest depth encountered up to now.
5096 depth_type min_depth = getDepth(it);
5097 ParIterator prev_it = it;
5100 --prev_it.top().pit();
5102 // start of nested inset: go to outer par
5104 if (prev_it.empty()) {
5105 // start of document: nothing to do
5110 // We search for the first paragraph with same label
5111 // that is not more deeply nested.
5112 Paragraph & prev_par = *prev_it;
5113 depth_type const prev_depth = getDepth(prev_it);
5114 if (labeltype == prev_par.layout().labeltype) {
5115 if (prev_depth < min_depth)
5116 return prev_par.itemdepth + 1;
5117 if (prev_depth == min_depth)
5118 return prev_par.itemdepth;
5120 min_depth = min(min_depth, prev_depth);
5121 // small optimization: if we are at depth 0, we won't
5122 // find anything else
5123 if (prev_depth == 0)
5129 static bool needEnumCounterReset(ParIterator const & it)
5131 Paragraph const & par = *it;
5132 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5133 depth_type const cur_depth = par.getDepth();
5134 ParIterator prev_it = it;
5135 while (prev_it.pit()) {
5136 --prev_it.top().pit();
5137 Paragraph const & prev_par = *prev_it;
5138 if (prev_par.getDepth() <= cur_depth)
5139 return prev_par.layout().name() != par.layout().name();
5141 // start of nested inset: reset
5146 // set the label of a paragraph. This includes the counters.
5147 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5149 BufferParams const & bp = owner_->masterBuffer()->params();
5150 DocumentClass const & textclass = bp.documentClass();
5151 Paragraph & par = it.paragraph();
5152 Layout const & layout = par.layout();
5153 Counters & counters = textclass.counters();
5155 if (par.params().startOfAppendix()) {
5156 // We want to reset the counter corresponding to toplevel sectioning
5157 Layout const & lay = textclass.getTOCLayout();
5158 docstring const cnt = lay.counter;
5160 counters.reset(cnt);
5161 counters.appendix(true);
5163 par.params().appendix(counters.appendix());
5165 // Compute the item depth of the paragraph
5166 par.itemdepth = getItemDepth(it);
5168 if (layout.margintype == MARGIN_MANUAL) {
5169 if (par.params().labelWidthString().empty())
5170 par.params().labelWidthString(par.expandLabel(layout, bp));
5171 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5172 // we do not need to do anything here, since the empty case is
5173 // handled during export.
5175 par.params().labelWidthString(docstring());
5178 switch(layout.labeltype) {
5179 case LABEL_ITEMIZE: {
5180 // At some point of time we should do something more
5181 // clever here, like:
5182 // par.params().labelString(
5183 // bp.user_defined_bullet(par.itemdepth).getText());
5184 // for now, use a simple hardcoded label
5185 docstring itemlabel;
5186 switch (par.itemdepth) {
5189 itemlabel = char_type(0x2022);
5193 itemlabel = char_type(0x2013);
5196 // ∗ U+2217 ASTERISK OPERATOR
5197 itemlabel = char_type(0x2217);
5200 // · U+00B7 MIDDLE DOT
5201 itemlabel = char_type(0x00b7);
5204 par.params().labelString(itemlabel);
5208 case LABEL_ENUMERATE: {
5209 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5211 switch (par.itemdepth) {
5222 enumcounter += "iv";
5225 // not a valid enumdepth...
5229 if (needEnumCounterReset(it)) {
5230 // Increase the master counter?
5231 if (layout.stepmastercounter)
5232 counters.stepMaster(enumcounter, utype);
5233 // Maybe we have to reset the enumeration counter.
5234 if (!layout.resumecounter)
5235 counters.reset(enumcounter);
5237 counters.step(enumcounter, utype);
5239 string const & lang = par.getParLanguage(bp)->code();
5240 par.params().labelString(counters.theCounter(enumcounter, lang));
5245 case LABEL_SENSITIVE: {
5246 string const & type = counters.current_float();
5247 docstring full_label;
5249 full_label = owner_->B_("Senseless!!! ");
5251 docstring name = owner_->B_(textclass.floats().getType(type).name());
5252 if (counters.hasCounter(from_utf8(type))) {
5253 string const & lang = par.getParLanguage(bp)->code();
5254 counters.step(from_utf8(type), utype);
5255 full_label = bformat(from_ascii("%1$s %2$s:"),
5257 counters.theCounter(from_utf8(type), lang));
5259 full_label = bformat(from_ascii("%1$s #:"), name);
5261 par.params().labelString(full_label);
5265 case LABEL_NO_LABEL:
5266 par.params().labelString(docstring());
5270 case LABEL_CENTERED:
5271 case LABEL_STATIC: {
5272 docstring const & lcounter = layout.counter;
5273 if (!lcounter.empty()) {
5274 if (layout.toclevel <= bp.secnumdepth
5275 && (layout.latextype != LATEX_ENVIRONMENT
5276 || it.text()->isFirstInSequence(it.pit()))) {
5277 if (counters.hasCounter(lcounter))
5278 counters.step(lcounter, utype);
5279 par.params().labelString(par.expandLabel(layout, bp));
5281 par.params().labelString(docstring());
5283 par.params().labelString(par.expandLabel(layout, bp));
5289 par.params().labelString(par.expandLabel(layout, bp));
5294 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5296 // LASSERT: Is it safe to continue here, or should we just return?
5297 LASSERT(parit.pit() == 0, /**/);
5299 // Set the position of the text in the buffer to be able
5300 // to resolve macros in it.
5301 parit.text()->setMacrocontextPosition(parit);
5303 // Reset bibitem counter in master (#8499)
5304 Buffer const * const master = masterBuffer();
5305 if (master == this && !d->ignore_parent)
5306 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5308 depth_type maxdepth = 0;
5309 pit_type const lastpit = parit.lastpit();
5310 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5311 // reduce depth if necessary
5312 if (parit->params().depth() > maxdepth) {
5313 /** FIXME: this function is const, but
5314 * nevertheless it modifies the buffer. To be
5315 * cleaner, one should modify the buffer in
5316 * another function, which is actually
5317 * non-const. This would however be costly in
5318 * terms of code duplication.
5320 CursorData(parit).recordUndo();
5321 parit->params().depth(maxdepth);
5323 maxdepth = parit->getMaxDepthAfter();
5325 if (utype == OutputUpdate) {
5326 // track the active counters
5327 // we have to do this for the master buffer, since the local
5328 // buffer isn't tracking anything.
5329 masterBuffer()->params().documentClass().counters().
5330 setActiveLayout(parit->layout());
5333 // set the counter for this paragraph
5334 d->setLabel(parit, utype);
5336 // update change-tracking flag
5337 parit->addChangesToBuffer(*this);
5340 for (auto const & insit : parit->insetList()) {
5341 parit.pos() = insit.pos;
5342 insit.inset->updateBuffer(parit, utype);
5348 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5349 WordLangTuple & word_lang, docstring_list & suggestions) const
5353 suggestions.clear();
5354 word_lang = WordLangTuple();
5355 bool const to_end = to.empty();
5356 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5357 // OK, we start from here.
5358 for (; from != end; from.forwardPos()) {
5359 // This skips all insets with spell check disabled.
5360 while (!from.allowSpellCheck()) {
5364 // If from is at the end of the document (which is possible
5365 // when "from" was changed above) LyX will crash later otherwise.
5366 if (from.atEnd() || (!to_end && from >= end))
5369 from.paragraph().spellCheck();
5370 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5371 if (SpellChecker::misspelled(res)) {
5375 // Do not increase progress when from == to, otherwise the word
5376 // count will be wrong.
5386 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5388 bool inword = false;
5393 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5394 if (!dit.inTexted()) {
5399 Paragraph const & par = dit.paragraph();
5400 pos_type const pos = dit.pos();
5402 // Copied and adapted from isWordSeparator() in Paragraph
5403 if (pos == dit.lastpos()) {
5406 Inset const * ins = par.getInset(pos);
5407 if (ins && skipNoOutput && !ins->producesOutput()) {
5410 // stop if end of range was skipped
5411 if (!to.atEnd() && dit >= to)
5414 } else if (!par.isDeleted(pos)) {
5415 if (par.isWordSeparator(pos))
5421 if (ins && ins->isLetter())
5423 else if (ins && ins->isSpace())
5426 char_type const c = par.getChar(pos);
5427 if (isPrintableNonspace(c))
5429 else if (isSpace(c))
5439 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5441 d->updateStatistics(from, to, skipNoOutput);
5445 int Buffer::wordCount() const
5447 return d->wordCount();
5451 int Buffer::charCount(bool with_blanks) const
5453 return d->charCount(with_blanks);
5457 Buffer::ReadStatus Buffer::reload()
5460 // c.f. bug https://www.lyx.org/trac/ticket/6587
5461 removeAutosaveFile();
5462 // e.g., read-only status could have changed due to version control
5463 d->filename.refresh();
5464 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5466 // clear parent. this will get reset if need be.
5468 ReadStatus const status = loadLyXFile();
5469 if (status == ReadSuccess) {
5474 message(bformat(_("Document %1$s reloaded."), disp_fn));
5477 message(bformat(_("Could not reload document %1$s."), disp_fn));
5487 bool Buffer::saveAs(FileName const & fn)
5489 FileName const old_name = fileName();
5490 FileName const old_auto = getAutosaveFileName();
5491 bool const old_unnamed = isUnnamed();
5492 bool success = true;
5493 d->old_position = filePath();
5500 // bring the autosave file with us, just in case.
5501 moveAutosaveFile(old_auto);
5502 // validate version control data and
5503 // correct buffer title
5504 lyxvc().file_found_hook(fileName());
5506 // the file has now been saved to the new location.
5507 // we need to check that the locations of child buffers
5509 checkChildBuffers();
5510 checkMasterBuffer();
5513 // reset the old filename and unnamed state
5514 setFileName(old_name);
5515 setUnnamed(old_unnamed);
5519 d->old_position.clear();
5524 void Buffer::checkChildBuffers()
5526 for (auto const & bit : d->children_positions) {
5527 DocIterator dit = bit.second;
5528 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5529 if (!cbuf || !theBufferList().isLoaded(cbuf))
5531 Inset * inset = dit.nextInset();
5532 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5533 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5534 docstring const & incfile = inset_inc->getParam("filename");
5535 string oldloc = cbuf->absFileName();
5536 string newloc = makeAbsPath(to_utf8(incfile),
5537 onlyPath(absFileName())).absFileName();
5538 if (oldloc == newloc)
5540 // the location of the child file is incorrect.
5542 inset_inc->setChildBuffer(0);
5544 // invalidate cache of children
5545 d->children_positions.clear();
5546 d->position_to_children.clear();
5550 // If a child has been saved under a different name/path, it might have been
5551 // orphaned. Therefore the master needs to be reset (bug 8161).
5552 void Buffer::checkMasterBuffer()
5554 Buffer const * const master = masterBuffer();
5558 // necessary to re-register the child (bug 5873)
5559 // FIXME: clean up updateMacros (here, only
5560 // child registering is needed).
5561 master->updateMacros();
5562 // (re)set master as master buffer, but only
5563 // if we are a real child
5564 if (master->isChild(this))
5571 string Buffer::includedFilePath(string const & name, string const & ext) const
5573 if (d->old_position.empty() ||
5574 equivalent(FileName(d->old_position), FileName(filePath())))
5577 bool isabsolute = FileName::isAbsolute(name);
5578 // both old_position and filePath() end with a path separator
5579 string absname = isabsolute ? name : d->old_position + name;
5581 // if old_position is set to origin, we need to do the equivalent of
5582 // getReferencedFileName() (see readDocument())
5583 if (!isabsolute && d->old_position == params().origin) {
5584 FileName const test(addExtension(filePath() + name, ext));
5586 absname = filePath() + name;
5589 if (!FileName(addExtension(absname, ext)).exists())
5593 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5595 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5596 from_utf8(filePath())));
5600 void Buffer::setChangesPresent(bool b) const
5602 d->tracked_changes_present_ = b;
5606 bool Buffer::areChangesPresent() const
5608 return d->tracked_changes_present_;
5612 void Buffer::updateChangesPresent() const
5614 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5615 setChangesPresent(false);
5616 ParConstIterator it = par_iterator_begin();
5617 ParConstIterator const end = par_iterator_end();
5618 for (; !areChangesPresent() && it != end; ++it)
5619 it->addChangesToBuffer(*this);
5623 void Buffer::Impl::refreshFileMonitor()
5625 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5626 file_monitor_->refresh();
5630 // The previous file monitor is invalid
5631 // This also destroys the previous file monitor and all its connections
5632 file_monitor_ = FileSystemWatcher::monitor(filename);
5633 // file_monitor_ will be destroyed with *this, so it is not going to call a
5634 // destroyed object method.
5635 file_monitor_->connect([this](bool exists) {
5636 fileExternallyModified(exists);
5641 void Buffer::Impl::fileExternallyModified(bool const exists)
5643 // ignore notifications after our own saving operations
5644 if (checksum_ == filename.checksum()) {
5645 LYXERR(Debug::FILES, "External modification but "
5646 "checksum unchanged: " << filename);
5649 // If the file has been deleted, only mark the file as dirty since it is
5650 // pointless to prompt for reloading. If later a file is moved into this
5651 // location, then the externally modified warning will appear then.
5653 externally_modified_ = true;
5654 // Update external modification notification.
5655 // Dirty buffers must be visible at all times.
5656 if (wa_ && wa_->unhide(owner_))
5657 wa_->updateTitles();
5659 // Unable to unhide the buffer (e.g. no GUI or not current View)
5664 bool Buffer::notifiesExternalModification() const
5666 return d->externally_modified_;
5670 void Buffer::clearExternalModification() const
5672 d->externally_modified_ = false;
5674 d->wa_->updateTitles();