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_;
314 /// These two hold the file name and format, written to by
315 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
316 FileName preview_file_;
317 string preview_format_;
318 /// If there was an error when previewing, on the next preview we do
319 /// a fresh compile (e.g. in case the user installed a package that
323 /// Cache the references associated to a label and their positions
325 mutable RefCache ref_cache_;
326 /// Cache the label insets and their activity status.
327 mutable LabelCache label_cache_;
329 /// our Text that should be wrapped in an InsetText
333 PreviewLoader * preview_loader_;
335 /// This is here to force the test to be done whenever parent_buffer
337 Buffer const * parent() const
339 // ignore_parent temporarily "orphans" a buffer
340 // (e.g. if a child is compiled standalone)
343 // if parent_buffer is not loaded, then it has been unloaded,
344 // which means that parent_buffer is an invalid pointer. So we
345 // set it to null in that case.
346 // however, the BufferList doesn't know about cloned buffers, so
347 // they will always be regarded as unloaded. in that case, we hope
349 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
351 return parent_buffer;
355 void setParent(Buffer const * pb)
357 if (parent_buffer == pb)
360 if (!cloned_buffer_ && parent_buffer && pb)
361 LYXERR0("Warning: a buffer should not have two parents!");
363 if (!cloned_buffer_ && parent_buffer)
364 parent_buffer->invalidateBibinfoCache();
367 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
368 /// This one is useful for preview detached in a thread.
369 Buffer const * cloned_buffer_;
371 CloneList * clone_list_;
372 /// are we in the process of exporting this buffer?
373 mutable bool doing_export;
375 /// compute statistics
376 /// \p from initial position
377 /// \p to points to the end position
378 void updateStatistics(DocIterator & from, DocIterator & to,
379 bool skipNoOutput = true);
380 /// statistics accessor functions
381 int wordCount() const
385 int charCount(bool with_blanks) const
388 + (with_blanks ? blank_count_ : 0);
391 // does the buffer contain tracked changes? (if so, we automatically
392 // display the review toolbar, for instance)
393 mutable bool tracked_changes_present_;
395 // Make sure the file monitor monitors the good file.
396 void refreshFileMonitor();
398 /// Notify or clear of external modification
399 void fileExternallyModified(bool exists);
401 /// has been externally modified? Can be reset by the user.
402 mutable bool externally_modified_;
405 /// So we can force access via the accessors.
406 mutable Buffer const * parent_buffer;
412 FileMonitorPtr file_monitor_;
416 /// Creates the per buffer temporary directory
417 static FileName createBufferTmpDir()
419 // FIXME This would be the ideal application for a TempDir class (like
420 // TempFile but for directories)
425 Mutex::Locker locker(&mutex);
426 counter = convert<string>(count++);
428 // We are in our own directory. Why bother to mangle name?
429 // In fact I wrote this code to circumvent a problematic behaviour
430 // (bug?) of EMX mkstemp().
431 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
434 if (!tmpfl.createDirectory(0777)) {
435 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
436 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
437 from_utf8(tmpfl.absFileName())));
443 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
444 Buffer const * cloned_buffer)
445 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
446 internal_buffer(false), read_only(readonly_), filename(file),
447 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
448 ignore_parent(false), toc_backend(owner), macro_lock(false),
449 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
450 cite_labels_valid_(false), preview_error_(false),
451 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
452 clone_list_(0), doing_export(false),
453 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
454 word_count_(0), char_count_(0), blank_count_(0)
456 refreshFileMonitor();
457 if (!cloned_buffer_) {
458 temppath = createBufferTmpDir();
459 lyxvc.setBuffer(owner_);
461 wa_ = new frontend::WorkAreaManager;
464 temppath = cloned_buffer_->d->temppath;
465 file_fully_loaded = true;
466 params = cloned_buffer_->d->params;
467 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
468 bibinfo_ = cloned_buffer_->d->bibinfo_;
469 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
470 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
471 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
472 unnamed = cloned_buffer_->d->unnamed;
473 internal_buffer = cloned_buffer_->d->internal_buffer;
474 layout_position = cloned_buffer_->d->layout_position;
475 preview_file_ = cloned_buffer_->d->preview_file_;
476 preview_format_ = cloned_buffer_->d->preview_format_;
477 preview_error_ = cloned_buffer_->d->preview_error_;
478 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
482 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
483 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
485 LYXERR(Debug::INFO, "Buffer::Buffer()");
487 d->inset = new InsetText(*cloned_buffer->d->inset);
488 d->inset->setBuffer(*this);
489 // FIXME: optimize this loop somewhat, maybe by creating a new
490 // general recursive Inset::setId().
491 DocIterator it = doc_iterator_begin(this);
492 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
493 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
494 it.paragraph().setId(cloned_it.paragraph().id());
496 d->inset = new InsetText(this);
497 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
503 LYXERR(Debug::INFO, "Buffer::~Buffer()");
504 // here the buffer should take care that it is
505 // saved properly, before it goes into the void.
507 // GuiView already destroyed
511 // No need to do additional cleanups for internal buffer.
517 // this is in case of recursive includes: we won't try to delete
518 // ourselves as a child.
519 d->clone_list_->erase(this);
520 // loop over children
521 for (auto const & p : d->children_positions) {
522 Buffer * child = const_cast<Buffer *>(p.first);
523 if (d->clone_list_->erase(child))
526 // if we're the master buffer, then we should get rid of the list
529 // If this is not empty, we have leaked something. Worse, one of the
530 // children still has a reference to this list. But we will try to
531 // continue, rather than shut down.
532 LATTEST(d->clone_list_->empty());
533 list<CloneList *>::iterator it =
534 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
535 if (it == cloned_buffers.end()) {
536 // We will leak in this case, but it is safe to continue.
539 cloned_buffers.erase(it);
540 delete d->clone_list_;
542 // FIXME Do we really need to do this right before we delete d?
543 // clear references to children in macro tables
544 d->children_positions.clear();
545 d->position_to_children.clear();
547 // loop over children
548 for (auto const & p : d->children_positions) {
549 Buffer * child = const_cast<Buffer *>(p.first);
550 if (theBufferList().isLoaded(child)) {
551 if (theBufferList().isOthersChild(this, child))
554 theBufferList().release(child);
559 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
561 msg += emergencyWrite();
563 msg += " " + _("Save failed! Document is lost.");
565 Alert::warning(_("Attempting to close changed document!"), msg);
568 // FIXME Do we really need to do this right before we delete d?
569 // clear references to children in macro tables
570 d->children_positions.clear();
571 d->position_to_children.clear();
573 if (!d->temppath.destroyDirectory()) {
574 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
575 from_utf8(d->temppath.absFileName())));
584 Buffer * Buffer::cloneWithChildren() const
587 cloned_buffers.push_back(new CloneList);
588 CloneList * clones = cloned_buffers.back();
590 cloneWithChildren(bufmap, clones);
592 // make sure we got cloned
593 BufferMap::const_iterator bit = bufmap.find(this);
594 LASSERT(bit != bufmap.end(), return 0);
595 Buffer * cloned_buffer = bit->second;
597 return cloned_buffer;
601 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
603 // have we already been cloned?
604 if (bufmap.find(this) != bufmap.end())
607 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
609 // The clone needs its own DocumentClass, since running updateBuffer() will
610 // modify it, and we would otherwise be sharing it with the original Buffer.
611 buffer_clone->params().makeDocumentClass(true);
613 cap::switchBetweenClasses(
614 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
615 static_cast<InsetText &>(buffer_clone->inset()), el);
617 bufmap[this] = buffer_clone;
618 clones->insert(buffer_clone);
619 buffer_clone->d->clone_list_ = clones;
620 buffer_clone->d->macro_lock = true;
621 buffer_clone->d->children_positions.clear();
623 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
624 // math macro caches need to be rethought and simplified.
625 // I am not sure wether we should handle Buffer cloning here or in BufferList.
626 // Right now BufferList knows nothing about buffer clones.
627 for (auto const & p : d->position_to_children) {
628 DocIterator dit = p.first.clone(buffer_clone);
629 dit.setBuffer(buffer_clone);
630 Buffer * child = const_cast<Buffer *>(p.second.buffer);
632 child->cloneWithChildren(bufmap, clones);
633 BufferMap::iterator const bit = bufmap.find(child);
634 LASSERT(bit != bufmap.end(), continue);
635 Buffer * child_clone = bit->second;
637 Inset * inset = dit.nextInset();
638 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
639 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
640 inset_inc->setChildBuffer(child_clone);
641 child_clone->d->setParent(buffer_clone);
642 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
643 buffer_clone->setChild(dit, child_clone);
645 buffer_clone->d->macro_lock = false;
650 Buffer * Buffer::cloneBufferOnly() const {
651 cloned_buffers.push_back(new CloneList);
652 CloneList * clones = cloned_buffers.back();
653 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
655 // The clone needs its own DocumentClass, since running updateBuffer() will
656 // modify it, and we would otherwise be sharing it with the original Buffer.
657 buffer_clone->params().makeDocumentClass(true);
659 cap::switchBetweenClasses(
660 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
661 static_cast<InsetText &>(buffer_clone->inset()), el);
663 clones->insert(buffer_clone);
664 buffer_clone->d->clone_list_ = clones;
666 // we won't be cloning the children
667 buffer_clone->d->children_positions.clear();
672 bool Buffer::isClone() const
674 return d->cloned_buffer_;
678 void Buffer::changed(bool update_metrics) const
681 d->wa_->redrawAll(update_metrics);
685 frontend::WorkAreaManager & Buffer::workAreaManager() const
692 Text & Buffer::text() const
694 return d->inset->text();
698 Inset & Buffer::inset() const
704 BufferParams & Buffer::params()
710 BufferParams const & Buffer::params() const
716 BufferParams const & Buffer::masterParams() const
718 if (masterBuffer() == this)
721 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
722 // Copy child authors to the params. We need those pointers.
723 for (Author const & a : params().authors())
724 mparams.authors().record(a);
729 double Buffer::fontScalingFactor() const
731 return isExporting() ? 75.0 * params().html_math_img_scale
732 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
736 ParagraphList & Buffer::paragraphs()
738 return text().paragraphs();
742 ParagraphList const & Buffer::paragraphs() const
744 return text().paragraphs();
748 LyXVC & Buffer::lyxvc()
754 LyXVC const & Buffer::lyxvc() const
760 string const Buffer::temppath() const
762 return d->temppath.absFileName();
766 TexRow & Buffer::texrow()
772 TexRow const & Buffer::texrow() const
778 TocBackend & Buffer::tocBackend() const
780 return d->toc_backend;
784 Undo & Buffer::undo()
790 void Buffer::setChild(DocIterator const & dit, Buffer * child)
792 d->children_positions[child] = dit;
796 string Buffer::latexName(bool const no_path) const
798 FileName latex_name =
799 makeLatexName(d->exportFileName());
800 return no_path ? latex_name.onlyFileName()
801 : latex_name.absFileName();
805 FileName Buffer::Impl::exportFileName() const
807 docstring const branch_suffix =
808 params.branchlist().getFileNameSuffix();
809 if (branch_suffix.empty())
812 string const name = filename.onlyFileNameWithoutExt()
813 + to_utf8(branch_suffix);
814 FileName res(filename.onlyPath().absFileName() + "/" + name);
815 res.changeExtension(filename.extension());
821 string Buffer::logName(LogType * type) const
823 string const filename = latexName(false);
825 if (filename.empty()) {
831 string const path = temppath();
833 FileName const fname(addName(temppath(),
834 onlyFileName(changeExtension(filename,
837 // FIXME: how do we know this is the name of the build log?
838 FileName const bname(
839 addName(path, onlyFileName(
840 changeExtension(filename,
841 theFormats().extension(params().bufferFormat()) + ".out"))));
843 // Also consider the master buffer log file
844 FileName masterfname = fname;
845 LogType mtype = latexlog;
846 if (masterBuffer() != this) {
847 string const mlogfile = masterBuffer()->logName(&mtype);
848 masterfname = FileName(mlogfile);
851 // If no Latex log or Build log is newer, show Build log
852 if (bname.exists() &&
853 ((!fname.exists() && !masterfname.exists())
854 || (fname.lastModified() < bname.lastModified()
855 && masterfname.lastModified() < bname.lastModified()))) {
856 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
859 return bname.absFileName();
860 // If we have a newer master file log or only a master log, show this
861 } else if (fname != masterfname
862 && (!fname.exists() && (masterfname.exists()
863 || fname.lastModified() < masterfname.lastModified()))) {
864 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
867 return masterfname.absFileName();
869 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
872 return fname.absFileName();
876 void Buffer::setReadonly(bool const flag)
878 if (d->read_only != flag) {
885 void Buffer::setFileName(FileName const & fname)
887 bool const changed = fname != d->filename;
889 d->refreshFileMonitor();
891 lyxvc().file_found_hook(fname);
892 setReadonly(d->filename.isReadOnly());
898 int Buffer::readHeader(Lexer & lex)
900 int unknown_tokens = 0;
902 int begin_header_line = -1;
904 // Initialize parameters that may be/go lacking in header:
905 params().branchlist().clear();
906 params().preamble.erase();
907 params().options.erase();
908 params().master.erase();
909 params().float_placement.erase();
910 params().float_alignment.erase();
911 params().paperwidth.erase();
912 params().paperheight.erase();
913 params().leftmargin.erase();
914 params().rightmargin.erase();
915 params().topmargin.erase();
916 params().bottommargin.erase();
917 params().headheight.erase();
918 params().headsep.erase();
919 params().footskip.erase();
920 params().columnsep.erase();
921 params().fonts_cjk.erase();
922 params().listings_params.clear();
923 params().clearLayoutModules();
924 params().clearRemovedModules();
925 params().clearIncludedChildren();
926 params().pdfoptions().clear();
927 params().indiceslist().clear();
928 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
929 params().isbackgroundcolor = false;
930 params().fontcolor = RGBColor(0, 0, 0);
931 params().isfontcolor = false;
932 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
933 params().boxbgcolor = RGBColor(0xFF, 0, 0);
934 params().html_latex_start.clear();
935 params().html_latex_end.clear();
936 params().html_math_img_scale = 1.0;
937 params().output_sync_macro.erase();
938 params().setLocalLayout(docstring(), false);
939 params().setLocalLayout(docstring(), true);
940 params().biblio_opts.erase();
941 params().biblatex_bibstyle.erase();
942 params().biblatex_citestyle.erase();
943 params().multibib.erase();
945 for (int i = 0; i < 4; ++i) {
946 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
947 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
950 ErrorList & errorList = d->errorLists["Parse"];
959 if (token == "\\end_header")
963 if (token == "\\begin_header") {
964 begin_header_line = line;
968 LYXERR(Debug::PARSER, "Handling document header token: `"
971 string const result =
972 params().readToken(lex, token, d->filename.onlyPath());
973 if (!result.empty()) {
974 if (token == "\\textclass") {
975 d->layout_position = result;
978 docstring const s = bformat(_("Unknown token: "
982 errorList.push_back(ErrorItem(_("Document header error"), s));
986 if (begin_header_line) {
987 docstring const s = _("\\begin_header is missing");
988 errorList.push_back(ErrorItem(_("Document header error"), s));
991 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
993 params().makeDocumentClass();
995 return unknown_tokens;
1000 // changed to be public and have one parameter
1001 // Returns true if "\end_document" is not read (Asger)
1002 bool Buffer::readDocument(Lexer & lex)
1004 ErrorList & errorList = d->errorLists["Parse"];
1007 // remove dummy empty par
1008 paragraphs().clear();
1010 if (!lex.checkFor("\\begin_document")) {
1011 docstring const s = _("\\begin_document is missing");
1012 errorList.push_back(ErrorItem(_("Document header error"), s));
1017 if (params().output_changes) {
1018 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1019 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1020 LaTeXFeatures::isAvailable("xcolor");
1022 if (!dvipost && !xcolorulem) {
1023 Alert::warning(_("Changes not shown in LaTeX output"),
1024 _("Changes will not be highlighted in LaTeX output, "
1025 "because neither dvipost nor xcolor/ulem are installed.\n"
1026 "Please install these packages or redefine "
1027 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1028 } else if (!xcolorulem) {
1029 Alert::warning(_("Changes not shown in LaTeX output"),
1030 _("Changes will not be highlighted in LaTeX output "
1031 "when using pdflatex, because xcolor and ulem are not installed.\n"
1032 "Please install both packages or redefine "
1033 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1037 if (!parent() && !params().master.empty()) {
1038 FileName const master_file = makeAbsPath(params().master,
1039 onlyPath(absFileName()));
1040 if (isLyXFileName(master_file.absFileName())) {
1042 checkAndLoadLyXFile(master_file, true);
1044 // necessary e.g. after a reload
1045 // to re-register the child (bug 5873)
1046 // FIXME: clean up updateMacros (here, only
1047 // child registering is needed).
1048 master->updateMacros();
1049 // set master as master buffer, but only
1050 // if we are a real child
1051 if (master->isChild(this))
1053 // if the master is not fully loaded
1054 // it is probably just loading this
1055 // child. No warning needed then.
1056 else if (master->isFullyLoaded())
1057 LYXERR0("The master '"
1059 << "' assigned to this document ("
1061 << ") does not include "
1062 "this document. Ignoring the master assignment.");
1063 // If the master has just been created, un-hide it (#11162)
1064 if (!master->fileName().exists())
1065 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1066 master->absFileName()));
1071 // assure we have a default index
1072 params().indiceslist().addDefault(B_("Index"));
1075 if (FileName::isAbsolute(params().origin))
1076 d->old_position = params().origin;
1078 d->old_position = filePath();
1079 bool const res = text().read(lex, errorList, d->inset);
1080 d->old_position.clear();
1082 // inform parent buffer about local macros
1084 Buffer const * pbuf = parent();
1085 for (auto const & m : usermacros)
1086 pbuf->usermacros.insert(m);
1090 updateMacroInstances(InternalUpdate);
1095 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1097 Format const * fmt = theFormats().getFormat(format);
1100 // It is important to use the correct extension here, since some
1101 // converters create a wrong output file otherwise (e.g. html2latex)
1102 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1103 ofdocstream os(name.toFilesystemEncoding().c_str());
1104 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1105 bool const success = !(os << contents).fail();
1108 bool converted = false;
1110 params().compressed = false;
1112 // remove dummy empty par
1113 paragraphs().clear();
1115 converted = importFile(format, name, errorList);
1118 removeTempFile(name);
1123 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1125 if (!theConverters().isReachable(format, "lyx"))
1128 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1129 Converters::RetVal const retval =
1130 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1131 if (retval == Converters::SUCCESS) {
1132 bool const success = readFile(lyx) == ReadSuccess;
1133 removeTempFile(lyx);
1141 bool Buffer::readString(string const & s)
1143 params().compressed = false;
1146 istringstream is(s);
1148 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1149 FileName const fn = tempfile.name();
1152 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1154 if (success && file_format != LYX_FORMAT) {
1155 // We need to call lyx2lyx, so write the input to a file
1156 ofstream os(fn.toFilesystemEncoding().c_str());
1159 // lyxvc in readFile
1160 if (readFile(fn) != ReadSuccess)
1164 if (readDocument(lex))
1170 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1174 if (!lex.setFile(fname)) {
1175 Alert::error(_("File Not Found"),
1176 bformat(_("Unable to open file `%1$s'."),
1177 from_utf8(fn.absFileName())));
1178 return ReadFileNotFound;
1182 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1183 if (ret_plf != ReadSuccess)
1186 if (file_format != LYX_FORMAT) {
1188 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1189 if (ret_clf != ReadSuccess)
1191 ret_clf = readFile(tmpFile);
1192 if (ret_clf == ReadSuccess) {
1193 d->file_format = file_format;
1194 d->need_format_backup = true;
1199 // FIXME: InsetInfo needs to know whether the file is under VCS
1200 // during the parse process, so this has to be done before.
1201 lyxvc().file_found_hook(d->filename);
1203 if (readDocument(lex)) {
1204 Alert::error(_("Document format failure"),
1205 bformat(_("%1$s ended unexpectedly, which means"
1206 " that it is probably corrupted."),
1207 from_utf8(fn.absFileName())));
1208 return ReadDocumentFailure;
1211 d->file_fully_loaded = true;
1212 d->read_only = !d->filename.isWritable();
1213 params().compressed = theFormats().isZippedFile(d->filename);
1219 bool Buffer::isFullyLoaded() const
1221 return d->file_fully_loaded;
1225 void Buffer::setFullyLoaded(bool value)
1227 d->file_fully_loaded = value;
1231 bool Buffer::lastPreviewError() const
1233 return d->preview_error_;
1237 PreviewLoader * Buffer::loader() const
1239 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1241 if (!d->preview_loader_)
1242 d->preview_loader_ = new PreviewLoader(*this);
1243 return d->preview_loader_;
1247 void Buffer::removePreviews() const
1249 delete d->preview_loader_;
1250 d->preview_loader_ = 0;
1254 void Buffer::updatePreviews() const
1256 PreviewLoader * ploader = loader();
1260 InsetIterator it = inset_iterator_begin(*d->inset);
1261 InsetIterator const end = inset_iterator_end(*d->inset);
1262 for (; it != end; ++it)
1263 it->addPreview(it, *ploader);
1265 ploader->startLoading();
1269 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1270 FileName const & fn, int & file_format) const
1272 if(!lex.checkFor("\\lyxformat")) {
1273 Alert::error(_("Document format failure"),
1274 bformat(_("%1$s is not a readable LyX document."),
1275 from_utf8(fn.absFileName())));
1276 return ReadNoLyXFormat;
1282 // LyX formats 217 and earlier were written as 2.17. This corresponds
1283 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1284 // these cases. See also: www.lyx.org/trac/changeset/1313.
1285 size_t dot = tmp_format.find_first_of(".,");
1286 if (dot != string::npos)
1287 tmp_format.erase(dot, 1);
1289 file_format = convert<int>(tmp_format);
1294 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1295 FileName & tmpfile, int from_format)
1297 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1298 tempfile.setAutoRemove(false);
1299 tmpfile = tempfile.name();
1300 if(tmpfile.empty()) {
1301 Alert::error(_("Conversion failed"),
1302 bformat(_("%1$s is from a different"
1303 " version of LyX, but a temporary"
1304 " file for converting it could"
1305 " not be created."),
1306 from_utf8(fn.absFileName())));
1307 return LyX2LyXNoTempFile;
1310 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1311 if (lyx2lyx.empty()) {
1312 Alert::error(_("Conversion script not found"),
1313 bformat(_("%1$s is from a different"
1314 " version of LyX, but the"
1315 " conversion script lyx2lyx"
1316 " could not be found."),
1317 from_utf8(fn.absFileName())));
1318 return LyX2LyXNotFound;
1322 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1323 ostringstream command;
1324 command << os::python()
1325 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1326 << " -t " << convert<string>(LYX_FORMAT)
1327 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1328 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1329 string const command_str = command.str();
1331 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1333 cmd_ret const ret = runCommand(command_str);
1334 if (ret.first != 0) {
1335 if (from_format < LYX_FORMAT) {
1336 Alert::error(_("Conversion script failed"),
1337 bformat(_("%1$s is from an older version"
1338 " of LyX and the lyx2lyx script"
1339 " failed to convert it."),
1340 from_utf8(fn.absFileName())));
1341 return LyX2LyXOlderFormat;
1343 Alert::error(_("Conversion script failed"),
1344 bformat(_("%1$s is from a newer version"
1345 " of LyX and the lyx2lyx script"
1346 " failed to convert it."),
1347 from_utf8(fn.absFileName())));
1348 return LyX2LyXNewerFormat;
1355 FileName Buffer::getBackupName() const {
1356 map<int, string> const file_formats = {
1373 FileName const & fn = fileName();
1374 string const fname = fn.onlyFileNameWithoutExt();
1375 string const fext = fn.extension() + "~";
1376 string const fpath = lyxrc.backupdir_path.empty() ?
1377 fn.onlyPath().absFileName() :
1378 lyxrc.backupdir_path;
1379 string backup_suffix;
1380 // If file format is from a stable series use version instead of file format
1381 auto const it = file_formats.find(d->file_format);
1382 if (it != file_formats.end())
1383 backup_suffix = "-lyx" + it->second;
1385 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1386 string const backname = fname + backup_suffix;
1387 FileName backup(addName(fpath, addExtension(backname, fext)));
1389 // limit recursion, just in case
1391 unsigned long orig_checksum = 0;
1392 while (backup.exists() && v < 100) {
1393 if (orig_checksum == 0)
1394 orig_checksum = fn.checksum();
1395 unsigned long new_checksum = backup.checksum();
1396 if (orig_checksum == new_checksum) {
1397 LYXERR(Debug::FILES, "Not backing up " << fn <<
1398 "since " << backup << "has the same checksum.");
1399 // a bit of a hack, but we have to check this anyway
1400 // below, and setting this is simpler than introducing
1401 // a special boolean for this purpose.
1405 string const newbackname = backname + "-" + convert<string>(v);
1406 backup.set(addName(fpath, addExtension(newbackname, fext)));
1409 return v < 100 ? backup : FileName();
1413 // Should probably be moved to somewhere else: BufferView? GuiView?
1414 bool Buffer::save() const
1416 docstring const file = makeDisplayPath(absFileName(), 20);
1417 d->filename.refresh();
1419 // check the read-only status before moving the file as a backup
1420 if (d->filename.exists()) {
1421 bool const read_only = !d->filename.isWritable();
1423 Alert::warning(_("File is read-only"),
1424 bformat(_("The file %1$s cannot be written because it "
1425 "is marked as read-only."), file));
1430 // ask if the disk file has been externally modified (use checksum method)
1431 if (fileName().exists() && isChecksumModified()) {
1433 bformat(_("Document %1$s has been externally modified. "
1434 "Are you sure you want to overwrite this file?"), file);
1435 int const ret = Alert::prompt(_("Overwrite modified file?"),
1436 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1441 // We don't need autosaves in the immediate future. (Asger)
1442 resetAutosaveTimers();
1444 // if the file does not yet exist, none of the backup activity
1445 // that follows is necessary
1446 if (!fileName().exists()) {
1447 if (!writeFile(fileName()))
1453 // we first write the file to a new name, then move it to its
1454 // proper location once that has been done successfully. that
1455 // way we preserve the original file if something goes wrong.
1456 string const justname = fileName().onlyFileNameWithoutExt();
1457 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1458 justname + "-XXXXXX.lyx");
1459 bool const symlink = fileName().isSymLink();
1461 tempfile->setAutoRemove(false);
1463 FileName savefile(tempfile->name());
1464 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1465 if (!savefile.clonePermissions(fileName()))
1466 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1468 if (!writeFile(savefile))
1471 // we will set this to false if we fail
1472 bool made_backup = true;
1474 FileName backupName;
1475 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1477 if (d->need_format_backup)
1478 backupName = getBackupName();
1480 // If we for some reason failed to find a backup name in case of
1481 // a format change, this will still set one. It's the best we can
1483 if (backupName.empty()) {
1484 backupName.set(fileName().absFileName() + "~");
1485 if (!lyxrc.backupdir_path.empty()) {
1486 string const mangledName =
1487 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1488 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1492 LYXERR(Debug::FILES, "Backing up original file to " <<
1493 backupName.absFileName());
1494 // Except file is symlink do not copy because of #6587.
1495 // Hard links have bad luck.
1496 made_backup = symlink ?
1497 fileName().copyTo(backupName):
1498 fileName().moveTo(backupName);
1501 Alert::error(_("Backup failure"),
1502 bformat(_("Cannot create backup file %1$s.\n"
1503 "Please check whether the directory exists and is writable."),
1504 from_utf8(backupName.absFileName())));
1505 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1506 } else if (d->need_format_backup) {
1507 // the original file has been backed up successfully, so we
1508 // will not need to do that again
1509 d->need_format_backup = false;
1513 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1514 // Only do this if tempfile is not in autoremove mode
1517 // If we have no symlink, we can simply rename the temp file.
1518 // Otherwise, we need to copy it so the symlink stays intact.
1519 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1520 savefile.moveTo(fileName()))
1522 // saveCheckSum() was already called by writeFile(), but the
1523 // time stamp is invalidated by copying/moving
1526 if (d->file_format != LYX_FORMAT)
1527 // the file associated with this buffer is now in the current format
1528 d->file_format = LYX_FORMAT;
1531 // else we saved the file, but failed to move it to the right location.
1533 if (needBackup && made_backup && !symlink) {
1534 // the original file was moved to some new location, so it will look
1535 // to the user as if it was deleted. (see bug #9234.) we could try
1536 // to restore it, but that would basically mean trying to do again
1537 // what we just failed to do. better to leave things as they are.
1538 Alert::error(_("Write failure"),
1539 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1540 "But LyX could not move it to:\n %2$s.\n"
1541 "Your original file has been backed up to:\n %3$s"),
1542 from_utf8(savefile.absFileName()),
1543 from_utf8(fileName().absFileName()),
1544 from_utf8(backupName.absFileName())));
1546 // either we did not try to make a backup, or else we tried and failed,
1547 // or else the original file was a symlink, in which case it was copied,
1548 // not moved. so the original file is intact.
1549 Alert::error(_("Write failure"),
1550 bformat(_("Cannot move saved file to:\n %1$s.\n"
1551 "But the file has successfully been saved as:\n %2$s."),
1552 from_utf8(fileName().absFileName()),
1553 from_utf8(savefile.absFileName())));
1559 bool Buffer::writeFile(FileName const & fname) const
1561 if (d->read_only && fname == d->filename)
1564 bool retval = false;
1566 docstring const str = bformat(_("Saving document %1$s..."),
1567 makeDisplayPath(fname.absFileName()));
1570 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1572 if (params().compressed) {
1573 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1574 retval = ofs && write(ofs);
1576 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1577 retval = ofs && write(ofs);
1581 message(str + _(" could not write file!"));
1586 // removeAutosaveFile();
1589 message(str + _(" done."));
1595 docstring Buffer::emergencyWrite()
1597 // No need to save if the buffer has not changed.
1601 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1603 docstring user_message = bformat(
1604 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1606 // We try to save three places:
1607 // 1) Same place as document. Unless it is an unnamed doc.
1609 string s = absFileName();
1612 if (writeFile(FileName(s))) {
1614 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1615 return user_message;
1617 user_message += " " + _("Save failed! Trying again...\n");
1621 // 2) In HOME directory.
1622 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1624 lyxerr << ' ' << s << endl;
1625 if (writeFile(FileName(s))) {
1627 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1628 return user_message;
1631 user_message += " " + _("Save failed! Trying yet again...\n");
1633 // 3) In "/tmp" directory.
1634 // MakeAbsPath to prepend the current
1635 // drive letter on OS/2
1636 s = addName(package().temp_dir().absFileName(), absFileName());
1638 lyxerr << ' ' << s << endl;
1639 if (writeFile(FileName(s))) {
1641 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1642 return user_message;
1645 user_message += " " + _("Save failed! Document is lost.");
1648 return user_message;
1652 bool Buffer::write(ostream & ofs) const
1655 // Use the standard "C" locale for file output.
1656 ofs.imbue(locale::classic());
1659 // The top of the file should not be written by params().
1661 // write out a comment in the top of the file
1662 // Important: Keep the version formatting in sync with lyx2lyx and
1663 // tex2lyx (bug 7951)
1664 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1665 << " created this file. For more info see https://www.lyx.org/\n"
1666 << "\\lyxformat " << LYX_FORMAT << "\n"
1667 << "\\begin_document\n";
1669 /// For each author, set 'used' to true if there is a change
1670 /// by this author in the document; otherwise set it to 'false'.
1671 for (Author const & a : params().authors())
1674 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1675 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1676 for ( ; it != end; ++it)
1677 it->checkAuthors(params().authors());
1679 // now write out the buffer parameters.
1680 ofs << "\\begin_header\n";
1681 params().writeFile(ofs, this);
1682 ofs << "\\end_header\n";
1685 ofs << "\n\\begin_body\n";
1687 ofs << "\n\\end_body\n";
1689 // Write marker that shows file is complete
1690 ofs << "\\end_document" << endl;
1692 // Shouldn't really be needed....
1695 // how to check if close went ok?
1696 // Following is an attempt... (BE 20001011)
1698 // good() returns false if any error occurred, including some
1699 // formatting error.
1700 // bad() returns true if something bad happened in the buffer,
1701 // which should include file system full errors.
1706 lyxerr << "File was not closed properly." << endl;
1713 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1714 string const & original_path,
1715 OutputParams const & runparams_in,
1716 OutputWhat output) const
1718 OutputParams runparams = runparams_in;
1720 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1721 // Check here, because the "flavor" is not known in BufferParams::encoding()
1722 // (power users can override this safety measure selecting "utf8-plain").
1723 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1724 && (runparams.encoding->name() != "utf8-plain"))
1725 runparams.encoding = encodings.fromLyXName("ascii");
1727 string const encoding = runparams.encoding->iconvName();
1728 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1731 try { ofs.reset(encoding); }
1732 catch (iconv_codecvt_facet_exception const & e) {
1733 lyxerr << "Caught iconv exception: " << e.what() << endl;
1734 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1735 "verify that the support software for your encoding (%1$s) is "
1736 "properly installed"), from_ascii(encoding)));
1739 if (!openFileWrite(ofs, fname))
1742 ErrorList & errorList = d->errorLists["Export"];
1744 ExportStatus status = ExportSuccess;
1747 // make sure we are ready to export
1748 // this needs to be done before we validate
1749 // FIXME Do we need to do this all the time? I.e., in children
1750 // of a master we are exporting?
1752 updateMacroInstances(OutputUpdate);
1754 ExportStatus retval;
1756 retval = writeLaTeXSource(os, original_path, runparams, output);
1757 if (retval == ExportKilled)
1758 return ExportKilled;
1760 catch (EncodingException const & e) {
1761 docstring const failed(1, e.failed_char);
1763 oss << "0x" << hex << e.failed_char << dec;
1764 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1765 docstring msg = bformat(_("Uncodable character '%1$s'"
1766 " (code point %2$s)"),
1767 failed, from_utf8(oss.str()));
1768 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1769 "representable in specific verbatim contexts.\n"
1770 "Changing the document encoding to utf8 could help."),
1771 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1773 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1774 " (code point %2$s)"),
1775 failed, from_utf8(oss.str()));
1776 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1777 "representable in the chosen encoding.\n"
1778 "Changing the document encoding to utf8 could help."),
1779 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1781 status = ExportError;
1783 catch (iconv_codecvt_facet_exception const & e) {
1784 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1786 status = ExportError;
1788 catch (exception const & e) {
1789 errorList.push_back(ErrorItem(_("conversion failed"),
1791 lyxerr << e.what() << endl;
1792 status = ExportError;
1795 lyxerr << "Caught some really weird exception..." << endl;
1799 d->texrow = move(os.texrow());
1803 status = ExportError;
1804 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1807 if (runparams_in.silent)
1815 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1816 string const & original_path,
1817 OutputParams const & runparams_in,
1818 OutputWhat output) const
1820 // The child documents, if any, shall be already loaded at this point.
1822 OutputParams runparams = runparams_in;
1824 // XeTeX with TeX fonts is only safe with ASCII encoding,
1825 // Check here, because the "flavor" is not known in BufferParams::encoding()
1826 // (power users can override this safety measure selecting "utf8-plain").
1827 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1828 && (runparams.encoding->name() != "utf8-plain"))
1829 runparams.encoding = encodings.fromLyXName("ascii");
1830 // FIXME: when only the current paragraph is shown, this is ignored
1831 // (or not reached) and characters encodable in the current
1832 // encoding are not converted to ASCII-representation.
1834 // Some macros rely on font encoding
1835 runparams.main_fontenc = params().main_font_encoding();
1837 // If we are compiling a file standalone, even if this is the
1838 // child of some other buffer, let's cut the link here, so the
1839 // file is really independent and no concurring settings from
1840 // the master (e.g. branch state) interfere (see #8100).
1841 if (!runparams.is_child)
1842 d->ignore_parent = true;
1844 // Classify the unicode characters appearing in math insets
1845 BufferEncodings::initUnicodeMath(*this);
1847 // validate the buffer.
1848 LYXERR(Debug::LATEX, " Validating buffer...");
1849 LaTeXFeatures features(*this, params(), runparams);
1851 // This is only set once per document (in master)
1852 if (!runparams.is_child)
1853 runparams.use_polyglossia = features.usePolyglossia();
1854 LYXERR(Debug::LATEX, " Buffer validation done.");
1856 bool const output_preamble =
1857 output == FullSource || output == OnlyPreamble;
1858 bool const output_body =
1859 output == FullSource || output == OnlyBody;
1861 // The starting paragraph of the coming rows is the
1862 // first paragraph of the document. (Asger)
1863 if (output_preamble && runparams.nice) {
1864 os << "%% LyX " << lyx_version << " created this file. "
1865 "For more info, see https://www.lyx.org/.\n"
1866 "%% Do not edit unless you really know what "
1869 LYXERR(Debug::INFO, "lyx document header finished");
1871 // There are a few differences between nice LaTeX and usual files:
1872 // usual files have \batchmode and special input@path to allow
1873 // inclusion of figures specified by an explicitly relative path
1874 // (i.e., a path starting with './' or '../') with either \input or
1875 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1876 // input@path is set when the actual parameter original_path is set.
1877 // This is done for usual tex-file, but not for nice-latex-file.
1878 // (Matthias 250696)
1879 // Note that input@path is only needed for something the user does
1880 // in the preamble, included .tex files or ERT, files included by
1881 // LyX work without it.
1882 if (output_preamble) {
1883 if (!runparams.nice) {
1884 // code for usual, NOT nice-latex-file
1885 os << "\\batchmode\n"; // changed from \nonstopmode
1887 if (!original_path.empty()) {
1889 // We don't know the encoding of inputpath
1890 docstring const inputpath = from_utf8(original_path);
1891 docstring uncodable_glyphs;
1892 Encoding const * const enc = runparams.encoding;
1894 for (size_t n = 0; n < inputpath.size(); ++n) {
1895 if (!enc->encodable(inputpath[n])) {
1896 docstring const glyph(1, inputpath[n]);
1897 LYXERR0("Uncodable character '"
1899 << "' in input path!");
1900 uncodable_glyphs += glyph;
1905 // warn user if we found uncodable glyphs.
1906 if (!uncodable_glyphs.empty()) {
1907 frontend::Alert::warning(
1908 _("Uncodable character in file path"),
1910 _("The path of your document\n"
1912 "contains glyphs that are unknown "
1913 "in the current document encoding "
1914 "(namely %2$s). This may result in "
1915 "incomplete output, unless "
1916 "TEXINPUTS contains the document "
1917 "directory and you don't use "
1918 "explicitly relative paths (i.e., "
1919 "paths starting with './' or "
1920 "'../') in the preamble or in ERT."
1921 "\n\nIn case of problems, choose "
1922 "an appropriate document encoding\n"
1923 "(such as utf8) or change the "
1925 inputpath, uncodable_glyphs));
1927 string docdir = os::latex_path(original_path);
1928 if (contains(docdir, '#')) {
1929 docdir = subst(docdir, "#", "\\#");
1930 os << "\\catcode`\\#=11"
1931 "\\def\\#{#}\\catcode`\\#=6\n";
1933 if (contains(docdir, '%')) {
1934 docdir = subst(docdir, "%", "\\%");
1935 os << "\\catcode`\\%=11"
1936 "\\def\\%{%}\\catcode`\\%=14\n";
1938 bool const detokenize = !isAscii(from_utf8(docdir));
1939 bool const quote = contains(docdir, ' ');
1940 os << "\\makeatletter\n"
1941 << "\\def\\input@path{{";
1943 os << "\\detokenize{";
1952 << "\\makeatother\n";
1956 // get parent macros (if this buffer has a parent) which will be
1957 // written at the document begin further down.
1958 MacroSet parentMacros;
1959 listParentMacros(parentMacros, features);
1961 // Write the preamble
1962 runparams.use_babel = params().writeLaTeX(os, features,
1963 d->filename.onlyPath());
1965 // Biblatex bibliographies are loaded here
1966 if (params().useBiblatex()) {
1967 vector<docstring> const bibfiles =
1968 prepareBibFilePaths(runparams, getBibfiles(), true);
1969 for (docstring const & file: bibfiles)
1970 os << "\\addbibresource{" << file << "}\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., bibfileCache[bibid]
2481 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2482 string texfile = changeExtension(to_utf8(bibid), "bib");
2483 // note that, if the filename can be found directly from the path,
2484 // findtexfile will just return a FileName object for that path.
2485 FileName file(findtexfile(texfile, "bib"));
2487 file = FileName(makeAbsPath(texfile, filePath()));
2488 LYXERR(Debug::FILES, "Found at: " << file);
2490 bibfileCache[bibid] = file;
2491 return bibfileCache[bibid];
2495 void Buffer::checkIfBibInfoCacheIsValid() const
2497 // use the master's cache
2498 Buffer const * const tmp = masterBuffer();
2500 tmp->checkIfBibInfoCacheIsValid();
2504 // If we already know the cache is invalid, stop here.
2505 // This is important in the case when the bibliography
2506 // environment (rather than Bib[la]TeX) is used.
2507 // In that case, the timestamp check below gives no
2508 // sensible result. Rather than that, the cache will
2509 // be invalidated explicitly via invalidateBibInfoCache()
2510 // by the Bibitem inset.
2511 // Same applies for bib encoding changes, which trigger
2512 // invalidateBibInfoCache() by InsetBibtex.
2513 if (!d->bibinfo_cache_valid_)
2516 // we'll assume it's ok and change this if it's not
2517 d->bibinfo_cache_valid_ = true;
2518 d->cite_labels_valid_ = true;
2520 // compare the cached timestamps with the actual ones.
2521 docstring_list const & bibfiles_cache = getBibfiles();
2522 for (auto const & bf : bibfiles_cache) {
2523 FileName const fn = getBibfilePath(bf);
2524 time_t lastw = fn.lastModified();
2525 time_t prevw = d->bibfile_status_[fn];
2526 if (lastw != prevw) {
2527 d->bibinfo_cache_valid_ = false;
2528 d->cite_labels_valid_ = false;
2529 d->bibfile_status_[fn] = lastw;
2535 void Buffer::clearBibFileCache() const
2537 bibfileCache.clear();
2541 void Buffer::reloadBibInfoCache(bool const force) const
2543 // we should not need to do this for internal buffers
2547 // use the master's cache
2548 Buffer const * const tmp = masterBuffer();
2550 tmp->reloadBibInfoCache(force);
2555 checkIfBibInfoCacheIsValid();
2556 if (d->bibinfo_cache_valid_)
2560 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2561 // re-read file locations when this info changes
2562 // FIXME Is this sufficient? Or should we also force that
2563 // in some other cases? If so, then it is easy enough to
2564 // add the following line in some other places.
2565 clearBibFileCache();
2566 d->bibinfo_.clear();
2567 FileNameList checkedFiles;
2568 collectBibKeys(checkedFiles);
2569 d->bibinfo_cache_valid_ = true;
2573 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2575 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2576 it->collectBibKeys(it, checkedFiles);
2580 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2582 // We add the biblio info to the master buffer,
2583 // if there is one, but also to every single buffer,
2584 // in case a child is compiled alone.
2585 BiblioInfo & bi = d->bibinfo_;
2586 bi.mergeBiblioInfo(bin);
2588 if (parent() != 0) {
2589 BiblioInfo & masterbi = parent()->d->bibinfo_;
2590 masterbi.mergeBiblioInfo(bin);
2595 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2597 // We add the bibtex info to the master buffer,
2598 // if there is one, but also to every single buffer,
2599 // in case a child is compiled alone.
2600 BiblioInfo & bi = d->bibinfo_;
2603 if (parent() != 0) {
2604 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2605 masterbi[key] = bin;
2610 void Buffer::makeCitationLabels() const
2612 Buffer const * const master = masterBuffer();
2613 return d->bibinfo_.makeCitationLabels(*master);
2617 void Buffer::invalidateCiteLabels() const
2619 masterBuffer()->d->cite_labels_valid_ = false;
2622 bool Buffer::citeLabelsValid() const
2624 return masterBuffer()->d->cite_labels_valid_;
2628 void Buffer::removeBiblioTempFiles() const
2630 // We remove files that contain LaTeX commands specific to the
2631 // particular bibliographic style being used, in order to avoid
2632 // LaTeX errors when we switch style.
2633 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2634 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2635 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2636 aux_file.removeFile();
2637 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2638 bbl_file.removeFile();
2639 // Also for the parent buffer
2640 Buffer const * const pbuf = parent();
2642 pbuf->removeBiblioTempFiles();
2646 bool Buffer::isDepClean(string const & name) const
2648 DepClean::const_iterator const it = d->dep_clean.find(name);
2649 if (it == d->dep_clean.end())
2655 void Buffer::markDepClean(string const & name)
2657 d->dep_clean[name] = true;
2661 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2664 // FIXME? if there is an Buffer LFUN that can be dispatched even
2665 // if internal, put a switch '(cmd.action)' here.
2671 switch (cmd.action()) {
2673 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2674 flag.setOnOff(hasReadonlyFlag());
2677 // FIXME: There is need for a command-line import.
2678 //case LFUN_BUFFER_IMPORT:
2680 case LFUN_BUFFER_AUTO_SAVE:
2683 case LFUN_BUFFER_EXPORT_CUSTOM:
2684 // FIXME: Nothing to check here?
2687 case LFUN_BUFFER_EXPORT: {
2688 docstring const arg = cmd.argument();
2689 if (arg == "custom") {
2693 string format = (arg.empty() || arg == "default") ?
2694 params().getDefaultOutputFormat() : to_utf8(arg);
2695 size_t pos = format.find(' ');
2696 if (pos != string::npos)
2697 format = format.substr(0, pos);
2698 enable = params().isExportable(format, false);
2700 flag.message(bformat(
2701 _("Don't know how to export to format: %1$s"), arg));
2705 case LFUN_BUILD_PROGRAM:
2706 enable = params().isExportable("program", false);
2709 case LFUN_BRANCH_ACTIVATE:
2710 case LFUN_BRANCH_DEACTIVATE:
2711 case LFUN_BRANCH_MASTER_ACTIVATE:
2712 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2713 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2714 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2715 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2716 : params().branchlist();
2717 docstring const branchName = cmd.argument();
2718 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2722 case LFUN_BRANCH_ADD:
2723 case LFUN_BRANCHES_RENAME:
2724 // if no Buffer is present, then of course we won't be called!
2727 case LFUN_BUFFER_LANGUAGE:
2728 enable = !isReadonly();
2731 case LFUN_BUFFER_VIEW_CACHE:
2732 (d->preview_file_).refresh();
2733 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2736 case LFUN_CHANGES_TRACK:
2737 flag.setEnabled(true);
2738 flag.setOnOff(params().track_changes);
2741 case LFUN_CHANGES_OUTPUT:
2742 flag.setEnabled(true);
2743 flag.setOnOff(params().output_changes);
2746 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2747 flag.setOnOff(params().compressed);
2750 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2751 flag.setOnOff(params().output_sync);
2754 case LFUN_BUFFER_ANONYMIZE:
2760 flag.setEnabled(enable);
2765 void Buffer::dispatch(string const & command, DispatchResult & result)
2767 return dispatch(lyxaction.lookupFunc(command), result);
2771 // NOTE We can end up here even if we have no GUI, because we are called
2772 // by LyX::exec to handled command-line requests. So we may need to check
2773 // whether we have a GUI or not. The boolean use_gui holds this information.
2774 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2777 // FIXME? if there is an Buffer LFUN that can be dispatched even
2778 // if internal, put a switch '(cmd.action())' here.
2779 dr.dispatched(false);
2782 string const argument = to_utf8(func.argument());
2783 // We'll set this back to false if need be.
2784 bool dispatched = true;
2785 // This handles undo groups automagically
2786 UndoGroupHelper ugh(this);
2788 switch (func.action()) {
2789 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2790 if (lyxvc().inUse()) {
2791 string log = lyxvc().toggleReadOnly();
2796 setReadonly(!hasReadonlyFlag());
2799 case LFUN_BUFFER_EXPORT: {
2800 string const format = (argument.empty() || argument == "default") ?
2801 params().getDefaultOutputFormat() : argument;
2802 ExportStatus const status = doExport(format, false);
2803 dr.setError(status != ExportSuccess);
2804 if (status != ExportSuccess)
2805 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2806 from_utf8(format)));
2810 case LFUN_BUILD_PROGRAM: {
2811 ExportStatus const status = doExport("program", true);
2812 dr.setError(status != ExportSuccess);
2813 if (status != ExportSuccess)
2814 dr.setMessage(_("Error generating literate programming code."));
2818 case LFUN_BUFFER_EXPORT_CUSTOM: {
2820 string command = split(argument, format_name, ' ');
2821 Format const * format = theFormats().getFormat(format_name);
2823 lyxerr << "Format \"" << format_name
2824 << "\" not recognized!"
2829 // The name of the file created by the conversion process
2832 // Output to filename
2833 if (format->name() == "lyx") {
2834 string const latexname = latexName(false);
2835 filename = changeExtension(latexname,
2836 format->extension());
2837 filename = addName(temppath(), filename);
2839 if (!writeFile(FileName(filename)))
2843 doExport(format_name, true, filename);
2846 // Substitute $$FName for filename
2847 if (!contains(command, "$$FName"))
2848 command = "( " + command + " ) < $$FName";
2849 command = subst(command, "$$FName", filename);
2851 // Execute the command in the background
2853 call.startscript(Systemcall::DontWait, command,
2854 filePath(), layoutPos());
2858 // FIXME: There is need for a command-line import.
2860 case LFUN_BUFFER_IMPORT:
2865 case LFUN_BUFFER_AUTO_SAVE:
2867 resetAutosaveTimers();
2870 case LFUN_BRANCH_ACTIVATE:
2871 case LFUN_BRANCH_DEACTIVATE:
2872 case LFUN_BRANCH_MASTER_ACTIVATE:
2873 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2874 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2875 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2876 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2879 docstring const branch_name = func.argument();
2880 // the case without a branch name is handled elsewhere
2881 if (branch_name.empty()) {
2885 Branch * branch = buf->params().branchlist().find(branch_name);
2887 LYXERR0("Branch " << branch_name << " does not exist.");
2889 docstring const msg =
2890 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2894 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2895 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2896 if (branch->isSelected() != activate) {
2897 buf->undo().recordUndoBufferParams(CursorData());
2898 branch->setSelected(activate);
2900 dr.screenUpdate(Update::Force);
2901 dr.forceBufferUpdate();
2906 case LFUN_BRANCH_ADD: {
2907 docstring branchnames = func.argument();
2908 if (branchnames.empty()) {
2912 BranchList & branch_list = params().branchlist();
2913 vector<docstring> const branches =
2914 getVectorFromString(branchnames, branch_list.separator());
2916 for (docstring const & branch_name : branches) {
2917 Branch * branch = branch_list.find(branch_name);
2919 LYXERR0("Branch " << branch_name << " already exists.");
2923 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2925 undo().recordUndoBufferParams(CursorData());
2926 branch_list.add(branch_name);
2927 branch = branch_list.find(branch_name);
2928 string const x11hexname = X11hexname(branch->color());
2929 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2930 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2932 dr.screenUpdate(Update::Force);
2940 case LFUN_BRANCHES_RENAME: {
2941 if (func.argument().empty())
2944 docstring const oldname = from_utf8(func.getArg(0));
2945 docstring const newname = from_utf8(func.getArg(1));
2946 InsetIterator it = inset_iterator_begin(inset());
2947 InsetIterator const end = inset_iterator_end(inset());
2948 bool success = false;
2949 for (; it != end; ++it) {
2950 if (it->lyxCode() == BRANCH_CODE) {
2951 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2952 if (ins.branch() == oldname) {
2953 undo().recordUndo(CursorData(it));
2954 ins.rename(newname);
2959 if (it->lyxCode() == INCLUDE_CODE) {
2960 // get buffer of external file
2961 InsetInclude const & ins =
2962 static_cast<InsetInclude const &>(*it);
2963 Buffer * child = ins.getChildBuffer();
2966 child->dispatch(func, dr);
2971 dr.screenUpdate(Update::Force);
2972 dr.forceBufferUpdate();
2977 case LFUN_BUFFER_VIEW_CACHE:
2978 if (!theFormats().view(*this, d->preview_file_,
2979 d->preview_format_))
2980 dr.setMessage(_("Error viewing the output file."));
2983 case LFUN_CHANGES_TRACK:
2984 if (params().save_transient_properties)
2985 undo().recordUndoBufferParams(CursorData());
2986 params().track_changes = !params().track_changes;
2987 if (!params().track_changes)
2988 dr.forceChangesUpdate();
2991 case LFUN_CHANGES_OUTPUT:
2992 if (params().save_transient_properties)
2993 undo().recordUndoBufferParams(CursorData());
2994 params().output_changes = !params().output_changes;
2995 if (params().output_changes) {
2996 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2997 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2998 LaTeXFeatures::isAvailable("xcolor");
3000 if (!dvipost && !xcolorulem) {
3001 Alert::warning(_("Changes not shown in LaTeX output"),
3002 _("Changes will not be highlighted in LaTeX output, "
3003 "because neither dvipost nor xcolor/ulem are installed.\n"
3004 "Please install these packages or redefine "
3005 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3006 } else if (!xcolorulem) {
3007 Alert::warning(_("Changes not shown in LaTeX output"),
3008 _("Changes will not be highlighted in LaTeX output "
3009 "when using pdflatex, because xcolor and ulem are not installed.\n"
3010 "Please install both packages or redefine "
3011 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3016 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3017 // turn compression on/off
3018 undo().recordUndoBufferParams(CursorData());
3019 params().compressed = !params().compressed;
3022 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3023 undo().recordUndoBufferParams(CursorData());
3024 params().output_sync = !params().output_sync;
3027 case LFUN_BUFFER_ANONYMIZE: {
3028 undo().recordUndoFullBuffer(CursorData());
3029 CursorData cur(doc_iterator_begin(this));
3030 for ( ; cur ; cur.forwardPar())
3031 cur.paragraph().anonymize();
3032 dr.forceBufferUpdate();
3033 dr.screenUpdate(Update::Force);
3041 dr.dispatched(dispatched);
3045 void Buffer::changeLanguage(Language const * from, Language const * to)
3047 LASSERT(from, return);
3048 LASSERT(to, return);
3050 for_each(par_iterator_begin(),
3052 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3056 bool Buffer::isMultiLingual() const
3058 ParConstIterator end = par_iterator_end();
3059 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3060 if (it->isMultiLingual(params()))
3067 std::set<Language const *> Buffer::getLanguages() const
3069 std::set<Language const *> langs;
3070 getLanguages(langs);
3075 void Buffer::getLanguages(std::set<Language const *> & langs) const
3077 ParConstIterator end = par_iterator_end();
3078 // add the buffer language, even if it's not actively used
3079 langs.insert(language());
3080 // iterate over the paragraphs
3081 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3082 it->getLanguages(langs);
3084 ListOfBuffers clist = getDescendents();
3085 for (auto const & cit : clist)
3086 cit->getLanguages(langs);
3090 DocIterator Buffer::getParFromID(int const id) const
3092 Buffer * buf = const_cast<Buffer *>(this);
3094 // This means non-existent
3095 return doc_iterator_end(buf);
3097 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3098 if (it.paragraph().id() == id)
3101 return doc_iterator_end(buf);
3105 bool Buffer::hasParWithID(int const id) const
3107 return !getParFromID(id).atEnd();
3111 ParIterator Buffer::par_iterator_begin()
3113 return ParIterator(doc_iterator_begin(this));
3117 ParIterator Buffer::par_iterator_end()
3119 return ParIterator(doc_iterator_end(this));
3123 ParConstIterator Buffer::par_iterator_begin() const
3125 return ParConstIterator(doc_iterator_begin(this));
3129 ParConstIterator Buffer::par_iterator_end() const
3131 return ParConstIterator(doc_iterator_end(this));
3135 Language const * Buffer::language() const
3137 return params().language;
3141 docstring const Buffer::B_(string const & l10n) const
3143 return params().B_(l10n);
3147 bool Buffer::isClean() const
3149 return d->lyx_clean;
3153 bool Buffer::isChecksumModified() const
3155 LASSERT(d->filename.exists(), return false);
3156 return d->checksum_ != d->filename.checksum();
3160 void Buffer::saveCheckSum() const
3162 FileName const & file = d->filename;
3164 d->checksum_ = file.exists() ? file.checksum()
3165 : 0; // in the case of save to a new file.
3169 void Buffer::markClean() const
3171 if (!d->lyx_clean) {
3172 d->lyx_clean = true;
3175 // if the .lyx file has been saved, we don't need an
3177 d->bak_clean = true;
3178 d->undo_.markDirty();
3179 clearExternalModification();
3183 void Buffer::setUnnamed(bool flag)
3189 bool Buffer::isUnnamed() const
3196 /// Don't check unnamed, here: isInternal() is used in
3197 /// newBuffer(), where the unnamed flag has not been set by anyone
3198 /// yet. Also, for an internal buffer, there should be no need for
3199 /// retrieving fileName() nor for checking if it is unnamed or not.
3200 bool Buffer::isInternal() const
3202 return d->internal_buffer;
3206 void Buffer::setInternal(bool flag)
3208 d->internal_buffer = flag;
3212 void Buffer::markDirty()
3215 d->lyx_clean = false;
3218 d->bak_clean = false;
3220 for (auto & depit : d->dep_clean)
3221 depit.second = false;
3225 FileName Buffer::fileName() const
3231 string Buffer::absFileName() const
3233 return d->filename.absFileName();
3237 string Buffer::filePath() const
3239 string const abs = d->filename.onlyPath().absFileName();
3242 int last = abs.length() - 1;
3244 return abs[last] == '/' ? abs : abs + '/';
3248 DocFileName Buffer::getReferencedFileName(string const & fn) const
3251 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3252 result.set(fn, filePath());
3254 // filePath() ends with a path separator
3255 FileName const test(filePath() + fn);
3257 result.set(fn, filePath());
3259 result.set(fn, params().origin);
3266 string const Buffer::prepareFileNameForLaTeX(string const & name,
3267 string const & ext, bool nice) const
3269 string const fname = makeAbsPath(name, filePath()).absFileName();
3270 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3276 return to_utf8(makeRelPath(from_utf8(fname),
3277 from_utf8(masterBuffer()->filePath())));
3281 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3282 docstring_list const & bibfilelist,
3283 bool const add_extension) const
3285 // If we are processing the LaTeX file in a temp directory then
3286 // copy the .bib databases to this temp directory, mangling their
3287 // names in the process. Store this mangled name in the list of
3289 // (We need to do all this because BibTeX *really*, *really*
3290 // can't handle "files with spaces" and Windows users tend to
3291 // use such filenames.)
3292 // Otherwise, store the (maybe absolute) path to the original,
3293 // unmangled database name.
3295 vector<docstring> res;
3297 // determine the export format
3298 string const tex_format = flavor2format(runparams.flavor);
3300 // check for spaces in paths
3301 bool found_space = false;
3303 for (auto const & bit : bibfilelist) {
3304 string utf8input = to_utf8(bit);
3306 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3307 FileName try_in_file =
3308 makeAbsPath(database + ".bib", filePath());
3309 bool not_from_texmf = try_in_file.isReadableFile();
3310 // If the file has not been found, try with the real file name
3311 // (it might come from a child in a sub-directory)
3312 if (!not_from_texmf) {
3313 try_in_file = getBibfilePath(bit);
3314 if (try_in_file.isReadableFile()) {
3315 // Check if the file is in texmf
3316 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3317 not_from_texmf = kpsefile.empty()
3318 || kpsefile.absFileName() != try_in_file.absFileName();
3320 // If this exists, make path relative to the master
3323 removeExtension(prepareFileNameForLaTeX(
3324 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3325 from_utf8(filePath()))),
3326 ".bib", runparams.nice));
3330 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3332 // mangledFileName() needs the extension
3333 DocFileName const in_file = DocFileName(try_in_file);
3334 database = removeExtension(in_file.mangledFileName());
3335 FileName const out_file = makeAbsPath(database + ".bib",
3336 masterBuffer()->temppath());
3337 bool const success = in_file.copyTo(out_file);
3339 LYXERR0("Failed to copy '" << in_file
3340 << "' to '" << out_file << "'");
3342 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3343 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3344 if (!isValidLaTeXFileName(database)) {
3345 frontend::Alert::warning(_("Invalid filename"),
3346 _("The following filename will cause troubles "
3347 "when running the exported file through LaTeX: ") +
3348 from_utf8(database));
3350 if (!isValidDVIFileName(database)) {
3351 frontend::Alert::warning(_("Problematic filename for DVI"),
3352 _("The following filename can cause troubles "
3353 "when running the exported file through LaTeX "
3354 "and opening the resulting DVI: ") +
3355 from_utf8(database), true);
3363 docstring const path = from_utf8(latex_path(database));
3365 if (contains(path, ' '))
3368 if (find(res.begin(), res.end(), path) == res.end())
3369 res.push_back(path);
3372 // Check if there are spaces in the path and warn BibTeX users, if so.
3373 // (biber can cope with such paths)
3374 if (!prefixIs(runparams.bibtex_command, "biber")) {
3375 // Post this warning only once.
3376 static bool warned_about_spaces = false;
3377 if (!warned_about_spaces &&
3378 runparams.nice && found_space) {
3379 warned_about_spaces = true;
3380 Alert::warning(_("Export Warning!"),
3381 _("There are spaces in the paths to your BibTeX databases.\n"
3382 "BibTeX will be unable to find them."));
3391 string Buffer::layoutPos() const
3393 return d->layout_position;
3397 void Buffer::setLayoutPos(string const & path)
3400 d->layout_position.clear();
3404 LATTEST(FileName::isAbsolute(path));
3406 d->layout_position =
3407 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3409 if (d->layout_position.empty())
3410 d->layout_position = ".";
3414 bool Buffer::hasReadonlyFlag() const
3416 return d->read_only;
3420 bool Buffer::isReadonly() const
3422 return hasReadonlyFlag() || notifiesExternalModification();
3426 void Buffer::setParent(Buffer const * buffer)
3428 // Avoids recursive include.
3429 d->setParent(buffer == this ? 0 : buffer);
3434 Buffer const * Buffer::parent() const
3440 ListOfBuffers Buffer::allRelatives() const
3442 ListOfBuffers lb = masterBuffer()->getDescendents();
3443 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3448 Buffer const * Buffer::masterBuffer() const
3450 // FIXME Should be make sure we are not in some kind
3451 // of recursive include? A -> B -> A will crash this.
3452 Buffer const * const pbuf = d->parent();
3456 return pbuf->masterBuffer();
3460 bool Buffer::isChild(Buffer * child) const
3462 return d->children_positions.find(child) != d->children_positions.end();
3466 DocIterator Buffer::firstChildPosition(Buffer const * child)
3468 Impl::BufferPositionMap::iterator it;
3469 it = d->children_positions.find(child);
3470 if (it == d->children_positions.end())
3471 return DocIterator(this);
3476 bool Buffer::hasChildren() const
3478 return !d->children_positions.empty();
3482 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3484 // loop over children
3485 for (auto const & p : d->children_positions) {
3486 Buffer * child = const_cast<Buffer *>(p.first);
3488 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3489 if (bit != clist.end())
3491 clist.push_back(child);
3493 // there might be grandchildren
3494 child->collectChildren(clist, true);
3499 ListOfBuffers Buffer::getChildren() const
3502 collectChildren(v, false);
3503 // Make sure we have not included ourselves.
3504 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3505 if (bit != v.end()) {
3506 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3513 ListOfBuffers Buffer::getDescendents() const
3516 collectChildren(v, true);
3517 // Make sure we have not included ourselves.
3518 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3519 if (bit != v.end()) {
3520 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3527 template<typename M>
3528 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3533 typename M::const_iterator it = m.lower_bound(x);
3534 if (it == m.begin())
3542 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3543 DocIterator const & pos) const
3545 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3547 // if paragraphs have no macro context set, pos will be empty
3551 // we haven't found anything yet
3552 DocIterator bestPos = owner_->par_iterator_begin();
3553 MacroData const * bestData = 0;
3555 // find macro definitions for name
3556 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3557 if (nameIt != macros.end()) {
3558 // find last definition in front of pos or at pos itself
3559 PositionScopeMacroMap::const_iterator it
3560 = greatest_below(nameIt->second, pos);
3561 if (it != nameIt->second.end()) {
3563 // scope ends behind pos?
3564 if (pos < it->second.scope) {
3565 // Looks good, remember this. If there
3566 // is no external macro behind this,
3567 // we found the right one already.
3568 bestPos = it->first;
3569 bestData = &it->second.macro;
3573 // try previous macro if there is one
3574 if (it == nameIt->second.begin())
3581 // find macros in included files
3582 PositionScopeBufferMap::const_iterator it
3583 = greatest_below(position_to_children, pos);
3584 if (it == position_to_children.end())
3585 // no children before
3589 // do we know something better (i.e. later) already?
3590 if (it->first < bestPos )
3593 // scope ends behind pos?
3594 if (pos < it->second.scope
3595 && (cloned_buffer_ ||
3596 theBufferList().isLoaded(it->second.buffer))) {
3597 // look for macro in external file
3599 MacroData const * data
3600 = it->second.buffer->getMacro(name, false);
3603 bestPos = it->first;
3609 // try previous file if there is one
3610 if (it == position_to_children.begin())
3615 // return the best macro we have found
3620 MacroData const * Buffer::getMacro(docstring const & name,
3621 DocIterator const & pos, bool global) const
3626 // query buffer macros
3627 MacroData const * data = d->getBufferMacro(name, pos);
3631 // If there is a master buffer, query that
3632 Buffer const * const pbuf = d->parent();
3634 d->macro_lock = true;
3635 MacroData const * macro = pbuf->getMacro(
3636 name, *this, false);
3637 d->macro_lock = false;
3643 data = MacroTable::globalMacros().get(name);
3652 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3654 // set scope end behind the last paragraph
3655 DocIterator scope = par_iterator_begin();
3656 scope.pit() = scope.lastpit() + 1;
3658 return getMacro(name, scope, global);
3662 MacroData const * Buffer::getMacro(docstring const & name,
3663 Buffer const & child, bool global) const
3665 // look where the child buffer is included first
3666 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3667 if (it == d->children_positions.end())
3670 // check for macros at the inclusion position
3671 return getMacro(name, it->second, global);
3675 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3677 pit_type const lastpit = it.lastpit();
3679 // look for macros in each paragraph
3680 while (it.pit() <= lastpit) {
3681 Paragraph & par = it.paragraph();
3683 // FIXME Can this be done with the new-style iterators?
3684 // iterate over the insets of the current paragraph
3685 for (auto const & insit : par.insetList()) {
3686 it.pos() = insit.pos;
3688 // is it a nested text inset?
3689 if (insit.inset->asInsetText()) {
3690 // Inset needs its own scope?
3691 InsetText const * itext = insit.inset->asInsetText();
3692 bool newScope = itext->isMacroScope();
3694 // scope which ends just behind the inset
3695 DocIterator insetScope = it;
3698 // collect macros in inset
3699 it.push_back(CursorSlice(*insit.inset));
3700 updateMacros(it, newScope ? insetScope : scope);
3705 if (insit.inset->asInsetTabular()) {
3706 CursorSlice slice(*insit.inset);
3707 size_t const numcells = slice.nargs();
3708 for (; slice.idx() < numcells; slice.forwardIdx()) {
3709 it.push_back(slice);
3710 updateMacros(it, scope);
3716 // is it an external file?
3717 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3718 // get buffer of external file
3719 InsetInclude const & incinset =
3720 static_cast<InsetInclude const &>(*insit.inset);
3722 Buffer * child = incinset.getChildBuffer();
3727 // register its position, but only when it is
3728 // included first in the buffer
3729 if (children_positions.find(child) ==
3730 children_positions.end())
3731 children_positions[child] = it;
3733 // register child with its scope
3734 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3738 InsetMath * im = insit.inset->asInsetMath();
3739 if (doing_export && im) {
3740 InsetMathHull * hull = im->asHullInset();
3742 hull->recordLocation(it);
3745 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3749 InsetMathMacroTemplate & macroTemplate =
3750 *insit.inset->asInsetMath()->asMacroTemplate();
3751 MacroContext mc(owner_, it);
3752 macroTemplate.updateToContext(mc);
3755 bool valid = macroTemplate.validMacro();
3756 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3757 // then the BufferView's cursor will be invalid in
3758 // some cases which leads to crashes.
3763 // FIXME (Abdel), I don't understand why we pass 'it' here
3764 // instead of 'macroTemplate' defined above... is this correct?
3765 macros[macroTemplate.name()][it] =
3766 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3776 void Buffer::updateMacros() const
3781 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3783 // start with empty table
3785 d->children_positions.clear();
3786 d->position_to_children.clear();
3788 // Iterate over buffer, starting with first paragraph
3789 // The scope must be bigger than any lookup DocIterator
3790 // later. For the global lookup, lastpit+1 is used, hence
3791 // we use lastpit+2 here.
3792 DocIterator it = par_iterator_begin();
3793 DocIterator outerScope = it;
3794 outerScope.pit() = outerScope.lastpit() + 2;
3795 d->updateMacros(it, outerScope);
3799 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3801 InsetIterator it = inset_iterator_begin(inset());
3802 InsetIterator const end = inset_iterator_end(inset());
3803 for (; it != end; ++it) {
3804 if (it->lyxCode() == BRANCH_CODE) {
3805 InsetBranch & br = static_cast<InsetBranch &>(*it);
3806 docstring const name = br.branch();
3807 if (!from_master && !params().branchlist().find(name))
3808 result.push_back(name);
3809 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3810 result.push_back(name);
3813 if (it->lyxCode() == INCLUDE_CODE) {
3814 // get buffer of external file
3815 InsetInclude const & ins =
3816 static_cast<InsetInclude const &>(*it);
3817 Buffer * child = ins.getChildBuffer();
3820 child->getUsedBranches(result, true);
3823 // remove duplicates
3828 void Buffer::updateMacroInstances(UpdateType utype) const
3830 LYXERR(Debug::MACROS, "updateMacroInstances for "
3831 << d->filename.onlyFileName());
3832 DocIterator it = doc_iterator_begin(this);
3834 DocIterator const end = doc_iterator_end(this);
3835 for (; it != end; it.forwardInset()) {
3836 // look for MathData cells in InsetMathNest insets
3837 InsetMath * minset = it.nextInset()->asInsetMath();
3841 // update macro in all cells of the InsetMathNest
3842 DocIterator::idx_type n = minset->nargs();
3843 MacroContext mc = MacroContext(this, it);
3844 for (DocIterator::idx_type i = 0; i < n; ++i) {
3845 MathData & data = minset->cell(i);
3846 data.updateMacros(0, mc, utype, 0);
3852 void Buffer::listMacroNames(MacroNameSet & macros) const
3857 d->macro_lock = true;
3859 // loop over macro names
3860 for (auto const & nameit : d->macros)
3861 macros.insert(nameit.first);
3863 // loop over children
3864 for (auto const & p : d->children_positions) {
3865 Buffer * child = const_cast<Buffer *>(p.first);
3866 // The buffer might have been closed (see #10766).
3867 if (theBufferList().isLoaded(child))
3868 child->listMacroNames(macros);
3872 Buffer const * const pbuf = d->parent();
3874 pbuf->listMacroNames(macros);
3876 d->macro_lock = false;
3880 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3882 Buffer const * const pbuf = d->parent();
3887 pbuf->listMacroNames(names);
3890 for (auto const & mit : names) {
3892 MacroData const * data = pbuf->getMacro(mit, *this, false);
3894 macros.insert(data);
3896 // we cannot access the original InsetMathMacroTemplate anymore
3897 // here to calls validate method. So we do its work here manually.
3898 // FIXME: somehow make the template accessible here.
3899 if (data->optionals() > 0)
3900 features.require("xargs");
3906 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3909 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3911 RefCache::iterator it = d->ref_cache_.find(label);
3912 if (it != d->ref_cache_.end())
3915 static References const dummy_refs = References();
3916 it = d->ref_cache_.insert(
3917 make_pair(label, dummy_refs)).first;
3922 Buffer::References const & Buffer::references(docstring const & label) const
3924 return const_cast<Buffer *>(this)->getReferenceCache(label);
3928 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3930 References & refs = getReferenceCache(label);
3931 refs.push_back(make_pair(inset, it));
3935 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3939 linfo.label = label;
3941 linfo.active = active;
3942 masterBuffer()->d->label_cache_.push_back(linfo);
3946 InsetLabel const * Buffer::insetLabel(docstring const & label,
3947 bool const active) const
3949 for (auto & rc : masterBuffer()->d->label_cache_) {
3950 if (rc.label == label && (rc.active || !active))
3957 bool Buffer::activeLabel(docstring const & label) const
3959 if (!insetLabel(label, true))
3966 void Buffer::clearReferenceCache() const
3969 d->ref_cache_.clear();
3970 d->label_cache_.clear();
3975 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3977 //FIXME: This does not work for child documents yet.
3978 reloadBibInfoCache();
3980 // Check if the label 'from' appears more than once
3981 vector<docstring> labels;
3982 for (auto const & bibit : masterBibInfo())
3983 labels.push_back(bibit.first);
3985 if (count(labels.begin(), labels.end(), from) > 1)
3988 string const paramName = "key";
3989 InsetIterator it = inset_iterator_begin(inset());
3991 if (it->lyxCode() != CITE_CODE)
3993 InsetCommand * inset = it->asInsetCommand();
3994 docstring const oldValue = inset->getParam(paramName);
3995 if (oldValue == from)
3996 inset->setParam(paramName, to);
4000 // returns NULL if id-to-row conversion is unsupported
4001 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4002 pit_type par_begin, pit_type par_end,
4003 OutputWhat output, bool master) const
4005 unique_ptr<TexRow> texrow;
4006 OutputParams runparams(¶ms().encoding());
4007 runparams.nice = true;
4008 runparams.flavor = params().getOutputFlavor(format);
4009 runparams.linelen = lyxrc.plaintext_linelen;
4010 // No side effect of file copying and image conversion
4011 runparams.dryrun = true;
4013 // Some macros rely on font encoding
4014 runparams.main_fontenc = params().main_font_encoding();
4016 if (output == CurrentParagraph) {
4017 runparams.par_begin = par_begin;
4018 runparams.par_end = par_end;
4019 if (par_begin + 1 == par_end) {
4021 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4025 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4026 convert<docstring>(par_begin),
4027 convert<docstring>(par_end - 1))
4030 // output paragraphs
4031 if (runparams.flavor == OutputParams::LYX) {
4032 Paragraph const & par = text().paragraphs()[par_begin];
4034 depth_type dt = par.getDepth();
4035 par.write(ods, params(), dt);
4036 os << from_utf8(ods.str());
4037 } else if (runparams.flavor == OutputParams::HTML) {
4039 setMathFlavor(runparams);
4040 xhtmlParagraphs(text(), *this, xs, runparams);
4041 } else if (runparams.flavor == OutputParams::TEXT) {
4043 // FIXME Handles only one paragraph, unlike the others.
4044 // Probably should have some routine with a signature like them.
4045 writePlaintextParagraph(*this,
4046 text().paragraphs()[par_begin], os, runparams, dummy);
4047 } else if (params().isDocBook()) {
4048 docbookParagraphs(text(), *this, os, runparams);
4050 // If we are previewing a paragraph, even if this is the
4051 // child of some other buffer, let's cut the link here,
4052 // so that no concurring settings from the master
4053 // (e.g. branch state) interfere (see #8101).
4055 d->ignore_parent = true;
4056 // We need to validate the Buffer params' features here
4057 // in order to know if we should output polyglossia
4058 // macros (instead of babel macros)
4059 LaTeXFeatures features(*this, params(), runparams);
4061 runparams.use_polyglossia = features.usePolyglossia();
4062 // latex or literate
4065 ots.texrow().newlines(2);
4067 latexParagraphs(*this, text(), ots, runparams);
4068 texrow = ots.releaseTexRow();
4070 // Restore the parenthood
4072 d->ignore_parent = false;
4076 if (output == FullSource)
4077 os << _("Preview source code");
4078 else if (output == OnlyPreamble)
4079 os << _("Preview preamble");
4080 else if (output == OnlyBody)
4081 os << _("Preview body");
4083 if (runparams.flavor == OutputParams::LYX) {
4085 if (output == FullSource)
4087 else if (output == OnlyPreamble)
4088 params().writeFile(ods, this);
4089 else if (output == OnlyBody)
4091 os << from_utf8(ods.str());
4092 } else if (runparams.flavor == OutputParams::HTML) {
4093 writeLyXHTMLSource(os, runparams, output);
4094 } else if (runparams.flavor == OutputParams::TEXT) {
4095 if (output == OnlyPreamble) {
4096 os << "% "<< _("Plain text does not have a preamble.");
4098 writePlaintextFile(*this, os, runparams);
4099 } else if (params().isDocBook()) {
4100 writeDocBookSource(os, absFileName(), runparams, output);
4102 // latex or literate
4105 ots.texrow().newlines(2);
4107 runparams.is_child = true;
4109 writeLaTeXSource(ots, string(), runparams, output);
4110 texrow = ots.releaseTexRow();
4117 ErrorList & Buffer::errorList(string const & type) const
4119 return d->errorLists[type];
4123 void Buffer::updateTocItem(std::string const & type,
4124 DocIterator const & dit) const
4127 d->gui_->updateTocItem(type, dit);
4131 void Buffer::structureChanged() const
4134 d->gui_->structureChanged();
4138 void Buffer::errors(string const & err, bool from_master) const
4141 d->gui_->errors(err, from_master);
4145 void Buffer::message(docstring const & msg) const
4148 d->gui_->message(msg);
4152 void Buffer::setBusy(bool on) const
4155 d->gui_->setBusy(on);
4159 void Buffer::updateTitles() const
4162 d->wa_->updateTitles();
4166 void Buffer::resetAutosaveTimers() const
4169 d->gui_->resetAutosaveTimers();
4173 bool Buffer::hasGuiDelegate() const
4179 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4188 class AutoSaveBuffer : public ForkedProcess {
4191 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4192 : buffer_(buffer), fname_(fname) {}
4194 virtual shared_ptr<ForkedProcess> clone() const
4196 return make_shared<AutoSaveBuffer>(*this);
4201 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4202 from_utf8(fname_.absFileName())));
4203 return run(DontWait);
4207 virtual int generateChild();
4209 Buffer const & buffer_;
4214 int AutoSaveBuffer::generateChild()
4216 #if defined(__APPLE__)
4217 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4218 * We should use something else like threads.
4220 * Since I do not know how to determine at run time what is the OS X
4221 * version, I just disable forking altogether for now (JMarc)
4223 pid_t const pid = -1;
4225 // tmp_ret will be located (usually) in /tmp
4226 // will that be a problem?
4227 // Note that this calls ForkedCalls::fork(), so it's
4228 // ok cross-platform.
4229 pid_t const pid = fork();
4230 // If you want to debug the autosave
4231 // you should set pid to -1, and comment out the fork.
4232 if (pid != 0 && pid != -1)
4236 // pid = -1 signifies that lyx was unable
4237 // to fork. But we will do the save
4239 bool failed = false;
4240 TempFile tempfile("lyxautoXXXXXX.lyx");
4241 tempfile.setAutoRemove(false);
4242 FileName const tmp_ret = tempfile.name();
4243 if (!tmp_ret.empty()) {
4244 if (!buffer_.writeFile(tmp_ret))
4246 else if (!tmp_ret.moveTo(fname_))
4252 // failed to write/rename tmp_ret so try writing direct
4253 if (!buffer_.writeFile(fname_)) {
4254 // It is dangerous to do this in the child,
4255 // but safe in the parent, so...
4256 if (pid == -1) // emit message signal.
4257 buffer_.message(_("Autosave failed!"));
4261 if (pid == 0) // we are the child so...
4270 FileName Buffer::getEmergencyFileName() const
4272 return FileName(d->filename.absFileName() + ".emergency");
4276 FileName Buffer::getAutosaveFileName() const
4278 // if the document is unnamed try to save in the backup dir, else
4279 // in the default document path, and as a last try in the filePath,
4280 // which will most often be the temporary directory
4283 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4284 : lyxrc.backupdir_path;
4285 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4288 string const fname = "#" + d->filename.onlyFileName() + "#";
4290 return makeAbsPath(fname, fpath);
4294 void Buffer::removeAutosaveFile() const
4296 FileName const f = getAutosaveFileName();
4302 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4304 FileName const newauto = getAutosaveFileName();
4306 if (newauto != oldauto && oldauto.exists())
4307 if (!oldauto.moveTo(newauto))
4308 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4312 bool Buffer::autoSave() const
4314 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4315 if (buf->d->bak_clean || hasReadonlyFlag())
4318 message(_("Autosaving current document..."));
4319 buf->d->bak_clean = true;
4321 FileName const fname = getAutosaveFileName();
4322 LASSERT(d->cloned_buffer_, return false);
4324 // If this buffer is cloned, we assume that
4325 // we are running in a separate thread already.
4326 TempFile tempfile("lyxautoXXXXXX.lyx");
4327 tempfile.setAutoRemove(false);
4328 FileName const tmp_ret = tempfile.name();
4329 if (!tmp_ret.empty()) {
4331 // assume successful write of tmp_ret
4332 if (tmp_ret.moveTo(fname))
4335 // failed to write/rename tmp_ret so try writing direct
4336 return writeFile(fname);
4340 void Buffer::setExportStatus(bool e) const
4342 d->doing_export = e;
4343 ListOfBuffers clist = getDescendents();
4344 for (auto const & bit : clist)
4345 bit->d->doing_export = e;
4349 bool Buffer::isExporting() const
4351 return d->doing_export;
4355 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4359 return doExport(target, put_in_tempdir, result_file);
4362 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4363 string & result_file) const
4365 bool const update_unincluded =
4366 params().maintain_unincluded_children
4367 && !params().getIncludedChildren().empty();
4369 // (1) export with all included children (omit \includeonly)
4370 if (update_unincluded) {
4371 ExportStatus const status =
4372 doExport(target, put_in_tempdir, true, result_file);
4373 if (status != ExportSuccess)
4376 // (2) export with included children only
4377 return doExport(target, put_in_tempdir, false, result_file);
4381 void Buffer::setMathFlavor(OutputParams & op) const
4383 switch (params().html_math_output) {
4384 case BufferParams::MathML:
4385 op.math_flavor = OutputParams::MathAsMathML;
4387 case BufferParams::HTML:
4388 op.math_flavor = OutputParams::MathAsHTML;
4390 case BufferParams::Images:
4391 op.math_flavor = OutputParams::MathAsImages;
4393 case BufferParams::LaTeX:
4394 op.math_flavor = OutputParams::MathAsLaTeX;
4400 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4401 bool includeall, string & result_file) const
4403 LYXERR(Debug::FILES, "target=" << target);
4404 OutputParams runparams(¶ms().encoding());
4405 string format = target;
4406 string dest_filename;
4407 size_t pos = target.find(' ');
4408 if (pos != string::npos) {
4409 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4410 format = target.substr(0, pos);
4411 if (format == "default")
4412 format = params().getDefaultOutputFormat();
4413 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4414 FileName(dest_filename).onlyPath().createPath();
4415 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4417 MarkAsExporting exporting(this);
4418 string backend_format;
4419 runparams.flavor = OutputParams::LATEX;
4420 runparams.linelen = lyxrc.plaintext_linelen;
4421 runparams.includeall = includeall;
4422 vector<string> backs = params().backends();
4423 Converters converters = theConverters();
4424 bool need_nice_file = false;
4425 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4426 // Get shortest path to format
4427 converters.buildGraph();
4428 Graph::EdgePath path;
4429 for (string const & sit : backs) {
4430 Graph::EdgePath p = converters.getPath(sit, format);
4431 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4432 backend_format = sit;
4437 if (!put_in_tempdir) {
4438 // Only show this alert if this is an export to a non-temporary
4439 // file (not for previewing).
4440 Alert::error(_("Couldn't export file"), bformat(
4441 _("No information for exporting the format %1$s."),
4442 theFormats().prettyName(format)));
4444 return ExportNoPathToFormat;
4446 runparams.flavor = converters.getFlavor(path, this);
4447 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4448 for (auto const & edge : path)
4449 if (theConverters().get(edge).nice()) {
4450 need_nice_file = true;
4455 backend_format = format;
4456 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4457 // FIXME: Don't hardcode format names here, but use a flag
4458 if (backend_format == "pdflatex")
4459 runparams.flavor = OutputParams::PDFLATEX;
4460 else if (backend_format == "luatex")
4461 runparams.flavor = OutputParams::LUATEX;
4462 else if (backend_format == "dviluatex")
4463 runparams.flavor = OutputParams::DVILUATEX;
4464 else if (backend_format == "xetex")
4465 runparams.flavor = OutputParams::XETEX;
4468 string filename = latexName(false);
4469 filename = addName(temppath(), filename);
4470 filename = changeExtension(filename,
4471 theFormats().extension(backend_format));
4472 LYXERR(Debug::FILES, "filename=" << filename);
4474 // Plain text backend
4475 if (backend_format == "text") {
4476 runparams.flavor = OutputParams::TEXT;
4478 writePlaintextFile(*this, FileName(filename), runparams);
4480 catch (ConversionException const &) { return ExportCancel; }
4483 else if (backend_format == "xhtml") {
4484 runparams.flavor = OutputParams::HTML;
4485 setMathFlavor(runparams);
4486 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4487 return ExportKilled;
4488 } else if (backend_format == "lyx")
4489 writeFile(FileName(filename));
4491 else if (params().isDocBook()) {
4492 runparams.nice = !put_in_tempdir;
4493 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4494 return ExportKilled;
4497 else if (backend_format == format || need_nice_file) {
4498 runparams.nice = true;
4499 ExportStatus const retval =
4500 makeLaTeXFile(FileName(filename), string(), runparams);
4501 if (retval == ExportKilled)
4502 return ExportKilled;
4503 if (d->cloned_buffer_)
4504 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4505 if (retval != ExportSuccess)
4507 } else if (!lyxrc.tex_allows_spaces
4508 && contains(filePath(), ' ')) {
4509 Alert::error(_("File name error"),
4510 bformat(_("The directory path to the document\n%1$s\n"
4511 "contains spaces, but your TeX installation does "
4512 "not allow them. You should save the file to a directory "
4513 "whose name does not contain spaces."), from_ascii(filePath())));
4514 return ExportTexPathHasSpaces;
4516 runparams.nice = false;
4517 ExportStatus const retval =
4518 makeLaTeXFile(FileName(filename), filePath(), runparams);
4519 if (retval == ExportKilled)
4520 return ExportKilled;
4521 if (d->cloned_buffer_)
4522 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4523 if (retval != ExportSuccess)
4527 string const error_type = (format == "program")
4528 ? "Build" : params().bufferFormat();
4529 ErrorList & error_list = d->errorLists[error_type];
4530 string const ext = theFormats().extension(format);
4531 FileName const tmp_result_file(changeExtension(filename, ext));
4532 Converters::RetVal const retval =
4533 converters.convert(this, FileName(filename), tmp_result_file,
4534 FileName(absFileName()), backend_format, format, error_list);
4535 if (retval == Converters::KILLED)
4536 return ExportCancel;
4537 bool success = (retval == Converters::SUCCESS);
4539 // Emit the signal to show the error list or copy it back to the
4540 // cloned Buffer so that it can be emitted afterwards.
4541 if (format != backend_format) {
4542 if (runparams.silent)
4544 else if (d->cloned_buffer_)
4545 d->cloned_buffer_->d->errorLists[error_type] =
4546 d->errorLists[error_type];
4549 // also to the children, in case of master-buffer-view
4550 ListOfBuffers clist = getDescendents();
4551 for (auto const & bit : clist) {
4552 if (runparams.silent)
4553 bit->d->errorLists[error_type].clear();
4554 else if (d->cloned_buffer_) {
4555 // Enable reverse search by copying back the
4556 // texrow object to the cloned buffer.
4557 // FIXME: this is not thread safe.
4558 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4559 bit->d->cloned_buffer_->d->errorLists[error_type] =
4560 bit->d->errorLists[error_type];
4562 bit->errors(error_type, true);
4566 if (d->cloned_buffer_) {
4567 // Enable reverse dvi or pdf to work by copying back the texrow
4568 // object to the cloned buffer.
4569 // FIXME: There is a possibility of concurrent access to texrow
4570 // here from the main GUI thread that should be securized.
4571 d->cloned_buffer_->d->texrow = d->texrow;
4572 string const err_type = params().bufferFormat();
4573 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4577 if (put_in_tempdir) {
4578 result_file = tmp_result_file.absFileName();
4579 return success ? ExportSuccess : ExportConverterError;
4582 if (dest_filename.empty())
4583 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4585 result_file = dest_filename;
4586 // We need to copy referenced files (e. g. included graphics
4587 // if format == "dvi") to the result dir.
4588 vector<ExportedFile> const files =
4589 runparams.exportdata->externalFiles(format);
4590 string const dest = runparams.export_folder.empty() ?
4591 onlyPath(result_file) : runparams.export_folder;
4592 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4593 : force_overwrite == ALL_FILES;
4594 CopyStatus status = use_force ? FORCE : SUCCESS;
4596 for (ExportedFile const & exp : files) {
4597 if (status == CANCEL) {
4598 message(_("Document export cancelled."));
4599 return ExportCancel;
4601 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4602 string fixedName = exp.exportName;
4603 if (!runparams.export_folder.empty()) {
4604 // Relative pathnames starting with ../ will be sanitized
4605 // if exporting to a different folder
4606 while (fixedName.substr(0, 3) == "../")
4607 fixedName = fixedName.substr(3, fixedName.length() - 3);
4609 FileName fixedFileName = makeAbsPath(fixedName, dest);
4610 fixedFileName.onlyPath().createPath();
4611 status = copyFile(fmt, exp.sourceName,
4613 exp.exportName, status == FORCE,
4614 runparams.export_folder.empty());
4618 if (tmp_result_file.exists()) {
4619 // Finally copy the main file
4620 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4621 : force_overwrite != NO_FILES;
4622 if (status == SUCCESS && use_force)
4624 status = copyFile(format, tmp_result_file,
4625 FileName(result_file), result_file,
4627 if (status == CANCEL) {
4628 message(_("Document export cancelled."));
4629 return ExportCancel;
4631 message(bformat(_("Document exported as %1$s "
4633 theFormats().prettyName(format),
4634 makeDisplayPath(result_file)));
4637 // This must be a dummy converter like fax (bug 1888)
4638 message(bformat(_("Document exported as %1$s"),
4639 theFormats().prettyName(format)));
4642 return success ? ExportSuccess : ExportConverterError;
4646 Buffer::ExportStatus Buffer::preview(string const & format) const
4648 bool const update_unincluded =
4649 params().maintain_unincluded_children
4650 && !params().getIncludedChildren().empty();
4651 return preview(format, update_unincluded);
4655 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4657 MarkAsExporting exporting(this);
4659 // (1) export with all included children (omit \includeonly)
4661 ExportStatus const status = doExport(format, true, true, result_file);
4662 if (status != ExportSuccess)
4665 // (2) export with included children only
4666 ExportStatus const status = doExport(format, true, false, result_file);
4667 FileName const previewFile(result_file);
4669 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4670 theimpl->preview_file_ = previewFile;
4671 theimpl->preview_format_ = format;
4672 theimpl->preview_error_ = (status != ExportSuccess);
4674 if (status != ExportSuccess)
4677 if (previewFile.exists())
4678 return theFormats().view(*this, previewFile, format) ?
4679 PreviewSuccess : PreviewError;
4681 // Successful export but no output file?
4682 // Probably a bug in error detection.
4683 LATTEST(status != ExportSuccess);
4688 Buffer::ReadStatus Buffer::extractFromVC()
4690 bool const found = LyXVC::file_not_found_hook(d->filename);
4692 return ReadFileNotFound;
4693 if (!d->filename.isReadableFile())
4699 Buffer::ReadStatus Buffer::loadEmergency()
4701 FileName const emergencyFile = getEmergencyFileName();
4702 if (!emergencyFile.exists()
4703 || emergencyFile.lastModified() <= d->filename.lastModified())
4704 return ReadFileNotFound;
4706 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4707 docstring const text = bformat(_("An emergency save of the document "
4708 "%1$s exists.\n\nRecover emergency save?"), file);
4710 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4711 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4717 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4718 bool const success = (ret_llf == ReadSuccess);
4720 if (hasReadonlyFlag()) {
4721 Alert::warning(_("File is read-only"),
4722 bformat(_("An emergency file is successfully loaded, "
4723 "but the original file %1$s is marked read-only. "
4724 "Please make sure to save the document as a different "
4725 "file."), from_utf8(d->filename.absFileName())));
4728 lyxvc().file_found_hook(d->filename);
4729 str = _("Document was successfully recovered.");
4731 str = _("Document was NOT successfully recovered.");
4732 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4733 makeDisplayPath(emergencyFile.absFileName()));
4735 int const del_emerg =
4736 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4737 _("&Remove"), _("&Keep"));
4738 if (del_emerg == 0) {
4739 emergencyFile.removeFile();
4741 Alert::warning(_("Emergency file deleted"),
4742 _("Do not forget to save your file now!"), true);
4744 return success ? ReadSuccess : ReadEmergencyFailure;
4747 int const del_emerg =
4748 Alert::prompt(_("Delete emergency file?"),
4749 _("Remove emergency file now?"), 1, 1,
4750 _("&Remove"), _("&Keep"));
4752 emergencyFile.removeFile();
4753 return ReadOriginal;
4763 Buffer::ReadStatus Buffer::loadAutosave()
4765 // Now check if autosave file is newer.
4766 FileName const autosaveFile = getAutosaveFileName();
4767 if (!autosaveFile.exists()
4768 || autosaveFile.lastModified() <= d->filename.lastModified())
4769 return ReadFileNotFound;
4771 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4772 docstring const text = bformat(_("The backup of the document %1$s "
4773 "is newer.\n\nLoad the backup instead?"), file);
4774 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4775 _("&Load backup"), _("Load &original"), _("&Cancel"));
4780 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4781 // the file is not saved if we load the autosave file.
4782 if (ret_llf == ReadSuccess) {
4783 if (hasReadonlyFlag()) {
4784 Alert::warning(_("File is read-only"),
4785 bformat(_("A backup file is successfully loaded, "
4786 "but the original file %1$s is marked read-only. "
4787 "Please make sure to save the document as a "
4789 from_utf8(d->filename.absFileName())));
4792 lyxvc().file_found_hook(d->filename);
4795 return ReadAutosaveFailure;
4798 // Here we delete the autosave
4799 autosaveFile.removeFile();
4800 return ReadOriginal;
4808 Buffer::ReadStatus Buffer::loadLyXFile()
4810 if (!d->filename.isReadableFile()) {
4811 ReadStatus const ret_rvc = extractFromVC();
4812 if (ret_rvc != ReadSuccess)
4816 ReadStatus const ret_re = loadEmergency();
4817 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4820 ReadStatus const ret_ra = loadAutosave();
4821 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4824 return loadThisLyXFile(d->filename);
4828 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4830 return readFile(fn);
4834 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4836 for (auto const & err : terr) {
4837 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4838 int errorRow = err.error_in_line;
4839 Buffer const * buf = 0;
4841 if (err.child_name.empty())
4842 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4844 // The error occurred in a child
4845 for (Buffer const * child : getDescendents()) {
4846 string const child_name =
4847 DocFileName(changeExtension(child->absFileName(), "tex")).
4849 if (err.child_name != child_name)
4851 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4852 if (!TexRow::isNone(start)) {
4853 buf = d->cloned_buffer_
4854 ? child->d->cloned_buffer_->d->owner_
4861 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4867 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4869 LBUFERR(!text().paragraphs().empty());
4871 // Use the master text class also for child documents
4872 Buffer const * const master = masterBuffer();
4873 DocumentClass const & textclass = master->params().documentClass();
4875 docstring_list old_bibfiles;
4876 // Do this only if we are the top-level Buffer. We also need to account
4877 // for the case of a previewed child with ignored parent here.
4878 if (master == this && !d->ignore_parent) {
4879 textclass.counters().reset(from_ascii("bibitem"));
4880 reloadBibInfoCache();
4881 // we will re-read this cache as we go through, but we need
4882 // to know whether it's changed to know whether we need to
4883 // update the bibinfo cache.
4884 old_bibfiles = d->bibfiles_cache_;
4885 d->bibfiles_cache_.clear();
4888 // keep the buffers to be children in this set. If the call from the
4889 // master comes back we can see which of them were actually seen (i.e.
4890 // via an InsetInclude). The remaining ones in the set need still be updated.
4891 static std::set<Buffer const *> bufToUpdate;
4892 if (scope == UpdateMaster) {
4893 // If this is a child document start with the master
4894 if (master != this) {
4895 bufToUpdate.insert(this);
4896 master->updateBuffer(UpdateMaster, utype);
4897 // If the master buffer has no gui associated with it, then the TocModel is
4898 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4899 // (bug 5699). The same happens if the master buffer is open in a different
4900 // window. This test catches both possibilities.
4901 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4902 // There remains a problem here: If there is another child open in yet a third
4903 // window, that TOC is not updated. So some more general solution is needed at
4905 if (master->d->gui_ != d->gui_)
4908 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4909 if (bufToUpdate.find(this) == bufToUpdate.end())
4913 // start over the counters in the master
4914 textclass.counters().reset();
4917 // update will be done below for this buffer
4918 bufToUpdate.erase(this);
4920 // update all caches
4921 clearReferenceCache();
4923 setChangesPresent(false);
4925 Buffer & cbuf = const_cast<Buffer &>(*this);
4928 ParIterator parit = cbuf.par_iterator_begin();
4929 updateBuffer(parit, utype);
4931 // If this document has siblings, then update the TocBackend later. The
4932 // reason is to ensure that later siblings are up to date when e.g. the
4933 // broken or not status of references is computed. The update is called
4934 // in InsetInclude::addToToc.
4938 // if the bibfiles changed, the cache of bibinfo is invalid
4939 docstring_list new_bibfiles = d->bibfiles_cache_;
4940 // this is a trick to determine whether the two vectors have
4941 // the same elements.
4942 sort(new_bibfiles.begin(), new_bibfiles.end());
4943 sort(old_bibfiles.begin(), old_bibfiles.end());
4944 if (old_bibfiles != new_bibfiles) {
4945 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
4946 invalidateBibinfoCache();
4947 reloadBibInfoCache();
4948 // We relied upon the bibinfo cache when recalculating labels. But that
4949 // cache was invalid, although we didn't find that out until now. So we
4950 // have to do it all again.
4951 // That said, the only thing we really need to do is update the citation
4952 // labels. Nothing else will have changed. So we could create a new
4953 // UpdateType that would signal that fact, if we needed to do so.
4954 parit = cbuf.par_iterator_begin();
4955 // we will be re-doing the counters and references and such.
4956 textclass.counters().reset();
4957 clearReferenceCache();
4958 // we should not need to do this again?
4960 setChangesPresent(false);
4961 updateBuffer(parit, utype);
4962 // this will already have been done by reloadBibInfoCache();
4963 // d->bibinfo_cache_valid_ = true;
4966 LYXERR(Debug::FILES, "Bibfiles unchanged.");
4967 // this is also set to true on the other path, by reloadBibInfoCache.
4968 d->bibinfo_cache_valid_ = true;
4970 d->cite_labels_valid_ = true;
4972 cbuf.tocBackend().update(true, utype);
4973 if (scope == UpdateMaster)
4974 cbuf.structureChanged();
4978 static depth_type getDepth(DocIterator const & it)
4980 depth_type depth = 0;
4981 for (size_t i = 0 ; i < it.depth() ; ++i)
4982 if (!it[i].inset().inMathed())
4983 depth += it[i].paragraph().getDepth() + 1;
4984 // remove 1 since the outer inset does not count
4985 // we should have at least one non-math inset, so
4986 // depth should nevery be 0. but maybe it is worth
4987 // marking this, just in case.
4989 // coverity[INTEGER_OVERFLOW]
4993 static depth_type getItemDepth(ParIterator const & it)
4995 Paragraph const & par = *it;
4996 LabelType const labeltype = par.layout().labeltype;
4998 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5001 // this will hold the lowest depth encountered up to now.
5002 depth_type min_depth = getDepth(it);
5003 ParIterator prev_it = it;
5006 --prev_it.top().pit();
5008 // start of nested inset: go to outer par
5010 if (prev_it.empty()) {
5011 // start of document: nothing to do
5016 // We search for the first paragraph with same label
5017 // that is not more deeply nested.
5018 Paragraph & prev_par = *prev_it;
5019 depth_type const prev_depth = getDepth(prev_it);
5020 if (labeltype == prev_par.layout().labeltype) {
5021 if (prev_depth < min_depth)
5022 return prev_par.itemdepth + 1;
5023 if (prev_depth == min_depth)
5024 return prev_par.itemdepth;
5026 min_depth = min(min_depth, prev_depth);
5027 // small optimization: if we are at depth 0, we won't
5028 // find anything else
5029 if (prev_depth == 0)
5035 static bool needEnumCounterReset(ParIterator const & it)
5037 Paragraph const & par = *it;
5038 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5039 depth_type const cur_depth = par.getDepth();
5040 ParIterator prev_it = it;
5041 while (prev_it.pit()) {
5042 --prev_it.top().pit();
5043 Paragraph const & prev_par = *prev_it;
5044 if (prev_par.getDepth() <= cur_depth)
5045 return prev_par.layout().name() != par.layout().name();
5047 // start of nested inset: reset
5052 // set the label of a paragraph. This includes the counters.
5053 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5055 BufferParams const & bp = owner_->masterBuffer()->params();
5056 DocumentClass const & textclass = bp.documentClass();
5057 Paragraph & par = it.paragraph();
5058 Layout const & layout = par.layout();
5059 Counters & counters = textclass.counters();
5061 if (par.params().startOfAppendix()) {
5062 // We want to reset the counter corresponding to toplevel sectioning
5063 Layout const & lay = textclass.getTOCLayout();
5064 docstring const cnt = lay.counter;
5066 counters.reset(cnt);
5067 counters.appendix(true);
5069 par.params().appendix(counters.appendix());
5071 // Compute the item depth of the paragraph
5072 par.itemdepth = getItemDepth(it);
5074 if (layout.margintype == MARGIN_MANUAL) {
5075 if (par.params().labelWidthString().empty())
5076 par.params().labelWidthString(par.expandLabel(layout, bp));
5077 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5078 // we do not need to do anything here, since the empty case is
5079 // handled during export.
5081 par.params().labelWidthString(docstring());
5084 switch(layout.labeltype) {
5085 case LABEL_ITEMIZE: {
5086 // At some point of time we should do something more
5087 // clever here, like:
5088 // par.params().labelString(
5089 // bp.user_defined_bullet(par.itemdepth).getText());
5090 // for now, use a simple hardcoded label
5091 docstring itemlabel;
5092 switch (par.itemdepth) {
5094 itemlabel = char_type(0x2022);
5097 itemlabel = char_type(0x2013);
5100 itemlabel = char_type(0x2217);
5103 itemlabel = char_type(0x2219); // or 0x00b7
5106 par.params().labelString(itemlabel);
5110 case LABEL_ENUMERATE: {
5111 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5113 switch (par.itemdepth) {
5124 enumcounter += "iv";
5127 // not a valid enumdepth...
5131 if (needEnumCounterReset(it)) {
5132 // Increase the master counter?
5133 if (layout.stepmastercounter)
5134 counters.stepMaster(enumcounter, utype);
5135 // Maybe we have to reset the enumeration counter.
5136 if (!layout.resumecounter)
5137 counters.reset(enumcounter);
5139 counters.step(enumcounter, utype);
5141 string const & lang = par.getParLanguage(bp)->code();
5142 par.params().labelString(counters.theCounter(enumcounter, lang));
5147 case LABEL_SENSITIVE: {
5148 string const & type = counters.current_float();
5149 docstring full_label;
5151 full_label = owner_->B_("Senseless!!! ");
5153 docstring name = owner_->B_(textclass.floats().getType(type).name());
5154 if (counters.hasCounter(from_utf8(type))) {
5155 string const & lang = par.getParLanguage(bp)->code();
5156 counters.step(from_utf8(type), utype);
5157 full_label = bformat(from_ascii("%1$s %2$s:"),
5159 counters.theCounter(from_utf8(type), lang));
5161 full_label = bformat(from_ascii("%1$s #:"), name);
5163 par.params().labelString(full_label);
5167 case LABEL_NO_LABEL:
5168 par.params().labelString(docstring());
5172 case LABEL_CENTERED:
5173 case LABEL_STATIC: {
5174 docstring const & lcounter = layout.counter;
5175 if (!lcounter.empty()) {
5176 if (layout.toclevel <= bp.secnumdepth
5177 && (layout.latextype != LATEX_ENVIRONMENT
5178 || it.text()->isFirstInSequence(it.pit()))) {
5179 if (counters.hasCounter(lcounter))
5180 counters.step(lcounter, utype);
5181 par.params().labelString(par.expandLabel(layout, bp));
5183 par.params().labelString(docstring());
5185 par.params().labelString(par.expandLabel(layout, bp));
5191 par.params().labelString(par.expandLabel(layout, bp));
5196 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5198 // LASSERT: Is it safe to continue here, or should we just return?
5199 LASSERT(parit.pit() == 0, /**/);
5201 // Set the position of the text in the buffer to be able
5202 // to resolve macros in it.
5203 parit.text()->setMacrocontextPosition(parit);
5205 depth_type maxdepth = 0;
5206 pit_type const lastpit = parit.lastpit();
5207 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5208 // reduce depth if necessary
5209 if (parit->params().depth() > maxdepth) {
5210 /** FIXME: this function is const, but
5211 * nevertheless it modifies the buffer. To be
5212 * cleaner, one should modify the buffer in
5213 * another function, which is actually
5214 * non-const. This would however be costly in
5215 * terms of code duplication.
5217 CursorData(parit).recordUndo();
5218 parit->params().depth(maxdepth);
5220 maxdepth = parit->getMaxDepthAfter();
5222 if (utype == OutputUpdate) {
5223 // track the active counters
5224 // we have to do this for the master buffer, since the local
5225 // buffer isn't tracking anything.
5226 masterBuffer()->params().documentClass().counters().
5227 setActiveLayout(parit->layout());
5230 // set the counter for this paragraph
5231 d->setLabel(parit, utype);
5233 // update change-tracking flag
5234 parit->addChangesToBuffer(*this);
5237 for (auto const & insit : parit->insetList()) {
5238 parit.pos() = insit.pos;
5239 insit.inset->updateBuffer(parit, utype);
5245 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5246 WordLangTuple & word_lang, docstring_list & suggestions) const
5250 suggestions.clear();
5251 word_lang = WordLangTuple();
5252 bool const to_end = to.empty();
5253 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5254 // OK, we start from here.
5255 for (; from != end; from.forwardPos()) {
5256 // This skips all insets with spell check disabled.
5257 while (!from.allowSpellCheck()) {
5261 // If from is at the end of the document (which is possible
5262 // when "from" was changed above) LyX will crash later otherwise.
5263 if (from.atEnd() || (!to_end && from >= end))
5266 from.paragraph().spellCheck();
5267 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5268 if (SpellChecker::misspelled(res)) {
5272 // Do not increase progress when from == to, otherwise the word
5273 // count will be wrong.
5283 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5285 bool inword = false;
5290 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5291 if (!dit.inTexted()) {
5296 Paragraph const & par = dit.paragraph();
5297 pos_type const pos = dit.pos();
5299 // Copied and adapted from isWordSeparator() in Paragraph
5300 if (pos == dit.lastpos()) {
5303 Inset const * ins = par.getInset(pos);
5304 if (ins && skipNoOutput && !ins->producesOutput()) {
5307 // stop if end of range was skipped
5308 if (!to.atEnd() && dit >= to)
5311 } else if (!par.isDeleted(pos)) {
5312 if (par.isWordSeparator(pos))
5318 if (ins && ins->isLetter())
5320 else if (ins && ins->isSpace())
5323 char_type const c = par.getChar(pos);
5324 if (isPrintableNonspace(c))
5326 else if (isSpace(c))
5336 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5338 d->updateStatistics(from, to, skipNoOutput);
5342 int Buffer::wordCount() const
5344 return d->wordCount();
5348 int Buffer::charCount(bool with_blanks) const
5350 return d->charCount(with_blanks);
5354 Buffer::ReadStatus Buffer::reload()
5357 // c.f. bug https://www.lyx.org/trac/ticket/6587
5358 removeAutosaveFile();
5359 // e.g., read-only status could have changed due to version control
5360 d->filename.refresh();
5361 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5363 // clear parent. this will get reset if need be.
5365 ReadStatus const status = loadLyXFile();
5366 if (status == ReadSuccess) {
5371 message(bformat(_("Document %1$s reloaded."), disp_fn));
5374 message(bformat(_("Could not reload document %1$s."), disp_fn));
5384 bool Buffer::saveAs(FileName const & fn)
5386 FileName const old_name = fileName();
5387 FileName const old_auto = getAutosaveFileName();
5388 bool const old_unnamed = isUnnamed();
5389 bool success = true;
5390 d->old_position = filePath();
5397 // bring the autosave file with us, just in case.
5398 moveAutosaveFile(old_auto);
5399 // validate version control data and
5400 // correct buffer title
5401 lyxvc().file_found_hook(fileName());
5403 // the file has now been saved to the new location.
5404 // we need to check that the locations of child buffers
5406 checkChildBuffers();
5407 checkMasterBuffer();
5410 // reset the old filename and unnamed state
5411 setFileName(old_name);
5412 setUnnamed(old_unnamed);
5416 d->old_position.clear();
5421 void Buffer::checkChildBuffers()
5423 for (auto const & bit : d->children_positions) {
5424 DocIterator dit = bit.second;
5425 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5426 if (!cbuf || !theBufferList().isLoaded(cbuf))
5428 Inset * inset = dit.nextInset();
5429 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5430 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5431 docstring const & incfile = inset_inc->getParam("filename");
5432 string oldloc = cbuf->absFileName();
5433 string newloc = makeAbsPath(to_utf8(incfile),
5434 onlyPath(absFileName())).absFileName();
5435 if (oldloc == newloc)
5437 // the location of the child file is incorrect.
5439 inset_inc->setChildBuffer(0);
5441 // invalidate cache of children
5442 d->children_positions.clear();
5443 d->position_to_children.clear();
5447 // If a child has been saved under a different name/path, it might have been
5448 // orphaned. Therefore the master needs to be reset (bug 8161).
5449 void Buffer::checkMasterBuffer()
5451 Buffer const * const master = masterBuffer();
5455 // necessary to re-register the child (bug 5873)
5456 // FIXME: clean up updateMacros (here, only
5457 // child registering is needed).
5458 master->updateMacros();
5459 // (re)set master as master buffer, but only
5460 // if we are a real child
5461 if (master->isChild(this))
5468 string Buffer::includedFilePath(string const & name, string const & ext) const
5470 if (d->old_position.empty() ||
5471 equivalent(FileName(d->old_position), FileName(filePath())))
5474 bool isabsolute = FileName::isAbsolute(name);
5475 // both old_position and filePath() end with a path separator
5476 string absname = isabsolute ? name : d->old_position + name;
5478 // if old_position is set to origin, we need to do the equivalent of
5479 // getReferencedFileName() (see readDocument())
5480 if (!isabsolute && d->old_position == params().origin) {
5481 FileName const test(addExtension(filePath() + name, ext));
5483 absname = filePath() + name;
5486 if (!FileName(addExtension(absname, ext)).exists())
5490 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5492 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5493 from_utf8(filePath())));
5497 void Buffer::setChangesPresent(bool b) const
5499 d->tracked_changes_present_ = b;
5503 bool Buffer::areChangesPresent() const
5505 return d->tracked_changes_present_;
5509 void Buffer::updateChangesPresent() const
5511 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5512 setChangesPresent(false);
5513 ParConstIterator it = par_iterator_begin();
5514 ParConstIterator const end = par_iterator_end();
5515 for (; !areChangesPresent() && it != end; ++it)
5516 it->addChangesToBuffer(*this);
5520 void Buffer::Impl::refreshFileMonitor()
5522 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5523 file_monitor_->refresh();
5527 // The previous file monitor is invalid
5528 // This also destroys the previous file monitor and all its connections
5529 file_monitor_ = FileSystemWatcher::monitor(filename);
5530 // file_monitor_ will be destroyed with *this, so it is not going to call a
5531 // destroyed object method.
5532 file_monitor_->connect([this](bool exists) {
5533 fileExternallyModified(exists);
5538 void Buffer::Impl::fileExternallyModified(bool const exists)
5540 // ignore notifications after our own saving operations
5541 if (checksum_ == filename.checksum()) {
5542 LYXERR(Debug::FILES, "External modification but "
5543 "checksum unchanged: " << filename);
5546 // If the file has been deleted, only mark the file as dirty since it is
5547 // pointless to prompt for reloading. If later a file is moved into this
5548 // location, then the externally modified warning will appear then.
5550 externally_modified_ = true;
5551 // Update external modification notification.
5552 // Dirty buffers must be visible at all times.
5553 if (wa_ && wa_->unhide(owner_))
5554 wa_->updateTitles();
5556 // Unable to unhide the buffer (e.g. no GUI or not current View)
5561 bool Buffer::notifiesExternalModification() const
5563 return d->externally_modified_;
5567 void Buffer::clearExternalModification() const
5569 d->externally_modified_ = false;
5571 d->wa_->updateTitles();