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/Application.h"
87 #include "frontends/alert.h"
88 #include "frontends/Delegates.h"
89 #include "frontends/WorkAreaManager.h"
91 #include "support/lassert.h"
92 #include "support/convert.h"
93 #include "support/debug.h"
94 #include "support/docstring_list.h"
95 #include "support/ExceptionMessage.h"
96 #include "support/FileMonitor.h"
97 #include "support/FileName.h"
98 #include "support/FileNameList.h"
99 #include "support/filetools.h"
100 #include "support/ForkedCalls.h"
101 #include "support/gettext.h"
102 #include "support/gzstream.h"
103 #include "support/lstrings.h"
104 #include "support/lyxalgo.h"
105 #include "support/mutex.h"
106 #include "support/os.h"
107 #include "support/Package.h"
108 #include "support/PathChanger.h"
109 #include "support/Systemcall.h"
110 #include "support/TempFile.h"
111 #include "support/textutils.h"
112 #include "support/types.h"
114 #include "support/bind.h"
126 using namespace lyx::support;
127 using namespace lyx::graphics;
131 namespace Alert = frontend::Alert;
132 namespace os = support::os;
136 int const LYX_FORMAT = LYX_FORMAT_LYX;
138 typedef map<string, bool> DepClean;
140 // Information about labels and their associated refs
145 InsetLabel const * inset;
146 /// associated references cache
147 Buffer::References references;
148 /// whether this label is active (i.e., not deleted)
152 typedef vector<LabelInfo> LabelCache;
154 typedef map<docstring, Buffer::References> RefCache;
159 // A storehouse for the cloned buffers.
160 list<CloneList *> cloned_buffers;
166 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
170 delete preview_loader_;
178 /// search for macro in local (buffer) table or in children
179 MacroData const * getBufferMacro(docstring const & name,
180 DocIterator const & pos) const;
182 /// Update macro table starting with position of it \param it in some
184 void updateMacros(DocIterator & it, DocIterator & scope);
186 void setLabel(ParIterator & it, UpdateType utype) const;
188 /** If we have branches that use the file suffix
189 feature, return the file name with suffix appended.
191 FileName exportFileName() const;
198 mutable TexRow texrow;
200 /// need to regenerate .tex?
204 mutable bool lyx_clean;
206 /// is autosave needed?
207 mutable bool bak_clean;
209 /// is this an unnamed file (New...)?
212 /// is this an internal bufffer?
213 bool internal_buffer;
218 /// name of the file the buffer is associated with.
221 /** Set to true only when the file is fully loaded.
222 * Used to prevent the premature generation of previews
223 * and by the citation inset.
225 bool file_fully_loaded;
227 /// original format of loaded file
230 /// if the file was originally loaded from an older format, do
231 /// we need to back it up still?
232 bool need_format_backup;
234 /// Ignore the parent (e.g. when exporting a child standalone)?
238 mutable TocBackend toc_backend;
243 ScopeMacro(DocIterator const & s, MacroData const & m)
244 : scope(s), macro(m) {}
248 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
249 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
250 /// map from the macro name to the position map,
251 /// which maps the macro definition position to the scope and the MacroData.
252 NamePositionScopeMacroMap macros;
253 /// This seem to change the way Buffer::getMacro() works
254 mutable bool macro_lock;
256 /// positions of child buffers in the buffer
257 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
259 ScopeBuffer() : buffer(0) {}
260 ScopeBuffer(DocIterator const & s, Buffer const * b)
261 : scope(s), buffer(b) {}
263 Buffer const * buffer;
265 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
266 /// position of children buffers in this buffer
267 BufferPositionMap children_positions;
268 /// map from children inclusion positions to their scope and their buffer
269 PositionScopeBufferMap position_to_children;
271 /// Contains the old buffer filePath() while saving-as, or the
272 /// directory where the document was last saved while loading.
275 /** Keeps track of the path of local layout files.
276 * If possible, it is always relative to the buffer path.
277 * Empty for layouts in system or user directory.
279 string layout_position;
281 /// Container for all sort of Buffer dependant errors.
282 map<string, ErrorList> errorLists;
284 /// checksum used to test if the file has been externally modified. Used to
285 /// double check whether the file had been externally modified when saving.
286 unsigned long checksum_;
289 frontend::WorkAreaManager * wa_;
291 frontend::GuiBufferDelegate * gui_;
296 /// A cache for the bibfiles (including bibfiles of loaded child
297 /// documents), needed for appropriate update of natbib labels.
298 mutable docstring_list bibfiles_cache_;
300 // FIXME The caching mechanism could be improved. At present, we have a
301 // cache for each Buffer, that caches all the bibliography info for that
302 // Buffer. A more efficient solution would be to have a global cache per
303 // file, and then to construct the Buffer's bibinfo from that.
304 /// A cache for bibliography info
305 mutable BiblioInfo bibinfo_;
306 /// whether the bibinfo cache is valid
307 mutable bool bibinfo_cache_valid_;
308 /// Cache of timestamps of .bib files
309 map<FileName, time_t> bibfile_status_;
310 /// Indicates whether the bibinfo has changed since the last time
311 /// we ran updateBuffer(), i.e., whether citation labels may need
313 mutable bool cite_labels_valid_;
314 /// Do we have a bibliography environment?
315 mutable bool have_bibitems_;
317 /// These two hold the file name and format, written to by
318 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
319 FileName preview_file_;
320 string preview_format_;
321 /// If there was an error when previewing, on the next preview we do
322 /// a fresh compile (e.g. in case the user installed a package that
324 bool require_fresh_start_;
326 /// Cache the references associated to a label and their positions
328 mutable RefCache ref_cache_;
329 /// Cache the label insets and their activity status.
330 mutable LabelCache label_cache_;
332 /// our Text that should be wrapped in an InsetText
336 PreviewLoader * preview_loader_;
338 /// This is here to force the test to be done whenever parent_buffer
340 Buffer const * parent() const
342 // ignore_parent temporarily "orphans" a buffer
343 // (e.g. if a child is compiled standalone)
346 // if parent_buffer is not loaded, then it has been unloaded,
347 // which means that parent_buffer is an invalid pointer. So we
348 // set it to null in that case.
349 // however, the BufferList doesn't know about cloned buffers, so
350 // they will always be regarded as unloaded. in that case, we hope
352 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
354 return parent_buffer;
358 void setParent(Buffer const * pb)
360 if (parent_buffer == pb)
363 if (!cloned_buffer_ && parent_buffer && pb)
364 LYXERR0("Warning: a buffer should not have two parents!");
366 if (!cloned_buffer_ && parent_buffer)
367 parent_buffer->invalidateBibinfoCache();
370 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
371 /// This one is useful for preview detached in a thread.
372 Buffer const * cloned_buffer_;
374 CloneList * clone_list_;
375 /// are we in the process of exporting this buffer?
376 mutable bool doing_export;
378 /// compute statistics
379 /// \p from initial position
380 /// \p to points to the end position
381 void updateStatistics(DocIterator & from, DocIterator & to,
382 bool skipNoOutput = true);
383 /// statistics accessor functions
384 int wordCount() const
388 int charCount(bool with_blanks) const
391 + (with_blanks ? blank_count_ : 0);
394 // does the buffer contain tracked changes? (if so, we automatically
395 // display the review toolbar, for instance)
396 mutable bool tracked_changes_present_;
398 // Make sure the file monitor monitors the good file.
399 void refreshFileMonitor();
401 /// Notify or clear of external modification
402 void fileExternallyModified(bool exists);
404 /// has been externally modified? Can be reset by the user.
405 mutable bool externally_modified_;
407 ///Binding LaTeX lines with buffer positions.
408 //Common routine for LaTeX and Reference errors listing.
409 void traverseErrors(TeXErrors::Errors::const_iterator err,
410 TeXErrors::Errors::const_iterator end,
411 ErrorList & errorList) const;
414 /// So we can force access via the accessors.
415 mutable Buffer const * parent_buffer;
421 FileMonitorPtr file_monitor_;
425 /// Creates the per buffer temporary directory
426 static FileName createBufferTmpDir()
428 // FIXME This would be the ideal application for a TempDir class (like
429 // TempFile but for directories)
434 Mutex::Locker locker(&mutex);
435 counter = convert<string>(count++);
437 // We are in our own directory. Why bother to mangle name?
438 // In fact I wrote this code to circumvent a problematic behaviour
439 // (bug?) of EMX mkstemp().
440 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
443 if (!tmpfl.createDirectory(0777)) {
444 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
445 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
446 from_utf8(tmpfl.absFileName())));
452 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
453 Buffer const * cloned_buffer)
454 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
455 internal_buffer(false), read_only(readonly_), filename(file),
456 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
457 ignore_parent(false), toc_backend(owner), macro_lock(false),
458 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
459 cite_labels_valid_(false), have_bibitems_(false), require_fresh_start_(false),
460 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
461 clone_list_(0), doing_export(false),
462 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
463 word_count_(0), char_count_(0), blank_count_(0)
465 refreshFileMonitor();
466 if (!cloned_buffer_) {
467 temppath = createBufferTmpDir();
468 lyxvc.setBuffer(owner_);
469 Language const * inplang = theApp() ?
470 languages.getFromCode(theApp()->inputLanguageCode())
473 params.language = inplang;
475 wa_ = new frontend::WorkAreaManager;
478 temppath = cloned_buffer_->d->temppath;
479 file_fully_loaded = true;
480 params = cloned_buffer_->d->params;
481 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
482 bibinfo_ = cloned_buffer_->d->bibinfo_;
483 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
484 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
485 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
486 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
487 unnamed = cloned_buffer_->d->unnamed;
488 internal_buffer = cloned_buffer_->d->internal_buffer;
489 layout_position = cloned_buffer_->d->layout_position;
490 preview_file_ = cloned_buffer_->d->preview_file_;
491 preview_format_ = cloned_buffer_->d->preview_format_;
492 require_fresh_start_ = cloned_buffer_->d->require_fresh_start_;
493 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
497 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
498 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
500 LYXERR(Debug::INFO, "Buffer::Buffer()");
502 d->inset = new InsetText(*cloned_buffer->d->inset);
503 d->inset->setBuffer(*this);
504 // FIXME: optimize this loop somewhat, maybe by creating a new
505 // general recursive Inset::setId().
506 DocIterator it = doc_iterator_begin(this);
507 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
508 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
509 it.paragraph().setId(cloned_it.paragraph().id());
511 d->inset = new InsetText(this);
512 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
518 LYXERR(Debug::INFO, "Buffer::~Buffer()");
519 // here the buffer should take care that it is
520 // saved properly, before it goes into the void.
522 // GuiView already destroyed
526 // No need to do additional cleanups for internal buffer.
532 // this is in case of recursive includes: we won't try to delete
533 // ourselves as a child.
534 d->clone_list_->erase(this);
535 // loop over children
536 for (auto const & p : d->children_positions) {
537 Buffer * child = const_cast<Buffer *>(p.first);
538 if (d->clone_list_->erase(child))
541 // if we're the master buffer, then we should get rid of the list
544 // If this is not empty, we have leaked something. Worse, one of the
545 // children still has a reference to this list. But we will try to
546 // continue, rather than shut down.
547 LATTEST(d->clone_list_->empty());
548 list<CloneList *>::iterator it =
549 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
550 if (it == cloned_buffers.end()) {
551 // We will leak in this case, but it is safe to continue.
554 cloned_buffers.erase(it);
555 delete d->clone_list_;
557 // FIXME Do we really need to do this right before we delete d?
558 // clear references to children in macro tables
559 d->children_positions.clear();
560 d->position_to_children.clear();
562 // loop over children
563 for (auto const & p : d->children_positions) {
564 Buffer * child = const_cast<Buffer *>(p.first);
565 if (theBufferList().isLoaded(child)) {
566 if (theBufferList().isOthersChild(this, child))
569 theBufferList().release(child);
574 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
576 msg += emergencyWrite();
578 msg += " " + _("Save failed! Document is lost.");
580 Alert::warning(_("Attempting to close changed document!"), msg);
583 // FIXME Do we really need to do this right before we delete d?
584 // clear references to children in macro tables
585 d->children_positions.clear();
586 d->position_to_children.clear();
588 if (!d->temppath.destroyDirectory()) {
589 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
590 from_utf8(d->temppath.absFileName())));
599 Buffer * Buffer::cloneWithChildren() const
602 cloned_buffers.push_back(new CloneList);
603 CloneList * clones = cloned_buffers.back();
605 cloneWithChildren(bufmap, clones);
607 // make sure we got cloned
608 BufferMap::const_iterator bit = bufmap.find(this);
609 LASSERT(bit != bufmap.end(), return 0);
610 Buffer * cloned_buffer = bit->second;
612 return cloned_buffer;
616 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
618 // have we already been cloned?
619 if (bufmap.find(this) != bufmap.end())
622 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
624 // The clone needs its own DocumentClass, since running updateBuffer() will
625 // modify it, and we would otherwise be sharing it with the original Buffer.
626 buffer_clone->params().makeDocumentClass(true);
628 cap::switchBetweenClasses(
629 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
630 static_cast<InsetText &>(buffer_clone->inset()), el);
632 bufmap[this] = buffer_clone;
633 clones->insert(buffer_clone);
634 buffer_clone->d->clone_list_ = clones;
635 buffer_clone->d->macro_lock = true;
636 buffer_clone->d->children_positions.clear();
638 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
639 // math macro caches need to be rethought and simplified.
640 // I am not sure wether we should handle Buffer cloning here or in BufferList.
641 // Right now BufferList knows nothing about buffer clones.
642 for (auto const & p : d->position_to_children) {
643 DocIterator dit = p.first.clone(buffer_clone);
644 dit.setBuffer(buffer_clone);
645 Buffer * child = const_cast<Buffer *>(p.second.buffer);
647 child->cloneWithChildren(bufmap, clones);
648 BufferMap::iterator const bit = bufmap.find(child);
649 LASSERT(bit != bufmap.end(), continue);
650 Buffer * child_clone = bit->second;
652 Inset * inset = dit.nextInset();
653 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
654 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
655 inset_inc->setChildBuffer(child_clone);
656 child_clone->d->setParent(buffer_clone);
657 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
658 buffer_clone->setChild(dit, child_clone);
660 buffer_clone->d->macro_lock = false;
665 Buffer * Buffer::cloneBufferOnly() const {
666 cloned_buffers.push_back(new CloneList);
667 CloneList * clones = cloned_buffers.back();
668 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
670 // The clone needs its own DocumentClass, since running updateBuffer() will
671 // modify it, and we would otherwise be sharing it with the original Buffer.
672 buffer_clone->params().makeDocumentClass(true);
674 cap::switchBetweenClasses(
675 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
676 static_cast<InsetText &>(buffer_clone->inset()), el);
678 clones->insert(buffer_clone);
679 buffer_clone->d->clone_list_ = clones;
681 // we won't be cloning the children
682 buffer_clone->d->children_positions.clear();
687 bool Buffer::isClone() const
689 return d->cloned_buffer_;
693 void Buffer::changed(bool update_metrics) const
696 d->wa_->redrawAll(update_metrics);
700 frontend::WorkAreaManager & Buffer::workAreaManager() const
707 Text & Buffer::text() const
709 return d->inset->text();
713 Inset & Buffer::inset() const
719 BufferParams & Buffer::params()
725 BufferParams const & Buffer::params() const
731 BufferParams const & Buffer::masterParams() const
733 if (masterBuffer() == this)
736 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
737 // Copy child authors to the params. We need those pointers.
738 for (Author const & a : params().authors())
739 mparams.authors().record(a);
744 double Buffer::fontScalingFactor() const
746 return isExporting() ? 75.0 * params().html_math_img_scale
747 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
751 ParagraphList & Buffer::paragraphs()
753 return text().paragraphs();
757 ParagraphList const & Buffer::paragraphs() const
759 return text().paragraphs();
763 LyXVC & Buffer::lyxvc()
769 LyXVC const & Buffer::lyxvc() const
775 string const Buffer::temppath() const
777 return d->temppath.absFileName();
781 TexRow & Buffer::texrow()
787 TexRow const & Buffer::texrow() const
793 TocBackend & Buffer::tocBackend() const
795 return d->toc_backend;
799 Undo & Buffer::undo()
805 void Buffer::setChild(DocIterator const & dit, Buffer * child)
807 d->children_positions[child] = dit;
811 string Buffer::latexName(bool const no_path) const
813 FileName latex_name =
814 makeLatexName(d->exportFileName());
815 return no_path ? latex_name.onlyFileName()
816 : latex_name.absFileName();
820 FileName Buffer::Impl::exportFileName() const
822 docstring const branch_suffix =
823 params.branchlist().getFileNameSuffix();
824 if (branch_suffix.empty())
827 string const name = addExtension(filename.onlyFileNameWithoutExt()
828 + to_utf8(branch_suffix), filename.extension());
829 FileName res(filename.onlyPath().absFileName() + "/" + name);
835 string Buffer::logName(LogType * type) const
837 string const filename = latexName(false);
839 if (filename.empty()) {
845 string const path = temppath();
847 FileName const fname(addName(temppath(),
848 onlyFileName(changeExtension(filename,
851 // FIXME: how do we know this is the name of the build log?
852 FileName const bname(
853 addName(path, onlyFileName(
854 changeExtension(filename,
855 theFormats().extension(params().bufferFormat()) + ".out"))));
857 // Also consider the master buffer log file
858 FileName masterfname = fname;
859 LogType mtype = latexlog;
860 if (masterBuffer() != this) {
861 string const mlogfile = masterBuffer()->logName(&mtype);
862 masterfname = FileName(mlogfile);
865 // If no Latex log or Build log is newer, show Build log
866 if (bname.exists() &&
867 ((!fname.exists() && !masterfname.exists())
868 || (fname.lastModified() < bname.lastModified()
869 && masterfname.lastModified() < bname.lastModified()))) {
870 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
873 return bname.absFileName();
874 // If we have a newer master file log or only a master log, show this
875 } else if (fname != masterfname
876 && (!fname.exists() && (masterfname.exists()
877 || fname.lastModified() < masterfname.lastModified()))) {
878 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
881 return masterfname.absFileName();
883 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
886 return fname.absFileName();
890 void Buffer::setReadonly(bool const flag)
892 if (d->read_only != flag) {
899 void Buffer::setFileName(FileName const & fname)
901 bool const changed = fname != d->filename;
903 d->refreshFileMonitor();
905 lyxvc().file_found_hook(fname);
906 setReadonly(d->filename.isReadOnly());
912 int Buffer::readHeader(Lexer & lex)
914 int unknown_tokens = 0;
916 int begin_header_line = -1;
918 // Initialize parameters that may be/go lacking in header:
919 params().branchlist().clear();
920 params().preamble.erase();
921 params().options.erase();
922 params().master.erase();
923 params().float_placement.erase();
924 params().float_alignment.erase();
925 params().paperwidth.erase();
926 params().paperheight.erase();
927 params().leftmargin.erase();
928 params().rightmargin.erase();
929 params().topmargin.erase();
930 params().bottommargin.erase();
931 params().headheight.erase();
932 params().headsep.erase();
933 params().footskip.erase();
934 params().columnsep.erase();
935 params().font_roman_opts.erase();
936 params().font_sans_opts.erase();
937 params().font_typewriter_opts.erase();
938 params().fonts_cjk.erase();
939 params().listings_params.clear();
940 params().clearLayoutModules();
941 params().clearRemovedModules();
942 params().clearIncludedChildren();
943 params().pdfoptions().clear();
944 params().indiceslist().clear();
945 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
946 params().isbackgroundcolor = false;
947 params().fontcolor = RGBColor(0, 0, 0);
948 params().isfontcolor = false;
949 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
950 params().boxbgcolor = RGBColor(0xFF, 0, 0);
951 params().html_latex_start.clear();
952 params().html_latex_end.clear();
953 params().html_math_img_scale = 1.0;
954 params().output_sync_macro.erase();
955 params().setLocalLayout(docstring(), false);
956 params().setLocalLayout(docstring(), true);
957 params().biblio_opts.erase();
958 params().biblatex_bibstyle.erase();
959 params().biblatex_citestyle.erase();
960 params().multibib.erase();
961 params().lineno_opts.clear();
963 for (int i = 0; i < 4; ++i) {
964 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
965 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
968 ErrorList & errorList = d->errorLists["Parse"];
977 if (token == "\\end_header")
981 if (token == "\\begin_header") {
982 begin_header_line = line;
986 LYXERR(Debug::PARSER, "Handling document header token: `"
989 string const result =
990 params().readToken(lex, token, d->filename.onlyPath());
991 if (!result.empty()) {
992 if (token == "\\textclass") {
993 d->layout_position = result;
996 docstring const s = bformat(_("Unknown token: "
1000 errorList.push_back(ErrorItem(_("Document header error"), s));
1004 if (begin_header_line) {
1005 docstring const s = _("\\begin_header is missing");
1006 errorList.push_back(ErrorItem(_("Document header error"), s));
1009 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1011 params().makeDocumentClass();
1013 return unknown_tokens;
1018 // changed to be public and have one parameter
1019 // Returns true if "\end_document" is not read (Asger)
1020 bool Buffer::readDocument(Lexer & lex)
1022 ErrorList & errorList = d->errorLists["Parse"];
1025 // remove dummy empty par
1026 paragraphs().clear();
1028 if (!lex.checkFor("\\begin_document")) {
1029 docstring const s = _("\\begin_document is missing");
1030 errorList.push_back(ErrorItem(_("Document header error"), s));
1035 if (params().output_changes) {
1036 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1037 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1038 LaTeXFeatures::isAvailable("xcolor");
1040 if (!dvipost && !xcolorulem) {
1041 Alert::warning(_("Changes not shown in LaTeX output"),
1042 _("Changes will not be highlighted in LaTeX output, "
1043 "because neither dvipost nor xcolor/ulem are installed.\n"
1044 "Please install these packages or redefine "
1045 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1046 } else if (!xcolorulem) {
1047 Alert::warning(_("Changes not shown in LaTeX output"),
1048 _("Changes will not be highlighted in LaTeX output "
1049 "when using pdflatex, because xcolor and ulem are not installed.\n"
1050 "Please install both packages or redefine "
1051 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1055 if (!parent() && !params().master.empty()) {
1056 FileName const master_file = makeAbsPath(params().master,
1057 onlyPath(absFileName()));
1058 if (isLyXFileName(master_file.absFileName())) {
1060 checkAndLoadLyXFile(master_file, true);
1062 // necessary e.g. after a reload
1063 // to re-register the child (bug 5873)
1064 // FIXME: clean up updateMacros (here, only
1065 // child registering is needed).
1066 master->updateMacros();
1067 // set master as master buffer, but only
1068 // if we are a real child
1069 if (master->isChild(this))
1071 // if the master is not fully loaded
1072 // it is probably just loading this
1073 // child. No warning needed then.
1074 else if (master->isFullyLoaded())
1075 LYXERR0("The master '"
1077 << "' assigned to this document ("
1079 << ") does not include "
1080 "this document. Ignoring the master assignment.");
1081 // If the master has just been created, un-hide it (#11162)
1082 if (!master->fileName().exists())
1083 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1084 master->absFileName()));
1089 // assure we have a default index
1090 params().indiceslist().addDefault(B_("Index"));
1093 if (FileName::isAbsolute(params().origin))
1094 d->old_position = params().origin;
1096 d->old_position = filePath();
1097 bool const res = text().read(lex, errorList, d->inset);
1098 d->old_position.clear();
1100 // inform parent buffer about local macros
1102 Buffer const * pbuf = parent();
1103 for (auto const & m : usermacros)
1104 pbuf->usermacros.insert(m);
1108 updateMacroInstances(InternalUpdate);
1113 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1115 Format const * fmt = theFormats().getFormat(format);
1118 // It is important to use the correct extension here, since some
1119 // converters create a wrong output file otherwise (e.g. html2latex)
1120 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1121 ofdocstream os(name.toFilesystemEncoding().c_str());
1122 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1123 bool const success = !(os << contents).fail();
1126 bool converted = false;
1128 params().compressed = false;
1130 // remove dummy empty par
1131 paragraphs().clear();
1133 converted = importFile(format, name, errorList);
1136 removeTempFile(name);
1141 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1143 if (!theConverters().isReachable(format, "lyx"))
1146 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1147 Converters::RetVal const retval =
1148 theConverters().convert(0, name, lyx, name, format, "lyx", errorList);
1149 if (retval == Converters::SUCCESS) {
1150 bool const success = readFile(lyx) == ReadSuccess;
1151 removeTempFile(lyx);
1159 bool Buffer::readString(string const & s)
1161 params().compressed = false;
1164 istringstream is(s);
1166 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1167 FileName const fn = tempfile.name();
1170 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1172 if (success && file_format != LYX_FORMAT) {
1173 // We need to call lyx2lyx, so write the input to a file
1174 ofstream os(fn.toFilesystemEncoding().c_str());
1177 // lyxvc in readFile
1178 if (readFile(fn) != ReadSuccess)
1182 if (readDocument(lex))
1188 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1192 if (!lex.setFile(fname)) {
1193 Alert::error(_("File Not Found"),
1194 bformat(_("Unable to open file `%1$s'."),
1195 from_utf8(fn.absFileName())));
1196 return ReadFileNotFound;
1200 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1201 if (ret_plf != ReadSuccess)
1204 if (file_format != LYX_FORMAT) {
1206 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1207 if (ret_clf != ReadSuccess)
1209 ret_clf = readFile(tmpFile);
1210 if (ret_clf == ReadSuccess) {
1211 d->file_format = file_format;
1212 d->need_format_backup = true;
1217 // FIXME: InsetInfo needs to know whether the file is under VCS
1218 // during the parse process, so this has to be done before.
1219 lyxvc().file_found_hook(d->filename);
1221 if (readDocument(lex)) {
1222 Alert::error(_("Document format failure"),
1223 bformat(_("%1$s ended unexpectedly, which means"
1224 " that it is probably corrupted."),
1225 from_utf8(fn.absFileName())));
1226 return ReadDocumentFailure;
1229 d->file_fully_loaded = true;
1230 d->read_only = !d->filename.isWritable();
1231 params().compressed = theFormats().isZippedFile(d->filename);
1237 bool Buffer::isFullyLoaded() const
1239 return d->file_fully_loaded;
1243 void Buffer::setFullyLoaded(bool value)
1245 d->file_fully_loaded = value;
1249 bool Buffer::freshStartRequired() const
1251 return d->require_fresh_start_;
1254 void Buffer::requireFreshStart(bool const b) const
1256 d->require_fresh_start_ = b;
1260 PreviewLoader * Buffer::loader() const
1262 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1264 if (!d->preview_loader_)
1265 d->preview_loader_ = new PreviewLoader(*this);
1266 return d->preview_loader_;
1270 void Buffer::removePreviews() const
1272 delete d->preview_loader_;
1273 d->preview_loader_ = 0;
1277 void Buffer::updatePreviews() const
1279 PreviewLoader * ploader = loader();
1283 InsetIterator it = inset_iterator_begin(*d->inset);
1284 InsetIterator const end = inset_iterator_end(*d->inset);
1285 for (; it != end; ++it)
1286 it->addPreview(it, *ploader);
1288 ploader->startLoading();
1292 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1293 FileName const & fn, int & file_format) const
1295 if(!lex.checkFor("\\lyxformat")) {
1296 Alert::error(_("Document format failure"),
1297 bformat(_("%1$s is not a readable LyX document."),
1298 from_utf8(fn.absFileName())));
1299 return ReadNoLyXFormat;
1305 // LyX formats 217 and earlier were written as 2.17. This corresponds
1306 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1307 // these cases. See also: www.lyx.org/trac/changeset/1313.
1308 size_t dot = tmp_format.find_first_of(".,");
1309 if (dot != string::npos)
1310 tmp_format.erase(dot, 1);
1312 file_format = convert<int>(tmp_format);
1317 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1318 FileName & tmpfile, int from_format)
1320 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1321 tempfile.setAutoRemove(false);
1322 tmpfile = tempfile.name();
1323 if(tmpfile.empty()) {
1324 Alert::error(_("Conversion failed"),
1325 bformat(_("%1$s is from a different"
1326 " version of LyX, but a temporary"
1327 " file for converting it could"
1328 " not be created."),
1329 from_utf8(fn.absFileName())));
1330 return LyX2LyXNoTempFile;
1333 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1334 if (lyx2lyx.empty()) {
1335 Alert::error(_("Conversion script not found"),
1336 bformat(_("%1$s is from a different"
1337 " version of LyX, but the"
1338 " conversion script lyx2lyx"
1339 " could not be found."),
1340 from_utf8(fn.absFileName())));
1341 return LyX2LyXNotFound;
1345 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1346 ostringstream command;
1347 command << os::python()
1348 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1349 << " -t " << convert<string>(LYX_FORMAT)
1350 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1351 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1352 string const command_str = command.str();
1354 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1356 cmd_ret const ret = runCommand(command_str);
1357 if (ret.first != 0) {
1358 if (from_format < LYX_FORMAT) {
1359 Alert::error(_("Conversion script failed"),
1360 bformat(_("%1$s is from an older version"
1361 " of LyX and the lyx2lyx script"
1362 " failed to convert it."),
1363 from_utf8(fn.absFileName())));
1364 return LyX2LyXOlderFormat;
1366 Alert::error(_("Conversion script failed"),
1367 bformat(_("%1$s is from a newer version"
1368 " of LyX and the lyx2lyx script"
1369 " failed to convert it."),
1370 from_utf8(fn.absFileName())));
1371 return LyX2LyXNewerFormat;
1378 FileName Buffer::getBackupName() const {
1379 map<int, string> const file_formats = {
1396 FileName const & fn = fileName();
1397 string const fname = fn.onlyFileNameWithoutExt();
1398 string const fext = fn.extension() + "~";
1399 string const fpath = lyxrc.backupdir_path.empty() ?
1400 fn.onlyPath().absFileName() :
1401 lyxrc.backupdir_path;
1402 string backup_suffix;
1403 // If file format is from a stable series use version instead of file format
1404 auto const it = file_formats.find(d->file_format);
1405 if (it != file_formats.end())
1406 backup_suffix = "-lyx" + it->second;
1408 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1409 string const backname = fname + backup_suffix;
1410 FileName backup(addName(fpath, addExtension(backname, fext)));
1412 // limit recursion, just in case
1414 unsigned long orig_checksum = 0;
1415 while (backup.exists() && v < 100) {
1416 if (orig_checksum == 0)
1417 orig_checksum = fn.checksum();
1418 unsigned long new_checksum = backup.checksum();
1419 if (orig_checksum == new_checksum) {
1420 LYXERR(Debug::FILES, "Not backing up " << fn <<
1421 "since " << backup << "has the same checksum.");
1422 // a bit of a hack, but we have to check this anyway
1423 // below, and setting this is simpler than introducing
1424 // a special boolean for this purpose.
1428 string const newbackname = backname + "-" + convert<string>(v);
1429 backup.set(addName(fpath, addExtension(newbackname, fext)));
1432 return v < 100 ? backup : FileName();
1436 // Should probably be moved to somewhere else: BufferView? GuiView?
1437 bool Buffer::save() const
1439 docstring const file = makeDisplayPath(absFileName(), 20);
1440 d->filename.refresh();
1442 // check the read-only status before moving the file as a backup
1443 if (d->filename.exists()) {
1444 bool const read_only = !d->filename.isWritable();
1446 Alert::warning(_("File is read-only"),
1447 bformat(_("The file %1$s cannot be written because it "
1448 "is marked as read-only."), file));
1453 // ask if the disk file has been externally modified (use checksum method)
1454 if (fileName().exists() && isChecksumModified()) {
1456 bformat(_("Document %1$s has been externally modified. "
1457 "Are you sure you want to overwrite this file?"), file);
1458 int const ret = Alert::prompt(_("Overwrite modified file?"),
1459 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1464 // We don't need autosaves in the immediate future. (Asger)
1465 resetAutosaveTimers();
1467 // if the file does not yet exist, none of the backup activity
1468 // that follows is necessary
1469 if (!fileName().exists()) {
1470 if (!writeFile(fileName()))
1476 // we first write the file to a new name, then move it to its
1477 // proper location once that has been done successfully. that
1478 // way we preserve the original file if something goes wrong.
1479 string const justname = fileName().onlyFileNameWithoutExt();
1480 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1481 justname + "-XXXXXX.lyx");
1482 bool const symlink = fileName().isSymLink();
1484 tempfile->setAutoRemove(false);
1486 FileName savefile(tempfile->name());
1487 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1488 if (!savefile.clonePermissions(fileName()))
1489 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1491 if (!writeFile(savefile))
1494 // we will set this to false if we fail
1495 bool made_backup = true;
1497 FileName backupName;
1498 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1500 if (d->need_format_backup)
1501 backupName = getBackupName();
1503 // If we for some reason failed to find a backup name in case of
1504 // a format change, this will still set one. It's the best we can
1506 if (backupName.empty()) {
1507 backupName.set(fileName().absFileName() + "~");
1508 if (!lyxrc.backupdir_path.empty()) {
1509 string const mangledName =
1510 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1511 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1515 LYXERR(Debug::FILES, "Backing up original file to " <<
1516 backupName.absFileName());
1517 // Except file is symlink do not copy because of #6587.
1518 // Hard links have bad luck.
1519 made_backup = symlink ?
1520 fileName().copyTo(backupName):
1521 fileName().moveTo(backupName);
1524 Alert::error(_("Backup failure"),
1525 bformat(_("Cannot create backup file %1$s.\n"
1526 "Please check whether the directory exists and is writable."),
1527 from_utf8(backupName.absFileName())));
1528 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1529 } else if (d->need_format_backup) {
1530 // the original file has been backed up successfully, so we
1531 // will not need to do that again
1532 d->need_format_backup = false;
1536 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1537 // Only do this if tempfile is not in autoremove mode
1540 // If we have no symlink, we can simply rename the temp file.
1541 // Otherwise, we need to copy it so the symlink stays intact.
1542 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1543 savefile.moveTo(fileName()))
1545 // saveCheckSum() was already called by writeFile(), but the
1546 // time stamp is invalidated by copying/moving
1549 if (d->file_format != LYX_FORMAT)
1550 // the file associated with this buffer is now in the current format
1551 d->file_format = LYX_FORMAT;
1554 // else we saved the file, but failed to move it to the right location.
1556 if (needBackup && made_backup && !symlink) {
1557 // the original file was moved to some new location, so it will look
1558 // to the user as if it was deleted. (see bug #9234.) we could try
1559 // to restore it, but that would basically mean trying to do again
1560 // what we just failed to do. better to leave things as they are.
1561 Alert::error(_("Write failure"),
1562 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1563 "But LyX could not move it to:\n %2$s.\n"
1564 "Your original file has been backed up to:\n %3$s"),
1565 from_utf8(savefile.absFileName()),
1566 from_utf8(fileName().absFileName()),
1567 from_utf8(backupName.absFileName())));
1569 // either we did not try to make a backup, or else we tried and failed,
1570 // or else the original file was a symlink, in which case it was copied,
1571 // not moved. so the original file is intact.
1572 Alert::error(_("Write failure"),
1573 bformat(_("Cannot move saved file to:\n %1$s.\n"
1574 "But the file has successfully been saved as:\n %2$s."),
1575 from_utf8(fileName().absFileName()),
1576 from_utf8(savefile.absFileName())));
1582 bool Buffer::writeFile(FileName const & fname) const
1584 if (d->read_only && fname == d->filename)
1587 bool retval = false;
1589 docstring const str = bformat(_("Saving document %1$s..."),
1590 makeDisplayPath(fname.absFileName()));
1593 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1595 if (params().compressed) {
1596 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1597 retval = ofs && write(ofs);
1599 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1600 retval = ofs && write(ofs);
1604 message(str + _(" could not write file!"));
1609 // removeAutosaveFile();
1612 message(str + _(" done."));
1618 docstring Buffer::emergencyWrite()
1620 // No need to save if the buffer has not changed.
1624 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1626 docstring user_message = bformat(
1627 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1629 // We try to save three places:
1630 // 1) Same place as document. Unless it is an unnamed doc.
1632 string s = absFileName();
1635 if (writeFile(FileName(s))) {
1637 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1638 return user_message;
1640 user_message += " " + _("Save failed! Trying again...\n");
1644 // 2) In HOME directory.
1645 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1647 lyxerr << ' ' << s << endl;
1648 if (writeFile(FileName(s))) {
1650 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1651 return user_message;
1654 user_message += " " + _("Save failed! Trying yet again...\n");
1656 // 3) In "/tmp" directory.
1657 // MakeAbsPath to prepend the current
1658 // drive letter on OS/2
1659 s = addName(package().temp_dir().absFileName(), absFileName());
1661 lyxerr << ' ' << s << endl;
1662 if (writeFile(FileName(s))) {
1664 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1665 return user_message;
1668 user_message += " " + _("Save failed! Document is lost.");
1671 return user_message;
1675 bool Buffer::write(ostream & ofs) const
1678 // Use the standard "C" locale for file output.
1679 ofs.imbue(locale::classic());
1682 // The top of the file should not be written by params().
1684 // write out a comment in the top of the file
1685 // Important: Keep the version formatting in sync with lyx2lyx and
1686 // tex2lyx (bug 7951)
1687 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1688 << " created this file. For more info see https://www.lyx.org/\n"
1689 << "\\lyxformat " << LYX_FORMAT << "\n"
1690 << "\\begin_document\n";
1692 /// For each author, set 'used' to true if there is a change
1693 /// by this author in the document; otherwise set it to 'false'.
1694 for (Author const & a : params().authors())
1697 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1698 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1699 for ( ; it != end; ++it)
1700 it->checkAuthors(params().authors());
1702 // now write out the buffer parameters.
1703 ofs << "\\begin_header\n";
1704 params().writeFile(ofs, this);
1705 ofs << "\\end_header\n";
1708 ofs << "\n\\begin_body\n";
1710 ofs << "\n\\end_body\n";
1712 // Write marker that shows file is complete
1713 ofs << "\\end_document" << endl;
1715 // Shouldn't really be needed....
1718 // how to check if close went ok?
1719 // Following is an attempt... (BE 20001011)
1721 // good() returns false if any error occurred, including some
1722 // formatting error.
1723 // bad() returns true if something bad happened in the buffer,
1724 // which should include file system full errors.
1729 lyxerr << "File was not closed properly." << endl;
1736 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1737 string const & original_path,
1738 OutputParams const & runparams_in,
1739 OutputWhat output) const
1741 OutputParams runparams = runparams_in;
1743 string const encoding = runparams.encoding->iconvName();
1744 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1747 try { ofs.reset(encoding); }
1748 catch (iconv_codecvt_facet_exception const & e) {
1749 lyxerr << "Caught iconv exception: " << e.what() << endl;
1750 Alert::error(_("Iconv software exception Detected"),
1751 bformat(_("Please verify that the `iconv' support software is"
1752 " properly installed and supports the selected encoding"
1753 " (%1$s), or change the encoding in"
1754 " Document>Settings>Language."), from_ascii(encoding)));
1757 if (!openFileWrite(ofs, fname))
1760 ErrorList & errorList = d->errorLists["Export"];
1762 ExportStatus status = ExportSuccess;
1765 // make sure we are ready to export
1766 // this needs to be done before we validate
1767 // FIXME Do we need to do this all the time? I.e., in children
1768 // of a master we are exporting?
1770 updateMacroInstances(OutputUpdate);
1772 ExportStatus retval;
1774 retval = writeLaTeXSource(os, original_path, runparams, output);
1775 if (retval == ExportKilled)
1776 return ExportKilled;
1778 catch (EncodingException const & e) {
1779 docstring const failed(1, e.failed_char);
1781 oss << "0x" << hex << e.failed_char << dec;
1782 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1783 docstring msg = bformat(_("Uncodable character '%1$s'"
1784 " (code point %2$s)"),
1785 failed, from_utf8(oss.str()));
1786 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1787 "representable in specific verbatim contexts.\n"
1788 "Changing the document encoding to utf8 could help."),
1789 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1791 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1792 " (code point %2$s)"),
1793 failed, from_utf8(oss.str()));
1794 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1795 "representable in the chosen encoding.\n"
1796 "Changing the document encoding to utf8 could help."),
1797 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1799 status = ExportError;
1801 catch (iconv_codecvt_facet_exception const & e) {
1802 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1804 status = ExportError;
1806 catch (exception const & e) {
1807 errorList.push_back(ErrorItem(_("conversion failed"),
1809 lyxerr << e.what() << endl;
1810 status = ExportError;
1813 lyxerr << "Caught some really weird exception..." << endl;
1817 d->texrow = move(os.texrow());
1821 status = ExportError;
1822 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1825 if (runparams_in.silent)
1833 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1834 string const & original_path,
1835 OutputParams const & runparams_in,
1836 OutputWhat output) const
1838 // The child documents, if any, shall be already loaded at this point.
1840 OutputParams runparams = runparams_in;
1842 // Some macros rely on font encoding
1843 runparams.main_fontenc = params().main_font_encoding();
1845 // If we are compiling a file standalone, even if this is the
1846 // child of some other buffer, let's cut the link here, so the
1847 // file is really independent and no concurring settings from
1848 // the master (e.g. branch state) interfere (see #8100).
1849 if (!runparams.is_child)
1850 d->ignore_parent = true;
1852 // Classify the unicode characters appearing in math insets
1853 BufferEncodings::initUnicodeMath(*this);
1855 // validate the buffer.
1856 LYXERR(Debug::LATEX, " Validating buffer...");
1857 LaTeXFeatures features(*this, params(), runparams);
1859 // This is only set once per document (in master)
1860 if (!runparams.is_child) {
1861 runparams.use_polyglossia = features.usePolyglossia();
1862 runparams.use_CJK = features.mustProvide("CJK");
1864 LYXERR(Debug::LATEX, " Buffer validation done.");
1866 bool const output_preamble =
1867 output == FullSource || output == OnlyPreamble;
1868 bool const output_body =
1869 output == FullSource || output == OnlyBody;
1871 // The starting paragraph of the coming rows is the
1872 // first paragraph of the document. (Asger)
1873 if (output_preamble && runparams.nice) {
1874 os << "%% LyX " << lyx_version << " created this file. "
1875 "For more info, see https://www.lyx.org/.\n"
1876 "%% Do not edit unless you really know what "
1879 LYXERR(Debug::INFO, "lyx document header finished");
1881 // There are a few differences between nice LaTeX and usual files:
1882 // usual files have \batchmode and special input@path to allow
1883 // inclusion of figures specified by an explicitly relative path
1884 // (i.e., a path starting with './' or '../') with either \input or
1885 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1886 // input@path is set when the actual parameter original_path is set.
1887 // This is done for usual tex-file, but not for nice-latex-file.
1888 // (Matthias 250696)
1889 // Note that input@path is only needed for something the user does
1890 // in the preamble, included .tex files or ERT, files included by
1891 // LyX work without it.
1892 if (output_preamble) {
1893 if (!runparams.nice) {
1894 // code for usual, NOT nice-latex-file
1895 os << "\\batchmode\n"; // changed from \nonstopmode
1897 if (!original_path.empty()) {
1899 // We don't know the encoding of inputpath
1900 docstring const inputpath = from_utf8(original_path);
1901 docstring uncodable_glyphs;
1902 Encoding const * const enc = runparams.encoding;
1904 for (size_t n = 0; n < inputpath.size(); ++n) {
1905 if (!enc->encodable(inputpath[n])) {
1906 docstring const glyph(1, inputpath[n]);
1907 LYXERR0("Uncodable character '"
1909 << "' in input path!");
1910 uncodable_glyphs += glyph;
1915 // warn user if we found uncodable glyphs.
1916 if (!uncodable_glyphs.empty()) {
1917 frontend::Alert::warning(
1918 _("Uncodable character in file path"),
1920 _("The path of your document\n"
1922 "contains glyphs that are unknown "
1923 "in the current document encoding "
1924 "(namely %2$s). This may result in "
1925 "incomplete output, unless "
1926 "TEXINPUTS contains the document "
1927 "directory and you don't use "
1928 "explicitly relative paths (i.e., "
1929 "paths starting with './' or "
1930 "'../') in the preamble or in ERT."
1931 "\n\nIn case of problems, choose "
1932 "an appropriate document encoding\n"
1933 "(such as utf8) or change the "
1935 inputpath, uncodable_glyphs));
1937 string docdir = os::latex_path(original_path);
1938 if (contains(docdir, '#')) {
1939 docdir = subst(docdir, "#", "\\#");
1940 os << "\\catcode`\\#=11"
1941 "\\def\\#{#}\\catcode`\\#=6\n";
1943 if (contains(docdir, '%')) {
1944 docdir = subst(docdir, "%", "\\%");
1945 os << "\\catcode`\\%=11"
1946 "\\def\\%{%}\\catcode`\\%=14\n";
1948 if (contains(docdir, '~'))
1949 docdir = subst(docdir, "~", "\\string~");
1950 bool const nonascii = !isAscii(from_utf8(docdir));
1951 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1952 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1953 bool const detokenize = !utfpathlatex && nonascii;
1954 bool const quote = contains(docdir, ' ');
1955 if (utfpathlatex && nonascii)
1956 os << "\\UseRawInputEncoding\n";
1957 os << "\\makeatletter\n"
1958 << "\\def\\input@path{{";
1960 os << "\\detokenize{";
1969 << "\\makeatother\n";
1973 // get parent macros (if this buffer has a parent) which will be
1974 // written at the document begin further down.
1975 MacroSet parentMacros;
1976 listParentMacros(parentMacros, features);
1978 // Write the preamble
1979 runparams.use_babel = params().writeLaTeX(os, features,
1980 d->filename.onlyPath());
1982 // Active characters
1983 runparams.active_chars = features.getActiveChars();
1985 // Biblatex bibliographies are loaded here
1986 if (params().useBiblatex()) {
1987 vector<pair<docstring, string>> const bibfiles =
1988 prepareBibFilePaths(runparams, getBibfiles(), true);
1989 for (pair<docstring, string> const & file: bibfiles) {
1990 os << "\\addbibresource";
1991 if (!file.second.empty())
1992 os << "[bibencoding=" << file.second << "]";
1993 os << "{" << file.first << "}\n";
1997 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1998 && !features.hasOnlyPolyglossiaLanguages()) {
2001 vector<string> bll = features.getBabelExclusiveLanguages();
2002 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
2005 for (string const & sit : bll) {
2010 blangs = bll.size() > 1 ?
2011 bformat(_("The languages %1$s are only supported by Babel."), langs)
2012 : bformat(_("The language %1$s is only supported by Babel."), langs);
2016 for (string const & pit : pll) {
2021 plangs = pll.size() > 1 ?
2022 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2023 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2024 if (!blangs.empty())
2028 frontend::Alert::warning(
2029 _("Incompatible Languages!"),
2031 _("You cannot use the following languages "
2032 "together in one LaTeX document because "
2033 "they require conflicting language packages:\n"
2038 // Japanese might be required only in some children of a document,
2039 // but once required, we must keep use_japanese true.
2040 runparams.use_japanese |= features.isRequired("japanese");
2043 // Restore the parenthood if needed
2044 if (!runparams.is_child)
2045 d->ignore_parent = false;
2046 return ExportSuccess;
2050 // mark the beginning of the body to separate it from InPreamble insets
2051 os.texrow().start(TexRow::beginDocument());
2052 os << "\\begin{document}\n";
2054 // mark the start of a new paragraph by simulating a newline,
2055 // so that os.afterParbreak() returns true at document start
2058 // output the parent macros
2059 for (auto const & mac : parentMacros) {
2060 int num_lines = mac->write(os.os(), true);
2061 os.texrow().newlines(num_lines);
2064 } // output_preamble
2066 LYXERR(Debug::INFO, "preamble finished, now the body.");
2070 latexParagraphs(*this, text(), os, runparams);
2072 catch (ConversionException const &) { return ExportKilled; }
2074 // Restore the parenthood if needed
2075 if (!runparams.is_child)
2076 d->ignore_parent = false;
2078 // add this just in case after all the paragraphs
2081 if (output_preamble) {
2082 os << "\\end{document}\n";
2083 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2085 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2087 runparams_in.encoding = runparams.encoding;
2089 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2090 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2091 return ExportSuccess;
2095 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2096 OutputParams const & runparams,
2097 OutputWhat output) const
2099 LYXERR(Debug::LATEX, "makeDocBookFile...");
2102 if (!openFileWrite(ofs, fname))
2105 // make sure we are ready to export
2106 // this needs to be done before we validate
2108 updateMacroInstances(OutputUpdate);
2110 ExportStatus const retval =
2111 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2112 if (retval == ExportKilled)
2113 return ExportKilled;
2117 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2118 return ExportSuccess;
2122 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2123 OutputParams const & runparams,
2124 OutputWhat output) const
2126 LaTeXFeatures features(*this, params(), runparams);
2131 DocumentClass const & tclass = params().documentClass();
2132 string const & top_element = tclass.latexname();
2134 bool const output_preamble =
2135 output == FullSource || output == OnlyPreamble;
2136 bool const output_body =
2137 output == FullSource || output == OnlyBody;
2139 if (output_preamble) {
2140 if (runparams.flavor == OutputParams::XML)
2141 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2144 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2147 if (! tclass.class_header().empty())
2148 os << from_ascii(tclass.class_header());
2149 else if (runparams.flavor == OutputParams::XML)
2150 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2151 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2153 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2155 docstring preamble = params().preamble;
2156 if (runparams.flavor != OutputParams::XML ) {
2157 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2158 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2159 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2160 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2163 string const name = runparams.nice
2164 ? changeExtension(absFileName(), ".sgml") : fname;
2165 preamble += features.getIncludedFiles(name);
2166 preamble += features.getLyXSGMLEntities();
2168 if (!preamble.empty()) {
2169 os << "\n [ " << preamble << " ]";
2175 string top = top_element;
2177 if (runparams.flavor == OutputParams::XML)
2178 top += params().language->code();
2180 top += params().language->code().substr(0, 2);
2183 if (!params().options.empty()) {
2185 top += params().options;
2188 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2189 << " file was created by LyX " << lyx_version
2190 << "\n See https://www.lyx.org/ for more information -->\n";
2192 params().documentClass().counters().reset();
2194 sgml::openTag(os, top);
2197 docbookParagraphs(text(), *this, os, runparams);
2199 catch (ConversionException const &) { return ExportKilled; }
2200 sgml::closeTag(os, top_element);
2202 return ExportSuccess;
2206 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2207 OutputParams const & runparams) const
2209 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2212 if (!openFileWrite(ofs, fname))
2215 // make sure we are ready to export
2216 // this has to be done before we validate
2217 updateBuffer(UpdateMaster, OutputUpdate);
2218 updateMacroInstances(OutputUpdate);
2220 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2221 if (retval == ExportKilled)
2226 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2231 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2232 OutputParams const & runparams,
2233 OutputWhat output) const
2235 LaTeXFeatures features(*this, params(), runparams);
2237 d->bibinfo_.makeCitationLabels(*this);
2239 bool const output_preamble =
2240 output == FullSource || output == OnlyPreamble;
2241 bool const output_body =
2242 output == FullSource || output == OnlyBody || output == IncludedFile;
2244 if (output_preamble) {
2245 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2246 << "<!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"
2247 // FIXME Language should be set properly.
2248 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2250 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2251 // FIXME Presumably need to set this right
2252 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2254 docstring const & doctitle = features.htmlTitle();
2256 << (doctitle.empty() ?
2257 from_ascii("LyX Document") :
2258 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2261 docstring styles = features.getTClassHTMLPreamble();
2262 if (!styles.empty())
2263 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2265 styles = features.getPreambleSnippets().str;
2266 if (!styles.empty())
2267 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2269 // we will collect CSS information in a stream, and then output it
2270 // either here, as part of the header, or else in a separate file.
2271 odocstringstream css;
2272 styles = features.getCSSSnippets();
2273 if (!styles.empty())
2274 css << "/* LyX Provided Styles */\n" << styles << '\n';
2276 styles = features.getTClassHTMLStyles();
2277 if (!styles.empty())
2278 css << "/* Layout-provided Styles */\n" << styles << '\n';
2280 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2281 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2282 if (needfg || needbg) {
2283 css << "\nbody {\n";
2286 << from_ascii(X11hexname(params().fontcolor))
2289 css << " background-color: "
2290 << from_ascii(X11hexname(params().backgroundcolor))
2295 docstring const dstyles = css.str();
2296 if (!dstyles.empty()) {
2297 bool written = false;
2298 if (params().html_css_as_file) {
2299 // open a file for CSS info
2301 string const fcssname = addName(temppath(), "docstyle.css");
2302 FileName const fcssfile = FileName(fcssname);
2303 if (openFileWrite(ocss, fcssfile)) {
2307 // write link to header
2308 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2310 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2313 // we are here if the CSS is supposed to be written to the header
2314 // or if we failed to write it to an external file.
2316 os << "<style type='text/css'>\n"
2325 bool const output_body_tag = (output != IncludedFile);
2326 if (output_body_tag)
2327 os << "<body dir=\"auto\">\n";
2329 if (output != IncludedFile)
2330 // if we're an included file, the counters are in the master.
2331 params().documentClass().counters().reset();
2333 xhtmlParagraphs(text(), *this, xs, runparams);
2335 catch (ConversionException const &) { return ExportKilled; }
2336 if (output_body_tag)
2340 if (output_preamble)
2343 return ExportSuccess;
2347 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2348 // Other flags: -wall -v0 -x
2349 int Buffer::runChktex()
2353 // get LaTeX-Filename
2354 FileName const path(temppath());
2355 string const name = addName(path.absFileName(), latexName());
2356 string const org_path = filePath();
2358 PathChanger p(path); // path to LaTeX file
2359 message(_("Running chktex..."));
2361 // Generate the LaTeX file if neccessary
2362 OutputParams runparams(¶ms().encoding());
2363 runparams.flavor = OutputParams::LATEX;
2364 runparams.nice = false;
2365 runparams.linelen = lyxrc.plaintext_linelen;
2366 ExportStatus const retval =
2367 makeLaTeXFile(FileName(name), org_path, runparams);
2368 if (retval != ExportSuccess) {
2369 // error code on failure
2374 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2375 int const res = chktex.run(terr); // run chktex
2378 Alert::error(_("chktex failure"),
2379 _("Could not run chktex successfully."));
2381 ErrorList & errlist = d->errorLists["ChkTeX"];
2383 bufferErrors(terr, errlist);
2388 if (runparams.silent)
2389 d->errorLists["ChkTeX"].clear();
2397 void Buffer::validate(LaTeXFeatures & features) const
2399 // Validate the buffer params, but not for included
2400 // files, since they also use the parent buffer's
2402 if (!features.runparams().is_child)
2403 params().validate(features);
2405 for (Paragraph const & p : paragraphs())
2406 p.validate(features);
2408 if (lyxerr.debugging(Debug::LATEX)) {
2409 features.showStruct();
2414 void Buffer::getLabelList(vector<docstring> & list) const
2416 // If this is a child document, use the master's list instead.
2418 masterBuffer()->getLabelList(list);
2423 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2424 for (auto const & tocit : *toc) {
2425 if (tocit.depth() == 0)
2426 list.push_back(tocit.str());
2431 void Buffer::invalidateBibinfoCache() const
2433 d->bibinfo_cache_valid_ = false;
2434 d->cite_labels_valid_ = false;
2435 removeBiblioTempFiles();
2436 // also invalidate the cache for the parent buffer
2437 Buffer const * const pbuf = d->parent();
2439 pbuf->invalidateBibinfoCache();
2443 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2445 // FIXME This is probably unnecessary, given where we call this.
2446 // If this is a child document, use the master instead.
2447 Buffer const * const pbuf = masterBuffer();
2448 if (pbuf != this && scope != UpdateChildOnly)
2449 return pbuf->getBibfiles();
2451 // In 2.3.x, we have:
2452 //if (!d->bibfile_cache_valid_)
2453 // this->updateBibfilesCache(scope);
2454 // I think that is a leftover, but there have been so many back-
2455 // and-forths with this, due to Windows issues, that I am not sure.
2457 return d->bibfiles_cache_;
2461 BiblioInfo const & Buffer::masterBibInfo() const
2463 Buffer const * const tmp = masterBuffer();
2465 return tmp->masterBibInfo();
2470 BiblioInfo const & Buffer::bibInfo() const
2476 void Buffer::registerBibfiles(const docstring_list & bf) const
2478 // We register the bib files in the master buffer,
2479 // if there is one, but also in every single buffer,
2480 // in case a child is compiled alone.
2481 Buffer const * const tmp = masterBuffer();
2483 tmp->registerBibfiles(bf);
2485 for (auto const & p : bf) {
2486 docstring_list::const_iterator temp =
2487 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2488 if (temp == d->bibfiles_cache_.end())
2489 d->bibfiles_cache_.push_back(p);
2494 static map<docstring, FileName> bibfileCache;
2496 FileName Buffer::getBibfilePath(docstring const & bibid) const
2498 map<docstring, FileName>::const_iterator it =
2499 bibfileCache.find(bibid);
2500 if (it != bibfileCache.end()) {
2501 // i.e., return bibfileCache[bibid];
2505 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2506 string const texfile = changeExtension(to_utf8(bibid), "bib");
2507 // we need to check first if this file exists where it's said to be.
2508 // there's a weird bug that occurs otherwise: if the file is in the
2509 // Buffer's directory but has the same name as some file that would be
2510 // found by kpsewhich, then we find the latter, not the former.
2511 FileName const local_file = makeAbsPath(texfile, filePath());
2512 FileName file = local_file;
2513 if (!file.exists()) {
2514 // there's no need now to check whether the file can be found
2516 file = findtexfile(texfile, "bib", true);
2520 LYXERR(Debug::FILES, "Found at: " << file);
2522 bibfileCache[bibid] = file;
2523 return bibfileCache[bibid];
2527 void Buffer::checkIfBibInfoCacheIsValid() const
2529 // use the master's cache
2530 Buffer const * const tmp = masterBuffer();
2532 tmp->checkIfBibInfoCacheIsValid();
2536 // If we already know the cache is invalid, stop here.
2537 // This is important in the case when the bibliography
2538 // environment (rather than Bib[la]TeX) is used.
2539 // In that case, the timestamp check below gives no
2540 // sensible result. Rather than that, the cache will
2541 // be invalidated explicitly via invalidateBibInfoCache()
2542 // by the Bibitem inset.
2543 // Same applies for bib encoding changes, which trigger
2544 // invalidateBibInfoCache() by InsetBibtex.
2545 if (!d->bibinfo_cache_valid_)
2548 if (d->have_bibitems_) {
2549 // We have a bibliography environment.
2550 // Invalidate the bibinfo cache unconditionally.
2551 // Cite labels will get invalidated by the inset if needed.
2552 d->bibinfo_cache_valid_ = false;
2556 // OK. This is with Bib(la)tex. We'll assume the cache
2557 // is valid and change this if we find changes in the bibs.
2558 d->bibinfo_cache_valid_ = true;
2559 d->cite_labels_valid_ = true;
2561 // compare the cached timestamps with the actual ones.
2562 docstring_list const & bibfiles_cache = getBibfiles();
2563 for (auto const & bf : bibfiles_cache) {
2564 FileName const fn = getBibfilePath(bf);
2565 time_t lastw = fn.lastModified();
2566 time_t prevw = d->bibfile_status_[fn];
2567 if (lastw != prevw) {
2568 d->bibinfo_cache_valid_ = false;
2569 d->cite_labels_valid_ = false;
2570 d->bibfile_status_[fn] = lastw;
2576 void Buffer::clearBibFileCache() const
2578 bibfileCache.clear();
2582 void Buffer::reloadBibInfoCache(bool const force) const
2584 // we should not need to do this for internal buffers
2588 // use the master's cache
2589 Buffer const * const tmp = masterBuffer();
2591 tmp->reloadBibInfoCache(force);
2596 checkIfBibInfoCacheIsValid();
2597 if (d->bibinfo_cache_valid_)
2601 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2602 // re-read file locations when this info changes
2603 // FIXME Is this sufficient? Or should we also force that
2604 // in some other cases? If so, then it is easy enough to
2605 // add the following line in some other places.
2606 clearBibFileCache();
2607 d->bibinfo_.clear();
2608 FileNameList checkedFiles;
2609 d->have_bibitems_ = false;
2610 collectBibKeys(checkedFiles);
2611 d->bibinfo_cache_valid_ = true;
2615 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2617 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2618 it->collectBibKeys(it, checkedFiles);
2619 if (it->lyxCode() == BIBITEM_CODE) {
2621 parent()->d->have_bibitems_ = true;
2623 d->have_bibitems_ = true;
2629 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2631 // We add the biblio info to the master buffer,
2632 // if there is one, but also to every single buffer,
2633 // in case a child is compiled alone.
2634 BiblioInfo & bi = d->bibinfo_;
2635 bi.mergeBiblioInfo(bin);
2637 if (parent() != 0) {
2638 BiblioInfo & masterbi = parent()->d->bibinfo_;
2639 masterbi.mergeBiblioInfo(bin);
2644 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2646 // We add the bibtex info to the master buffer,
2647 // if there is one, but also to every single buffer,
2648 // in case a child is compiled alone.
2649 BiblioInfo & bi = d->bibinfo_;
2652 if (parent() != 0) {
2653 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2654 masterbi[key] = bin;
2659 void Buffer::makeCitationLabels() const
2661 Buffer const * const master = masterBuffer();
2662 return d->bibinfo_.makeCitationLabels(*master);
2666 void Buffer::invalidateCiteLabels() const
2668 masterBuffer()->d->cite_labels_valid_ = false;
2671 bool Buffer::citeLabelsValid() const
2673 return masterBuffer()->d->cite_labels_valid_;
2677 void Buffer::removeBiblioTempFiles() const
2679 // We remove files that contain LaTeX commands specific to the
2680 // particular bibliographic style being used, in order to avoid
2681 // LaTeX errors when we switch style.
2682 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2683 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2684 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2685 aux_file.removeFile();
2686 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2687 bbl_file.removeFile();
2688 // Also for the parent buffer
2689 Buffer const * const pbuf = parent();
2691 pbuf->removeBiblioTempFiles();
2695 bool Buffer::isDepClean(string const & name) const
2697 DepClean::const_iterator const it = d->dep_clean.find(name);
2698 if (it == d->dep_clean.end())
2704 void Buffer::markDepClean(string const & name)
2706 d->dep_clean[name] = true;
2710 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2713 // FIXME? if there is an Buffer LFUN that can be dispatched even
2714 // if internal, put a switch '(cmd.action)' here.
2720 switch (cmd.action()) {
2722 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2723 flag.setOnOff(hasReadonlyFlag());
2726 // FIXME: There is need for a command-line import.
2727 //case LFUN_BUFFER_IMPORT:
2729 case LFUN_BUFFER_AUTO_SAVE:
2732 case LFUN_BUFFER_EXPORT_CUSTOM:
2733 // FIXME: Nothing to check here?
2736 case LFUN_BUFFER_EXPORT: {
2737 docstring const arg = cmd.argument();
2738 if (arg == "custom") {
2742 string format = (arg.empty() || arg == "default") ?
2743 params().getDefaultOutputFormat() : to_utf8(arg);
2744 size_t pos = format.find(' ');
2745 if (pos != string::npos)
2746 format = format.substr(0, pos);
2747 enable = params().isExportable(format, false);
2749 flag.message(bformat(
2750 _("Don't know how to export to format: %1$s"), arg));
2754 case LFUN_BUILD_PROGRAM:
2755 enable = params().isExportable("program", false);
2758 case LFUN_BRANCH_ACTIVATE:
2759 case LFUN_BRANCH_DEACTIVATE:
2760 case LFUN_BRANCH_MASTER_ACTIVATE:
2761 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2762 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2763 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2764 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2765 : params().branchlist();
2766 docstring const branchName = cmd.argument();
2767 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2771 case LFUN_BRANCH_ADD:
2772 case LFUN_BRANCHES_RENAME:
2773 // if no Buffer is present, then of course we won't be called!
2776 case LFUN_BUFFER_LANGUAGE:
2777 enable = !isReadonly();
2780 case LFUN_BUFFER_VIEW_CACHE:
2781 (d->preview_file_).refresh();
2782 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2785 case LFUN_CHANGES_TRACK:
2786 flag.setEnabled(true);
2787 flag.setOnOff(params().track_changes);
2790 case LFUN_CHANGES_OUTPUT:
2791 flag.setEnabled(true);
2792 flag.setOnOff(params().output_changes);
2795 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2796 flag.setOnOff(params().compressed);
2799 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2800 flag.setOnOff(params().output_sync);
2803 case LFUN_BUFFER_ANONYMIZE:
2809 flag.setEnabled(enable);
2814 void Buffer::dispatch(string const & command, DispatchResult & result)
2816 return dispatch(lyxaction.lookupFunc(command), result);
2820 // NOTE We can end up here even if we have no GUI, because we are called
2821 // by LyX::exec to handled command-line requests. So we may need to check
2822 // whether we have a GUI or not. The boolean use_gui holds this information.
2823 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2826 // FIXME? if there is an Buffer LFUN that can be dispatched even
2827 // if internal, put a switch '(cmd.action())' here.
2828 dr.dispatched(false);
2831 string const argument = to_utf8(func.argument());
2832 // We'll set this back to false if need be.
2833 bool dispatched = true;
2834 // This handles undo groups automagically
2835 UndoGroupHelper ugh(this);
2837 switch (func.action()) {
2838 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2839 if (lyxvc().inUse()) {
2840 string log = lyxvc().toggleReadOnly();
2845 setReadonly(!hasReadonlyFlag());
2848 case LFUN_BUFFER_EXPORT: {
2849 string const format = (argument.empty() || argument == "default") ?
2850 params().getDefaultOutputFormat() : argument;
2851 ExportStatus const status = doExport(format, false);
2852 dr.setError(status != ExportSuccess);
2853 if (status != ExportSuccess)
2854 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2855 from_utf8(format)));
2859 case LFUN_BUILD_PROGRAM: {
2860 ExportStatus const status = doExport("program", true);
2861 dr.setError(status != ExportSuccess);
2862 if (status != ExportSuccess)
2863 dr.setMessage(_("Error generating literate programming code."));
2867 case LFUN_BUFFER_EXPORT_CUSTOM: {
2869 string command = split(argument, format_name, ' ');
2870 Format const * format = theFormats().getFormat(format_name);
2872 lyxerr << "Format \"" << format_name
2873 << "\" not recognized!"
2878 // The name of the file created by the conversion process
2881 // Output to filename
2882 if (format->name() == "lyx") {
2883 string const latexname = latexName(false);
2884 filename = changeExtension(latexname,
2885 format->extension());
2886 filename = addName(temppath(), filename);
2888 if (!writeFile(FileName(filename)))
2892 doExport(format_name, true, filename);
2895 // Substitute $$FName for filename
2896 if (!contains(command, "$$FName"))
2897 command = "( " + command + " ) < $$FName";
2898 command = subst(command, "$$FName", filename);
2900 // Execute the command in the background
2902 call.startscript(Systemcall::DontWait, command,
2903 filePath(), layoutPos());
2907 // FIXME: There is need for a command-line import.
2909 case LFUN_BUFFER_IMPORT:
2914 case LFUN_BUFFER_AUTO_SAVE:
2916 resetAutosaveTimers();
2919 case LFUN_BRANCH_ACTIVATE:
2920 case LFUN_BRANCH_DEACTIVATE:
2921 case LFUN_BRANCH_MASTER_ACTIVATE:
2922 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2923 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2924 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2925 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2928 docstring const branch_name = func.argument();
2929 // the case without a branch name is handled elsewhere
2930 if (branch_name.empty()) {
2934 Branch * branch = buf->params().branchlist().find(branch_name);
2936 LYXERR0("Branch " << branch_name << " does not exist.");
2938 docstring const msg =
2939 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2943 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2944 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2945 if (branch->isSelected() != activate) {
2946 buf->undo().recordUndoBufferParams(CursorData());
2947 branch->setSelected(activate);
2949 dr.screenUpdate(Update::Force);
2950 dr.forceBufferUpdate();
2955 case LFUN_BRANCH_ADD: {
2956 docstring branchnames = func.argument();
2957 if (branchnames.empty()) {
2961 BranchList & branch_list = params().branchlist();
2962 vector<docstring> const branches =
2963 getVectorFromString(branchnames, branch_list.separator());
2965 for (docstring const & branch_name : branches) {
2966 Branch * branch = branch_list.find(branch_name);
2968 LYXERR0("Branch " << branch_name << " already exists.");
2972 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2974 undo().recordUndoBufferParams(CursorData());
2975 branch_list.add(branch_name);
2976 branch = branch_list.find(branch_name);
2977 string const x11hexname = X11hexname(branch->color());
2978 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2979 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2981 dr.screenUpdate(Update::Force);
2989 case LFUN_BRANCHES_RENAME: {
2990 if (func.argument().empty())
2993 docstring const oldname = from_utf8(func.getArg(0));
2994 docstring const newname = from_utf8(func.getArg(1));
2995 InsetIterator it = inset_iterator_begin(inset());
2996 InsetIterator const end = inset_iterator_end(inset());
2997 bool success = false;
2998 for (; it != end; ++it) {
2999 if (it->lyxCode() == BRANCH_CODE) {
3000 InsetBranch & ins = static_cast<InsetBranch &>(*it);
3001 if (ins.branch() == oldname) {
3002 undo().recordUndo(CursorData(it));
3003 ins.rename(newname);
3008 if (it->lyxCode() == INCLUDE_CODE) {
3009 // get buffer of external file
3010 InsetInclude const & ins =
3011 static_cast<InsetInclude const &>(*it);
3012 Buffer * child = ins.getChildBuffer();
3015 child->dispatch(func, dr);
3020 dr.screenUpdate(Update::Force);
3021 dr.forceBufferUpdate();
3026 case LFUN_BUFFER_VIEW_CACHE:
3027 if (!theFormats().view(*this, d->preview_file_,
3028 d->preview_format_))
3029 dr.setMessage(_("Error viewing the output file."));
3032 case LFUN_CHANGES_TRACK:
3033 if (params().save_transient_properties)
3034 undo().recordUndoBufferParams(CursorData());
3035 params().track_changes = !params().track_changes;
3036 if (!params().track_changes)
3037 dr.forceChangesUpdate();
3040 case LFUN_CHANGES_OUTPUT:
3041 if (params().save_transient_properties)
3042 undo().recordUndoBufferParams(CursorData());
3043 params().output_changes = !params().output_changes;
3044 if (params().output_changes) {
3045 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3046 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3047 LaTeXFeatures::isAvailable("xcolor");
3049 if (!dvipost && !xcolorulem) {
3050 Alert::warning(_("Changes not shown in LaTeX output"),
3051 _("Changes will not be highlighted in LaTeX output, "
3052 "because neither dvipost nor xcolor/ulem are installed.\n"
3053 "Please install these packages or redefine "
3054 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3055 } else if (!xcolorulem) {
3056 Alert::warning(_("Changes not shown in LaTeX output"),
3057 _("Changes will not be highlighted in LaTeX output "
3058 "when using pdflatex, because xcolor and ulem are not installed.\n"
3059 "Please install both packages or redefine "
3060 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3065 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3066 // turn compression on/off
3067 undo().recordUndoBufferParams(CursorData());
3068 params().compressed = !params().compressed;
3071 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3072 undo().recordUndoBufferParams(CursorData());
3073 params().output_sync = !params().output_sync;
3076 case LFUN_BUFFER_ANONYMIZE: {
3077 undo().recordUndoFullBuffer(CursorData());
3078 CursorData cur(doc_iterator_begin(this));
3079 for ( ; cur ; cur.forwardPar())
3080 cur.paragraph().anonymize();
3081 dr.forceBufferUpdate();
3082 dr.screenUpdate(Update::Force);
3090 dr.dispatched(dispatched);
3094 void Buffer::changeLanguage(Language const * from, Language const * to)
3096 LASSERT(from, return);
3097 LASSERT(to, return);
3099 for_each(par_iterator_begin(),
3101 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3105 bool Buffer::isMultiLingual() const
3107 ParConstIterator end = par_iterator_end();
3108 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3109 if (it->isMultiLingual(params()))
3116 std::set<Language const *> Buffer::getLanguages() const
3118 std::set<Language const *> langs;
3119 getLanguages(langs);
3124 void Buffer::getLanguages(std::set<Language const *> & langs) const
3126 ParConstIterator end = par_iterator_end();
3127 // add the buffer language, even if it's not actively used
3128 langs.insert(language());
3129 // iterate over the paragraphs
3130 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3131 it->getLanguages(langs);
3133 ListOfBuffers clist = getDescendants();
3134 for (auto const & cit : clist)
3135 cit->getLanguages(langs);
3139 DocIterator Buffer::getParFromID(int const id) const
3141 Buffer * buf = const_cast<Buffer *>(this);
3143 // This means non-existent
3144 return doc_iterator_end(buf);
3146 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3147 if (it.paragraph().id() == id)
3150 return doc_iterator_end(buf);
3154 bool Buffer::hasParWithID(int const id) const
3156 return !getParFromID(id).atEnd();
3160 ParIterator Buffer::par_iterator_begin()
3162 return ParIterator(doc_iterator_begin(this));
3166 ParIterator Buffer::par_iterator_end()
3168 return ParIterator(doc_iterator_end(this));
3172 ParConstIterator Buffer::par_iterator_begin() const
3174 return ParConstIterator(doc_iterator_begin(this));
3178 ParConstIterator Buffer::par_iterator_end() const
3180 return ParConstIterator(doc_iterator_end(this));
3184 Language const * Buffer::language() const
3186 return params().language;
3190 docstring const Buffer::B_(string const & l10n) const
3192 return params().B_(l10n);
3196 bool Buffer::isClean() const
3198 return d->lyx_clean;
3202 bool Buffer::isChecksumModified() const
3204 LASSERT(d->filename.exists(), return false);
3205 return d->checksum_ != d->filename.checksum();
3209 void Buffer::saveCheckSum() const
3211 FileName const & file = d->filename;
3213 d->checksum_ = file.exists() ? file.checksum()
3214 : 0; // in the case of save to a new file.
3218 void Buffer::markClean() const
3220 if (!d->lyx_clean) {
3221 d->lyx_clean = true;
3224 // if the .lyx file has been saved, we don't need an
3226 d->bak_clean = true;
3227 d->undo_.markDirty();
3228 clearExternalModification();
3232 void Buffer::setUnnamed(bool flag)
3238 bool Buffer::isUnnamed() const
3245 /// Don't check unnamed, here: isInternal() is used in
3246 /// newBuffer(), where the unnamed flag has not been set by anyone
3247 /// yet. Also, for an internal buffer, there should be no need for
3248 /// retrieving fileName() nor for checking if it is unnamed or not.
3249 bool Buffer::isInternal() const
3251 return d->internal_buffer;
3255 void Buffer::setInternal(bool flag)
3257 d->internal_buffer = flag;
3261 void Buffer::markDirty()
3264 d->lyx_clean = false;
3267 d->bak_clean = false;
3269 for (auto & depit : d->dep_clean)
3270 depit.second = false;
3274 FileName Buffer::fileName() const
3280 string Buffer::absFileName() const
3282 return d->filename.absFileName();
3286 string Buffer::filePath() const
3288 string const abs = d->filename.onlyPath().absFileName();
3291 int last = abs.length() - 1;
3293 return abs[last] == '/' ? abs : abs + '/';
3297 DocFileName Buffer::getReferencedFileName(string const & fn) const
3300 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3301 result.set(fn, filePath());
3303 // filePath() ends with a path separator
3304 FileName const test(filePath() + fn);
3306 result.set(fn, filePath());
3308 result.set(fn, params().origin);
3315 string const Buffer::prepareFileNameForLaTeX(string const & name,
3316 string const & ext, bool nice) const
3318 string const fname = makeAbsPath(name, filePath()).absFileName();
3319 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3325 return to_utf8(makeRelPath(from_utf8(fname),
3326 from_utf8(masterBuffer()->filePath())));
3330 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3331 docstring_list const & bibfilelist,
3332 bool const add_extension) const
3334 // If we are processing the LaTeX file in a temp directory then
3335 // copy the .bib databases to this temp directory, mangling their
3336 // names in the process. Store this mangled name in the list of
3338 // (We need to do all this because BibTeX *really*, *really*
3339 // can't handle "files with spaces" and Windows users tend to
3340 // use such filenames.)
3341 // Otherwise, store the (maybe absolute) path to the original,
3342 // unmangled database name.
3344 vector<pair<docstring, string>> res;
3346 // determine the export format
3347 string const tex_format = flavor2format(runparams.flavor);
3349 // check for spaces in paths
3350 bool found_space = false;
3352 for (auto const & bit : bibfilelist) {
3353 string utf8input = to_utf8(bit);
3355 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3356 FileName try_in_file =
3357 makeAbsPath(database + ".bib", filePath());
3358 bool not_from_texmf = try_in_file.isReadableFile();
3359 // If the file has not been found, try with the real file name
3360 // (it might come from a child in a sub-directory)
3361 if (!not_from_texmf) {
3362 try_in_file = getBibfilePath(bit);
3363 if (try_in_file.isReadableFile()) {
3364 // Check if the file is in texmf
3365 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3366 not_from_texmf = kpsefile.empty()
3367 || kpsefile.absFileName() != try_in_file.absFileName();
3369 // If this exists, make path relative to the master
3372 removeExtension(prepareFileNameForLaTeX(
3373 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3374 from_utf8(filePath()))),
3375 ".bib", runparams.nice));
3379 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3381 // mangledFileName() needs the extension
3382 DocFileName const in_file = DocFileName(try_in_file);
3383 database = removeExtension(in_file.mangledFileName());
3384 FileName const out_file = makeAbsPath(database + ".bib",
3385 masterBuffer()->temppath());
3386 bool const success = in_file.copyTo(out_file);
3388 LYXERR0("Failed to copy '" << in_file
3389 << "' to '" << out_file << "'");
3391 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3392 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3393 if (!isValidLaTeXFileName(database)) {
3394 frontend::Alert::warning(_("Invalid filename"),
3395 _("The following filename will cause troubles "
3396 "when running the exported file through LaTeX: ") +
3397 from_utf8(database));
3399 if (!isValidDVIFileName(database)) {
3400 frontend::Alert::warning(_("Problematic filename for DVI"),
3401 _("The following filename can cause troubles "
3402 "when running the exported file through LaTeX "
3403 "and opening the resulting DVI: ") +
3404 from_utf8(database), true);
3412 docstring const path = from_utf8(latex_path(database));
3414 if (contains(path, ' '))
3417 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3418 enc = params().bibFileEncoding(utf8input);
3420 bool recorded = false;
3421 for (pair<docstring, string> pe : res) {
3422 if (pe.first == path) {
3429 res.push_back(make_pair(path, enc));
3432 // Check if there are spaces in the path and warn BibTeX users, if so.
3433 // (biber can cope with such paths)
3434 if (!prefixIs(runparams.bibtex_command, "biber")) {
3435 // Post this warning only once.
3436 static bool warned_about_spaces = false;
3437 if (!warned_about_spaces &&
3438 runparams.nice && found_space) {
3439 warned_about_spaces = true;
3440 Alert::warning(_("Export Warning!"),
3441 _("There are spaces in the paths to your BibTeX databases.\n"
3442 "BibTeX will be unable to find them."));
3451 string Buffer::layoutPos() const
3453 return d->layout_position;
3457 void Buffer::setLayoutPos(string const & path)
3460 d->layout_position.clear();
3464 LATTEST(FileName::isAbsolute(path));
3466 d->layout_position =
3467 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3469 if (d->layout_position.empty())
3470 d->layout_position = ".";
3474 bool Buffer::hasReadonlyFlag() const
3476 return d->read_only;
3480 bool Buffer::isReadonly() const
3482 return hasReadonlyFlag() || notifiesExternalModification();
3486 void Buffer::setParent(Buffer const * buffer)
3488 // Avoids recursive include.
3489 d->setParent(buffer == this ? 0 : buffer);
3494 Buffer const * Buffer::parent() const
3500 ListOfBuffers Buffer::allRelatives() const
3502 ListOfBuffers lb = masterBuffer()->getDescendants();
3503 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3508 Buffer const * Buffer::masterBuffer() const
3510 // FIXME Should be make sure we are not in some kind
3511 // of recursive include? A -> B -> A will crash this.
3512 Buffer const * const pbuf = d->parent();
3516 return pbuf->masterBuffer();
3520 bool Buffer::isChild(Buffer * child) const
3522 return d->children_positions.find(child) != d->children_positions.end();
3526 DocIterator Buffer::firstChildPosition(Buffer const * child)
3528 Impl::BufferPositionMap::iterator it;
3529 it = d->children_positions.find(child);
3530 if (it == d->children_positions.end())
3531 return DocIterator(this);
3536 bool Buffer::hasChildren() const
3538 return !d->children_positions.empty();
3542 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3544 // loop over children
3545 for (auto const & p : d->children_positions) {
3546 Buffer * child = const_cast<Buffer *>(p.first);
3548 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3549 if (bit != clist.end())
3551 clist.push_back(child);
3553 // there might be grandchildren
3554 child->collectChildren(clist, true);
3559 ListOfBuffers Buffer::getChildren() const
3562 collectChildren(v, false);
3563 // Make sure we have not included ourselves.
3564 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3565 if (bit != v.end()) {
3566 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3573 ListOfBuffers Buffer::getDescendants() const
3576 collectChildren(v, true);
3577 // Make sure we have not included ourselves.
3578 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3579 if (bit != v.end()) {
3580 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3587 template<typename M>
3588 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3593 typename M::const_iterator it = m.lower_bound(x);
3594 if (it == m.begin())
3602 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3603 DocIterator const & pos) const
3605 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3607 // if paragraphs have no macro context set, pos will be empty
3611 // we haven't found anything yet
3612 DocIterator bestPos = owner_->par_iterator_begin();
3613 MacroData const * bestData = 0;
3615 // find macro definitions for name
3616 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3617 if (nameIt != macros.end()) {
3618 // find last definition in front of pos or at pos itself
3619 PositionScopeMacroMap::const_iterator it
3620 = greatest_below(nameIt->second, pos);
3621 if (it != nameIt->second.end()) {
3623 // scope ends behind pos?
3624 if (pos < it->second.scope) {
3625 // Looks good, remember this. If there
3626 // is no external macro behind this,
3627 // we found the right one already.
3628 bestPos = it->first;
3629 bestData = &it->second.macro;
3633 // try previous macro if there is one
3634 if (it == nameIt->second.begin())
3641 // find macros in included files
3642 PositionScopeBufferMap::const_iterator it
3643 = greatest_below(position_to_children, pos);
3644 if (it == position_to_children.end())
3645 // no children before
3649 // do we know something better (i.e. later) already?
3650 if (it->first < bestPos )
3653 // scope ends behind pos?
3654 if (pos < it->second.scope
3655 && (cloned_buffer_ ||
3656 theBufferList().isLoaded(it->second.buffer))) {
3657 // look for macro in external file
3659 MacroData const * data
3660 = it->second.buffer->getMacro(name, false);
3663 bestPos = it->first;
3669 // try previous file if there is one
3670 if (it == position_to_children.begin())
3675 // return the best macro we have found
3680 MacroData const * Buffer::getMacro(docstring const & name,
3681 DocIterator const & pos, bool global) const
3686 // query buffer macros
3687 MacroData const * data = d->getBufferMacro(name, pos);
3691 // If there is a master buffer, query that
3692 Buffer const * const pbuf = d->parent();
3694 d->macro_lock = true;
3695 MacroData const * macro = pbuf->getMacro(
3696 name, *this, false);
3697 d->macro_lock = false;
3703 data = MacroTable::globalMacros().get(name);
3712 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3714 // set scope end behind the last paragraph
3715 DocIterator scope = par_iterator_begin();
3716 scope.pit() = scope.lastpit() + 1;
3718 return getMacro(name, scope, global);
3722 MacroData const * Buffer::getMacro(docstring const & name,
3723 Buffer const & child, bool global) const
3725 // look where the child buffer is included first
3726 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3727 if (it == d->children_positions.end())
3730 // check for macros at the inclusion position
3731 return getMacro(name, it->second, global);
3735 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3737 pit_type const lastpit = it.lastpit();
3739 // look for macros in each paragraph
3740 while (it.pit() <= lastpit) {
3741 Paragraph & par = it.paragraph();
3743 // FIXME Can this be done with the new-style iterators?
3744 // iterate over the insets of the current paragraph
3745 for (auto const & insit : par.insetList()) {
3746 it.pos() = insit.pos;
3748 // is it a nested text inset?
3749 if (insit.inset->asInsetText()) {
3750 // Inset needs its own scope?
3751 InsetText const * itext = insit.inset->asInsetText();
3752 bool newScope = itext->isMacroScope();
3754 // scope which ends just behind the inset
3755 DocIterator insetScope = it;
3758 // collect macros in inset
3759 it.push_back(CursorSlice(*insit.inset));
3760 updateMacros(it, newScope ? insetScope : scope);
3765 if (insit.inset->asInsetTabular()) {
3766 CursorSlice slice(*insit.inset);
3767 size_t const numcells = slice.nargs();
3768 for (; slice.idx() < numcells; slice.forwardIdx()) {
3769 it.push_back(slice);
3770 updateMacros(it, scope);
3776 // is it an external file?
3777 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3778 // get buffer of external file
3779 InsetInclude const & incinset =
3780 static_cast<InsetInclude const &>(*insit.inset);
3782 Buffer * child = incinset.getChildBuffer();
3787 // register its position, but only when it is
3788 // included first in the buffer
3789 if (children_positions.find(child) ==
3790 children_positions.end())
3791 children_positions[child] = it;
3793 // register child with its scope
3794 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3798 InsetMath * im = insit.inset->asInsetMath();
3799 if (doing_export && im) {
3800 InsetMathHull * hull = im->asHullInset();
3802 hull->recordLocation(it);
3805 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3809 InsetMathMacroTemplate & macroTemplate =
3810 *insit.inset->asInsetMath()->asMacroTemplate();
3811 MacroContext mc(owner_, it);
3812 macroTemplate.updateToContext(mc);
3815 bool valid = macroTemplate.validMacro();
3816 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3817 // then the BufferView's cursor will be invalid in
3818 // some cases which leads to crashes.
3823 // FIXME (Abdel), I don't understand why we pass 'it' here
3824 // instead of 'macroTemplate' defined above... is this correct?
3825 macros[macroTemplate.name()][it] =
3826 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3836 void Buffer::updateMacros() const
3841 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3843 // start with empty table
3845 d->children_positions.clear();
3846 d->position_to_children.clear();
3848 // Iterate over buffer, starting with first paragraph
3849 // The scope must be bigger than any lookup DocIterator
3850 // later. For the global lookup, lastpit+1 is used, hence
3851 // we use lastpit+2 here.
3852 DocIterator it = par_iterator_begin();
3853 DocIterator outerScope = it;
3854 outerScope.pit() = outerScope.lastpit() + 2;
3855 d->updateMacros(it, outerScope);
3859 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3861 InsetIterator it = inset_iterator_begin(inset());
3862 InsetIterator const end = inset_iterator_end(inset());
3863 for (; it != end; ++it) {
3864 if (it->lyxCode() == BRANCH_CODE) {
3865 InsetBranch & br = static_cast<InsetBranch &>(*it);
3866 docstring const name = br.branch();
3867 if (!from_master && !params().branchlist().find(name))
3868 result.push_back(name);
3869 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3870 result.push_back(name);
3873 if (it->lyxCode() == INCLUDE_CODE) {
3874 // get buffer of external file
3875 InsetInclude const & ins =
3876 static_cast<InsetInclude const &>(*it);
3877 Buffer * child = ins.getChildBuffer();
3880 child->getUsedBranches(result, true);
3883 // remove duplicates
3888 void Buffer::updateMacroInstances(UpdateType utype) const
3890 LYXERR(Debug::MACROS, "updateMacroInstances for "
3891 << d->filename.onlyFileName());
3892 DocIterator it = doc_iterator_begin(this);
3894 DocIterator const end = doc_iterator_end(this);
3895 for (; it != end; it.forwardInset()) {
3896 // look for MathData cells in InsetMathNest insets
3897 InsetMath * minset = it.nextInset()->asInsetMath();
3901 // update macro in all cells of the InsetMathNest
3902 DocIterator::idx_type n = minset->nargs();
3903 MacroContext mc = MacroContext(this, it);
3904 for (DocIterator::idx_type i = 0; i < n; ++i) {
3905 MathData & data = minset->cell(i);
3906 data.updateMacros(0, mc, utype, 0);
3912 void Buffer::listMacroNames(MacroNameSet & macros) const
3917 d->macro_lock = true;
3919 // loop over macro names
3920 for (auto const & nameit : d->macros)
3921 macros.insert(nameit.first);
3923 // loop over children
3924 for (auto const & p : d->children_positions) {
3925 Buffer * child = const_cast<Buffer *>(p.first);
3926 // The buffer might have been closed (see #10766).
3927 if (theBufferList().isLoaded(child))
3928 child->listMacroNames(macros);
3932 Buffer const * const pbuf = d->parent();
3934 pbuf->listMacroNames(macros);
3936 d->macro_lock = false;
3940 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3942 Buffer const * const pbuf = d->parent();
3947 pbuf->listMacroNames(names);
3950 for (auto const & mit : names) {
3952 MacroData const * data = pbuf->getMacro(mit, *this, false);
3954 macros.insert(data);
3956 // we cannot access the original InsetMathMacroTemplate anymore
3957 // here to calls validate method. So we do its work here manually.
3958 // FIXME: somehow make the template accessible here.
3959 if (data->optionals() > 0)
3960 features.require("xargs");
3966 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3969 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3971 RefCache::iterator it = d->ref_cache_.find(label);
3972 if (it != d->ref_cache_.end())
3975 static References const dummy_refs = References();
3976 it = d->ref_cache_.insert(
3977 make_pair(label, dummy_refs)).first;
3982 Buffer::References const & Buffer::references(docstring const & label) const
3984 return const_cast<Buffer *>(this)->getReferenceCache(label);
3988 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3990 References & refs = getReferenceCache(label);
3991 refs.push_back(make_pair(inset, it));
3995 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3999 linfo.label = label;
4001 linfo.active = active;
4002 masterBuffer()->d->label_cache_.push_back(linfo);
4006 InsetLabel const * Buffer::insetLabel(docstring const & label,
4007 bool const active) const
4009 for (auto & rc : masterBuffer()->d->label_cache_) {
4010 if (rc.label == label && (rc.active || !active))
4017 bool Buffer::activeLabel(docstring const & label) const
4019 if (!insetLabel(label, true))
4026 void Buffer::clearReferenceCache() const
4029 d->ref_cache_.clear();
4030 d->label_cache_.clear();
4035 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4037 //FIXME: This does not work for child documents yet.
4038 reloadBibInfoCache();
4040 // Check if the label 'from' appears more than once
4041 vector<docstring> labels;
4042 for (auto const & bibit : masterBibInfo())
4043 labels.push_back(bibit.first);
4045 if (count(labels.begin(), labels.end(), from) > 1)
4048 string const paramName = "key";
4049 InsetIterator it = inset_iterator_begin(inset());
4051 if (it->lyxCode() != CITE_CODE)
4053 InsetCommand * inset = it->asInsetCommand();
4054 docstring const oldValue = inset->getParam(paramName);
4055 if (oldValue == from)
4056 inset->setParam(paramName, to);
4060 // returns NULL if id-to-row conversion is unsupported
4061 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4062 pit_type par_begin, pit_type par_end,
4063 OutputWhat output, bool master) const
4065 unique_ptr<TexRow> texrow;
4066 OutputParams runparams(¶ms().encoding());
4067 runparams.nice = true;
4068 runparams.flavor = params().getOutputFlavor(format);
4069 runparams.linelen = lyxrc.plaintext_linelen;
4070 // No side effect of file copying and image conversion
4071 runparams.dryrun = true;
4073 // Some macros rely on font encoding
4074 runparams.main_fontenc = params().main_font_encoding();
4076 if (output == CurrentParagraph) {
4077 runparams.par_begin = par_begin;
4078 runparams.par_end = par_end;
4079 if (par_begin + 1 == par_end) {
4081 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4085 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4086 convert<docstring>(par_begin),
4087 convert<docstring>(par_end - 1))
4090 // output paragraphs
4091 if (runparams.flavor == OutputParams::LYX) {
4092 Paragraph const & par = text().paragraphs()[par_begin];
4094 depth_type dt = par.getDepth();
4095 par.write(ods, params(), dt);
4096 os << from_utf8(ods.str());
4097 } else if (runparams.flavor == OutputParams::HTML) {
4099 setMathFlavor(runparams);
4100 xhtmlParagraphs(text(), *this, xs, runparams);
4101 } else if (runparams.flavor == OutputParams::TEXT) {
4103 // FIXME Handles only one paragraph, unlike the others.
4104 // Probably should have some routine with a signature like them.
4105 writePlaintextParagraph(*this,
4106 text().paragraphs()[par_begin], os, runparams, dummy);
4107 } else if (params().isDocBook()) {
4108 docbookParagraphs(text(), *this, os, runparams);
4110 // If we are previewing a paragraph, even if this is the
4111 // child of some other buffer, let's cut the link here,
4112 // so that no concurring settings from the master
4113 // (e.g. branch state) interfere (see #8101).
4115 d->ignore_parent = true;
4116 // We need to validate the Buffer params' features here
4117 // in order to know if we should output polyglossia
4118 // macros (instead of babel macros)
4119 LaTeXFeatures features(*this, params(), runparams);
4121 runparams.use_polyglossia = features.usePolyglossia();
4122 // latex or literate
4125 ots.texrow().newlines(2);
4127 latexParagraphs(*this, text(), ots, runparams);
4128 texrow = ots.releaseTexRow();
4130 // Restore the parenthood
4132 d->ignore_parent = false;
4136 if (output == FullSource)
4137 os << _("Preview source code");
4138 else if (output == OnlyPreamble)
4139 os << _("Preview preamble");
4140 else if (output == OnlyBody)
4141 os << _("Preview body");
4143 if (runparams.flavor == OutputParams::LYX) {
4145 if (output == FullSource)
4147 else if (output == OnlyPreamble)
4148 params().writeFile(ods, this);
4149 else if (output == OnlyBody)
4151 os << from_utf8(ods.str());
4152 } else if (runparams.flavor == OutputParams::HTML) {
4153 writeLyXHTMLSource(os, runparams, output);
4154 } else if (runparams.flavor == OutputParams::TEXT) {
4155 if (output == OnlyPreamble) {
4156 os << "% "<< _("Plain text does not have a preamble.");
4158 writePlaintextFile(*this, os, runparams);
4159 } else if (params().isDocBook()) {
4160 writeDocBookSource(os, absFileName(), runparams, output);
4162 // latex or literate
4165 ots.texrow().newlines(2);
4167 runparams.is_child = true;
4169 writeLaTeXSource(ots, string(), runparams, output);
4170 texrow = ots.releaseTexRow();
4177 ErrorList & Buffer::errorList(string const & type) const
4179 return d->errorLists[type];
4183 void Buffer::updateTocItem(std::string const & type,
4184 DocIterator const & dit) const
4187 d->gui_->updateTocItem(type, dit);
4191 void Buffer::structureChanged() const
4194 d->gui_->structureChanged();
4198 void Buffer::errors(string const & err, bool from_master) const
4201 d->gui_->errors(err, from_master);
4205 void Buffer::message(docstring const & msg) const
4208 d->gui_->message(msg);
4212 void Buffer::setBusy(bool on) const
4215 d->gui_->setBusy(on);
4219 void Buffer::updateTitles() const
4222 d->wa_->updateTitles();
4226 void Buffer::resetAutosaveTimers() const
4229 d->gui_->resetAutosaveTimers();
4233 bool Buffer::hasGuiDelegate() const
4239 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4248 class AutoSaveBuffer : public ForkedProcess {
4251 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4252 : buffer_(buffer), fname_(fname) {}
4254 virtual shared_ptr<ForkedProcess> clone() const
4256 return make_shared<AutoSaveBuffer>(*this);
4261 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4262 from_utf8(fname_.absFileName())));
4263 return run(DontWait);
4267 virtual int generateChild();
4269 Buffer const & buffer_;
4274 int AutoSaveBuffer::generateChild()
4276 #if defined(__APPLE__)
4277 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4278 * We should use something else like threads.
4280 * Since I do not know how to determine at run time what is the OS X
4281 * version, I just disable forking altogether for now (JMarc)
4283 pid_t const pid = -1;
4285 // tmp_ret will be located (usually) in /tmp
4286 // will that be a problem?
4287 // Note that this calls ForkedCalls::fork(), so it's
4288 // ok cross-platform.
4289 pid_t const pid = fork();
4290 // If you want to debug the autosave
4291 // you should set pid to -1, and comment out the fork.
4292 if (pid != 0 && pid != -1)
4296 // pid = -1 signifies that lyx was unable
4297 // to fork. But we will do the save
4299 bool failed = false;
4300 TempFile tempfile("lyxautoXXXXXX.lyx");
4301 tempfile.setAutoRemove(false);
4302 FileName const tmp_ret = tempfile.name();
4303 if (!tmp_ret.empty()) {
4304 if (!buffer_.writeFile(tmp_ret))
4306 else if (!tmp_ret.moveTo(fname_))
4312 // failed to write/rename tmp_ret so try writing direct
4313 if (!buffer_.writeFile(fname_)) {
4314 // It is dangerous to do this in the child,
4315 // but safe in the parent, so...
4316 if (pid == -1) // emit message signal.
4317 buffer_.message(_("Autosave failed!"));
4321 if (pid == 0) // we are the child so...
4330 FileName Buffer::getEmergencyFileName() const
4332 return FileName(d->filename.absFileName() + ".emergency");
4336 FileName Buffer::getAutosaveFileName() const
4338 // if the document is unnamed try to save in the backup dir, else
4339 // in the default document path, and as a last try in the filePath,
4340 // which will most often be the temporary directory
4343 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4344 : lyxrc.backupdir_path;
4345 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4348 string const fname = "#" + d->filename.onlyFileName() + "#";
4350 return makeAbsPath(fname, fpath);
4354 void Buffer::removeAutosaveFile() const
4356 FileName const f = getAutosaveFileName();
4362 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4364 FileName const newauto = getAutosaveFileName();
4366 if (newauto != oldauto && oldauto.exists())
4367 if (!oldauto.moveTo(newauto))
4368 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4372 bool Buffer::autoSave() const
4374 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4375 if (buf->d->bak_clean || hasReadonlyFlag())
4378 message(_("Autosaving current document..."));
4379 buf->d->bak_clean = true;
4381 FileName const fname = getAutosaveFileName();
4382 LASSERT(d->cloned_buffer_, return false);
4384 // If this buffer is cloned, we assume that
4385 // we are running in a separate thread already.
4386 TempFile tempfile("lyxautoXXXXXX.lyx");
4387 tempfile.setAutoRemove(false);
4388 FileName const tmp_ret = tempfile.name();
4389 if (!tmp_ret.empty()) {
4391 // assume successful write of tmp_ret
4392 if (tmp_ret.moveTo(fname))
4395 // failed to write/rename tmp_ret so try writing direct
4396 return writeFile(fname);
4400 void Buffer::setExportStatus(bool e) const
4402 d->doing_export = e;
4403 ListOfBuffers clist = getDescendants();
4404 for (auto const & bit : clist)
4405 bit->d->doing_export = e;
4409 bool Buffer::isExporting() const
4411 return d->doing_export;
4415 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4419 return doExport(target, put_in_tempdir, result_file);
4422 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4423 string & result_file) const
4425 bool const update_unincluded =
4426 params().maintain_unincluded_children
4427 && !params().getIncludedChildren().empty();
4429 // (1) export with all included children (omit \includeonly)
4430 if (update_unincluded) {
4431 ExportStatus const status =
4432 doExport(target, put_in_tempdir, true, result_file);
4433 if (status != ExportSuccess)
4436 // (2) export with included children only
4437 return doExport(target, put_in_tempdir, false, result_file);
4441 void Buffer::setMathFlavor(OutputParams & op) const
4443 switch (params().html_math_output) {
4444 case BufferParams::MathML:
4445 op.math_flavor = OutputParams::MathAsMathML;
4447 case BufferParams::HTML:
4448 op.math_flavor = OutputParams::MathAsHTML;
4450 case BufferParams::Images:
4451 op.math_flavor = OutputParams::MathAsImages;
4453 case BufferParams::LaTeX:
4454 op.math_flavor = OutputParams::MathAsLaTeX;
4460 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4461 bool includeall, string & result_file) const
4463 LYXERR(Debug::FILES, "target=" << target);
4464 OutputParams runparams(¶ms().encoding());
4465 string format = target;
4466 string dest_filename;
4467 size_t pos = target.find(' ');
4468 if (pos != string::npos) {
4469 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4470 format = target.substr(0, pos);
4471 if (format == "default")
4472 format = params().getDefaultOutputFormat();
4473 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4474 FileName(dest_filename).onlyPath().createPath();
4475 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4477 MarkAsExporting exporting(this);
4478 string backend_format;
4479 runparams.flavor = OutputParams::LATEX;
4480 runparams.linelen = lyxrc.plaintext_linelen;
4481 runparams.includeall = includeall;
4482 vector<string> backs = params().backends();
4483 Converters converters = theConverters();
4484 bool need_nice_file = false;
4485 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4486 // Get shortest path to format
4487 converters.buildGraph();
4488 Graph::EdgePath path;
4489 for (string const & sit : backs) {
4490 Graph::EdgePath p = converters.getPath(sit, format);
4491 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4492 backend_format = sit;
4497 if (!put_in_tempdir) {
4498 // Only show this alert if this is an export to a non-temporary
4499 // file (not for previewing).
4500 docstring s = bformat(_("No information for exporting the format %1$s."),
4501 theFormats().prettyName(format));
4502 if (format == "pdf4")
4504 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4505 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4506 Alert::error(_("Couldn't export file"), s);
4508 return ExportNoPathToFormat;
4510 runparams.flavor = converters.getFlavor(path, this);
4511 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4512 for (auto const & edge : path)
4513 if (theConverters().get(edge).nice()) {
4514 need_nice_file = true;
4519 backend_format = format;
4520 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4521 // FIXME: Don't hardcode format names here, but use a flag
4522 if (backend_format == "pdflatex")
4523 runparams.flavor = OutputParams::PDFLATEX;
4524 else if (backend_format == "luatex")
4525 runparams.flavor = OutputParams::LUATEX;
4526 else if (backend_format == "dviluatex")
4527 runparams.flavor = OutputParams::DVILUATEX;
4528 else if (backend_format == "xetex")
4529 runparams.flavor = OutputParams::XETEX;
4532 string filename = latexName(false);
4533 filename = addName(temppath(), filename);
4534 filename = changeExtension(filename,
4535 theFormats().extension(backend_format));
4536 LYXERR(Debug::FILES, "filename=" << filename);
4538 // Plain text backend
4539 if (backend_format == "text") {
4540 runparams.flavor = OutputParams::TEXT;
4542 writePlaintextFile(*this, FileName(filename), runparams);
4544 catch (ConversionException const &) { return ExportCancel; }
4547 else if (backend_format == "xhtml") {
4548 runparams.flavor = OutputParams::HTML;
4549 setMathFlavor(runparams);
4550 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4551 return ExportKilled;
4552 } else if (backend_format == "lyx")
4553 writeFile(FileName(filename));
4555 else if (params().isDocBook()) {
4556 runparams.nice = !put_in_tempdir;
4557 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4558 return ExportKilled;
4561 else if (backend_format == format || need_nice_file) {
4562 runparams.nice = true;
4563 ExportStatus const retval =
4564 makeLaTeXFile(FileName(filename), string(), runparams);
4565 if (retval == ExportKilled)
4566 return ExportKilled;
4567 if (d->cloned_buffer_)
4568 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4569 if (retval != ExportSuccess)
4571 } else if (!lyxrc.tex_allows_spaces
4572 && contains(filePath(), ' ')) {
4573 Alert::error(_("File name error"),
4574 bformat(_("The directory path to the document\n%1$s\n"
4575 "contains spaces, but your TeX installation does "
4576 "not allow them. You should save the file to a directory "
4577 "whose name does not contain spaces."), from_utf8(filePath())));
4578 return ExportTexPathHasSpaces;
4580 runparams.nice = false;
4581 ExportStatus const retval =
4582 makeLaTeXFile(FileName(filename), filePath(), runparams);
4583 if (retval == ExportKilled)
4584 return ExportKilled;
4585 if (d->cloned_buffer_)
4586 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4587 if (retval != ExportSuccess)
4591 string const error_type = (format == "program")
4592 ? "Build" : params().bufferFormat();
4593 ErrorList & error_list = d->errorLists[error_type];
4594 string const ext = theFormats().extension(format);
4595 FileName const tmp_result_file(changeExtension(filename, ext));
4596 Converters::RetVal const retval =
4597 converters.convert(this, FileName(filename), tmp_result_file,
4598 FileName(absFileName()), backend_format, format, error_list);
4599 if (retval == Converters::KILLED)
4600 return ExportCancel;
4601 bool success = (retval == Converters::SUCCESS);
4603 // Emit the signal to show the error list or copy it back to the
4604 // cloned Buffer so that it can be emitted afterwards.
4605 if (format != backend_format) {
4606 if (runparams.silent)
4608 else if (d->cloned_buffer_)
4609 d->cloned_buffer_->d->errorLists[error_type] =
4610 d->errorLists[error_type];
4613 // also to the children, in case of master-buffer-view
4614 ListOfBuffers clist = getDescendants();
4615 for (auto const & bit : clist) {
4616 if (runparams.silent)
4617 bit->d->errorLists[error_type].clear();
4618 else if (d->cloned_buffer_) {
4619 // Enable reverse search by copying back the
4620 // texrow object to the cloned buffer.
4621 // FIXME: this is not thread safe.
4622 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4623 bit->d->cloned_buffer_->d->errorLists[error_type] =
4624 bit->d->errorLists[error_type];
4626 bit->errors(error_type, true);
4630 if (d->cloned_buffer_) {
4631 // Enable reverse dvi or pdf to work by copying back the texrow
4632 // object to the cloned buffer.
4633 // FIXME: There is a possibility of concurrent access to texrow
4634 // here from the main GUI thread that should be securized.
4635 d->cloned_buffer_->d->texrow = d->texrow;
4636 string const err_type = params().bufferFormat();
4637 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4641 if (put_in_tempdir) {
4642 result_file = tmp_result_file.absFileName();
4643 return success ? ExportSuccess : ExportConverterError;
4646 if (dest_filename.empty())
4647 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4649 result_file = dest_filename;
4650 // We need to copy referenced files (e. g. included graphics
4651 // if format == "dvi") to the result dir.
4652 vector<ExportedFile> const extfiles =
4653 runparams.exportdata->externalFiles(format);
4654 string const dest = runparams.export_folder.empty() ?
4655 onlyPath(result_file) : runparams.export_folder;
4656 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4657 : force_overwrite == ALL_FILES;
4658 CopyStatus status = use_force ? FORCE : SUCCESS;
4660 for (ExportedFile const & exp : extfiles) {
4661 if (status == CANCEL) {
4662 message(_("Document export cancelled."));
4663 return ExportCancel;
4665 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4666 string fixedName = exp.exportName;
4667 if (!runparams.export_folder.empty()) {
4668 // Relative pathnames starting with ../ will be sanitized
4669 // if exporting to a different folder
4670 while (fixedName.substr(0, 3) == "../")
4671 fixedName = fixedName.substr(3, fixedName.length() - 3);
4673 FileName fixedFileName = makeAbsPath(fixedName, dest);
4674 fixedFileName.onlyPath().createPath();
4675 status = copyFile(fmt, exp.sourceName,
4677 exp.exportName, status == FORCE,
4678 runparams.export_folder.empty());
4682 if (tmp_result_file.exists()) {
4683 // Finally copy the main file
4684 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4685 : force_overwrite != NO_FILES;
4686 if (status == SUCCESS && use_force)
4688 status = copyFile(format, tmp_result_file,
4689 FileName(result_file), result_file,
4691 if (status == CANCEL) {
4692 message(_("Document export cancelled."));
4693 return ExportCancel;
4695 message(bformat(_("Document exported as %1$s "
4697 theFormats().prettyName(format),
4698 makeDisplayPath(result_file)));
4701 // This must be a dummy converter like fax (bug 1888)
4702 message(bformat(_("Document exported as %1$s"),
4703 theFormats().prettyName(format)));
4706 return success ? ExportSuccess : ExportConverterError;
4710 Buffer::ExportStatus Buffer::preview(string const & format) const
4712 bool const update_unincluded =
4713 params().maintain_unincluded_children
4714 && !params().getIncludedChildren().empty();
4715 return preview(format, update_unincluded);
4719 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4721 MarkAsExporting exporting(this);
4723 // (1) export with all included children (omit \includeonly)
4725 ExportStatus const status = doExport(format, true, true, result_file);
4726 if (status != ExportSuccess)
4729 // (2) export with included children only
4730 ExportStatus const status = doExport(format, true, false, result_file);
4731 FileName const previewFile(result_file);
4733 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4734 theimpl->preview_file_ = previewFile;
4735 theimpl->preview_format_ = format;
4736 theimpl->require_fresh_start_ = (status != ExportSuccess);
4738 if (status != ExportSuccess)
4741 if (previewFile.exists())
4742 return theFormats().view(*this, previewFile, format) ?
4743 PreviewSuccess : PreviewError;
4745 // Successful export but no output file?
4746 // Probably a bug in error detection.
4747 LATTEST(status != ExportSuccess);
4752 Buffer::ReadStatus Buffer::extractFromVC()
4754 bool const found = LyXVC::file_not_found_hook(d->filename);
4756 return ReadFileNotFound;
4757 if (!d->filename.isReadableFile())
4763 Buffer::ReadStatus Buffer::loadEmergency()
4765 FileName const emergencyFile = getEmergencyFileName();
4766 if (!emergencyFile.exists()
4767 || emergencyFile.lastModified() <= d->filename.lastModified())
4768 return ReadFileNotFound;
4770 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4771 docstring const text = bformat(_("An emergency save of the document "
4772 "%1$s exists.\n\nRecover emergency save?"), file);
4774 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4775 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4781 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4782 bool const success = (ret_llf == ReadSuccess);
4784 if (hasReadonlyFlag()) {
4785 Alert::warning(_("File is read-only"),
4786 bformat(_("An emergency file is successfully loaded, "
4787 "but the original file %1$s is marked read-only. "
4788 "Please make sure to save the document as a different "
4789 "file."), from_utf8(d->filename.absFileName())));
4792 lyxvc().file_found_hook(d->filename);
4793 str = _("Document was successfully recovered.");
4795 str = _("Document was NOT successfully recovered.");
4796 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4797 makeDisplayPath(emergencyFile.absFileName()));
4799 int const del_emerg =
4800 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4801 _("&Remove"), _("&Keep"));
4802 if (del_emerg == 0) {
4803 emergencyFile.removeFile();
4805 Alert::warning(_("Emergency file deleted"),
4806 _("Do not forget to save your file now!"), true);
4808 return success ? ReadSuccess : ReadEmergencyFailure;
4811 int const del_emerg =
4812 Alert::prompt(_("Delete emergency file?"),
4813 _("Remove emergency file now?"), 1, 1,
4814 _("&Remove"), _("&Keep"));
4816 emergencyFile.removeFile();
4820 string const ename = emergencyFile.absFileName();
4822 // Surely we can find one in 100 tries?
4823 for (int i = 1; i < 100; ++i) {
4824 newname.set(ename + to_string(i) + ".lyx");
4825 if (!newname.exists()) {
4831 // renameTo returns true on success. So inverting that
4832 // will give us true if we fail.
4833 noname = !emergencyFile.renameTo(newname);
4836 Alert::warning(_("Can't rename emergency file!"),
4837 _("LyX was unable to rename the emergency file. "
4838 "You should do so manually. Otherwise, you will be "
4839 "asked about it again the next time you try to load "
4840 "this file, and may over-write your own work."));
4842 Alert::warning(_("Emergency File Renames"),
4843 bformat(_("Emergency file renamed as:\n %1$s"),
4844 from_utf8(newname.onlyFileName())));
4847 return ReadOriginal;
4857 Buffer::ReadStatus Buffer::loadAutosave()
4859 // Now check if autosave file is newer.
4860 FileName const autosaveFile = getAutosaveFileName();
4861 if (!autosaveFile.exists()
4862 || autosaveFile.lastModified() <= d->filename.lastModified())
4863 return ReadFileNotFound;
4865 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4866 docstring const text = bformat(_("The backup of the document %1$s "
4867 "is newer.\n\nLoad the backup instead?"), file);
4868 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4869 _("&Load backup"), _("Load &original"), _("&Cancel"));
4874 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4875 // the file is not saved if we load the autosave file.
4876 if (ret_llf == ReadSuccess) {
4877 if (hasReadonlyFlag()) {
4878 Alert::warning(_("File is read-only"),
4879 bformat(_("A backup file is successfully loaded, "
4880 "but the original file %1$s is marked read-only. "
4881 "Please make sure to save the document as a "
4883 from_utf8(d->filename.absFileName())));
4886 lyxvc().file_found_hook(d->filename);
4889 return ReadAutosaveFailure;
4892 // Here we delete the autosave
4893 autosaveFile.removeFile();
4894 return ReadOriginal;
4902 Buffer::ReadStatus Buffer::loadLyXFile()
4904 if (!d->filename.isReadableFile()) {
4905 ReadStatus const ret_rvc = extractFromVC();
4906 if (ret_rvc != ReadSuccess)
4910 ReadStatus const ret_re = loadEmergency();
4911 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4914 ReadStatus const ret_ra = loadAutosave();
4915 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4918 return loadThisLyXFile(d->filename);
4922 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4924 return readFile(fn);
4928 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4930 for (; err != end; ++err) {
4931 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4932 int errorRow = err->error_in_line;
4933 Buffer const * buf = 0;
4934 Impl const * p = this;
4935 if (err->child_name.empty())
4936 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4938 // The error occurred in a child
4939 for (Buffer const * child : owner_->getDescendants()) {
4940 string const child_name =
4941 DocFileName(changeExtension(child->absFileName(), "tex")).
4943 if (err->child_name != child_name)
4945 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4946 if (!TexRow::isNone(start)) {
4947 buf = this->cloned_buffer_
4948 ? child->d->cloned_buffer_->d->owner_
4955 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4961 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4963 TeXErrors::Errors::const_iterator err = terr.begin();
4964 TeXErrors::Errors::const_iterator end = terr.end();
4966 d->traverseErrors(err, end, errorList);
4970 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4972 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4973 TeXErrors::Errors::const_iterator end = terr.end_ref();
4975 d->traverseErrors(err, end, errorList);
4979 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4981 LBUFERR(!text().paragraphs().empty());
4983 // Use the master text class also for child documents
4984 Buffer const * const master = masterBuffer();
4985 DocumentClass const & textclass = master->params().documentClass();
4987 docstring_list old_bibfiles;
4988 // Do this only if we are the top-level Buffer. We also need to account
4989 // for the case of a previewed child with ignored parent here.
4990 if (master == this && !d->ignore_parent) {
4991 textclass.counters().reset(from_ascii("bibitem"));
4992 reloadBibInfoCache();
4993 // we will re-read this cache as we go through, but we need
4994 // to know whether it's changed to know whether we need to
4995 // update the bibinfo cache.
4996 old_bibfiles = d->bibfiles_cache_;
4997 d->bibfiles_cache_.clear();
5000 // keep the buffers to be children in this set. If the call from the
5001 // master comes back we can see which of them were actually seen (i.e.
5002 // via an InsetInclude). The remaining ones in the set need still be updated.
5003 static std::set<Buffer const *> bufToUpdate;
5004 if (scope == UpdateMaster) {
5005 // If this is a child document start with the master
5006 if (master != this) {
5007 bufToUpdate.insert(this);
5008 master->updateBuffer(UpdateMaster, utype);
5009 // If the master buffer has no gui associated with it, then the TocModel is
5010 // not updated during the updateBuffer call and TocModel::toc_ is invalid
5011 // (bug 5699). The same happens if the master buffer is open in a different
5012 // window. This test catches both possibilities.
5013 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5014 // There remains a problem here: If there is another child open in yet a third
5015 // window, that TOC is not updated. So some more general solution is needed at
5017 if (master->d->gui_ != d->gui_)
5020 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5021 if (bufToUpdate.find(this) == bufToUpdate.end())
5025 // start over the counters in the master
5026 textclass.counters().reset();
5029 // update will be done below for this buffer
5030 bufToUpdate.erase(this);
5032 // update all caches
5033 clearReferenceCache();
5035 setChangesPresent(false);
5037 Buffer & cbuf = const_cast<Buffer &>(*this);
5038 // if we are reloading, then we could have a dangling TOC,
5039 // in effect. so we need to go ahead and reset, even though
5040 // we will do so again when we rebuild the TOC later.
5041 cbuf.tocBackend().reset();
5044 ParIterator parit = cbuf.par_iterator_begin();
5045 updateBuffer(parit, utype);
5047 // If this document has siblings, then update the TocBackend later. The
5048 // reason is to ensure that later siblings are up to date when e.g. the
5049 // broken or not status of references is computed. The update is called
5050 // in InsetInclude::addToToc.
5054 // if the bibfiles changed, the cache of bibinfo is invalid
5055 docstring_list new_bibfiles = d->bibfiles_cache_;
5056 // this is a trick to determine whether the two vectors have
5057 // the same elements.
5058 sort(new_bibfiles.begin(), new_bibfiles.end());
5059 sort(old_bibfiles.begin(), old_bibfiles.end());
5060 if (old_bibfiles != new_bibfiles) {
5061 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5062 invalidateBibinfoCache();
5063 reloadBibInfoCache();
5064 // We relied upon the bibinfo cache when recalculating labels. But that
5065 // cache was invalid, although we didn't find that out until now. So we
5066 // have to do it all again.
5067 // That said, the only thing we really need to do is update the citation
5068 // labels. Nothing else will have changed. So we could create a new
5069 // UpdateType that would signal that fact, if we needed to do so.
5070 parit = cbuf.par_iterator_begin();
5071 // we will be re-doing the counters and references and such.
5072 textclass.counters().reset();
5073 clearReferenceCache();
5074 // we should not need to do this again?
5076 setChangesPresent(false);
5077 updateBuffer(parit, utype);
5078 // this will already have been done by reloadBibInfoCache();
5079 // d->bibinfo_cache_valid_ = true;
5082 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5083 // this is also set to true on the other path, by reloadBibInfoCache.
5084 d->bibinfo_cache_valid_ = true;
5086 d->cite_labels_valid_ = true;
5088 cbuf.tocBackend().update(true, utype);
5089 if (scope == UpdateMaster)
5090 cbuf.structureChanged();
5094 static depth_type getDepth(DocIterator const & it)
5096 depth_type depth = 0;
5097 for (size_t i = 0 ; i < it.depth() ; ++i)
5098 if (!it[i].inset().inMathed())
5099 depth += it[i].paragraph().getDepth() + 1;
5100 // remove 1 since the outer inset does not count
5101 // we should have at least one non-math inset, so
5102 // depth should nevery be 0. but maybe it is worth
5103 // marking this, just in case.
5105 // coverity[INTEGER_OVERFLOW]
5109 static depth_type getItemDepth(ParIterator const & it)
5111 Paragraph const & par = *it;
5112 LabelType const labeltype = par.layout().labeltype;
5114 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5117 // this will hold the lowest depth encountered up to now.
5118 depth_type min_depth = getDepth(it);
5119 ParIterator prev_it = it;
5122 --prev_it.top().pit();
5124 // start of nested inset: go to outer par
5126 if (prev_it.empty()) {
5127 // start of document: nothing to do
5132 // We search for the first paragraph with same label
5133 // that is not more deeply nested.
5134 Paragraph & prev_par = *prev_it;
5135 depth_type const prev_depth = getDepth(prev_it);
5136 if (labeltype == prev_par.layout().labeltype) {
5137 if (prev_depth < min_depth)
5138 return prev_par.itemdepth + 1;
5139 if (prev_depth == min_depth)
5140 return prev_par.itemdepth;
5142 min_depth = min(min_depth, prev_depth);
5143 // small optimization: if we are at depth 0, we won't
5144 // find anything else
5145 if (prev_depth == 0)
5151 static bool needEnumCounterReset(ParIterator const & it)
5153 Paragraph const & par = *it;
5154 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5155 depth_type const cur_depth = par.getDepth();
5156 ParIterator prev_it = it;
5157 while (prev_it.pit()) {
5158 --prev_it.top().pit();
5159 Paragraph const & prev_par = *prev_it;
5160 if (prev_par.getDepth() <= cur_depth)
5161 return prev_par.layout().name() != par.layout().name();
5163 // start of nested inset: reset
5168 // set the label of a paragraph. This includes the counters.
5169 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5171 BufferParams const & bp = owner_->masterBuffer()->params();
5172 DocumentClass const & textclass = bp.documentClass();
5173 Paragraph & par = it.paragraph();
5174 Layout const & layout = par.layout();
5175 Counters & counters = textclass.counters();
5177 if (par.params().startOfAppendix()) {
5178 // We want to reset the counter corresponding to toplevel sectioning
5179 Layout const & lay = textclass.getTOCLayout();
5180 docstring const cnt = lay.counter;
5182 counters.reset(cnt);
5183 counters.appendix(true);
5185 par.params().appendix(counters.appendix());
5187 // Compute the item depth of the paragraph
5188 par.itemdepth = getItemDepth(it);
5190 if (layout.margintype == MARGIN_MANUAL) {
5191 if (par.params().labelWidthString().empty())
5192 par.params().labelWidthString(par.expandLabel(layout, bp));
5193 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5194 // we do not need to do anything here, since the empty case is
5195 // handled during export.
5197 par.params().labelWidthString(docstring());
5200 switch(layout.labeltype) {
5201 case LABEL_ITEMIZE: {
5202 // At some point of time we should do something more
5203 // clever here, like:
5204 // par.params().labelString(
5205 // bp.user_defined_bullet(par.itemdepth).getText());
5206 // for now, use a simple hardcoded label
5207 docstring itemlabel;
5208 switch (par.itemdepth) {
5211 itemlabel = char_type(0x2022);
5215 itemlabel = char_type(0x2013);
5218 // ∗ U+2217 ASTERISK OPERATOR
5219 itemlabel = char_type(0x2217);
5222 // · U+00B7 MIDDLE DOT
5223 itemlabel = char_type(0x00b7);
5226 par.params().labelString(itemlabel);
5230 case LABEL_ENUMERATE: {
5231 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5233 switch (par.itemdepth) {
5244 enumcounter += "iv";
5247 // not a valid enumdepth...
5251 if (needEnumCounterReset(it)) {
5252 // Increase the master counter?
5253 if (layout.stepmastercounter)
5254 counters.stepMaster(enumcounter, utype);
5255 // Maybe we have to reset the enumeration counter.
5256 if (!layout.resumecounter)
5257 counters.reset(enumcounter);
5259 counters.step(enumcounter, utype);
5261 string const & lang = par.getParLanguage(bp)->code();
5262 par.params().labelString(counters.theCounter(enumcounter, lang));
5267 case LABEL_SENSITIVE: {
5268 string const & type = counters.current_float();
5269 docstring full_label;
5271 full_label = owner_->B_("Senseless!!! ");
5273 docstring name = owner_->B_(textclass.floats().getType(type).name());
5274 if (counters.hasCounter(from_utf8(type))) {
5275 string const & lang = par.getParLanguage(bp)->code();
5276 counters.step(from_utf8(type), utype);
5277 full_label = bformat(from_ascii("%1$s %2$s:"),
5279 counters.theCounter(from_utf8(type), lang));
5281 full_label = bformat(from_ascii("%1$s #:"), name);
5283 par.params().labelString(full_label);
5287 case LABEL_NO_LABEL:
5288 par.params().labelString(docstring());
5292 case LABEL_CENTERED:
5293 case LABEL_STATIC: {
5294 docstring const & lcounter = layout.counter;
5295 if (!lcounter.empty()) {
5296 if (layout.toclevel <= bp.secnumdepth
5297 && (layout.latextype != LATEX_ENVIRONMENT
5298 || it.text()->isFirstInSequence(it.pit()))) {
5299 if (counters.hasCounter(lcounter))
5300 counters.step(lcounter, utype);
5301 par.params().labelString(par.expandLabel(layout, bp));
5303 par.params().labelString(docstring());
5305 par.params().labelString(par.expandLabel(layout, bp));
5311 par.params().labelString(par.expandLabel(layout, bp));
5316 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5318 // LASSERT: Is it safe to continue here, or should we just return?
5319 LASSERT(parit.pit() == 0, /**/);
5321 // Set the position of the text in the buffer to be able
5322 // to resolve macros in it.
5323 parit.text()->setMacrocontextPosition(parit);
5325 // Reset bibitem counter in master (#8499)
5326 Buffer const * const master = masterBuffer();
5327 if (master == this && !d->ignore_parent)
5328 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5330 depth_type maxdepth = 0;
5331 pit_type const lastpit = parit.lastpit();
5332 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5333 // reduce depth if necessary
5334 if (parit->params().depth() > maxdepth) {
5335 /** FIXME: this function is const, but
5336 * nevertheless it modifies the buffer. To be
5337 * cleaner, one should modify the buffer in
5338 * another function, which is actually
5339 * non-const. This would however be costly in
5340 * terms of code duplication.
5342 CursorData(parit).recordUndo();
5343 parit->params().depth(maxdepth);
5345 maxdepth = parit->getMaxDepthAfter();
5347 if (utype == OutputUpdate) {
5348 // track the active counters
5349 // we have to do this for the master buffer, since the local
5350 // buffer isn't tracking anything.
5351 masterBuffer()->params().documentClass().counters().
5352 setActiveLayout(parit->layout());
5355 // set the counter for this paragraph
5356 d->setLabel(parit, utype);
5358 // update change-tracking flag
5359 parit->addChangesToBuffer(*this);
5362 for (auto const & insit : parit->insetList()) {
5363 parit.pos() = insit.pos;
5364 insit.inset->updateBuffer(parit, utype);
5370 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5371 WordLangTuple & word_lang, docstring_list & suggestions) const
5375 suggestions.clear();
5376 word_lang = WordLangTuple();
5377 bool const to_end = to.empty();
5378 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5379 // OK, we start from here.
5380 for (; from != end; from.forwardPos()) {
5381 // This skips all insets with spell check disabled.
5382 while (!from.allowSpellCheck()) {
5386 // If from is at the end of the document (which is possible
5387 // when "from" was changed above) LyX will crash later otherwise.
5388 if (from.atEnd() || (!to_end && from >= end))
5391 from.paragraph().spellCheck();
5392 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5393 if (SpellChecker::misspelled(res)) {
5397 // Do not increase progress when from == to, otherwise the word
5398 // count will be wrong.
5408 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5410 bool inword = false;
5415 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5416 if (!dit.inTexted()) {
5421 Paragraph const & par = dit.paragraph();
5422 pos_type const pos = dit.pos();
5424 // Copied and adapted from isWordSeparator() in Paragraph
5425 if (pos == dit.lastpos()) {
5428 Inset const * ins = par.getInset(pos);
5429 if (ins && skipNoOutput && !ins->producesOutput()) {
5432 // stop if end of range was skipped
5433 if (!to.atEnd() && dit >= to)
5436 } else if (!par.isDeleted(pos)) {
5437 if (par.isWordSeparator(pos))
5443 if (ins && ins->isLetter())
5445 else if (ins && ins->isSpace())
5448 char_type const c = par.getChar(pos);
5449 if (isPrintableNonspace(c))
5451 else if (isSpace(c))
5461 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5463 d->updateStatistics(from, to, skipNoOutput);
5467 int Buffer::wordCount() const
5469 return d->wordCount();
5473 int Buffer::charCount(bool with_blanks) const
5475 return d->charCount(with_blanks);
5479 Buffer::ReadStatus Buffer::reload()
5482 // c.f. bug https://www.lyx.org/trac/ticket/6587
5483 removeAutosaveFile();
5484 // e.g., read-only status could have changed due to version control
5485 d->filename.refresh();
5486 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5488 // clear parent. this will get reset if need be.
5490 ReadStatus const status = loadLyXFile();
5491 if (status == ReadSuccess) {
5496 message(bformat(_("Document %1$s reloaded."), disp_fn));
5499 message(bformat(_("Could not reload document %1$s."), disp_fn));
5509 bool Buffer::saveAs(FileName const & fn)
5511 FileName const old_name = fileName();
5512 FileName const old_auto = getAutosaveFileName();
5513 bool const old_unnamed = isUnnamed();
5514 bool success = true;
5515 d->old_position = filePath();
5522 // bring the autosave file with us, just in case.
5523 moveAutosaveFile(old_auto);
5524 // validate version control data and
5525 // correct buffer title
5526 lyxvc().file_found_hook(fileName());
5528 // the file has now been saved to the new location.
5529 // we need to check that the locations of child buffers
5531 checkChildBuffers();
5532 checkMasterBuffer();
5535 // reset the old filename and unnamed state
5536 setFileName(old_name);
5537 setUnnamed(old_unnamed);
5541 d->old_position.clear();
5546 void Buffer::checkChildBuffers()
5548 for (auto const & bit : d->children_positions) {
5549 DocIterator dit = bit.second;
5550 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5551 if (!cbuf || !theBufferList().isLoaded(cbuf))
5553 Inset * inset = dit.nextInset();
5554 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5555 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5556 docstring const & incfile = inset_inc->getParam("filename");
5557 string oldloc = cbuf->absFileName();
5558 string newloc = makeAbsPath(to_utf8(incfile),
5559 onlyPath(absFileName())).absFileName();
5560 if (oldloc == newloc)
5562 // the location of the child file is incorrect.
5564 inset_inc->setChildBuffer(0);
5566 // invalidate cache of children
5567 d->children_positions.clear();
5568 d->position_to_children.clear();
5572 // If a child has been saved under a different name/path, it might have been
5573 // orphaned. Therefore the master needs to be reset (bug 8161).
5574 void Buffer::checkMasterBuffer()
5576 Buffer const * const master = masterBuffer();
5580 // necessary to re-register the child (bug 5873)
5581 // FIXME: clean up updateMacros (here, only
5582 // child registering is needed).
5583 master->updateMacros();
5584 // (re)set master as master buffer, but only
5585 // if we are a real child
5586 if (master->isChild(this))
5593 string Buffer::includedFilePath(string const & name, string const & ext) const
5595 if (d->old_position.empty() ||
5596 equivalent(FileName(d->old_position), FileName(filePath())))
5599 bool isabsolute = FileName::isAbsolute(name);
5600 // both old_position and filePath() end with a path separator
5601 string absname = isabsolute ? name : d->old_position + name;
5603 // if old_position is set to origin, we need to do the equivalent of
5604 // getReferencedFileName() (see readDocument())
5605 if (!isabsolute && d->old_position == params().origin) {
5606 FileName const test(addExtension(filePath() + name, ext));
5608 absname = filePath() + name;
5611 if (!FileName(addExtension(absname, ext)).exists())
5615 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5617 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5618 from_utf8(filePath())));
5622 void Buffer::setChangesPresent(bool b) const
5624 d->tracked_changes_present_ = b;
5628 bool Buffer::areChangesPresent() const
5630 return d->tracked_changes_present_;
5634 void Buffer::updateChangesPresent() const
5636 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5637 setChangesPresent(false);
5638 ParConstIterator it = par_iterator_begin();
5639 ParConstIterator const end = par_iterator_end();
5640 for (; !areChangesPresent() && it != end; ++it)
5641 it->addChangesToBuffer(*this);
5645 void Buffer::Impl::refreshFileMonitor()
5647 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5648 file_monitor_->refresh();
5652 // The previous file monitor is invalid
5653 // This also destroys the previous file monitor and all its connections
5654 file_monitor_ = FileSystemWatcher::monitor(filename);
5655 // file_monitor_ will be destroyed with *this, so it is not going to call a
5656 // destroyed object method.
5657 file_monitor_->connect([this](bool exists) {
5658 fileExternallyModified(exists);
5663 void Buffer::Impl::fileExternallyModified(bool const exists)
5665 // ignore notifications after our own saving operations
5666 if (checksum_ == filename.checksum()) {
5667 LYXERR(Debug::FILES, "External modification but "
5668 "checksum unchanged: " << filename);
5671 // If the file has been deleted, only mark the file as dirty since it is
5672 // pointless to prompt for reloading. If later a file is moved into this
5673 // location, then the externally modified warning will appear then.
5675 externally_modified_ = true;
5676 // Update external modification notification.
5677 // Dirty buffers must be visible at all times.
5678 if (wa_ && wa_->unhide(owner_))
5679 wa_->updateTitles();
5681 // Unable to unhide the buffer (e.g. no GUI or not current View)
5686 bool Buffer::notifiesExternalModification() const
5688 return d->externally_modified_;
5692 void Buffer::clearExternalModification() const
5694 d->externally_modified_ = false;
5696 d->wa_->updateTitles();