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;
138 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
143 // A storehouse for the cloned buffers.
144 list<CloneList *> cloned_buffers;
150 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
154 delete preview_loader_;
162 /// search for macro in local (buffer) table or in children
163 MacroData const * getBufferMacro(docstring const & name,
164 DocIterator const & pos) const;
166 /// Update macro table starting with position of it \param it in some
168 void updateMacros(DocIterator & it, DocIterator & scope);
170 void setLabel(ParIterator & it, UpdateType utype) const;
172 /** If we have branches that use the file suffix
173 feature, return the file name with suffix appended.
175 FileName exportFileName() const;
182 mutable TexRow texrow;
184 /// need to regenerate .tex?
188 mutable bool lyx_clean;
190 /// is autosave needed?
191 mutable bool bak_clean;
193 /// is this an unnamed file (New...)?
196 /// is this an internal bufffer?
197 bool internal_buffer;
202 /// name of the file the buffer is associated with.
205 /** Set to true only when the file is fully loaded.
206 * Used to prevent the premature generation of previews
207 * and by the citation inset.
209 bool file_fully_loaded;
211 /// original format of loaded file
214 /// if the file was originally loaded from an older format, do
215 /// we need to back it up still?
216 bool need_format_backup;
218 /// Ignore the parent (e.g. when exporting a child standalone)?
222 mutable TocBackend toc_backend;
227 ScopeMacro(DocIterator const & s, MacroData const & m)
228 : scope(s), macro(m) {}
232 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
233 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
234 /// map from the macro name to the position map,
235 /// which maps the macro definition position to the scope and the MacroData.
236 NamePositionScopeMacroMap macros;
237 /// This seem to change the way Buffer::getMacro() works
238 mutable bool macro_lock;
240 /// positions of child buffers in the buffer
241 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
243 ScopeBuffer() : buffer(0) {}
244 ScopeBuffer(DocIterator const & s, Buffer const * b)
245 : scope(s), buffer(b) {}
247 Buffer const * buffer;
249 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
250 /// position of children buffers in this buffer
251 BufferPositionMap children_positions;
252 /// map from children inclusion positions to their scope and their buffer
253 PositionScopeBufferMap position_to_children;
255 /// Contains the old buffer filePath() while saving-as, or the
256 /// directory where the document was last saved while loading.
259 /** Keeps track of the path of local layout files.
260 * If possible, it is always relative to the buffer path.
261 * Empty for layouts in system or user directory.
263 string layout_position;
265 /// Container for all sort of Buffer dependant errors.
266 map<string, ErrorList> errorLists;
268 /// checksum used to test if the file has been externally modified. Used to
269 /// double check whether the file had been externally modified when saving.
270 unsigned long checksum_;
273 frontend::WorkAreaManager * wa_;
275 frontend::GuiBufferDelegate * gui_;
280 /// A cache for the bibfiles (including bibfiles of loaded child
281 /// documents), needed for appropriate update of natbib labels.
282 mutable FileNamePairList bibfiles_cache_;
284 // FIXME The caching mechanism could be improved. At present, we have a
285 // cache for each Buffer, that caches all the bibliography info for that
286 // Buffer. A more efficient solution would be to have a global cache per
287 // file, and then to construct the Buffer's bibinfo from that.
288 /// A cache for bibliography info
289 mutable BiblioInfo bibinfo_;
290 /// whether the bibinfo cache is valid
291 mutable bool bibinfo_cache_valid_;
292 /// Cache of timestamps of .bib files
293 map<FileName, time_t> bibfile_status_;
294 /// Indicates whether the bibinfo has changed since the last time
295 /// we ran updateBuffer(), i.e., whether citation labels may need
297 mutable bool cite_labels_valid_;
299 /// These two hold the file name and format, written to by
300 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
301 FileName preview_file_;
302 string preview_format_;
303 /// If there was an error when previewing, on the next preview we do
304 /// a fresh compile (e.g. in case the user installed a package that
308 mutable RefCache ref_cache_;
310 /// our Text that should be wrapped in an InsetText
314 PreviewLoader * preview_loader_;
316 /// This is here to force the test to be done whenever parent_buffer
318 Buffer const * parent() const
320 // ignore_parent temporarily "orphans" a buffer
321 // (e.g. if a child is compiled standalone)
324 // if parent_buffer is not loaded, then it has been unloaded,
325 // which means that parent_buffer is an invalid pointer. So we
326 // set it to null in that case.
327 // however, the BufferList doesn't know about cloned buffers, so
328 // they will always be regarded as unloaded. in that case, we hope
330 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
332 return parent_buffer;
336 void setParent(Buffer const * pb)
338 if (parent_buffer == pb)
341 if (!cloned_buffer_ && parent_buffer && pb)
342 LYXERR0("Warning: a buffer should not have two parents!");
344 if (!cloned_buffer_ && parent_buffer)
345 parent_buffer->invalidateBibinfoCache();
348 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
349 /// This one is useful for preview detached in a thread.
350 Buffer const * cloned_buffer_;
352 CloneList * clone_list_;
353 /// are we in the process of exporting this buffer?
354 mutable bool doing_export;
356 /// compute statistics
357 /// \p from initial position
358 /// \p to points to the end position
359 void updateStatistics(DocIterator & from, DocIterator & to,
360 bool skipNoOutput = true);
361 /// statistics accessor functions
362 int wordCount() const
366 int charCount(bool with_blanks) const
369 + (with_blanks ? blank_count_ : 0);
372 // does the buffer contain tracked changes? (if so, we automatically
373 // display the review toolbar, for instance)
374 mutable bool tracked_changes_present_;
376 // Make sure the file monitor monitors the good file.
377 void refreshFileMonitor();
379 /// Notify or clear of external modification
380 void fileExternallyModified(bool exists);
382 /// has been externally modified? Can be reset by the user.
383 mutable bool externally_modified_;
386 /// So we can force access via the accessors.
387 mutable Buffer const * parent_buffer;
393 FileMonitorPtr file_monitor_;
397 /// Creates the per buffer temporary directory
398 static FileName createBufferTmpDir()
400 // FIXME This would be the ideal application for a TempDir class (like
401 // TempFile but for directories)
406 Mutex::Locker locker(&mutex);
407 counter = convert<string>(count++);
409 // We are in our own directory. Why bother to mangle name?
410 // In fact I wrote this code to circumvent a problematic behaviour
411 // (bug?) of EMX mkstemp().
412 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
415 if (!tmpfl.createDirectory(0777)) {
416 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
417 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
418 from_utf8(tmpfl.absFileName())));
424 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
425 Buffer const * cloned_buffer)
426 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
427 internal_buffer(false), read_only(readonly_), filename(file),
428 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
429 ignore_parent(false), toc_backend(owner), macro_lock(false),
430 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
431 cite_labels_valid_(false), preview_error_(false),
432 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
433 clone_list_(0), doing_export(false),
434 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
435 word_count_(0), char_count_(0), blank_count_(0)
437 refreshFileMonitor();
438 if (!cloned_buffer_) {
439 temppath = createBufferTmpDir();
440 lyxvc.setBuffer(owner_);
442 wa_ = new frontend::WorkAreaManager;
445 temppath = cloned_buffer_->d->temppath;
446 file_fully_loaded = true;
447 params = cloned_buffer_->d->params;
448 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
449 bibinfo_ = cloned_buffer_->d->bibinfo_;
450 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
451 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
452 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
453 unnamed = cloned_buffer_->d->unnamed;
454 internal_buffer = cloned_buffer_->d->internal_buffer;
455 layout_position = cloned_buffer_->d->layout_position;
456 preview_file_ = cloned_buffer_->d->preview_file_;
457 preview_format_ = cloned_buffer_->d->preview_format_;
458 preview_error_ = cloned_buffer_->d->preview_error_;
459 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
463 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
464 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
466 LYXERR(Debug::INFO, "Buffer::Buffer()");
468 d->inset = new InsetText(*cloned_buffer->d->inset);
469 d->inset->setBuffer(*this);
470 // FIXME: optimize this loop somewhat, maybe by creating a new
471 // general recursive Inset::setId().
472 DocIterator it = doc_iterator_begin(this);
473 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
474 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
475 it.paragraph().setId(cloned_it.paragraph().id());
477 d->inset = new InsetText(this);
478 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
484 LYXERR(Debug::INFO, "Buffer::~Buffer()");
485 // here the buffer should take care that it is
486 // saved properly, before it goes into the void.
488 // GuiView already destroyed
492 // No need to do additional cleanups for internal buffer.
498 // this is in case of recursive includes: we won't try to delete
499 // ourselves as a child.
500 d->clone_list_->erase(this);
501 // loop over children
502 for (auto const & p : d->children_positions) {
503 Buffer * child = const_cast<Buffer *>(p.first);
504 if (d->clone_list_->erase(child))
507 // if we're the master buffer, then we should get rid of the list
510 // If this is not empty, we have leaked something. Worse, one of the
511 // children still has a reference to this list. But we will try to
512 // continue, rather than shut down.
513 LATTEST(d->clone_list_->empty());
514 list<CloneList *>::iterator it =
515 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
516 if (it == cloned_buffers.end()) {
517 // We will leak in this case, but it is safe to continue.
520 cloned_buffers.erase(it);
521 delete d->clone_list_;
523 // FIXME Do we really need to do this right before we delete d?
524 // clear references to children in macro tables
525 d->children_positions.clear();
526 d->position_to_children.clear();
528 // loop over children
529 for (auto const & p : d->children_positions) {
530 Buffer * child = const_cast<Buffer *>(p.first);
531 if (theBufferList().isLoaded(child)) {
532 if (theBufferList().isOthersChild(this, child))
535 theBufferList().release(child);
540 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
542 msg += emergencyWrite();
544 msg += " " + _("Save failed! Document is lost.");
546 Alert::warning(_("Attempting to close changed document!"), msg);
549 // FIXME Do we really need to do this right before we delete d?
550 // clear references to children in macro tables
551 d->children_positions.clear();
552 d->position_to_children.clear();
554 if (!d->temppath.destroyDirectory()) {
555 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
556 from_utf8(d->temppath.absFileName())));
565 Buffer * Buffer::cloneFromMaster() const
568 cloned_buffers.push_back(new CloneList);
569 CloneList * clones = cloned_buffers.back();
571 masterBuffer()->cloneWithChildren(bufmap, clones);
573 // make sure we got cloned
574 BufferMap::const_iterator bit = bufmap.find(this);
575 LASSERT(bit != bufmap.end(), return 0);
576 Buffer * cloned_buffer = bit->second;
578 return cloned_buffer;
582 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
584 // have we already been cloned?
585 if (bufmap.find(this) != bufmap.end())
588 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
590 // The clone needs its own DocumentClass, since running updateBuffer() will
591 // modify it, and we would otherwise be sharing it with the original Buffer.
592 buffer_clone->params().makeDocumentClass(true);
594 cap::switchBetweenClasses(
595 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
596 static_cast<InsetText &>(buffer_clone->inset()), el);
598 bufmap[this] = buffer_clone;
599 clones->insert(buffer_clone);
600 buffer_clone->d->clone_list_ = clones;
601 buffer_clone->d->macro_lock = true;
602 buffer_clone->d->children_positions.clear();
604 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
605 // math macro caches need to be rethought and simplified.
606 // I am not sure wether we should handle Buffer cloning here or in BufferList.
607 // Right now BufferList knows nothing about buffer clones.
608 for (auto const & p : d->position_to_children) {
609 DocIterator dit = p.first.clone(buffer_clone);
610 dit.setBuffer(buffer_clone);
611 Buffer * child = const_cast<Buffer *>(p.second.buffer);
613 child->cloneWithChildren(bufmap, clones);
614 BufferMap::iterator const bit = bufmap.find(child);
615 LASSERT(bit != bufmap.end(), continue);
616 Buffer * child_clone = bit->second;
618 Inset * inset = dit.nextInset();
619 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
620 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
621 inset_inc->setChildBuffer(child_clone);
622 child_clone->d->setParent(buffer_clone);
623 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
624 buffer_clone->setChild(dit, child_clone);
626 buffer_clone->d->macro_lock = false;
631 Buffer * Buffer::cloneBufferOnly() const {
632 cloned_buffers.push_back(new CloneList);
633 CloneList * clones = cloned_buffers.back();
634 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
636 // The clone needs its own DocumentClass, since running updateBuffer() will
637 // modify it, and we would otherwise be sharing it with the original Buffer.
638 buffer_clone->params().makeDocumentClass(true);
640 cap::switchBetweenClasses(
641 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
642 static_cast<InsetText &>(buffer_clone->inset()), el);
644 clones->insert(buffer_clone);
645 buffer_clone->d->clone_list_ = clones;
647 // we won't be cloning the children
648 buffer_clone->d->children_positions.clear();
653 bool Buffer::isClone() const
655 return d->cloned_buffer_;
659 void Buffer::changed(bool update_metrics) const
662 d->wa_->redrawAll(update_metrics);
666 frontend::WorkAreaManager & Buffer::workAreaManager() const
673 Text & Buffer::text() const
675 return d->inset->text();
679 Inset & Buffer::inset() const
685 BufferParams & Buffer::params()
691 BufferParams const & Buffer::params() const
697 BufferParams const & Buffer::masterParams() const
699 if (masterBuffer() == this)
702 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
703 // Copy child authors to the params. We need those pointers.
704 for (Author const & a : params().authors())
705 mparams.authors().record(a);
710 double Buffer::fontScalingFactor() const
712 return isExporting() ? 75.0 * params().html_math_img_scale
713 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
717 ParagraphList & Buffer::paragraphs()
719 return text().paragraphs();
723 ParagraphList const & Buffer::paragraphs() const
725 return text().paragraphs();
729 LyXVC & Buffer::lyxvc()
735 LyXVC const & Buffer::lyxvc() const
741 string const Buffer::temppath() const
743 return d->temppath.absFileName();
747 TexRow & Buffer::texrow()
753 TexRow const & Buffer::texrow() const
759 TocBackend & Buffer::tocBackend() const
761 return d->toc_backend;
765 Undo & Buffer::undo()
771 void Buffer::setChild(DocIterator const & dit, Buffer * child)
773 d->children_positions[child] = dit;
777 string Buffer::latexName(bool const no_path) const
779 FileName latex_name =
780 makeLatexName(d->exportFileName());
781 return no_path ? latex_name.onlyFileName()
782 : latex_name.absFileName();
786 FileName Buffer::Impl::exportFileName() const
788 docstring const branch_suffix =
789 params.branchlist().getFileNameSuffix();
790 if (branch_suffix.empty())
793 string const name = filename.onlyFileNameWithoutExt()
794 + to_utf8(branch_suffix);
795 FileName res(filename.onlyPath().absFileName() + "/" + name);
796 res.changeExtension(filename.extension());
802 string Buffer::logName(LogType * type) const
804 string const filename = latexName(false);
806 if (filename.empty()) {
812 string const path = temppath();
814 FileName const fname(addName(temppath(),
815 onlyFileName(changeExtension(filename,
818 // FIXME: how do we know this is the name of the build log?
819 FileName const bname(
820 addName(path, onlyFileName(
821 changeExtension(filename,
822 theFormats().extension(params().bufferFormat()) + ".out"))));
824 // Also consider the master buffer log file
825 FileName masterfname = fname;
826 LogType mtype = latexlog;
827 if (masterBuffer() != this) {
828 string const mlogfile = masterBuffer()->logName(&mtype);
829 masterfname = FileName(mlogfile);
832 // If no Latex log or Build log is newer, show Build log
833 if (bname.exists() &&
834 ((!fname.exists() && !masterfname.exists())
835 || (fname.lastModified() < bname.lastModified()
836 && masterfname.lastModified() < bname.lastModified()))) {
837 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
840 return bname.absFileName();
841 // If we have a newer master file log or only a master log, show this
842 } else if (fname != masterfname
843 && (!fname.exists() && (masterfname.exists()
844 || fname.lastModified() < masterfname.lastModified()))) {
845 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
848 return masterfname.absFileName();
850 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
853 return fname.absFileName();
857 void Buffer::setReadonly(bool const flag)
859 if (d->read_only != flag) {
866 void Buffer::setFileName(FileName const & fname)
868 bool const changed = fname != d->filename;
870 d->refreshFileMonitor();
872 lyxvc().file_found_hook(fname);
873 setReadonly(d->filename.isReadOnly());
879 int Buffer::readHeader(Lexer & lex)
881 int unknown_tokens = 0;
883 int begin_header_line = -1;
885 // Initialize parameters that may be/go lacking in header:
886 params().branchlist().clear();
887 params().preamble.erase();
888 params().options.erase();
889 params().master.erase();
890 params().float_placement.erase();
891 params().paperwidth.erase();
892 params().paperheight.erase();
893 params().leftmargin.erase();
894 params().rightmargin.erase();
895 params().topmargin.erase();
896 params().bottommargin.erase();
897 params().headheight.erase();
898 params().headsep.erase();
899 params().footskip.erase();
900 params().columnsep.erase();
901 params().fonts_cjk.erase();
902 params().listings_params.clear();
903 params().clearLayoutModules();
904 params().clearRemovedModules();
905 params().clearIncludedChildren();
906 params().pdfoptions().clear();
907 params().indiceslist().clear();
908 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
909 params().isbackgroundcolor = false;
910 params().fontcolor = RGBColor(0, 0, 0);
911 params().isfontcolor = false;
912 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
913 params().boxbgcolor = RGBColor(0xFF, 0, 0);
914 params().html_latex_start.clear();
915 params().html_latex_end.clear();
916 params().html_math_img_scale = 1.0;
917 params().output_sync_macro.erase();
918 params().setLocalLayout(docstring(), false);
919 params().setLocalLayout(docstring(), true);
920 params().biblio_opts.erase();
921 params().biblatex_bibstyle.erase();
922 params().biblatex_citestyle.erase();
923 params().multibib.erase();
925 for (int i = 0; i < 4; ++i) {
926 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
927 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
930 ErrorList & errorList = d->errorLists["Parse"];
939 if (token == "\\end_header")
943 if (token == "\\begin_header") {
944 begin_header_line = line;
948 LYXERR(Debug::PARSER, "Handling document header token: `"
951 string const result =
952 params().readToken(lex, token, d->filename.onlyPath());
953 if (!result.empty()) {
954 if (token == "\\textclass") {
955 d->layout_position = result;
958 docstring const s = bformat(_("Unknown token: "
962 errorList.push_back(ErrorItem(_("Document header error"), s));
966 if (begin_header_line) {
967 docstring const s = _("\\begin_header is missing");
968 errorList.push_back(ErrorItem(_("Document header error"), s));
971 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
973 params().makeDocumentClass();
975 return unknown_tokens;
980 // changed to be public and have one parameter
981 // Returns true if "\end_document" is not read (Asger)
982 bool Buffer::readDocument(Lexer & lex)
984 ErrorList & errorList = d->errorLists["Parse"];
987 // remove dummy empty par
988 paragraphs().clear();
990 if (!lex.checkFor("\\begin_document")) {
991 docstring const s = _("\\begin_document is missing");
992 errorList.push_back(ErrorItem(_("Document header error"), s));
997 if (params().output_changes) {
998 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
999 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1000 LaTeXFeatures::isAvailable("xcolor");
1002 if (!dvipost && !xcolorulem) {
1003 Alert::warning(_("Changes not shown in LaTeX output"),
1004 _("Changes will not be highlighted in LaTeX output, "
1005 "because neither dvipost nor xcolor/ulem are installed.\n"
1006 "Please install these packages or redefine "
1007 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1008 } else if (!xcolorulem) {
1009 Alert::warning(_("Changes not shown in LaTeX output"),
1010 _("Changes will not be highlighted in LaTeX output "
1011 "when using pdflatex, because xcolor and ulem are not installed.\n"
1012 "Please install both packages or redefine "
1013 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1017 if (!parent() && !params().master.empty()) {
1018 FileName const master_file = makeAbsPath(params().master,
1019 onlyPath(absFileName()));
1020 if (isLyXFileName(master_file.absFileName())) {
1022 checkAndLoadLyXFile(master_file, true);
1024 // necessary e.g. after a reload
1025 // to re-register the child (bug 5873)
1026 // FIXME: clean up updateMacros (here, only
1027 // child registering is needed).
1028 master->updateMacros();
1029 // set master as master buffer, but only
1030 // if we are a real child
1031 if (master->isChild(this))
1033 // if the master is not fully loaded
1034 // it is probably just loading this
1035 // child. No warning needed then.
1036 else if (master->isFullyLoaded())
1037 LYXERR0("The master '"
1039 << "' assigned to this document ("
1041 << ") does not include "
1042 "this document. Ignoring the master assignment.");
1047 // assure we have a default index
1048 params().indiceslist().addDefault(B_("Index"));
1051 if (FileName::isAbsolute(params().origin))
1052 d->old_position = params().origin;
1054 d->old_position = filePath();
1055 bool const res = text().read(lex, errorList, d->inset);
1056 d->old_position.clear();
1058 // inform parent buffer about local macros
1060 Buffer const * pbuf = parent();
1061 for (auto const & m : usermacros)
1062 pbuf->usermacros.insert(m);
1066 updateMacroInstances(InternalUpdate);
1071 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1073 Format const * fmt = theFormats().getFormat(format);
1076 // It is important to use the correct extension here, since some
1077 // converters create a wrong output file otherwise (e.g. html2latex)
1078 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1079 ofdocstream os(name.toFilesystemEncoding().c_str());
1080 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1081 bool const success = !(os << contents).fail();
1084 bool converted = false;
1086 params().compressed = false;
1088 // remove dummy empty par
1089 paragraphs().clear();
1091 converted = importFile(format, name, errorList);
1094 removeTempFile(name);
1099 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1101 if (!theConverters().isReachable(format, "lyx"))
1104 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1105 Converters::RetVal const retval =
1106 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1107 if (retval == Converters::SUCCESS) {
1108 bool const success = readFile(lyx) == ReadSuccess;
1109 removeTempFile(lyx);
1117 bool Buffer::readString(string const & s)
1119 params().compressed = false;
1122 istringstream is(s);
1124 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1125 FileName const fn = tempfile.name();
1128 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1130 if (success && file_format != LYX_FORMAT) {
1131 // We need to call lyx2lyx, so write the input to a file
1132 ofstream os(fn.toFilesystemEncoding().c_str());
1135 // lyxvc in readFile
1136 if (readFile(fn) != ReadSuccess)
1140 if (readDocument(lex))
1146 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1150 if (!lex.setFile(fname)) {
1151 Alert::error(_("File Not Found"),
1152 bformat(_("Unable to open file `%1$s'."),
1153 from_utf8(fn.absFileName())));
1154 return ReadFileNotFound;
1158 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1159 if (ret_plf != ReadSuccess)
1162 if (file_format != LYX_FORMAT) {
1164 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1165 if (ret_clf != ReadSuccess)
1167 ret_clf = readFile(tmpFile);
1168 if (ret_clf == ReadSuccess) {
1169 d->file_format = file_format;
1170 d->need_format_backup = true;
1175 // FIXME: InsetInfo needs to know whether the file is under VCS
1176 // during the parse process, so this has to be done before.
1177 lyxvc().file_found_hook(d->filename);
1179 if (readDocument(lex)) {
1180 Alert::error(_("Document format failure"),
1181 bformat(_("%1$s ended unexpectedly, which means"
1182 " that it is probably corrupted."),
1183 from_utf8(fn.absFileName())));
1184 return ReadDocumentFailure;
1187 d->file_fully_loaded = true;
1188 d->read_only = !d->filename.isWritable();
1189 params().compressed = theFormats().isZippedFile(d->filename);
1195 bool Buffer::isFullyLoaded() const
1197 return d->file_fully_loaded;
1201 void Buffer::setFullyLoaded(bool value)
1203 d->file_fully_loaded = value;
1207 bool Buffer::lastPreviewError() const
1209 return d->preview_error_;
1213 PreviewLoader * Buffer::loader() const
1215 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1217 if (!d->preview_loader_)
1218 d->preview_loader_ = new PreviewLoader(*this);
1219 return d->preview_loader_;
1223 void Buffer::removePreviews() const
1225 delete d->preview_loader_;
1226 d->preview_loader_ = 0;
1230 void Buffer::updatePreviews() const
1232 PreviewLoader * ploader = loader();
1236 InsetIterator it = inset_iterator_begin(*d->inset);
1237 InsetIterator const end = inset_iterator_end(*d->inset);
1238 for (; it != end; ++it)
1239 it->addPreview(it, *ploader);
1241 ploader->startLoading();
1245 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1246 FileName const & fn, int & file_format) const
1248 if(!lex.checkFor("\\lyxformat")) {
1249 Alert::error(_("Document format failure"),
1250 bformat(_("%1$s is not a readable LyX document."),
1251 from_utf8(fn.absFileName())));
1252 return ReadNoLyXFormat;
1258 // LyX formats 217 and earlier were written as 2.17. This corresponds
1259 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1260 // these cases. See also: www.lyx.org/trac/changeset/1313.
1261 size_t dot = tmp_format.find_first_of(".,");
1262 if (dot != string::npos)
1263 tmp_format.erase(dot, 1);
1265 file_format = convert<int>(tmp_format);
1270 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1271 FileName & tmpfile, int from_format)
1273 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1274 tempfile.setAutoRemove(false);
1275 tmpfile = tempfile.name();
1276 if(tmpfile.empty()) {
1277 Alert::error(_("Conversion failed"),
1278 bformat(_("%1$s is from a different"
1279 " version of LyX, but a temporary"
1280 " file for converting it could"
1281 " not be created."),
1282 from_utf8(fn.absFileName())));
1283 return LyX2LyXNoTempFile;
1286 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1287 if (lyx2lyx.empty()) {
1288 Alert::error(_("Conversion script not found"),
1289 bformat(_("%1$s is from a different"
1290 " version of LyX, but the"
1291 " conversion script lyx2lyx"
1292 " could not be found."),
1293 from_utf8(fn.absFileName())));
1294 return LyX2LyXNotFound;
1298 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1299 ostringstream command;
1300 command << os::python()
1301 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1302 << " -t " << convert<string>(LYX_FORMAT)
1303 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1304 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1305 string const command_str = command.str();
1307 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1309 cmd_ret const ret = runCommand(command_str);
1310 if (ret.first != 0) {
1311 if (from_format < LYX_FORMAT) {
1312 Alert::error(_("Conversion script failed"),
1313 bformat(_("%1$s is from an older version"
1314 " of LyX and the lyx2lyx script"
1315 " failed to convert it."),
1316 from_utf8(fn.absFileName())));
1317 return LyX2LyXOlderFormat;
1319 Alert::error(_("Conversion script failed"),
1320 bformat(_("%1$s is from a newer version"
1321 " of LyX and the lyx2lyx script"
1322 " failed to convert it."),
1323 from_utf8(fn.absFileName())));
1324 return LyX2LyXNewerFormat;
1331 FileName Buffer::getBackupName() const {
1332 FileName const & fn = fileName();
1333 string const fname = fn.onlyFileNameWithoutExt();
1334 string const fext = fn.extension() + "~";
1335 string const fpath = lyxrc.backupdir_path.empty() ?
1336 fn.onlyPath().absFileName() :
1337 lyxrc.backupdir_path;
1338 string const fform = convert<string>(d->file_format);
1339 string const backname = fname + "-lyxformat-" + fform;
1340 FileName backup(addName(fpath, addExtension(backname, fext)));
1342 // limit recursion, just in case
1344 unsigned long orig_checksum = 0;
1345 while (backup.exists() && v < 100) {
1346 if (orig_checksum == 0)
1347 orig_checksum = fn.checksum();
1348 unsigned long new_checksum = backup.checksum();
1349 if (orig_checksum == new_checksum) {
1350 LYXERR(Debug::FILES, "Not backing up " << fn <<
1351 "since " << backup << "has the same checksum.");
1352 // a bit of a hack, but we have to check this anyway
1353 // below, and setting this is simpler than introducing
1354 // a special boolean for this purpose.
1358 string const newbackname = backname + "-" + convert<string>(v);
1359 backup.set(addName(fpath, addExtension(newbackname, fext)));
1362 return v < 100 ? backup : FileName();
1366 // Should probably be moved to somewhere else: BufferView? GuiView?
1367 bool Buffer::save() const
1369 docstring const file = makeDisplayPath(absFileName(), 20);
1370 d->filename.refresh();
1372 // check the read-only status before moving the file as a backup
1373 if (d->filename.exists()) {
1374 bool const read_only = !d->filename.isWritable();
1376 Alert::warning(_("File is read-only"),
1377 bformat(_("The file %1$s cannot be written because it "
1378 "is marked as read-only."), file));
1383 // ask if the disk file has been externally modified (use checksum method)
1384 if (fileName().exists() && isChecksumModified()) {
1386 bformat(_("Document %1$s has been externally modified. "
1387 "Are you sure you want to overwrite this file?"), file);
1388 int const ret = Alert::prompt(_("Overwrite modified file?"),
1389 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1394 // We don't need autosaves in the immediate future. (Asger)
1395 resetAutosaveTimers();
1397 // if the file does not yet exist, none of the backup activity
1398 // that follows is necessary
1399 if (!fileName().exists()) {
1400 if (!writeFile(fileName()))
1406 // we first write the file to a new name, then move it to its
1407 // proper location once that has been done successfully. that
1408 // way we preserve the original file if something goes wrong.
1409 string const justname = fileName().onlyFileNameWithoutExt();
1410 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1411 justname + "-XXXXXX.lyx");
1412 bool const symlink = fileName().isSymLink();
1414 tempfile->setAutoRemove(false);
1416 FileName savefile(tempfile->name());
1417 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1418 if (!writeFile(savefile))
1421 // we will set this to false if we fail
1422 bool made_backup = true;
1424 FileName backupName;
1425 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1427 if (d->need_format_backup)
1428 backupName = getBackupName();
1430 // If we for some reason failed to find a backup name in case of
1431 // a format change, this will still set one. It's the best we can
1433 if (backupName.empty()) {
1434 backupName.set(fileName().absFileName() + "~");
1435 if (!lyxrc.backupdir_path.empty()) {
1436 string const mangledName =
1437 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1438 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1442 LYXERR(Debug::FILES, "Backing up original file to " <<
1443 backupName.absFileName());
1444 // Except file is symlink do not copy because of #6587.
1445 // Hard links have bad luck.
1446 made_backup = symlink ?
1447 fileName().copyTo(backupName):
1448 fileName().moveTo(backupName);
1451 Alert::error(_("Backup failure"),
1452 bformat(_("Cannot create backup file %1$s.\n"
1453 "Please check whether the directory exists and is writable."),
1454 from_utf8(backupName.absFileName())));
1455 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1456 } else if (d->need_format_backup) {
1457 // the original file has been backed up successfully, so we
1458 // will not need to do that again
1459 d->need_format_backup = false;
1463 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1464 // Only do this if tempfile is not in autoremove mode
1467 // If we have no symlink, we can simply rename the temp file.
1468 // Otherwise, we need to copy it so the symlink stays intact.
1469 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1470 savefile.moveTo(fileName()))
1472 // saveCheckSum() was already called by writeFile(), but the
1473 // time stamp is invalidated by copying/moving
1476 if (d->file_format != LYX_FORMAT)
1477 // the file associated with this buffer is now in the current format
1478 d->file_format = LYX_FORMAT;
1481 // else we saved the file, but failed to move it to the right location.
1483 if (needBackup && made_backup && !symlink) {
1484 // the original file was moved to some new location, so it will look
1485 // to the user as if it was deleted. (see bug #9234.) we could try
1486 // to restore it, but that would basically mean trying to do again
1487 // what we just failed to do. better to leave things as they are.
1488 Alert::error(_("Write failure"),
1489 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1490 "But LyX could not move it to:\n %2$s.\n"
1491 "Your original file has been backed up to:\n %3$s"),
1492 from_utf8(savefile.absFileName()),
1493 from_utf8(fileName().absFileName()),
1494 from_utf8(backupName.absFileName())));
1496 // either we did not try to make a backup, or else we tried and failed,
1497 // or else the original file was a symlink, in which case it was copied,
1498 // not moved. so the original file is intact.
1499 Alert::error(_("Write failure"),
1500 bformat(_("Cannot move saved file to:\n %1$s.\n"
1501 "But the file has successfully been saved as:\n %2$s."),
1502 from_utf8(fileName().absFileName()),
1503 from_utf8(savefile.absFileName())));
1509 bool Buffer::writeFile(FileName const & fname) const
1511 if (d->read_only && fname == d->filename)
1514 bool retval = false;
1516 docstring const str = bformat(_("Saving document %1$s..."),
1517 makeDisplayPath(fname.absFileName()));
1520 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1522 if (params().compressed) {
1523 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1524 retval = ofs && write(ofs);
1526 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1527 retval = ofs && write(ofs);
1531 message(str + _(" could not write file!"));
1536 // removeAutosaveFile();
1539 message(str + _(" done."));
1545 docstring Buffer::emergencyWrite()
1547 // No need to save if the buffer has not changed.
1551 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1553 docstring user_message = bformat(
1554 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1556 // We try to save three places:
1557 // 1) Same place as document. Unless it is an unnamed doc.
1559 string s = absFileName();
1562 if (writeFile(FileName(s))) {
1564 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1565 return user_message;
1567 user_message += " " + _("Save failed! Trying again...\n");
1571 // 2) In HOME directory.
1572 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1574 lyxerr << ' ' << s << endl;
1575 if (writeFile(FileName(s))) {
1577 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1578 return user_message;
1581 user_message += " " + _("Save failed! Trying yet again...\n");
1583 // 3) In "/tmp" directory.
1584 // MakeAbsPath to prepend the current
1585 // drive letter on OS/2
1586 s = addName(package().temp_dir().absFileName(), absFileName());
1588 lyxerr << ' ' << s << endl;
1589 if (writeFile(FileName(s))) {
1591 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1592 return user_message;
1595 user_message += " " + _("Save failed! Document is lost.");
1598 return user_message;
1602 bool Buffer::write(ostream & ofs) const
1605 // Use the standard "C" locale for file output.
1606 ofs.imbue(locale::classic());
1609 // The top of the file should not be written by params().
1611 // write out a comment in the top of the file
1612 // Important: Keep the version formatting in sync with lyx2lyx and
1613 // tex2lyx (bug 7951)
1614 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1615 << " created this file. For more info see https://www.lyx.org/\n"
1616 << "\\lyxformat " << LYX_FORMAT << "\n"
1617 << "\\begin_document\n";
1619 /// For each author, set 'used' to true if there is a change
1620 /// by this author in the document; otherwise set it to 'false'.
1621 for (Author const & a : params().authors())
1624 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1625 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1626 for ( ; it != end; ++it)
1627 it->checkAuthors(params().authors());
1629 // now write out the buffer parameters.
1630 ofs << "\\begin_header\n";
1631 params().writeFile(ofs, this);
1632 ofs << "\\end_header\n";
1635 ofs << "\n\\begin_body\n";
1637 ofs << "\n\\end_body\n";
1639 // Write marker that shows file is complete
1640 ofs << "\\end_document" << endl;
1642 // Shouldn't really be needed....
1645 // how to check if close went ok?
1646 // Following is an attempt... (BE 20001011)
1648 // good() returns false if any error occurred, including some
1649 // formatting error.
1650 // bad() returns true if something bad happened in the buffer,
1651 // which should include file system full errors.
1656 lyxerr << "File was not closed properly." << endl;
1663 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1664 string const & original_path,
1665 OutputParams const & runparams_in,
1666 OutputWhat output) const
1668 OutputParams runparams = runparams_in;
1670 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1671 // Check here, because the "flavor" is not known in BufferParams::encoding()
1672 // (power users can override this safety measure selecting "utf8-plain").
1673 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1674 && (runparams.encoding->name() != "utf8-plain"))
1675 runparams.encoding = encodings.fromLyXName("ascii");
1677 string const encoding = runparams.encoding->iconvName();
1678 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1681 try { ofs.reset(encoding); }
1682 catch (iconv_codecvt_facet_exception const & e) {
1683 lyxerr << "Caught iconv exception: " << e.what() << endl;
1684 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1685 "verify that the support software for your encoding (%1$s) is "
1686 "properly installed"), from_ascii(encoding)));
1689 if (!openFileWrite(ofs, fname))
1692 ErrorList & errorList = d->errorLists["Export"];
1694 ExportStatus status = ExportSuccess;
1697 // make sure we are ready to export
1698 // this needs to be done before we validate
1699 // FIXME Do we need to do this all the time? I.e., in children
1700 // of a master we are exporting?
1702 updateMacroInstances(OutputUpdate);
1704 ExportStatus retval;
1706 retval = writeLaTeXSource(os, original_path, runparams, output);
1707 if (retval == ExportKilled)
1708 return ExportKilled;
1710 catch (EncodingException const & e) {
1711 docstring const failed(1, e.failed_char);
1713 oss << "0x" << hex << e.failed_char << dec;
1714 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1715 docstring msg = bformat(_("Uncodable character '%1$s'"
1716 " (code point %2$s)"),
1717 failed, from_utf8(oss.str()));
1718 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1719 "representable in specific verbatim contexts.\n"
1720 "Changing the document encoding to utf8 could help."),
1721 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1723 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1724 " (code point %2$s)"),
1725 failed, from_utf8(oss.str()));
1726 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1727 "representable in the chosen encoding.\n"
1728 "Changing the document encoding to utf8 could help."),
1729 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1731 status = ExportError;
1733 catch (iconv_codecvt_facet_exception const & e) {
1734 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1736 status = ExportError;
1738 catch (exception const & e) {
1739 errorList.push_back(ErrorItem(_("conversion failed"),
1741 lyxerr << e.what() << endl;
1742 status = ExportError;
1745 lyxerr << "Caught some really weird exception..." << endl;
1749 d->texrow = move(os.texrow());
1753 status = ExportError;
1754 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1757 if (runparams_in.silent)
1765 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1766 string const & original_path,
1767 OutputParams const & runparams_in,
1768 OutputWhat output) const
1770 // The child documents, if any, shall be already loaded at this point.
1772 OutputParams runparams = runparams_in;
1774 // XeTeX with TeX fonts is only safe with ASCII encoding,
1775 // Check here, because the "flavor" is not known in BufferParams::encoding()
1776 // (power users can override this safety measure selecting "utf8-plain").
1777 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1778 && (runparams.encoding->name() != "utf8-plain"))
1779 runparams.encoding = encodings.fromLyXName("ascii");
1780 // FIXME: when only the current paragraph is shown, this is ignored
1781 // (or not reached) and characters encodable in the current
1782 // encoding are not converted to ASCII-representation.
1784 // If we are compiling a file standalone, even if this is the
1785 // child of some other buffer, let's cut the link here, so the
1786 // file is really independent and no concurring settings from
1787 // the master (e.g. branch state) interfere (see #8100).
1788 if (!runparams.is_child)
1789 d->ignore_parent = true;
1791 // Classify the unicode characters appearing in math insets
1792 BufferEncodings::initUnicodeMath(*this);
1794 // validate the buffer.
1795 LYXERR(Debug::LATEX, " Validating buffer...");
1796 LaTeXFeatures features(*this, params(), runparams);
1798 // This is only set once per document (in master)
1799 if (!runparams.is_child)
1800 runparams.use_polyglossia = features.usePolyglossia();
1801 LYXERR(Debug::LATEX, " Buffer validation done.");
1803 bool const output_preamble =
1804 output == FullSource || output == OnlyPreamble;
1805 bool const output_body =
1806 output == FullSource || output == OnlyBody;
1808 // The starting paragraph of the coming rows is the
1809 // first paragraph of the document. (Asger)
1810 if (output_preamble && runparams.nice) {
1811 os << "%% LyX " << lyx_version << " created this file. "
1812 "For more info, see https://www.lyx.org/.\n"
1813 "%% Do not edit unless you really know what "
1816 LYXERR(Debug::INFO, "lyx document header finished");
1818 // There are a few differences between nice LaTeX and usual files:
1819 // usual files have \batchmode and special input@path to allow
1820 // inclusion of figures specified by an explicitly relative path
1821 // (i.e., a path starting with './' or '../') with either \input or
1822 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1823 // input@path is set when the actual parameter original_path is set.
1824 // This is done for usual tex-file, but not for nice-latex-file.
1825 // (Matthias 250696)
1826 // Note that input@path is only needed for something the user does
1827 // in the preamble, included .tex files or ERT, files included by
1828 // LyX work without it.
1829 if (output_preamble) {
1830 if (!runparams.nice) {
1831 // code for usual, NOT nice-latex-file
1832 os << "\\batchmode\n"; // changed from \nonstopmode
1834 if (!original_path.empty()) {
1836 // We don't know the encoding of inputpath
1837 docstring const inputpath = from_utf8(original_path);
1838 docstring uncodable_glyphs;
1839 Encoding const * const enc = runparams.encoding;
1841 for (size_t n = 0; n < inputpath.size(); ++n) {
1842 if (!enc->encodable(inputpath[n])) {
1843 docstring const glyph(1, inputpath[n]);
1844 LYXERR0("Uncodable character '"
1846 << "' in input path!");
1847 uncodable_glyphs += glyph;
1852 // warn user if we found uncodable glyphs.
1853 if (!uncodable_glyphs.empty()) {
1854 frontend::Alert::warning(
1855 _("Uncodable character in file path"),
1857 _("The path of your document\n"
1859 "contains glyphs that are unknown "
1860 "in the current document encoding "
1861 "(namely %2$s). This may result in "
1862 "incomplete output, unless "
1863 "TEXINPUTS contains the document "
1864 "directory and you don't use "
1865 "explicitly relative paths (i.e., "
1866 "paths starting with './' or "
1867 "'../') in the preamble or in ERT."
1868 "\n\nIn case of problems, choose "
1869 "an appropriate document encoding\n"
1870 "(such as utf8) or change the "
1872 inputpath, uncodable_glyphs));
1875 latex_path(original_path);
1876 if (contains(docdir, '#')) {
1877 docdir = subst(docdir, "#", "\\#");
1878 os << "\\catcode`\\#=11"
1879 "\\def\\#{#}\\catcode`\\#=6\n";
1881 if (contains(docdir, '%')) {
1882 docdir = subst(docdir, "%", "\\%");
1883 os << "\\catcode`\\%=11"
1884 "\\def\\%{%}\\catcode`\\%=14\n";
1886 os << "\\makeatletter\n"
1887 << "\\def\\input@path{{"
1889 << "\\makeatother\n";
1893 // get parent macros (if this buffer has a parent) which will be
1894 // written at the document begin further down.
1895 MacroSet parentMacros;
1896 listParentMacros(parentMacros, features);
1898 // Write the preamble
1899 runparams.use_babel = params().writeLaTeX(os, features,
1900 d->filename.onlyPath());
1902 // Biblatex bibliographies are loaded here
1903 if (params().useBiblatex()) {
1904 vector<docstring> const bibfiles =
1905 prepareBibFilePaths(runparams, getBibfiles(), true);
1906 for (docstring const & file: bibfiles)
1907 os << "\\addbibresource{" << file << "}\n";
1910 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1911 && !features.hasOnlyPolyglossiaLanguages()) {
1914 vector<string> bll = features.getBabelExclusiveLanguages();
1915 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1918 for (string const & sit : bll) {
1923 blangs = bll.size() > 1 ?
1924 bformat(_("The languages %1$s are only supported by Babel."), langs)
1925 : bformat(_("The language %1$s is only supported by Babel."), langs);
1929 for (string const & pit : pll) {
1934 plangs = pll.size() > 1 ?
1935 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
1936 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
1937 if (!blangs.empty())
1941 frontend::Alert::warning(
1942 _("Incompatible Languages!"),
1944 _("You cannot use the following languages "
1945 "together in one LaTeX document because "
1946 "they require conflicting language packages:\n"
1951 // Japanese might be required only in some children of a document,
1952 // but once required, we must keep use_japanese true.
1953 runparams.use_japanese |= features.isRequired("japanese");
1956 // Restore the parenthood if needed
1957 if (!runparams.is_child)
1958 d->ignore_parent = false;
1959 return ExportSuccess;
1963 // mark the beginning of the body to separate it from InPreamble insets
1964 os.texrow().start(TexRow::beginDocument());
1965 os << "\\begin{document}\n";
1967 // mark the start of a new paragraph by simulating a newline,
1968 // so that os.afterParbreak() returns true at document start
1971 // output the parent macros
1972 for (auto const & mac : parentMacros) {
1973 int num_lines = mac->write(os.os(), true);
1974 os.texrow().newlines(num_lines);
1977 } // output_preamble
1979 LYXERR(Debug::INFO, "preamble finished, now the body.");
1983 latexParagraphs(*this, text(), os, runparams);
1985 catch (ConversionException const &) { return ExportKilled; }
1987 // Restore the parenthood if needed
1988 if (!runparams.is_child)
1989 d->ignore_parent = false;
1991 // add this just in case after all the paragraphs
1994 if (output_preamble) {
1995 os << "\\end{document}\n";
1996 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1998 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2000 runparams_in.encoding = runparams.encoding;
2002 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2003 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2004 return ExportSuccess;
2008 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2009 OutputParams const & runparams,
2010 OutputWhat output) const
2012 LYXERR(Debug::LATEX, "makeDocBookFile...");
2015 if (!openFileWrite(ofs, fname))
2018 // make sure we are ready to export
2019 // this needs to be done before we validate
2021 updateMacroInstances(OutputUpdate);
2023 ExportStatus const retval =
2024 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2025 if (retval == ExportKilled)
2026 return ExportKilled;
2030 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2031 return ExportSuccess;
2035 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2036 OutputParams const & runparams,
2037 OutputWhat output) const
2039 LaTeXFeatures features(*this, params(), runparams);
2044 DocumentClass const & tclass = params().documentClass();
2045 string const & top_element = tclass.latexname();
2047 bool const output_preamble =
2048 output == FullSource || output == OnlyPreamble;
2049 bool const output_body =
2050 output == FullSource || output == OnlyBody;
2052 if (output_preamble) {
2053 if (runparams.flavor == OutputParams::XML)
2054 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2057 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2060 if (! tclass.class_header().empty())
2061 os << from_ascii(tclass.class_header());
2062 else if (runparams.flavor == OutputParams::XML)
2063 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2064 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2066 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2068 docstring preamble = params().preamble;
2069 if (runparams.flavor != OutputParams::XML ) {
2070 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2071 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2072 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2073 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2076 string const name = runparams.nice
2077 ? changeExtension(absFileName(), ".sgml") : fname;
2078 preamble += features.getIncludedFiles(name);
2079 preamble += features.getLyXSGMLEntities();
2081 if (!preamble.empty()) {
2082 os << "\n [ " << preamble << " ]";
2088 string top = top_element;
2090 if (runparams.flavor == OutputParams::XML)
2091 top += params().language->code();
2093 top += params().language->code().substr(0, 2);
2096 if (!params().options.empty()) {
2098 top += params().options;
2101 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2102 << " file was created by LyX " << lyx_version
2103 << "\n See https://www.lyx.org/ for more information -->\n";
2105 params().documentClass().counters().reset();
2107 sgml::openTag(os, top);
2110 docbookParagraphs(text(), *this, os, runparams);
2112 catch (ConversionException const &) { return ExportKilled; }
2113 sgml::closeTag(os, top_element);
2115 return ExportSuccess;
2119 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2120 OutputParams const & runparams) const
2122 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2125 if (!openFileWrite(ofs, fname))
2128 // make sure we are ready to export
2129 // this has to be done before we validate
2130 updateBuffer(UpdateMaster, OutputUpdate);
2131 updateMacroInstances(OutputUpdate);
2133 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2134 if (retval == ExportKilled)
2139 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2144 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2145 OutputParams const & runparams,
2146 OutputWhat output) const
2148 LaTeXFeatures features(*this, params(), runparams);
2150 d->bibinfo_.makeCitationLabels(*this);
2152 bool const output_preamble =
2153 output == FullSource || output == OnlyPreamble;
2154 bool const output_body =
2155 output == FullSource || output == OnlyBody || output == IncludedFile;
2157 if (output_preamble) {
2158 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2159 << "<!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"
2160 // FIXME Language should be set properly.
2161 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2163 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2164 // FIXME Presumably need to set this right
2165 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2167 docstring const & doctitle = features.htmlTitle();
2169 << (doctitle.empty() ?
2170 from_ascii("LyX Document") :
2171 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2174 docstring styles = features.getTClassHTMLPreamble();
2175 if (!styles.empty())
2176 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2178 styles = features.getPreambleSnippets().str;
2179 if (!styles.empty())
2180 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2182 // we will collect CSS information in a stream, and then output it
2183 // either here, as part of the header, or else in a separate file.
2184 odocstringstream css;
2185 styles = features.getCSSSnippets();
2186 if (!styles.empty())
2187 css << "/* LyX Provided Styles */\n" << styles << '\n';
2189 styles = features.getTClassHTMLStyles();
2190 if (!styles.empty())
2191 css << "/* Layout-provided Styles */\n" << styles << '\n';
2193 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2194 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2195 if (needfg || needbg) {
2196 css << "\nbody {\n";
2199 << from_ascii(X11hexname(params().fontcolor))
2202 css << " background-color: "
2203 << from_ascii(X11hexname(params().backgroundcolor))
2208 docstring const dstyles = css.str();
2209 if (!dstyles.empty()) {
2210 bool written = false;
2211 if (params().html_css_as_file) {
2212 // open a file for CSS info
2214 string const fcssname = addName(temppath(), "docstyle.css");
2215 FileName const fcssfile = FileName(fcssname);
2216 if (openFileWrite(ocss, fcssfile)) {
2220 // write link to header
2221 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2223 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2226 // we are here if the CSS is supposed to be written to the header
2227 // or if we failed to write it to an external file.
2229 os << "<style type='text/css'>\n"
2238 bool const output_body_tag = (output != IncludedFile);
2239 if (output_body_tag)
2240 os << "<body dir=\"auto\">\n";
2242 if (output != IncludedFile)
2243 // if we're an included file, the counters are in the master.
2244 params().documentClass().counters().reset();
2246 xhtmlParagraphs(text(), *this, xs, runparams);
2248 catch (ConversionException const &) { return ExportKilled; }
2249 if (output_body_tag)
2253 if (output_preamble)
2256 return ExportSuccess;
2260 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2261 // Other flags: -wall -v0 -x
2262 int Buffer::runChktex()
2266 // get LaTeX-Filename
2267 FileName const path(temppath());
2268 string const name = addName(path.absFileName(), latexName());
2269 string const org_path = filePath();
2271 PathChanger p(path); // path to LaTeX file
2272 message(_("Running chktex..."));
2274 // Generate the LaTeX file if neccessary
2275 OutputParams runparams(¶ms().encoding());
2276 runparams.flavor = OutputParams::LATEX;
2277 runparams.nice = false;
2278 runparams.linelen = lyxrc.plaintext_linelen;
2279 ExportStatus const retval =
2280 makeLaTeXFile(FileName(name), org_path, runparams);
2281 if (retval != ExportSuccess) {
2282 // error code on failure
2287 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2288 int const res = chktex.run(terr); // run chktex
2291 Alert::error(_("chktex failure"),
2292 _("Could not run chktex successfully."));
2294 ErrorList & errlist = d->errorLists["ChkTeX"];
2296 bufferErrors(terr, errlist);
2301 if (runparams.silent)
2302 d->errorLists["ChkTeX"].clear();
2310 void Buffer::validate(LaTeXFeatures & features) const
2312 // Validate the buffer params, but not for included
2313 // files, since they also use the parent buffer's
2315 if (!features.runparams().is_child)
2316 params().validate(features);
2318 for (Paragraph const & p : paragraphs())
2319 p.validate(features);
2321 if (lyxerr.debugging(Debug::LATEX)) {
2322 features.showStruct();
2327 void Buffer::getLabelList(vector<docstring> & list) const
2329 // If this is a child document, use the master's list instead.
2331 masterBuffer()->getLabelList(list);
2336 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2337 for (auto const & tocit : *toc) {
2338 if (tocit.depth() == 0)
2339 list.push_back(tocit.str());
2344 void Buffer::invalidateBibinfoCache() const
2346 d->bibinfo_cache_valid_ = false;
2347 d->cite_labels_valid_ = false;
2348 removeBiblioTempFiles();
2349 // also invalidate the cache for the parent buffer
2350 Buffer const * const pbuf = d->parent();
2352 pbuf->invalidateBibinfoCache();
2356 FileNamePairList const & Buffer::getBibfiles(UpdateScope scope) const
2358 // FIXME This is probably unnecessary, given where we call this.
2359 // If this is a child document, use the master instead.
2360 Buffer const * const pbuf = masterBuffer();
2361 if (pbuf != this && scope != UpdateChildOnly)
2362 return pbuf->getBibfiles();
2363 return d->bibfiles_cache_;
2367 BiblioInfo const & Buffer::masterBibInfo() const
2369 Buffer const * const tmp = masterBuffer();
2371 return tmp->masterBibInfo();
2376 BiblioInfo const & Buffer::bibInfo() const
2382 void Buffer::registerBibfiles(FileNamePairList const & bf) const {
2383 // We register the bib files in the master buffer,
2384 // if there is one, but also in every single buffer,
2385 // in case a child is compiled alone.
2386 Buffer const * const tmp = masterBuffer();
2388 tmp->registerBibfiles(bf);
2390 for (auto const & p : bf) {
2391 FileNamePairList::const_iterator temp =
2392 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2393 if (temp == d->bibfiles_cache_.end())
2394 d->bibfiles_cache_.push_back(p);
2399 void Buffer::checkIfBibInfoCacheIsValid() const
2401 // use the master's cache
2402 Buffer const * const tmp = masterBuffer();
2404 tmp->checkIfBibInfoCacheIsValid();
2408 // if we already know the cache is invalid, no need to check
2410 if (!d->bibinfo_cache_valid_)
2413 // compare the cached timestamps with the actual ones.
2414 FileNamePairList const & bibfiles_cache = getBibfiles();
2415 FileNamePairList::const_iterator ei = bibfiles_cache.begin();
2416 FileNamePairList::const_iterator en = bibfiles_cache.end();
2417 for (; ei != en; ++ ei) {
2418 FileName const fn = ei->second;
2419 time_t lastw = fn.lastModified();
2420 time_t prevw = d->bibfile_status_[fn];
2421 if (lastw != prevw) {
2422 d->bibinfo_cache_valid_ = false;
2423 d->cite_labels_valid_ = false;
2424 d->bibfile_status_[fn] = lastw;
2430 void Buffer::reloadBibInfoCache() const
2432 // use the master's cache
2433 Buffer const * const tmp = masterBuffer();
2435 tmp->reloadBibInfoCache();
2439 checkIfBibInfoCacheIsValid();
2440 if (d->bibinfo_cache_valid_)
2443 d->bibinfo_.clear();
2444 FileNameList checkedFiles;
2445 collectBibKeys(checkedFiles);
2446 d->bibinfo_cache_valid_ = true;
2450 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2452 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2453 it->collectBibKeys(it, checkedFiles);
2457 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2459 // We add the biblio info to the master buffer,
2460 // if there is one, but also to every single buffer,
2461 // in case a child is compiled alone.
2462 BiblioInfo & bi = d->bibinfo_;
2463 bi.mergeBiblioInfo(bin);
2465 if (parent() != 0) {
2466 BiblioInfo & masterbi = parent()->d->bibinfo_;
2467 masterbi.mergeBiblioInfo(bin);
2472 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2474 // We add the bibtex info to the master buffer,
2475 // if there is one, but also to every single buffer,
2476 // in case a child is compiled alone.
2477 BiblioInfo & bi = d->bibinfo_;
2480 if (parent() != 0) {
2481 BiblioInfo & masterbi = parent()->d->bibinfo_;
2482 masterbi[key] = bin;
2487 void Buffer::makeCitationLabels() const
2489 Buffer const * const master = masterBuffer();
2490 return d->bibinfo_.makeCitationLabels(*master);
2494 void Buffer::invalidateCiteLabels() const
2496 masterBuffer()->d->cite_labels_valid_ = false;
2499 bool Buffer::citeLabelsValid() const
2501 return masterBuffer()->d->cite_labels_valid_;
2505 void Buffer::removeBiblioTempFiles() const
2507 // We remove files that contain LaTeX commands specific to the
2508 // particular bibliographic style being used, in order to avoid
2509 // LaTeX errors when we switch style.
2510 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2511 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2512 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2513 aux_file.removeFile();
2514 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2515 bbl_file.removeFile();
2516 // Also for the parent buffer
2517 Buffer const * const pbuf = parent();
2519 pbuf->removeBiblioTempFiles();
2523 bool Buffer::isDepClean(string const & name) const
2525 DepClean::const_iterator const it = d->dep_clean.find(name);
2526 if (it == d->dep_clean.end())
2532 void Buffer::markDepClean(string const & name)
2534 d->dep_clean[name] = true;
2538 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2541 // FIXME? if there is an Buffer LFUN that can be dispatched even
2542 // if internal, put a switch '(cmd.action)' here.
2548 switch (cmd.action()) {
2550 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2551 flag.setOnOff(hasReadonlyFlag());
2554 // FIXME: There is need for a command-line import.
2555 //case LFUN_BUFFER_IMPORT:
2557 case LFUN_BUFFER_AUTO_SAVE:
2560 case LFUN_BUFFER_EXPORT_CUSTOM:
2561 // FIXME: Nothing to check here?
2564 case LFUN_BUFFER_EXPORT: {
2565 docstring const arg = cmd.argument();
2566 if (arg == "custom") {
2570 string format = (arg.empty() || arg == "default") ?
2571 params().getDefaultOutputFormat() : to_utf8(arg);
2572 size_t pos = format.find(' ');
2573 if (pos != string::npos)
2574 format = format.substr(0, pos);
2575 enable = params().isExportable(format, false);
2577 flag.message(bformat(
2578 _("Don't know how to export to format: %1$s"), arg));
2582 case LFUN_BUILD_PROGRAM:
2583 enable = params().isExportable("program", false);
2586 case LFUN_BRANCH_ACTIVATE:
2587 case LFUN_BRANCH_DEACTIVATE:
2588 case LFUN_BRANCH_MASTER_ACTIVATE:
2589 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2590 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2591 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2592 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2593 : params().branchlist();
2594 docstring const branchName = cmd.argument();
2595 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2599 case LFUN_BRANCH_ADD:
2600 case LFUN_BRANCHES_RENAME:
2601 // if no Buffer is present, then of course we won't be called!
2604 case LFUN_BUFFER_LANGUAGE:
2605 enable = !isReadonly();
2608 case LFUN_BUFFER_VIEW_CACHE:
2609 (d->preview_file_).refresh();
2610 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2613 case LFUN_CHANGES_TRACK:
2614 flag.setEnabled(true);
2615 flag.setOnOff(params().track_changes);
2618 case LFUN_CHANGES_OUTPUT:
2619 flag.setEnabled(true);
2620 flag.setOnOff(params().output_changes);
2623 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2624 flag.setOnOff(params().compressed);
2627 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2628 flag.setOnOff(params().output_sync);
2631 case LFUN_BUFFER_ANONYMIZE:
2637 flag.setEnabled(enable);
2642 void Buffer::dispatch(string const & command, DispatchResult & result)
2644 return dispatch(lyxaction.lookupFunc(command), result);
2648 // NOTE We can end up here even if we have no GUI, because we are called
2649 // by LyX::exec to handled command-line requests. So we may need to check
2650 // whether we have a GUI or not. The boolean use_gui holds this information.
2651 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2654 // FIXME? if there is an Buffer LFUN that can be dispatched even
2655 // if internal, put a switch '(cmd.action())' here.
2656 dr.dispatched(false);
2659 string const argument = to_utf8(func.argument());
2660 // We'll set this back to false if need be.
2661 bool dispatched = true;
2662 // This handles undo groups automagically
2663 UndoGroupHelper ugh(this);
2665 switch (func.action()) {
2666 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2667 if (lyxvc().inUse()) {
2668 string log = lyxvc().toggleReadOnly();
2673 setReadonly(!hasReadonlyFlag());
2676 case LFUN_BUFFER_EXPORT: {
2677 string const format = (argument.empty() || argument == "default") ?
2678 params().getDefaultOutputFormat() : argument;
2679 ExportStatus const status = doExport(format, false);
2680 dr.setError(status != ExportSuccess);
2681 if (status != ExportSuccess)
2682 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2683 from_utf8(format)));
2687 case LFUN_BUILD_PROGRAM: {
2688 ExportStatus const status = doExport("program", true);
2689 dr.setError(status != ExportSuccess);
2690 if (status != ExportSuccess)
2691 dr.setMessage(_("Error generating literate programming code."));
2695 case LFUN_BUFFER_EXPORT_CUSTOM: {
2697 string command = split(argument, format_name, ' ');
2698 Format const * format = theFormats().getFormat(format_name);
2700 lyxerr << "Format \"" << format_name
2701 << "\" not recognized!"
2706 // The name of the file created by the conversion process
2709 // Output to filename
2710 if (format->name() == "lyx") {
2711 string const latexname = latexName(false);
2712 filename = changeExtension(latexname,
2713 format->extension());
2714 filename = addName(temppath(), filename);
2716 if (!writeFile(FileName(filename)))
2720 doExport(format_name, true, filename);
2723 // Substitute $$FName for filename
2724 if (!contains(command, "$$FName"))
2725 command = "( " + command + " ) < $$FName";
2726 command = subst(command, "$$FName", filename);
2728 // Execute the command in the background
2730 call.startscript(Systemcall::DontWait, command,
2731 filePath(), layoutPos());
2735 // FIXME: There is need for a command-line import.
2737 case LFUN_BUFFER_IMPORT:
2742 case LFUN_BUFFER_AUTO_SAVE:
2744 resetAutosaveTimers();
2747 case LFUN_BRANCH_ACTIVATE:
2748 case LFUN_BRANCH_DEACTIVATE:
2749 case LFUN_BRANCH_MASTER_ACTIVATE:
2750 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2751 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2752 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2753 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2756 docstring const branch_name = func.argument();
2757 // the case without a branch name is handled elsewhere
2758 if (branch_name.empty()) {
2762 Branch * branch = buf->params().branchlist().find(branch_name);
2764 LYXERR0("Branch " << branch_name << " does not exist.");
2766 docstring const msg =
2767 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2771 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2772 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2773 if (branch->isSelected() != activate) {
2774 buf->undo().recordUndoBufferParams(CursorData());
2775 branch->setSelected(activate);
2777 dr.screenUpdate(Update::Force);
2778 dr.forceBufferUpdate();
2783 case LFUN_BRANCH_ADD: {
2784 docstring branchnames = func.argument();
2785 if (branchnames.empty()) {
2789 BranchList & branch_list = params().branchlist();
2790 vector<docstring> const branches =
2791 getVectorFromString(branchnames, branch_list.separator());
2793 for (docstring const & branch_name : branches) {
2794 Branch * branch = branch_list.find(branch_name);
2796 LYXERR0("Branch " << branch_name << " already exists.");
2800 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2802 undo().recordUndoBufferParams(CursorData());
2803 branch_list.add(branch_name);
2804 branch = branch_list.find(branch_name);
2805 string const x11hexname = X11hexname(branch->color());
2806 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2807 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2809 dr.screenUpdate(Update::Force);
2817 case LFUN_BRANCHES_RENAME: {
2818 if (func.argument().empty())
2821 docstring const oldname = from_utf8(func.getArg(0));
2822 docstring const newname = from_utf8(func.getArg(1));
2823 InsetIterator it = inset_iterator_begin(inset());
2824 InsetIterator const end = inset_iterator_end(inset());
2825 bool success = false;
2826 for (; it != end; ++it) {
2827 if (it->lyxCode() == BRANCH_CODE) {
2828 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2829 if (ins.branch() == oldname) {
2830 undo().recordUndo(CursorData(it));
2831 ins.rename(newname);
2836 if (it->lyxCode() == INCLUDE_CODE) {
2837 // get buffer of external file
2838 InsetInclude const & ins =
2839 static_cast<InsetInclude const &>(*it);
2840 Buffer * child = ins.getChildBuffer();
2843 child->dispatch(func, dr);
2848 dr.screenUpdate(Update::Force);
2849 dr.forceBufferUpdate();
2854 case LFUN_BUFFER_VIEW_CACHE:
2855 if (!theFormats().view(*this, d->preview_file_,
2856 d->preview_format_))
2857 dr.setMessage(_("Error viewing the output file."));
2860 case LFUN_CHANGES_TRACK:
2861 if (params().save_transient_properties)
2862 undo().recordUndoBufferParams(CursorData());
2863 params().track_changes = !params().track_changes;
2864 if (!params().track_changes)
2865 dr.forceChangesUpdate();
2868 case LFUN_CHANGES_OUTPUT:
2869 if (params().save_transient_properties)
2870 undo().recordUndoBufferParams(CursorData());
2871 params().output_changes = !params().output_changes;
2872 if (params().output_changes) {
2873 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2874 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2875 LaTeXFeatures::isAvailable("xcolor");
2877 if (!dvipost && !xcolorulem) {
2878 Alert::warning(_("Changes not shown in LaTeX output"),
2879 _("Changes will not be highlighted in LaTeX output, "
2880 "because neither dvipost nor xcolor/ulem are installed.\n"
2881 "Please install these packages or redefine "
2882 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2883 } else if (!xcolorulem) {
2884 Alert::warning(_("Changes not shown in LaTeX output"),
2885 _("Changes will not be highlighted in LaTeX output "
2886 "when using pdflatex, because xcolor and ulem are not installed.\n"
2887 "Please install both packages or redefine "
2888 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2893 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2894 // turn compression on/off
2895 undo().recordUndoBufferParams(CursorData());
2896 params().compressed = !params().compressed;
2899 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2900 undo().recordUndoBufferParams(CursorData());
2901 params().output_sync = !params().output_sync;
2904 case LFUN_BUFFER_ANONYMIZE: {
2905 undo().recordUndoFullBuffer(CursorData());
2906 CursorData cur(doc_iterator_begin(this));
2907 for ( ; cur ; cur.forwardPar())
2908 cur.paragraph().anonymize();
2909 dr.forceBufferUpdate();
2917 dr.dispatched(dispatched);
2921 void Buffer::changeLanguage(Language const * from, Language const * to)
2923 LASSERT(from, return);
2924 LASSERT(to, return);
2926 for_each(par_iterator_begin(),
2928 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2932 bool Buffer::isMultiLingual() const
2934 ParConstIterator end = par_iterator_end();
2935 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2936 if (it->isMultiLingual(params()))
2943 std::set<Language const *> Buffer::getLanguages() const
2945 std::set<Language const *> langs;
2946 getLanguages(langs);
2951 void Buffer::getLanguages(std::set<Language const *> & langs) const
2953 ParConstIterator end = par_iterator_end();
2954 // add the buffer language, even if it's not actively used
2955 langs.insert(language());
2956 // iterate over the paragraphs
2957 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2958 it->getLanguages(langs);
2960 ListOfBuffers clist = getDescendents();
2961 for (auto const & cit : clist)
2962 cit->getLanguages(langs);
2966 DocIterator Buffer::getParFromID(int const id) const
2968 Buffer * buf = const_cast<Buffer *>(this);
2970 // This means non-existent
2971 return doc_iterator_end(buf);
2973 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2974 if (it.paragraph().id() == id)
2977 return doc_iterator_end(buf);
2981 bool Buffer::hasParWithID(int const id) const
2983 return !getParFromID(id).atEnd();
2987 ParIterator Buffer::par_iterator_begin()
2989 return ParIterator(doc_iterator_begin(this));
2993 ParIterator Buffer::par_iterator_end()
2995 return ParIterator(doc_iterator_end(this));
2999 ParConstIterator Buffer::par_iterator_begin() const
3001 return ParConstIterator(doc_iterator_begin(this));
3005 ParConstIterator Buffer::par_iterator_end() const
3007 return ParConstIterator(doc_iterator_end(this));
3011 Language const * Buffer::language() const
3013 return params().language;
3017 docstring const Buffer::B_(string const & l10n) const
3019 return params().B_(l10n);
3023 bool Buffer::isClean() const
3025 return d->lyx_clean;
3029 bool Buffer::isChecksumModified() const
3031 LASSERT(d->filename.exists(), return false);
3032 return d->checksum_ != d->filename.checksum();
3036 void Buffer::saveCheckSum() const
3038 FileName const & file = d->filename;
3040 d->checksum_ = file.exists() ? file.checksum()
3041 : 0; // in the case of save to a new file.
3045 void Buffer::markClean() const
3047 if (!d->lyx_clean) {
3048 d->lyx_clean = true;
3051 // if the .lyx file has been saved, we don't need an
3053 d->bak_clean = true;
3054 d->undo_.markDirty();
3055 clearExternalModification();
3059 void Buffer::setUnnamed(bool flag)
3065 bool Buffer::isUnnamed() const
3072 /// Don't check unnamed, here: isInternal() is used in
3073 /// newBuffer(), where the unnamed flag has not been set by anyone
3074 /// yet. Also, for an internal buffer, there should be no need for
3075 /// retrieving fileName() nor for checking if it is unnamed or not.
3076 bool Buffer::isInternal() const
3078 return d->internal_buffer;
3082 void Buffer::setInternal(bool flag)
3084 d->internal_buffer = flag;
3088 void Buffer::markDirty()
3091 d->lyx_clean = false;
3094 d->bak_clean = false;
3096 for (auto & depit : d->dep_clean)
3097 depit.second = false;
3101 FileName Buffer::fileName() const
3107 string Buffer::absFileName() const
3109 return d->filename.absFileName();
3113 string Buffer::filePath() const
3115 string const abs = d->filename.onlyPath().absFileName();
3118 int last = abs.length() - 1;
3120 return abs[last] == '/' ? abs : abs + '/';
3124 DocFileName Buffer::getReferencedFileName(string const & fn) const
3127 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3128 result.set(fn, filePath());
3130 // filePath() ends with a path separator
3131 FileName const test(filePath() + fn);
3133 result.set(fn, filePath());
3135 result.set(fn, params().origin);
3142 string const Buffer::prepareFileNameForLaTeX(string const & name,
3143 string const & ext, bool nice) const
3145 string const fname = makeAbsPath(name, filePath()).absFileName();
3146 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3152 return to_utf8(makeRelPath(from_utf8(fname),
3153 from_utf8(masterBuffer()->filePath())));
3157 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3158 FileNamePairList const bibfilelist,
3159 bool const add_extension) const
3161 // If we are processing the LaTeX file in a temp directory then
3162 // copy the .bib databases to this temp directory, mangling their
3163 // names in the process. Store this mangled name in the list of
3165 // (We need to do all this because BibTeX *really*, *really*
3166 // can't handle "files with spaces" and Windows users tend to
3167 // use such filenames.)
3168 // Otherwise, store the (maybe absolute) path to the original,
3169 // unmangled database name.
3171 vector<docstring> res;
3173 // determine the export format
3174 string const tex_format = flavor2format(runparams.flavor);
3176 // check for spaces in paths
3177 bool found_space = false;
3179 for (auto const & bit : bibfilelist) {
3180 string utf8input = to_utf8(bit.first);
3182 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3183 FileName try_in_file =
3184 makeAbsPath(database + ".bib", filePath());
3185 bool not_from_texmf = try_in_file.isReadableFile();
3186 // If the file has not been found, try with the real file name
3187 // (it might come from a child in a sub-directory)
3188 if (!not_from_texmf) {
3189 try_in_file = bit.second;
3190 if (try_in_file.isReadableFile()) {
3191 // Check if the file is in texmf
3192 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3193 not_from_texmf = kpsefile.empty()
3194 || kpsefile.absFileName() != try_in_file.absFileName();
3196 // If this exists, make path relative to the master
3199 removeExtension(prepareFileNameForLaTeX(
3200 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3201 from_utf8(filePath()))),
3202 ".bib", runparams.nice));
3206 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3208 // mangledFileName() needs the extension
3209 DocFileName const in_file = DocFileName(try_in_file);
3210 database = removeExtension(in_file.mangledFileName());
3211 FileName const out_file = makeAbsPath(database + ".bib",
3212 masterBuffer()->temppath());
3213 bool const success = in_file.copyTo(out_file);
3215 LYXERR0("Failed to copy '" << in_file
3216 << "' to '" << out_file << "'");
3218 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3219 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3220 if (!isValidLaTeXFileName(database)) {
3221 frontend::Alert::warning(_("Invalid filename"),
3222 _("The following filename will cause troubles "
3223 "when running the exported file through LaTeX: ") +
3224 from_utf8(database));
3226 if (!isValidDVIFileName(database)) {
3227 frontend::Alert::warning(_("Problematic filename for DVI"),
3228 _("The following filename can cause troubles "
3229 "when running the exported file through LaTeX "
3230 "and opening the resulting DVI: ") +
3231 from_utf8(database), true);
3239 docstring const path = from_utf8(latex_path(database));
3241 if (contains(path, ' '))
3244 if (find(res.begin(), res.end(), path) == res.end())
3245 res.push_back(path);
3248 // Check if there are spaces in the path and warn BibTeX users, if so.
3249 // (biber can cope with such paths)
3250 if (!prefixIs(runparams.bibtex_command, "biber")) {
3251 // Post this warning only once.
3252 static bool warned_about_spaces = false;
3253 if (!warned_about_spaces &&
3254 runparams.nice && found_space) {
3255 warned_about_spaces = true;
3256 Alert::warning(_("Export Warning!"),
3257 _("There are spaces in the paths to your BibTeX databases.\n"
3258 "BibTeX will be unable to find them."));
3267 string Buffer::layoutPos() const
3269 return d->layout_position;
3273 void Buffer::setLayoutPos(string const & path)
3276 d->layout_position.clear();
3280 LATTEST(FileName::isAbsolute(path));
3282 d->layout_position =
3283 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3285 if (d->layout_position.empty())
3286 d->layout_position = ".";
3290 bool Buffer::hasReadonlyFlag() const
3292 return d->read_only;
3296 bool Buffer::isReadonly() const
3298 return hasReadonlyFlag() || notifiesExternalModification();
3302 void Buffer::setParent(Buffer const * buffer)
3304 // Avoids recursive include.
3305 d->setParent(buffer == this ? 0 : buffer);
3310 Buffer const * Buffer::parent() const
3316 ListOfBuffers Buffer::allRelatives() const
3318 ListOfBuffers lb = masterBuffer()->getDescendents();
3319 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3324 Buffer const * Buffer::masterBuffer() const
3326 // FIXME Should be make sure we are not in some kind
3327 // of recursive include? A -> B -> A will crash this.
3328 Buffer const * const pbuf = d->parent();
3332 return pbuf->masterBuffer();
3336 bool Buffer::isChild(Buffer * child) const
3338 return d->children_positions.find(child) != d->children_positions.end();
3342 DocIterator Buffer::firstChildPosition(Buffer const * child)
3344 Impl::BufferPositionMap::iterator it;
3345 it = d->children_positions.find(child);
3346 if (it == d->children_positions.end())
3347 return DocIterator(this);
3352 bool Buffer::hasChildren() const
3354 return !d->children_positions.empty();
3358 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3360 // loop over children
3361 for (auto const & p : d->children_positions) {
3362 Buffer * child = const_cast<Buffer *>(p.first);
3364 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3365 if (bit != clist.end())
3367 clist.push_back(child);
3369 // there might be grandchildren
3370 child->collectChildren(clist, true);
3375 ListOfBuffers Buffer::getChildren() const
3378 collectChildren(v, false);
3379 // Make sure we have not included ourselves.
3380 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3381 if (bit != v.end()) {
3382 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3389 ListOfBuffers Buffer::getDescendents() const
3392 collectChildren(v, true);
3393 // Make sure we have not included ourselves.
3394 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3395 if (bit != v.end()) {
3396 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3403 template<typename M>
3404 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3409 typename M::const_iterator it = m.lower_bound(x);
3410 if (it == m.begin())
3418 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3419 DocIterator const & pos) const
3421 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3423 // if paragraphs have no macro context set, pos will be empty
3427 // we haven't found anything yet
3428 DocIterator bestPos = owner_->par_iterator_begin();
3429 MacroData const * bestData = 0;
3431 // find macro definitions for name
3432 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3433 if (nameIt != macros.end()) {
3434 // find last definition in front of pos or at pos itself
3435 PositionScopeMacroMap::const_iterator it
3436 = greatest_below(nameIt->second, pos);
3437 if (it != nameIt->second.end()) {
3439 // scope ends behind pos?
3440 if (pos < it->second.scope) {
3441 // Looks good, remember this. If there
3442 // is no external macro behind this,
3443 // we found the right one already.
3444 bestPos = it->first;
3445 bestData = &it->second.macro;
3449 // try previous macro if there is one
3450 if (it == nameIt->second.begin())
3457 // find macros in included files
3458 PositionScopeBufferMap::const_iterator it
3459 = greatest_below(position_to_children, pos);
3460 if (it == position_to_children.end())
3461 // no children before
3465 // do we know something better (i.e. later) already?
3466 if (it->first < bestPos )
3469 // scope ends behind pos?
3470 if (pos < it->second.scope
3471 && (cloned_buffer_ ||
3472 theBufferList().isLoaded(it->second.buffer))) {
3473 // look for macro in external file
3475 MacroData const * data
3476 = it->second.buffer->getMacro(name, false);
3479 bestPos = it->first;
3485 // try previous file if there is one
3486 if (it == position_to_children.begin())
3491 // return the best macro we have found
3496 MacroData const * Buffer::getMacro(docstring const & name,
3497 DocIterator const & pos, bool global) const
3502 // query buffer macros
3503 MacroData const * data = d->getBufferMacro(name, pos);
3507 // If there is a master buffer, query that
3508 Buffer const * const pbuf = d->parent();
3510 d->macro_lock = true;
3511 MacroData const * macro = pbuf->getMacro(
3512 name, *this, false);
3513 d->macro_lock = false;
3519 data = MacroTable::globalMacros().get(name);
3528 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3530 // set scope end behind the last paragraph
3531 DocIterator scope = par_iterator_begin();
3532 scope.pit() = scope.lastpit() + 1;
3534 return getMacro(name, scope, global);
3538 MacroData const * Buffer::getMacro(docstring const & name,
3539 Buffer const & child, bool global) const
3541 // look where the child buffer is included first
3542 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3543 if (it == d->children_positions.end())
3546 // check for macros at the inclusion position
3547 return getMacro(name, it->second, global);
3551 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3553 pit_type const lastpit = it.lastpit();
3555 // look for macros in each paragraph
3556 while (it.pit() <= lastpit) {
3557 Paragraph & par = it.paragraph();
3559 // FIXME Can this be done with the new-style iterators?
3560 // iterate over the insets of the current paragraph
3561 for (auto const & insit : par.insetList()) {
3562 it.pos() = insit.pos;
3564 // is it a nested text inset?
3565 if (insit.inset->asInsetText()) {
3566 // Inset needs its own scope?
3567 InsetText const * itext = insit.inset->asInsetText();
3568 bool newScope = itext->isMacroScope();
3570 // scope which ends just behind the inset
3571 DocIterator insetScope = it;
3574 // collect macros in inset
3575 it.push_back(CursorSlice(*insit.inset));
3576 updateMacros(it, newScope ? insetScope : scope);
3581 if (insit.inset->asInsetTabular()) {
3582 CursorSlice slice(*insit.inset);
3583 size_t const numcells = slice.nargs();
3584 for (; slice.idx() < numcells; slice.forwardIdx()) {
3585 it.push_back(slice);
3586 updateMacros(it, scope);
3592 // is it an external file?
3593 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3594 // get buffer of external file
3595 InsetInclude const & incinset =
3596 static_cast<InsetInclude const &>(*insit.inset);
3598 Buffer * child = incinset.getChildBuffer();
3603 // register its position, but only when it is
3604 // included first in the buffer
3605 if (children_positions.find(child) ==
3606 children_positions.end())
3607 children_positions[child] = it;
3609 // register child with its scope
3610 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3614 InsetMath * im = insit.inset->asInsetMath();
3615 if (doing_export && im) {
3616 InsetMathHull * hull = im->asHullInset();
3618 hull->recordLocation(it);
3621 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3625 InsetMathMacroTemplate & macroTemplate =
3626 *insit.inset->asInsetMath()->asMacroTemplate();
3627 MacroContext mc(owner_, it);
3628 macroTemplate.updateToContext(mc);
3631 bool valid = macroTemplate.validMacro();
3632 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3633 // then the BufferView's cursor will be invalid in
3634 // some cases which leads to crashes.
3639 // FIXME (Abdel), I don't understand why we pass 'it' here
3640 // instead of 'macroTemplate' defined above... is this correct?
3641 macros[macroTemplate.name()][it] =
3642 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3652 void Buffer::updateMacros() const
3657 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3659 // start with empty table
3661 d->children_positions.clear();
3662 d->position_to_children.clear();
3664 // Iterate over buffer, starting with first paragraph
3665 // The scope must be bigger than any lookup DocIterator
3666 // later. For the global lookup, lastpit+1 is used, hence
3667 // we use lastpit+2 here.
3668 DocIterator it = par_iterator_begin();
3669 DocIterator outerScope = it;
3670 outerScope.pit() = outerScope.lastpit() + 2;
3671 d->updateMacros(it, outerScope);
3675 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3677 InsetIterator it = inset_iterator_begin(inset());
3678 InsetIterator const end = inset_iterator_end(inset());
3679 for (; it != end; ++it) {
3680 if (it->lyxCode() == BRANCH_CODE) {
3681 InsetBranch & br = static_cast<InsetBranch &>(*it);
3682 docstring const name = br.branch();
3683 if (!from_master && !params().branchlist().find(name))
3684 result.push_back(name);
3685 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3686 result.push_back(name);
3689 if (it->lyxCode() == INCLUDE_CODE) {
3690 // get buffer of external file
3691 InsetInclude const & ins =
3692 static_cast<InsetInclude const &>(*it);
3693 Buffer * child = ins.getChildBuffer();
3696 child->getUsedBranches(result, true);
3699 // remove duplicates
3704 void Buffer::updateMacroInstances(UpdateType utype) const
3706 LYXERR(Debug::MACROS, "updateMacroInstances for "
3707 << d->filename.onlyFileName());
3708 DocIterator it = doc_iterator_begin(this);
3710 DocIterator const end = doc_iterator_end(this);
3711 for (; it != end; it.forwardInset()) {
3712 // look for MathData cells in InsetMathNest insets
3713 InsetMath * minset = it.nextInset()->asInsetMath();
3717 // update macro in all cells of the InsetMathNest
3718 DocIterator::idx_type n = minset->nargs();
3719 MacroContext mc = MacroContext(this, it);
3720 for (DocIterator::idx_type i = 0; i < n; ++i) {
3721 MathData & data = minset->cell(i);
3722 data.updateMacros(0, mc, utype, 0);
3728 void Buffer::listMacroNames(MacroNameSet & macros) const
3733 d->macro_lock = true;
3735 // loop over macro names
3736 for (auto const & nameit : d->macros)
3737 macros.insert(nameit.first);
3739 // loop over children
3740 for (auto const & p : d->children_positions) {
3741 Buffer * child = const_cast<Buffer *>(p.first);
3742 // The buffer might have been closed (see #10766).
3743 if (theBufferList().isLoaded(child))
3744 child->listMacroNames(macros);
3748 Buffer const * const pbuf = d->parent();
3750 pbuf->listMacroNames(macros);
3752 d->macro_lock = false;
3756 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3758 Buffer const * const pbuf = d->parent();
3763 pbuf->listMacroNames(names);
3766 for (auto const & mit : names) {
3768 MacroData const * data = pbuf->getMacro(mit, *this, false);
3770 macros.insert(data);
3772 // we cannot access the original InsetMathMacroTemplate anymore
3773 // here to calls validate method. So we do its work here manually.
3774 // FIXME: somehow make the template accessible here.
3775 if (data->optionals() > 0)
3776 features.require("xargs");
3782 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3785 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3787 RefCache::iterator it = d->ref_cache_.find(label);
3788 if (it != d->ref_cache_.end())
3789 return it->second.second;
3791 static InsetLabel const * dummy_il = 0;
3792 static References const dummy_refs = References();
3793 it = d->ref_cache_.insert(
3794 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3795 return it->second.second;
3799 Buffer::References const & Buffer::references(docstring const & label) const
3801 return const_cast<Buffer *>(this)->getReferenceCache(label);
3805 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3807 References & refs = getReferenceCache(label);
3808 refs.push_back(make_pair(inset, it));
3812 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3814 masterBuffer()->d->ref_cache_[label].first = il;
3818 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3820 return masterBuffer()->d->ref_cache_[label].first;
3824 void Buffer::clearReferenceCache() const
3827 d->ref_cache_.clear();
3831 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3833 //FIXME: This does not work for child documents yet.
3834 reloadBibInfoCache();
3836 // Check if the label 'from' appears more than once
3837 vector<docstring> labels;
3838 for (auto const & bibit : masterBibInfo())
3839 labels.push_back(bibit.first);
3841 if (count(labels.begin(), labels.end(), from) > 1)
3844 string const paramName = "key";
3845 InsetIterator it = inset_iterator_begin(inset());
3847 if (it->lyxCode() != CITE_CODE)
3849 InsetCommand * inset = it->asInsetCommand();
3850 docstring const oldValue = inset->getParam(paramName);
3851 if (oldValue == from)
3852 inset->setParam(paramName, to);
3856 // returns NULL if id-to-row conversion is unsupported
3857 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3858 pit_type par_begin, pit_type par_end,
3859 OutputWhat output, bool master) const
3861 unique_ptr<TexRow> texrow;
3862 OutputParams runparams(¶ms().encoding());
3863 runparams.nice = true;
3864 runparams.flavor = params().getOutputFlavor(format);
3865 runparams.linelen = lyxrc.plaintext_linelen;
3866 // No side effect of file copying and image conversion
3867 runparams.dryrun = true;
3869 if (output == CurrentParagraph) {
3870 runparams.par_begin = par_begin;
3871 runparams.par_end = par_end;
3872 if (par_begin + 1 == par_end) {
3874 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3878 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3879 convert<docstring>(par_begin),
3880 convert<docstring>(par_end - 1))
3883 // output paragraphs
3884 if (runparams.flavor == OutputParams::LYX) {
3885 Paragraph const & par = text().paragraphs()[par_begin];
3887 depth_type dt = par.getDepth();
3888 par.write(ods, params(), dt);
3889 os << from_utf8(ods.str());
3890 } else if (runparams.flavor == OutputParams::HTML) {
3892 setMathFlavor(runparams);
3893 xhtmlParagraphs(text(), *this, xs, runparams);
3894 } else if (runparams.flavor == OutputParams::TEXT) {
3896 // FIXME Handles only one paragraph, unlike the others.
3897 // Probably should have some routine with a signature like them.
3898 writePlaintextParagraph(*this,
3899 text().paragraphs()[par_begin], os, runparams, dummy);
3900 } else if (params().isDocBook()) {
3901 docbookParagraphs(text(), *this, os, runparams);
3903 // If we are previewing a paragraph, even if this is the
3904 // child of some other buffer, let's cut the link here,
3905 // so that no concurring settings from the master
3906 // (e.g. branch state) interfere (see #8101).
3908 d->ignore_parent = true;
3909 // We need to validate the Buffer params' features here
3910 // in order to know if we should output polyglossia
3911 // macros (instead of babel macros)
3912 LaTeXFeatures features(*this, params(), runparams);
3914 runparams.use_polyglossia = features.usePolyglossia();
3915 // latex or literate
3918 ots.texrow().newlines(2);
3920 latexParagraphs(*this, text(), ots, runparams);
3921 texrow = ots.releaseTexRow();
3923 // Restore the parenthood
3925 d->ignore_parent = false;
3929 if (output == FullSource)
3930 os << _("Preview source code");
3931 else if (output == OnlyPreamble)
3932 os << _("Preview preamble");
3933 else if (output == OnlyBody)
3934 os << _("Preview body");
3936 if (runparams.flavor == OutputParams::LYX) {
3938 if (output == FullSource)
3940 else if (output == OnlyPreamble)
3941 params().writeFile(ods, this);
3942 else if (output == OnlyBody)
3944 os << from_utf8(ods.str());
3945 } else if (runparams.flavor == OutputParams::HTML) {
3946 writeLyXHTMLSource(os, runparams, output);
3947 } else if (runparams.flavor == OutputParams::TEXT) {
3948 if (output == OnlyPreamble) {
3949 os << "% "<< _("Plain text does not have a preamble.");
3951 writePlaintextFile(*this, os, runparams);
3952 } else if (params().isDocBook()) {
3953 writeDocBookSource(os, absFileName(), runparams, output);
3955 // latex or literate
3958 ots.texrow().newlines(2);
3960 runparams.is_child = true;
3962 writeLaTeXSource(ots, string(), runparams, output);
3963 texrow = ots.releaseTexRow();
3970 ErrorList & Buffer::errorList(string const & type) const
3972 return d->errorLists[type];
3976 void Buffer::updateTocItem(std::string const & type,
3977 DocIterator const & dit) const
3980 d->gui_->updateTocItem(type, dit);
3984 void Buffer::structureChanged() const
3987 d->gui_->structureChanged();
3991 void Buffer::errors(string const & err, bool from_master) const
3994 d->gui_->errors(err, from_master);
3998 void Buffer::message(docstring const & msg) const
4001 d->gui_->message(msg);
4005 void Buffer::setBusy(bool on) const
4008 d->gui_->setBusy(on);
4012 void Buffer::updateTitles() const
4015 d->wa_->updateTitles();
4019 void Buffer::resetAutosaveTimers() const
4022 d->gui_->resetAutosaveTimers();
4026 bool Buffer::hasGuiDelegate() const
4032 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4041 class AutoSaveBuffer : public ForkedProcess {
4044 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4045 : buffer_(buffer), fname_(fname) {}
4047 virtual shared_ptr<ForkedProcess> clone() const
4049 return make_shared<AutoSaveBuffer>(*this);
4054 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4055 from_utf8(fname_.absFileName())));
4056 return run(DontWait);
4060 virtual int generateChild();
4062 Buffer const & buffer_;
4067 int AutoSaveBuffer::generateChild()
4069 #if defined(__APPLE__)
4070 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4071 * We should use something else like threads.
4073 * Since I do not know how to determine at run time what is the OS X
4074 * version, I just disable forking altogether for now (JMarc)
4076 pid_t const pid = -1;
4078 // tmp_ret will be located (usually) in /tmp
4079 // will that be a problem?
4080 // Note that this calls ForkedCalls::fork(), so it's
4081 // ok cross-platform.
4082 pid_t const pid = fork();
4083 // If you want to debug the autosave
4084 // you should set pid to -1, and comment out the fork.
4085 if (pid != 0 && pid != -1)
4089 // pid = -1 signifies that lyx was unable
4090 // to fork. But we will do the save
4092 bool failed = false;
4093 TempFile tempfile("lyxautoXXXXXX.lyx");
4094 tempfile.setAutoRemove(false);
4095 FileName const tmp_ret = tempfile.name();
4096 if (!tmp_ret.empty()) {
4097 if (!buffer_.writeFile(tmp_ret))
4099 else if (!tmp_ret.moveTo(fname_))
4105 // failed to write/rename tmp_ret so try writing direct
4106 if (!buffer_.writeFile(fname_)) {
4107 // It is dangerous to do this in the child,
4108 // but safe in the parent, so...
4109 if (pid == -1) // emit message signal.
4110 buffer_.message(_("Autosave failed!"));
4114 if (pid == 0) // we are the child so...
4123 FileName Buffer::getEmergencyFileName() const
4125 return FileName(d->filename.absFileName() + ".emergency");
4129 FileName Buffer::getAutosaveFileName() const
4131 // if the document is unnamed try to save in the backup dir, else
4132 // in the default document path, and as a last try in the filePath,
4133 // which will most often be the temporary directory
4136 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4137 : lyxrc.backupdir_path;
4138 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4141 string const fname = "#" + d->filename.onlyFileName() + "#";
4143 return makeAbsPath(fname, fpath);
4147 void Buffer::removeAutosaveFile() const
4149 FileName const f = getAutosaveFileName();
4155 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4157 FileName const newauto = getAutosaveFileName();
4159 if (newauto != oldauto && oldauto.exists())
4160 if (!oldauto.moveTo(newauto))
4161 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4165 bool Buffer::autoSave() const
4167 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4168 if (buf->d->bak_clean || hasReadonlyFlag())
4171 message(_("Autosaving current document..."));
4172 buf->d->bak_clean = true;
4174 FileName const fname = getAutosaveFileName();
4175 LASSERT(d->cloned_buffer_, return false);
4177 // If this buffer is cloned, we assume that
4178 // we are running in a separate thread already.
4179 TempFile tempfile("lyxautoXXXXXX.lyx");
4180 tempfile.setAutoRemove(false);
4181 FileName const tmp_ret = tempfile.name();
4182 if (!tmp_ret.empty()) {
4184 // assume successful write of tmp_ret
4185 if (tmp_ret.moveTo(fname))
4188 // failed to write/rename tmp_ret so try writing direct
4189 return writeFile(fname);
4193 void Buffer::setExportStatus(bool e) const
4195 d->doing_export = e;
4196 ListOfBuffers clist = getDescendents();
4197 for (auto const & bit : clist)
4198 bit->d->doing_export = e;
4202 bool Buffer::isExporting() const
4204 return d->doing_export;
4208 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4212 return doExport(target, put_in_tempdir, result_file);
4215 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4216 string & result_file) const
4218 bool const update_unincluded =
4219 params().maintain_unincluded_children
4220 && !params().getIncludedChildren().empty();
4222 // (1) export with all included children (omit \includeonly)
4223 if (update_unincluded) {
4224 ExportStatus const status =
4225 doExport(target, put_in_tempdir, true, result_file);
4226 if (status != ExportSuccess)
4229 // (2) export with included children only
4230 return doExport(target, put_in_tempdir, false, result_file);
4234 void Buffer::setMathFlavor(OutputParams & op) const
4236 switch (params().html_math_output) {
4237 case BufferParams::MathML:
4238 op.math_flavor = OutputParams::MathAsMathML;
4240 case BufferParams::HTML:
4241 op.math_flavor = OutputParams::MathAsHTML;
4243 case BufferParams::Images:
4244 op.math_flavor = OutputParams::MathAsImages;
4246 case BufferParams::LaTeX:
4247 op.math_flavor = OutputParams::MathAsLaTeX;
4253 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4254 bool includeall, string & result_file) const
4256 LYXERR(Debug::FILES, "target=" << target);
4257 OutputParams runparams(¶ms().encoding());
4258 string format = target;
4259 string dest_filename;
4260 size_t pos = target.find(' ');
4261 if (pos != string::npos) {
4262 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4263 format = target.substr(0, pos);
4264 if (format == "default")
4265 format = params().getDefaultOutputFormat();
4266 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4267 FileName(dest_filename).onlyPath().createPath();
4268 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4270 MarkAsExporting exporting(this);
4271 string backend_format;
4272 runparams.flavor = OutputParams::LATEX;
4273 runparams.linelen = lyxrc.plaintext_linelen;
4274 runparams.includeall = includeall;
4275 vector<string> backs = params().backends();
4276 Converters converters = theConverters();
4277 bool need_nice_file = false;
4278 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4279 // Get shortest path to format
4280 converters.buildGraph();
4281 Graph::EdgePath path;
4282 for (string const & sit : backs) {
4283 Graph::EdgePath p = converters.getPath(sit, format);
4284 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4285 backend_format = sit;
4290 if (!put_in_tempdir) {
4291 // Only show this alert if this is an export to a non-temporary
4292 // file (not for previewing).
4293 Alert::error(_("Couldn't export file"), bformat(
4294 _("No information for exporting the format %1$s."),
4295 theFormats().prettyName(format)));
4297 return ExportNoPathToFormat;
4299 runparams.flavor = converters.getFlavor(path, this);
4300 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4301 for (auto const & edge : path)
4302 if (theConverters().get(edge).nice()) {
4303 need_nice_file = true;
4308 backend_format = format;
4309 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4310 // FIXME: Don't hardcode format names here, but use a flag
4311 if (backend_format == "pdflatex")
4312 runparams.flavor = OutputParams::PDFLATEX;
4313 else if (backend_format == "luatex")
4314 runparams.flavor = OutputParams::LUATEX;
4315 else if (backend_format == "dviluatex")
4316 runparams.flavor = OutputParams::DVILUATEX;
4317 else if (backend_format == "xetex")
4318 runparams.flavor = OutputParams::XETEX;
4321 string filename = latexName(false);
4322 filename = addName(temppath(), filename);
4323 filename = changeExtension(filename,
4324 theFormats().extension(backend_format));
4325 LYXERR(Debug::FILES, "filename=" << filename);
4327 // Plain text backend
4328 if (backend_format == "text") {
4329 runparams.flavor = OutputParams::TEXT;
4331 writePlaintextFile(*this, FileName(filename), runparams);
4333 catch (ConversionException const &) { return ExportCancel; }
4336 else if (backend_format == "xhtml") {
4337 runparams.flavor = OutputParams::HTML;
4338 setMathFlavor(runparams);
4339 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4340 return ExportKilled;
4341 } else if (backend_format == "lyx")
4342 writeFile(FileName(filename));
4344 else if (params().isDocBook()) {
4345 runparams.nice = !put_in_tempdir;
4346 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4347 return ExportKilled;
4350 else if (backend_format == format || need_nice_file) {
4351 runparams.nice = true;
4352 ExportStatus const retval =
4353 makeLaTeXFile(FileName(filename), string(), runparams);
4354 if (retval == ExportKilled)
4355 return ExportKilled;
4356 if (d->cloned_buffer_)
4357 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4358 if (retval != ExportSuccess)
4360 } else if (!lyxrc.tex_allows_spaces
4361 && contains(filePath(), ' ')) {
4362 Alert::error(_("File name error"),
4363 _("The directory path to the document cannot contain spaces."));
4364 return ExportTexPathHasSpaces;
4366 runparams.nice = false;
4367 ExportStatus const retval =
4368 makeLaTeXFile(FileName(filename), filePath(), runparams);
4369 if (retval == ExportKilled)
4370 return ExportKilled;
4371 if (d->cloned_buffer_)
4372 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4373 if (retval != ExportSuccess)
4377 string const error_type = (format == "program")
4378 ? "Build" : params().bufferFormat();
4379 ErrorList & error_list = d->errorLists[error_type];
4380 string const ext = theFormats().extension(format);
4381 FileName const tmp_result_file(changeExtension(filename, ext));
4382 Converters::RetVal const retval =
4383 converters.convert(this, FileName(filename), tmp_result_file,
4384 FileName(absFileName()), backend_format, format, error_list);
4385 if (retval == Converters::KILLED)
4386 return ExportCancel;
4387 bool success = (retval == Converters::SUCCESS);
4389 // Emit the signal to show the error list or copy it back to the
4390 // cloned Buffer so that it can be emitted afterwards.
4391 if (format != backend_format) {
4392 if (runparams.silent)
4394 else if (d->cloned_buffer_)
4395 d->cloned_buffer_->d->errorLists[error_type] =
4396 d->errorLists[error_type];
4399 // also to the children, in case of master-buffer-view
4400 ListOfBuffers clist = getDescendents();
4401 for (auto const & bit : clist) {
4402 if (runparams.silent)
4403 bit->d->errorLists[error_type].clear();
4404 else if (d->cloned_buffer_) {
4405 // Enable reverse search by copying back the
4406 // texrow object to the cloned buffer.
4407 // FIXME: this is not thread safe.
4408 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4409 bit->d->cloned_buffer_->d->errorLists[error_type] =
4410 bit->d->errorLists[error_type];
4412 bit->errors(error_type, true);
4416 if (d->cloned_buffer_) {
4417 // Enable reverse dvi or pdf to work by copying back the texrow
4418 // object to the cloned buffer.
4419 // FIXME: There is a possibility of concurrent access to texrow
4420 // here from the main GUI thread that should be securized.
4421 d->cloned_buffer_->d->texrow = d->texrow;
4422 string const err_type = params().bufferFormat();
4423 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4427 if (put_in_tempdir) {
4428 result_file = tmp_result_file.absFileName();
4429 return success ? ExportSuccess : ExportConverterError;
4432 if (dest_filename.empty())
4433 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4435 result_file = dest_filename;
4436 // We need to copy referenced files (e. g. included graphics
4437 // if format == "dvi") to the result dir.
4438 vector<ExportedFile> const files =
4439 runparams.exportdata->externalFiles(format);
4440 string const dest = runparams.export_folder.empty() ?
4441 onlyPath(result_file) : runparams.export_folder;
4442 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4443 : force_overwrite == ALL_FILES;
4444 CopyStatus status = use_force ? FORCE : SUCCESS;
4446 for (ExportedFile const & exp : files) {
4447 if (status == CANCEL) {
4448 message(_("Document export cancelled."));
4449 return ExportCancel;
4451 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4452 string fixedName = exp.exportName;
4453 if (!runparams.export_folder.empty()) {
4454 // Relative pathnames starting with ../ will be sanitized
4455 // if exporting to a different folder
4456 while (fixedName.substr(0, 3) == "../")
4457 fixedName = fixedName.substr(3, fixedName.length() - 3);
4459 FileName fixedFileName = makeAbsPath(fixedName, dest);
4460 fixedFileName.onlyPath().createPath();
4461 status = copyFile(fmt, exp.sourceName,
4463 exp.exportName, status == FORCE,
4464 runparams.export_folder.empty());
4468 if (tmp_result_file.exists()) {
4469 // Finally copy the main file
4470 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4471 : force_overwrite != NO_FILES;
4472 if (status == SUCCESS && use_force)
4474 status = copyFile(format, tmp_result_file,
4475 FileName(result_file), result_file,
4477 if (status == CANCEL) {
4478 message(_("Document export cancelled."));
4479 return ExportCancel;
4481 message(bformat(_("Document exported as %1$s "
4483 theFormats().prettyName(format),
4484 makeDisplayPath(result_file)));
4487 // This must be a dummy converter like fax (bug 1888)
4488 message(bformat(_("Document exported as %1$s"),
4489 theFormats().prettyName(format)));
4492 return success ? ExportSuccess : ExportConverterError;
4496 Buffer::ExportStatus Buffer::preview(string const & format) const
4498 bool const update_unincluded =
4499 params().maintain_unincluded_children
4500 && !params().getIncludedChildren().empty();
4501 return preview(format, update_unincluded);
4505 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4507 MarkAsExporting exporting(this);
4509 // (1) export with all included children (omit \includeonly)
4511 ExportStatus const status = doExport(format, true, true, result_file);
4512 if (status != ExportSuccess)
4515 // (2) export with included children only
4516 ExportStatus const status = doExport(format, true, false, result_file);
4517 FileName const previewFile(result_file);
4519 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4520 theimpl->preview_file_ = previewFile;
4521 theimpl->preview_format_ = format;
4522 theimpl->preview_error_ = (status != ExportSuccess);
4524 if (status != ExportSuccess)
4527 if (previewFile.exists())
4528 return theFormats().view(*this, previewFile, format) ?
4529 PreviewSuccess : PreviewError;
4531 // Successful export but no output file?
4532 // Probably a bug in error detection.
4533 LATTEST(status != ExportSuccess);
4538 Buffer::ReadStatus Buffer::extractFromVC()
4540 bool const found = LyXVC::file_not_found_hook(d->filename);
4542 return ReadFileNotFound;
4543 if (!d->filename.isReadableFile())
4549 Buffer::ReadStatus Buffer::loadEmergency()
4551 FileName const emergencyFile = getEmergencyFileName();
4552 if (!emergencyFile.exists()
4553 || emergencyFile.lastModified() <= d->filename.lastModified())
4554 return ReadFileNotFound;
4556 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4557 docstring const text = bformat(_("An emergency save of the document "
4558 "%1$s exists.\n\nRecover emergency save?"), file);
4560 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4561 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4567 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4568 bool const success = (ret_llf == ReadSuccess);
4570 if (hasReadonlyFlag()) {
4571 Alert::warning(_("File is read-only"),
4572 bformat(_("An emergency file is successfully loaded, "
4573 "but the original file %1$s is marked read-only. "
4574 "Please make sure to save the document as a different "
4575 "file."), from_utf8(d->filename.absFileName())));
4578 lyxvc().file_found_hook(d->filename);
4579 str = _("Document was successfully recovered.");
4581 str = _("Document was NOT successfully recovered.");
4582 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4583 makeDisplayPath(emergencyFile.absFileName()));
4585 int const del_emerg =
4586 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4587 _("&Remove"), _("&Keep"));
4588 if (del_emerg == 0) {
4589 emergencyFile.removeFile();
4591 Alert::warning(_("Emergency file deleted"),
4592 _("Do not forget to save your file now!"), true);
4594 return success ? ReadSuccess : ReadEmergencyFailure;
4597 int const del_emerg =
4598 Alert::prompt(_("Delete emergency file?"),
4599 _("Remove emergency file now?"), 1, 1,
4600 _("&Remove"), _("&Keep"));
4602 emergencyFile.removeFile();
4603 return ReadOriginal;
4613 Buffer::ReadStatus Buffer::loadAutosave()
4615 // Now check if autosave file is newer.
4616 FileName const autosaveFile = getAutosaveFileName();
4617 if (!autosaveFile.exists()
4618 || autosaveFile.lastModified() <= d->filename.lastModified())
4619 return ReadFileNotFound;
4621 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4622 docstring const text = bformat(_("The backup of the document %1$s "
4623 "is newer.\n\nLoad the backup instead?"), file);
4624 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4625 _("&Load backup"), _("Load &original"), _("&Cancel"));
4630 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4631 // the file is not saved if we load the autosave file.
4632 if (ret_llf == ReadSuccess) {
4633 if (hasReadonlyFlag()) {
4634 Alert::warning(_("File is read-only"),
4635 bformat(_("A backup file is successfully loaded, "
4636 "but the original file %1$s is marked read-only. "
4637 "Please make sure to save the document as a "
4639 from_utf8(d->filename.absFileName())));
4642 lyxvc().file_found_hook(d->filename);
4645 return ReadAutosaveFailure;
4648 // Here we delete the autosave
4649 autosaveFile.removeFile();
4650 return ReadOriginal;
4658 Buffer::ReadStatus Buffer::loadLyXFile()
4660 if (!d->filename.isReadableFile()) {
4661 ReadStatus const ret_rvc = extractFromVC();
4662 if (ret_rvc != ReadSuccess)
4666 ReadStatus const ret_re = loadEmergency();
4667 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4670 ReadStatus const ret_ra = loadAutosave();
4671 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4674 return loadThisLyXFile(d->filename);
4678 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4680 return readFile(fn);
4684 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4686 for (auto const & err : terr) {
4687 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4688 int errorRow = err.error_in_line;
4689 Buffer const * buf = 0;
4691 if (err.child_name.empty())
4692 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4694 // The error occurred in a child
4695 for (Buffer const * child : getDescendents()) {
4696 string const child_name =
4697 DocFileName(changeExtension(child->absFileName(), "tex")).
4699 if (err.child_name != child_name)
4701 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4702 if (!TexRow::isNone(start)) {
4703 buf = d->cloned_buffer_
4704 ? child->d->cloned_buffer_->d->owner_
4711 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4717 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4719 LBUFERR(!text().paragraphs().empty());
4721 // Use the master text class also for child documents
4722 Buffer const * const master = masterBuffer();
4723 DocumentClass const & textclass = master->params().documentClass();
4725 FileNamePairList old_bibfiles;
4726 // Do this only if we are the top-level Buffer. We also need to account
4727 // for the case of a previewed child with ignored parent here.
4728 if (master == this && !d->ignore_parent) {
4729 textclass.counters().reset(from_ascii("bibitem"));
4730 reloadBibInfoCache();
4731 // we will re-read this cache as we go through, but we need
4732 // to know whether it's changed to know whether we need to
4733 // update the bibinfo cache.
4734 old_bibfiles = d->bibfiles_cache_;
4735 d->bibfiles_cache_.clear();
4738 // keep the buffers to be children in this set. If the call from the
4739 // master comes back we can see which of them were actually seen (i.e.
4740 // via an InsetInclude). The remaining ones in the set need still be updated.
4741 static std::set<Buffer const *> bufToUpdate;
4742 if (scope == UpdateMaster) {
4743 // If this is a child document start with the master
4744 if (master != this) {
4745 bufToUpdate.insert(this);
4746 master->updateBuffer(UpdateMaster, utype);
4747 // If the master buffer has no gui associated with it, then the TocModel is
4748 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4749 // (bug 5699). The same happens if the master buffer is open in a different
4750 // window. This test catches both possibilities.
4751 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4752 // There remains a problem here: If there is another child open in yet a third
4753 // window, that TOC is not updated. So some more general solution is needed at
4755 if (master->d->gui_ != d->gui_)
4758 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4759 if (bufToUpdate.find(this) == bufToUpdate.end())
4763 // start over the counters in the master
4764 textclass.counters().reset();
4767 // update will be done below for this buffer
4768 bufToUpdate.erase(this);
4770 // update all caches
4771 clearReferenceCache();
4773 setChangesPresent(false);
4775 Buffer & cbuf = const_cast<Buffer &>(*this);
4778 ParIterator parit = cbuf.par_iterator_begin();
4779 updateBuffer(parit, utype);
4781 // If this document has siblings, then update the TocBackend later. The
4782 // reason is to ensure that later siblings are up to date when e.g. the
4783 // broken or not status of references is computed. The update is called
4784 // in InsetInclude::addToToc.
4788 // if the bibfiles changed, the cache of bibinfo is invalid
4789 sort(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end());
4790 // the old one should already be sorted
4791 if (old_bibfiles != d->bibfiles_cache_) {
4792 invalidateBibinfoCache();
4793 reloadBibInfoCache();
4794 // We relied upon the bibinfo cache when recalculating labels. But that
4795 // cache was invalid, although we didn't find that out until now. So we
4796 // have to do it all again.
4797 // That said, the only thing we really need to do is update the citation
4798 // labels. Nothing else will have changed. So we could create a new
4799 // UpdateType that would signal that fact, if we needed to do so.
4800 parit = cbuf.par_iterator_begin();
4801 updateBuffer(parit, utype);
4804 d->bibinfo_cache_valid_ = true;
4805 d->cite_labels_valid_ = true;
4807 cbuf.tocBackend().update(true, utype);
4808 if (scope == UpdateMaster)
4809 cbuf.structureChanged();
4813 static depth_type getDepth(DocIterator const & it)
4815 depth_type depth = 0;
4816 for (size_t i = 0 ; i < it.depth() ; ++i)
4817 if (!it[i].inset().inMathed())
4818 depth += it[i].paragraph().getDepth() + 1;
4819 // remove 1 since the outer inset does not count
4820 // we should have at least one non-math inset, so
4821 // depth should nevery be 0. but maybe it is worth
4822 // marking this, just in case.
4824 // coverity[INTEGER_OVERFLOW]
4828 static depth_type getItemDepth(ParIterator const & it)
4830 Paragraph const & par = *it;
4831 LabelType const labeltype = par.layout().labeltype;
4833 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4836 // this will hold the lowest depth encountered up to now.
4837 depth_type min_depth = getDepth(it);
4838 ParIterator prev_it = it;
4841 --prev_it.top().pit();
4843 // start of nested inset: go to outer par
4845 if (prev_it.empty()) {
4846 // start of document: nothing to do
4851 // We search for the first paragraph with same label
4852 // that is not more deeply nested.
4853 Paragraph & prev_par = *prev_it;
4854 depth_type const prev_depth = getDepth(prev_it);
4855 if (labeltype == prev_par.layout().labeltype) {
4856 if (prev_depth < min_depth)
4857 return prev_par.itemdepth + 1;
4858 if (prev_depth == min_depth)
4859 return prev_par.itemdepth;
4861 min_depth = min(min_depth, prev_depth);
4862 // small optimization: if we are at depth 0, we won't
4863 // find anything else
4864 if (prev_depth == 0)
4870 static bool needEnumCounterReset(ParIterator const & it)
4872 Paragraph const & par = *it;
4873 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4874 depth_type const cur_depth = par.getDepth();
4875 ParIterator prev_it = it;
4876 while (prev_it.pit()) {
4877 --prev_it.top().pit();
4878 Paragraph const & prev_par = *prev_it;
4879 if (prev_par.getDepth() <= cur_depth)
4880 return prev_par.layout().name() != par.layout().name();
4882 // start of nested inset: reset
4887 // set the label of a paragraph. This includes the counters.
4888 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4890 BufferParams const & bp = owner_->masterBuffer()->params();
4891 DocumentClass const & textclass = bp.documentClass();
4892 Paragraph & par = it.paragraph();
4893 Layout const & layout = par.layout();
4894 Counters & counters = textclass.counters();
4896 if (par.params().startOfAppendix()) {
4897 // We want to reset the counter corresponding to toplevel sectioning
4898 Layout const & lay = textclass.getTOCLayout();
4899 docstring const cnt = lay.counter;
4901 counters.reset(cnt);
4902 counters.appendix(true);
4904 par.params().appendix(counters.appendix());
4906 // Compute the item depth of the paragraph
4907 par.itemdepth = getItemDepth(it);
4909 if (layout.margintype == MARGIN_MANUAL) {
4910 if (par.params().labelWidthString().empty())
4911 par.params().labelWidthString(par.expandLabel(layout, bp));
4912 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4913 // we do not need to do anything here, since the empty case is
4914 // handled during export.
4916 par.params().labelWidthString(docstring());
4919 switch(layout.labeltype) {
4920 case LABEL_ITEMIZE: {
4921 // At some point of time we should do something more
4922 // clever here, like:
4923 // par.params().labelString(
4924 // bp.user_defined_bullet(par.itemdepth).getText());
4925 // for now, use a simple hardcoded label
4926 docstring itemlabel;
4927 switch (par.itemdepth) {
4929 itemlabel = char_type(0x2022);
4932 itemlabel = char_type(0x2013);
4935 itemlabel = char_type(0x2217);
4938 itemlabel = char_type(0x2219); // or 0x00b7
4941 par.params().labelString(itemlabel);
4945 case LABEL_ENUMERATE: {
4946 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4948 switch (par.itemdepth) {
4959 enumcounter += "iv";
4962 // not a valid enumdepth...
4966 if (needEnumCounterReset(it)) {
4967 // Increase the master counter?
4968 if (layout.stepmastercounter)
4969 counters.stepMaster(enumcounter, utype);
4970 // Maybe we have to reset the enumeration counter.
4971 if (!layout.resumecounter)
4972 counters.reset(enumcounter);
4974 counters.step(enumcounter, utype);
4976 string const & lang = par.getParLanguage(bp)->code();
4977 par.params().labelString(counters.theCounter(enumcounter, lang));
4982 case LABEL_SENSITIVE: {
4983 string const & type = counters.current_float();
4984 docstring full_label;
4986 full_label = owner_->B_("Senseless!!! ");
4988 docstring name = owner_->B_(textclass.floats().getType(type).name());
4989 if (counters.hasCounter(from_utf8(type))) {
4990 string const & lang = par.getParLanguage(bp)->code();
4991 counters.step(from_utf8(type), utype);
4992 full_label = bformat(from_ascii("%1$s %2$s:"),
4994 counters.theCounter(from_utf8(type), lang));
4996 full_label = bformat(from_ascii("%1$s #:"), name);
4998 par.params().labelString(full_label);
5002 case LABEL_NO_LABEL:
5003 par.params().labelString(docstring());
5007 case LABEL_CENTERED:
5008 case LABEL_STATIC: {
5009 docstring const & lcounter = layout.counter;
5010 if (!lcounter.empty()) {
5011 if (layout.toclevel <= bp.secnumdepth
5012 && (layout.latextype != LATEX_ENVIRONMENT
5013 || it.text()->isFirstInSequence(it.pit()))) {
5014 if (counters.hasCounter(lcounter))
5015 counters.step(lcounter, utype);
5016 par.params().labelString(par.expandLabel(layout, bp));
5018 par.params().labelString(docstring());
5020 par.params().labelString(par.expandLabel(layout, bp));
5026 par.params().labelString(par.expandLabel(layout, bp));
5031 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5033 // LASSERT: Is it safe to continue here, or should we just return?
5034 LASSERT(parit.pit() == 0, /**/);
5036 // Set the position of the text in the buffer to be able
5037 // to resolve macros in it.
5038 parit.text()->setMacrocontextPosition(parit);
5040 depth_type maxdepth = 0;
5041 pit_type const lastpit = parit.lastpit();
5042 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5043 // reduce depth if necessary
5044 if (parit->params().depth() > maxdepth) {
5045 /** FIXME: this function is const, but
5046 * nevertheless it modifies the buffer. To be
5047 * cleaner, one should modify the buffer in
5048 * another function, which is actually
5049 * non-const. This would however be costly in
5050 * terms of code duplication.
5052 CursorData(parit).recordUndo();
5053 parit->params().depth(maxdepth);
5055 maxdepth = parit->getMaxDepthAfter();
5057 if (utype == OutputUpdate) {
5058 // track the active counters
5059 // we have to do this for the master buffer, since the local
5060 // buffer isn't tracking anything.
5061 masterBuffer()->params().documentClass().counters().
5062 setActiveLayout(parit->layout());
5065 // set the counter for this paragraph
5066 d->setLabel(parit, utype);
5068 // update change-tracking flag
5069 parit->addChangesToBuffer(*this);
5072 for (auto const & insit : parit->insetList()) {
5073 parit.pos() = insit.pos;
5074 insit.inset->updateBuffer(parit, utype);
5080 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5081 WordLangTuple & word_lang, docstring_list & suggestions) const
5085 suggestions.clear();
5086 word_lang = WordLangTuple();
5087 bool const to_end = to.empty();
5088 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5089 // OK, we start from here.
5090 for (; from != end; from.forwardPos()) {
5091 // This skips all insets with spell check disabled.
5092 while (!from.allowSpellCheck()) {
5096 // If from is at the end of the document (which is possible
5097 // when "from" was changed above) LyX will crash later otherwise.
5098 if (from.atEnd() || (!to_end && from >= end))
5101 from.paragraph().spellCheck();
5102 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5103 if (SpellChecker::misspelled(res)) {
5107 // Do not increase progress when from == to, otherwise the word
5108 // count will be wrong.
5118 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5120 bool inword = false;
5125 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5126 if (!dit.inTexted()) {
5131 Paragraph const & par = dit.paragraph();
5132 pos_type const pos = dit.pos();
5134 // Copied and adapted from isWordSeparator() in Paragraph
5135 if (pos == dit.lastpos()) {
5138 Inset const * ins = par.getInset(pos);
5139 if (ins && skipNoOutput && !ins->producesOutput()) {
5142 // stop if end of range was skipped
5143 if (!to.atEnd() && dit >= to)
5146 } else if (!par.isDeleted(pos)) {
5147 if (par.isWordSeparator(pos))
5153 if (ins && ins->isLetter())
5155 else if (ins && ins->isSpace())
5158 char_type const c = par.getChar(pos);
5159 if (isPrintableNonspace(c))
5161 else if (isSpace(c))
5171 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5173 d->updateStatistics(from, to, skipNoOutput);
5177 int Buffer::wordCount() const
5179 return d->wordCount();
5183 int Buffer::charCount(bool with_blanks) const
5185 return d->charCount(with_blanks);
5189 Buffer::ReadStatus Buffer::reload()
5192 // c.f. bug https://www.lyx.org/trac/ticket/6587
5193 removeAutosaveFile();
5194 // e.g., read-only status could have changed due to version control
5195 d->filename.refresh();
5196 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5198 // clear parent. this will get reset if need be.
5200 ReadStatus const status = loadLyXFile();
5201 if (status == ReadSuccess) {
5206 message(bformat(_("Document %1$s reloaded."), disp_fn));
5209 message(bformat(_("Could not reload document %1$s."), disp_fn));
5219 bool Buffer::saveAs(FileName const & fn)
5221 FileName const old_name = fileName();
5222 FileName const old_auto = getAutosaveFileName();
5223 bool const old_unnamed = isUnnamed();
5224 bool success = true;
5225 d->old_position = filePath();
5232 // bring the autosave file with us, just in case.
5233 moveAutosaveFile(old_auto);
5234 // validate version control data and
5235 // correct buffer title
5236 lyxvc().file_found_hook(fileName());
5238 // the file has now been saved to the new location.
5239 // we need to check that the locations of child buffers
5241 checkChildBuffers();
5242 checkMasterBuffer();
5245 // reset the old filename and unnamed state
5246 setFileName(old_name);
5247 setUnnamed(old_unnamed);
5251 d->old_position.clear();
5256 void Buffer::checkChildBuffers()
5258 for (auto const & bit : d->children_positions) {
5259 DocIterator dit = bit.second;
5260 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5261 if (!cbuf || !theBufferList().isLoaded(cbuf))
5263 Inset * inset = dit.nextInset();
5264 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5265 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5266 docstring const & incfile = inset_inc->getParam("filename");
5267 string oldloc = cbuf->absFileName();
5268 string newloc = makeAbsPath(to_utf8(incfile),
5269 onlyPath(absFileName())).absFileName();
5270 if (oldloc == newloc)
5272 // the location of the child file is incorrect.
5274 inset_inc->setChildBuffer(0);
5276 // invalidate cache of children
5277 d->children_positions.clear();
5278 d->position_to_children.clear();
5282 // If a child has been saved under a different name/path, it might have been
5283 // orphaned. Therefore the master needs to be reset (bug 8161).
5284 void Buffer::checkMasterBuffer()
5286 Buffer const * const master = masterBuffer();
5290 // necessary to re-register the child (bug 5873)
5291 // FIXME: clean up updateMacros (here, only
5292 // child registering is needed).
5293 master->updateMacros();
5294 // (re)set master as master buffer, but only
5295 // if we are a real child
5296 if (master->isChild(this))
5303 string Buffer::includedFilePath(string const & name, string const & ext) const
5305 if (d->old_position.empty() ||
5306 equivalent(FileName(d->old_position), FileName(filePath())))
5309 bool isabsolute = FileName::isAbsolute(name);
5310 // both old_position and filePath() end with a path separator
5311 string absname = isabsolute ? name : d->old_position + name;
5313 // if old_position is set to origin, we need to do the equivalent of
5314 // getReferencedFileName() (see readDocument())
5315 if (!isabsolute && d->old_position == params().origin) {
5316 FileName const test(addExtension(filePath() + name, ext));
5318 absname = filePath() + name;
5321 if (!FileName(addExtension(absname, ext)).exists())
5325 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5327 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5328 from_utf8(filePath())));
5332 void Buffer::setChangesPresent(bool b) const
5334 d->tracked_changes_present_ = b;
5338 bool Buffer::areChangesPresent() const
5340 return d->tracked_changes_present_;
5344 void Buffer::updateChangesPresent() const
5346 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5347 setChangesPresent(false);
5348 ParConstIterator it = par_iterator_begin();
5349 ParConstIterator const end = par_iterator_end();
5350 for (; !areChangesPresent() && it != end; ++it)
5351 it->addChangesToBuffer(*this);
5355 void Buffer::Impl::refreshFileMonitor()
5357 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5358 file_monitor_->refresh();
5362 // The previous file monitor is invalid
5363 // This also destroys the previous file monitor and all its connections
5364 file_monitor_ = FileSystemWatcher::monitor(filename);
5365 // file_monitor_ will be destroyed with *this, so it is not going to call a
5366 // destroyed object method.
5367 file_monitor_->connect([this](bool exists) {
5368 fileExternallyModified(exists);
5373 void Buffer::Impl::fileExternallyModified(bool const exists)
5375 // ignore notifications after our own saving operations
5376 if (checksum_ == filename.checksum()) {
5377 LYXERR(Debug::FILES, "External modification but "
5378 "checksum unchanged: " << filename);
5381 // If the file has been deleted, only mark the file as dirty since it is
5382 // pointless to prompt for reloading. If later a file is moved into this
5383 // location, then the externally modified warning will appear then.
5385 externally_modified_ = true;
5386 // Update external modification notification.
5387 // Dirty buffers must be visible at all times.
5388 if (wa_ && wa_->unhide(owner_))
5389 wa_->updateTitles();
5391 // Unable to unhide the buffer (e.g. no GUI or not current View)
5396 bool Buffer::notifiesExternalModification() const
5398 return d->externally_modified_;
5402 void Buffer::clearExternalModification() const
5404 d->externally_modified_ = false;
5406 d->wa_->updateTitles();