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
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), preview_error_(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 preview_error_ = cloned_buffer_->d->preview_error_;
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::lastPreviewError() const
1251 return d->preview_error_;
1255 PreviewLoader * Buffer::loader() const
1257 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1259 if (!d->preview_loader_)
1260 d->preview_loader_ = new PreviewLoader(*this);
1261 return d->preview_loader_;
1265 void Buffer::removePreviews() const
1267 delete d->preview_loader_;
1268 d->preview_loader_ = 0;
1272 void Buffer::updatePreviews() const
1274 PreviewLoader * ploader = loader();
1278 InsetIterator it = inset_iterator_begin(*d->inset);
1279 InsetIterator const end = inset_iterator_end(*d->inset);
1280 for (; it != end; ++it)
1281 it->addPreview(it, *ploader);
1283 ploader->startLoading();
1287 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1288 FileName const & fn, int & file_format) const
1290 if(!lex.checkFor("\\lyxformat")) {
1291 Alert::error(_("Document format failure"),
1292 bformat(_("%1$s is not a readable LyX document."),
1293 from_utf8(fn.absFileName())));
1294 return ReadNoLyXFormat;
1300 // LyX formats 217 and earlier were written as 2.17. This corresponds
1301 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1302 // these cases. See also: www.lyx.org/trac/changeset/1313.
1303 size_t dot = tmp_format.find_first_of(".,");
1304 if (dot != string::npos)
1305 tmp_format.erase(dot, 1);
1307 file_format = convert<int>(tmp_format);
1312 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1313 FileName & tmpfile, int from_format)
1315 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1316 tempfile.setAutoRemove(false);
1317 tmpfile = tempfile.name();
1318 if(tmpfile.empty()) {
1319 Alert::error(_("Conversion failed"),
1320 bformat(_("%1$s is from a different"
1321 " version of LyX, but a temporary"
1322 " file for converting it could"
1323 " not be created."),
1324 from_utf8(fn.absFileName())));
1325 return LyX2LyXNoTempFile;
1328 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1329 if (lyx2lyx.empty()) {
1330 Alert::error(_("Conversion script not found"),
1331 bformat(_("%1$s is from a different"
1332 " version of LyX, but the"
1333 " conversion script lyx2lyx"
1334 " could not be found."),
1335 from_utf8(fn.absFileName())));
1336 return LyX2LyXNotFound;
1340 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1341 ostringstream command;
1342 command << os::python()
1343 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1344 << " -t " << convert<string>(LYX_FORMAT)
1345 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1346 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1347 string const command_str = command.str();
1349 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1351 cmd_ret const ret = runCommand(command_str);
1352 if (ret.first != 0) {
1353 if (from_format < LYX_FORMAT) {
1354 Alert::error(_("Conversion script failed"),
1355 bformat(_("%1$s is from an older version"
1356 " of LyX and the lyx2lyx script"
1357 " failed to convert it."),
1358 from_utf8(fn.absFileName())));
1359 return LyX2LyXOlderFormat;
1361 Alert::error(_("Conversion script failed"),
1362 bformat(_("%1$s is from a newer version"
1363 " of LyX and the lyx2lyx script"
1364 " failed to convert it."),
1365 from_utf8(fn.absFileName())));
1366 return LyX2LyXNewerFormat;
1373 FileName Buffer::getBackupName() const {
1374 map<int, string> const file_formats = {
1391 FileName const & fn = fileName();
1392 string const fname = fn.onlyFileNameWithoutExt();
1393 string const fext = fn.extension() + "~";
1394 string const fpath = lyxrc.backupdir_path.empty() ?
1395 fn.onlyPath().absFileName() :
1396 lyxrc.backupdir_path;
1397 string backup_suffix;
1398 // If file format is from a stable series use version instead of file format
1399 auto const it = file_formats.find(d->file_format);
1400 if (it != file_formats.end())
1401 backup_suffix = "-lyx" + it->second;
1403 backup_suffix = "-lyxformat-" + convert<string>(d->file_format);
1404 string const backname = fname + backup_suffix;
1405 FileName backup(addName(fpath, addExtension(backname, fext)));
1407 // limit recursion, just in case
1409 unsigned long orig_checksum = 0;
1410 while (backup.exists() && v < 100) {
1411 if (orig_checksum == 0)
1412 orig_checksum = fn.checksum();
1413 unsigned long new_checksum = backup.checksum();
1414 if (orig_checksum == new_checksum) {
1415 LYXERR(Debug::FILES, "Not backing up " << fn <<
1416 "since " << backup << "has the same checksum.");
1417 // a bit of a hack, but we have to check this anyway
1418 // below, and setting this is simpler than introducing
1419 // a special boolean for this purpose.
1423 string const newbackname = backname + "-" + convert<string>(v);
1424 backup.set(addName(fpath, addExtension(newbackname, fext)));
1427 return v < 100 ? backup : FileName();
1431 // Should probably be moved to somewhere else: BufferView? GuiView?
1432 bool Buffer::save() const
1434 docstring const file = makeDisplayPath(absFileName(), 20);
1435 d->filename.refresh();
1437 // check the read-only status before moving the file as a backup
1438 if (d->filename.exists()) {
1439 bool const read_only = !d->filename.isWritable();
1441 Alert::warning(_("File is read-only"),
1442 bformat(_("The file %1$s cannot be written because it "
1443 "is marked as read-only."), file));
1448 // ask if the disk file has been externally modified (use checksum method)
1449 if (fileName().exists() && isChecksumModified()) {
1451 bformat(_("Document %1$s has been externally modified. "
1452 "Are you sure you want to overwrite this file?"), file);
1453 int const ret = Alert::prompt(_("Overwrite modified file?"),
1454 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1459 // We don't need autosaves in the immediate future. (Asger)
1460 resetAutosaveTimers();
1462 // if the file does not yet exist, none of the backup activity
1463 // that follows is necessary
1464 if (!fileName().exists()) {
1465 if (!writeFile(fileName()))
1471 // we first write the file to a new name, then move it to its
1472 // proper location once that has been done successfully. that
1473 // way we preserve the original file if something goes wrong.
1474 string const justname = fileName().onlyFileNameWithoutExt();
1475 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1476 justname + "-XXXXXX.lyx");
1477 bool const symlink = fileName().isSymLink();
1479 tempfile->setAutoRemove(false);
1481 FileName savefile(tempfile->name());
1482 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1483 if (!savefile.clonePermissions(fileName()))
1484 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1486 if (!writeFile(savefile))
1489 // we will set this to false if we fail
1490 bool made_backup = true;
1492 FileName backupName;
1493 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1495 if (d->need_format_backup)
1496 backupName = getBackupName();
1498 // If we for some reason failed to find a backup name in case of
1499 // a format change, this will still set one. It's the best we can
1501 if (backupName.empty()) {
1502 backupName.set(fileName().absFileName() + "~");
1503 if (!lyxrc.backupdir_path.empty()) {
1504 string const mangledName =
1505 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1506 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1510 LYXERR(Debug::FILES, "Backing up original file to " <<
1511 backupName.absFileName());
1512 // Except file is symlink do not copy because of #6587.
1513 // Hard links have bad luck.
1514 made_backup = symlink ?
1515 fileName().copyTo(backupName):
1516 fileName().moveTo(backupName);
1519 Alert::error(_("Backup failure"),
1520 bformat(_("Cannot create backup file %1$s.\n"
1521 "Please check whether the directory exists and is writable."),
1522 from_utf8(backupName.absFileName())));
1523 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1524 } else if (d->need_format_backup) {
1525 // the original file has been backed up successfully, so we
1526 // will not need to do that again
1527 d->need_format_backup = false;
1531 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1532 // Only do this if tempfile is not in autoremove mode
1535 // If we have no symlink, we can simply rename the temp file.
1536 // Otherwise, we need to copy it so the symlink stays intact.
1537 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1538 savefile.moveTo(fileName()))
1540 // saveCheckSum() was already called by writeFile(), but the
1541 // time stamp is invalidated by copying/moving
1544 if (d->file_format != LYX_FORMAT)
1545 // the file associated with this buffer is now in the current format
1546 d->file_format = LYX_FORMAT;
1549 // else we saved the file, but failed to move it to the right location.
1551 if (needBackup && made_backup && !symlink) {
1552 // the original file was moved to some new location, so it will look
1553 // to the user as if it was deleted. (see bug #9234.) we could try
1554 // to restore it, but that would basically mean trying to do again
1555 // what we just failed to do. better to leave things as they are.
1556 Alert::error(_("Write failure"),
1557 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1558 "But LyX could not move it to:\n %2$s.\n"
1559 "Your original file has been backed up to:\n %3$s"),
1560 from_utf8(savefile.absFileName()),
1561 from_utf8(fileName().absFileName()),
1562 from_utf8(backupName.absFileName())));
1564 // either we did not try to make a backup, or else we tried and failed,
1565 // or else the original file was a symlink, in which case it was copied,
1566 // not moved. so the original file is intact.
1567 Alert::error(_("Write failure"),
1568 bformat(_("Cannot move saved file to:\n %1$s.\n"
1569 "But the file has successfully been saved as:\n %2$s."),
1570 from_utf8(fileName().absFileName()),
1571 from_utf8(savefile.absFileName())));
1577 bool Buffer::writeFile(FileName const & fname) const
1579 if (d->read_only && fname == d->filename)
1582 bool retval = false;
1584 docstring const str = bformat(_("Saving document %1$s..."),
1585 makeDisplayPath(fname.absFileName()));
1588 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1590 if (params().compressed) {
1591 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1592 retval = ofs && write(ofs);
1594 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1595 retval = ofs && write(ofs);
1599 message(str + _(" could not write file!"));
1604 // removeAutosaveFile();
1607 message(str + _(" done."));
1613 docstring Buffer::emergencyWrite()
1615 // No need to save if the buffer has not changed.
1619 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1621 docstring user_message = bformat(
1622 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1624 // We try to save three places:
1625 // 1) Same place as document. Unless it is an unnamed doc.
1627 string s = absFileName();
1630 if (writeFile(FileName(s))) {
1632 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1633 return user_message;
1635 user_message += " " + _("Save failed! Trying again...\n");
1639 // 2) In HOME directory.
1640 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1642 lyxerr << ' ' << s << endl;
1643 if (writeFile(FileName(s))) {
1645 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1646 return user_message;
1649 user_message += " " + _("Save failed! Trying yet again...\n");
1651 // 3) In "/tmp" directory.
1652 // MakeAbsPath to prepend the current
1653 // drive letter on OS/2
1654 s = addName(package().temp_dir().absFileName(), absFileName());
1656 lyxerr << ' ' << s << endl;
1657 if (writeFile(FileName(s))) {
1659 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1660 return user_message;
1663 user_message += " " + _("Save failed! Document is lost.");
1666 return user_message;
1670 bool Buffer::write(ostream & ofs) const
1673 // Use the standard "C" locale for file output.
1674 ofs.imbue(locale::classic());
1677 // The top of the file should not be written by params().
1679 // write out a comment in the top of the file
1680 // Important: Keep the version formatting in sync with lyx2lyx and
1681 // tex2lyx (bug 7951)
1682 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1683 << " created this file. For more info see https://www.lyx.org/\n"
1684 << "\\lyxformat " << LYX_FORMAT << "\n"
1685 << "\\begin_document\n";
1687 /// For each author, set 'used' to true if there is a change
1688 /// by this author in the document; otherwise set it to 'false'.
1689 for (Author const & a : params().authors())
1692 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1693 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1694 for ( ; it != end; ++it)
1695 it->checkAuthors(params().authors());
1697 // now write out the buffer parameters.
1698 ofs << "\\begin_header\n";
1699 params().writeFile(ofs, this);
1700 ofs << "\\end_header\n";
1703 ofs << "\n\\begin_body\n";
1705 ofs << "\n\\end_body\n";
1707 // Write marker that shows file is complete
1708 ofs << "\\end_document" << endl;
1710 // Shouldn't really be needed....
1713 // how to check if close went ok?
1714 // Following is an attempt... (BE 20001011)
1716 // good() returns false if any error occurred, including some
1717 // formatting error.
1718 // bad() returns true if something bad happened in the buffer,
1719 // which should include file system full errors.
1724 lyxerr << "File was not closed properly." << endl;
1731 Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
1732 string const & original_path,
1733 OutputParams const & runparams_in,
1734 OutputWhat output) const
1736 OutputParams runparams = runparams_in;
1738 string const encoding = runparams.encoding->iconvName();
1739 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1742 try { ofs.reset(encoding); }
1743 catch (iconv_codecvt_facet_exception const & e) {
1744 lyxerr << "Caught iconv exception: " << e.what() << endl;
1745 Alert::error(_("Iconv software exception Detected"),
1746 bformat(_("Please verify that the `iconv' support software is"
1747 " properly installed and supports the selected encoding"
1748 " (%1$s), or change the encoding in"
1749 " Document>Settings>Language."), from_ascii(encoding)));
1752 if (!openFileWrite(ofs, fname))
1755 ErrorList & errorList = d->errorLists["Export"];
1757 ExportStatus status = ExportSuccess;
1760 // make sure we are ready to export
1761 // this needs to be done before we validate
1762 // FIXME Do we need to do this all the time? I.e., in children
1763 // of a master we are exporting?
1765 updateMacroInstances(OutputUpdate);
1767 ExportStatus retval;
1769 retval = writeLaTeXSource(os, original_path, runparams, output);
1770 if (retval == ExportKilled)
1771 return ExportKilled;
1773 catch (EncodingException const & e) {
1774 docstring const failed(1, e.failed_char);
1776 oss << "0x" << hex << e.failed_char << dec;
1777 if (getParFromID(e.par_id).paragraph().layout().pass_thru) {
1778 docstring msg = bformat(_("Uncodable character '%1$s'"
1779 " (code point %2$s)"),
1780 failed, from_utf8(oss.str()));
1781 errorList.push_back(ErrorItem(msg, _("Some characters of your document are not "
1782 "representable in specific verbatim contexts.\n"
1783 "Changing the document encoding to utf8 could help."),
1784 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1786 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1787 " (code point %2$s)"),
1788 failed, from_utf8(oss.str()));
1789 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1790 "representable in the chosen encoding.\n"
1791 "Changing the document encoding to utf8 could help."),
1792 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1794 status = ExportError;
1796 catch (iconv_codecvt_facet_exception const & e) {
1797 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1799 status = ExportError;
1801 catch (exception const & e) {
1802 errorList.push_back(ErrorItem(_("conversion failed"),
1804 lyxerr << e.what() << endl;
1805 status = ExportError;
1808 lyxerr << "Caught some really weird exception..." << endl;
1812 d->texrow = move(os.texrow());
1816 status = ExportError;
1817 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1820 if (runparams_in.silent)
1828 Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
1829 string const & original_path,
1830 OutputParams const & runparams_in,
1831 OutputWhat output) const
1833 // The child documents, if any, shall be already loaded at this point.
1835 OutputParams runparams = runparams_in;
1837 // Some macros rely on font encoding
1838 runparams.main_fontenc = params().main_font_encoding();
1840 // If we are compiling a file standalone, even if this is the
1841 // child of some other buffer, let's cut the link here, so the
1842 // file is really independent and no concurring settings from
1843 // the master (e.g. branch state) interfere (see #8100).
1844 if (!runparams.is_child)
1845 d->ignore_parent = true;
1847 // Classify the unicode characters appearing in math insets
1848 BufferEncodings::initUnicodeMath(*this);
1850 // validate the buffer.
1851 LYXERR(Debug::LATEX, " Validating buffer...");
1852 LaTeXFeatures features(*this, params(), runparams);
1854 // This is only set once per document (in master)
1855 if (!runparams.is_child) {
1856 runparams.use_polyglossia = features.usePolyglossia();
1857 runparams.use_CJK = features.mustProvide("CJK");
1859 LYXERR(Debug::LATEX, " Buffer validation done.");
1861 bool const output_preamble =
1862 output == FullSource || output == OnlyPreamble;
1863 bool const output_body =
1864 output == FullSource || output == OnlyBody;
1866 // The starting paragraph of the coming rows is the
1867 // first paragraph of the document. (Asger)
1868 if (output_preamble && runparams.nice) {
1869 os << "%% LyX " << lyx_version << " created this file. "
1870 "For more info, see https://www.lyx.org/.\n"
1871 "%% Do not edit unless you really know what "
1874 LYXERR(Debug::INFO, "lyx document header finished");
1876 // There are a few differences between nice LaTeX and usual files:
1877 // usual files have \batchmode and special input@path to allow
1878 // inclusion of figures specified by an explicitly relative path
1879 // (i.e., a path starting with './' or '../') with either \input or
1880 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1881 // input@path is set when the actual parameter original_path is set.
1882 // This is done for usual tex-file, but not for nice-latex-file.
1883 // (Matthias 250696)
1884 // Note that input@path is only needed for something the user does
1885 // in the preamble, included .tex files or ERT, files included by
1886 // LyX work without it.
1887 if (output_preamble) {
1888 if (!runparams.nice) {
1889 // code for usual, NOT nice-latex-file
1890 os << "\\batchmode\n"; // changed from \nonstopmode
1892 if (!original_path.empty()) {
1894 // We don't know the encoding of inputpath
1895 docstring const inputpath = from_utf8(original_path);
1896 docstring uncodable_glyphs;
1897 Encoding const * const enc = runparams.encoding;
1899 for (size_t n = 0; n < inputpath.size(); ++n) {
1900 if (!enc->encodable(inputpath[n])) {
1901 docstring const glyph(1, inputpath[n]);
1902 LYXERR0("Uncodable character '"
1904 << "' in input path!");
1905 uncodable_glyphs += glyph;
1910 // warn user if we found uncodable glyphs.
1911 if (!uncodable_glyphs.empty()) {
1912 frontend::Alert::warning(
1913 _("Uncodable character in file path"),
1915 _("The path of your document\n"
1917 "contains glyphs that are unknown "
1918 "in the current document encoding "
1919 "(namely %2$s). This may result in "
1920 "incomplete output, unless "
1921 "TEXINPUTS contains the document "
1922 "directory and you don't use "
1923 "explicitly relative paths (i.e., "
1924 "paths starting with './' or "
1925 "'../') in the preamble or in ERT."
1926 "\n\nIn case of problems, choose "
1927 "an appropriate document encoding\n"
1928 "(such as utf8) or change the "
1930 inputpath, uncodable_glyphs));
1932 string docdir = os::latex_path(original_path);
1933 if (contains(docdir, '#')) {
1934 docdir = subst(docdir, "#", "\\#");
1935 os << "\\catcode`\\#=11"
1936 "\\def\\#{#}\\catcode`\\#=6\n";
1938 if (contains(docdir, '%')) {
1939 docdir = subst(docdir, "%", "\\%");
1940 os << "\\catcode`\\%=11"
1941 "\\def\\%{%}\\catcode`\\%=14\n";
1943 bool const nonascii = !isAscii(from_utf8(docdir));
1944 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1945 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1946 bool const detokenize = !utfpathlatex
1947 && (nonascii || contains(docdir, '~'));
1948 bool const quote = contains(docdir, ' ');
1949 if (utfpathlatex && nonascii)
1950 os << "\\UseRawInputEncoding\n";
1951 os << "\\makeatletter\n"
1952 << "\\def\\input@path{{";
1954 os << "\\detokenize{";
1963 << "\\makeatother\n";
1967 // get parent macros (if this buffer has a parent) which will be
1968 // written at the document begin further down.
1969 MacroSet parentMacros;
1970 listParentMacros(parentMacros, features);
1972 // Write the preamble
1973 runparams.use_babel = params().writeLaTeX(os, features,
1974 d->filename.onlyPath());
1976 // Active characters
1977 runparams.active_chars = features.getActiveChars();
1979 // Biblatex bibliographies are loaded here
1980 if (params().useBiblatex()) {
1981 vector<pair<docstring, string>> const bibfiles =
1982 prepareBibFilePaths(runparams, getBibfiles(), true);
1983 for (pair<docstring, string> const & file: bibfiles) {
1984 os << "\\addbibresource";
1985 if (!file.second.empty())
1986 os << "[bibencoding=" << file.second << "]";
1987 os << "{" << file.first << "}\n";
1991 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1992 && !features.hasOnlyPolyglossiaLanguages()) {
1995 vector<string> bll = features.getBabelExclusiveLanguages();
1996 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1999 for (string const & sit : bll) {
2004 blangs = bll.size() > 1 ?
2005 bformat(_("The languages %1$s are only supported by Babel."), langs)
2006 : bformat(_("The language %1$s is only supported by Babel."), langs);
2010 for (string const & pit : pll) {
2015 plangs = pll.size() > 1 ?
2016 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2017 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2018 if (!blangs.empty())
2022 frontend::Alert::warning(
2023 _("Incompatible Languages!"),
2025 _("You cannot use the following languages "
2026 "together in one LaTeX document because "
2027 "they require conflicting language packages:\n"
2032 // Japanese might be required only in some children of a document,
2033 // but once required, we must keep use_japanese true.
2034 runparams.use_japanese |= features.isRequired("japanese");
2037 // Restore the parenthood if needed
2038 if (!runparams.is_child)
2039 d->ignore_parent = false;
2040 return ExportSuccess;
2044 // mark the beginning of the body to separate it from InPreamble insets
2045 os.texrow().start(TexRow::beginDocument());
2046 os << "\\begin{document}\n";
2048 // mark the start of a new paragraph by simulating a newline,
2049 // so that os.afterParbreak() returns true at document start
2052 // output the parent macros
2053 for (auto const & mac : parentMacros) {
2054 int num_lines = mac->write(os.os(), true);
2055 os.texrow().newlines(num_lines);
2058 } // output_preamble
2060 LYXERR(Debug::INFO, "preamble finished, now the body.");
2064 latexParagraphs(*this, text(), os, runparams);
2066 catch (ConversionException const &) { return ExportKilled; }
2068 // Restore the parenthood if needed
2069 if (!runparams.is_child)
2070 d->ignore_parent = false;
2072 // add this just in case after all the paragraphs
2075 if (output_preamble) {
2076 os << "\\end{document}\n";
2077 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2079 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2081 runparams_in.encoding = runparams.encoding;
2083 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2084 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2085 return ExportSuccess;
2089 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2090 OutputParams const & runparams,
2091 OutputWhat output) const
2093 LYXERR(Debug::LATEX, "makeDocBookFile...");
2096 if (!openFileWrite(ofs, fname))
2099 // make sure we are ready to export
2100 // this needs to be done before we validate
2102 updateMacroInstances(OutputUpdate);
2104 ExportStatus const retval =
2105 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2106 if (retval == ExportKilled)
2107 return ExportKilled;
2111 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2112 return ExportSuccess;
2116 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2117 OutputParams const & runparams,
2118 OutputWhat output) const
2120 LaTeXFeatures features(*this, params(), runparams);
2125 DocumentClass const & tclass = params().documentClass();
2126 string const & top_element = tclass.latexname();
2128 bool const output_preamble =
2129 output == FullSource || output == OnlyPreamble;
2130 bool const output_body =
2131 output == FullSource || output == OnlyBody;
2133 if (output_preamble) {
2134 if (runparams.flavor == OutputParams::XML)
2135 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2138 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2141 if (! tclass.class_header().empty())
2142 os << from_ascii(tclass.class_header());
2143 else if (runparams.flavor == OutputParams::XML)
2144 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2145 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2147 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2149 docstring preamble = params().preamble;
2150 if (runparams.flavor != OutputParams::XML ) {
2151 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2152 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2153 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2154 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2157 string const name = runparams.nice
2158 ? changeExtension(absFileName(), ".sgml") : fname;
2159 preamble += features.getIncludedFiles(name);
2160 preamble += features.getLyXSGMLEntities();
2162 if (!preamble.empty()) {
2163 os << "\n [ " << preamble << " ]";
2169 string top = top_element;
2171 if (runparams.flavor == OutputParams::XML)
2172 top += params().language->code();
2174 top += params().language->code().substr(0, 2);
2177 if (!params().options.empty()) {
2179 top += params().options;
2182 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2183 << " file was created by LyX " << lyx_version
2184 << "\n See https://www.lyx.org/ for more information -->\n";
2186 params().documentClass().counters().reset();
2188 sgml::openTag(os, top);
2191 docbookParagraphs(text(), *this, os, runparams);
2193 catch (ConversionException const &) { return ExportKilled; }
2194 sgml::closeTag(os, top_element);
2196 return ExportSuccess;
2200 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2201 OutputParams const & runparams) const
2203 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2206 if (!openFileWrite(ofs, fname))
2209 // make sure we are ready to export
2210 // this has to be done before we validate
2211 updateBuffer(UpdateMaster, OutputUpdate);
2212 updateMacroInstances(OutputUpdate);
2214 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2215 if (retval == ExportKilled)
2220 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2225 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2226 OutputParams const & runparams,
2227 OutputWhat output) const
2229 LaTeXFeatures features(*this, params(), runparams);
2231 d->bibinfo_.makeCitationLabels(*this);
2233 bool const output_preamble =
2234 output == FullSource || output == OnlyPreamble;
2235 bool const output_body =
2236 output == FullSource || output == OnlyBody || output == IncludedFile;
2238 if (output_preamble) {
2239 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2240 << "<!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"
2241 // FIXME Language should be set properly.
2242 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2244 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2245 // FIXME Presumably need to set this right
2246 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2248 docstring const & doctitle = features.htmlTitle();
2250 << (doctitle.empty() ?
2251 from_ascii("LyX Document") :
2252 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2255 docstring styles = features.getTClassHTMLPreamble();
2256 if (!styles.empty())
2257 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2259 styles = features.getPreambleSnippets().str;
2260 if (!styles.empty())
2261 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2263 // we will collect CSS information in a stream, and then output it
2264 // either here, as part of the header, or else in a separate file.
2265 odocstringstream css;
2266 styles = features.getCSSSnippets();
2267 if (!styles.empty())
2268 css << "/* LyX Provided Styles */\n" << styles << '\n';
2270 styles = features.getTClassHTMLStyles();
2271 if (!styles.empty())
2272 css << "/* Layout-provided Styles */\n" << styles << '\n';
2274 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2275 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2276 if (needfg || needbg) {
2277 css << "\nbody {\n";
2280 << from_ascii(X11hexname(params().fontcolor))
2283 css << " background-color: "
2284 << from_ascii(X11hexname(params().backgroundcolor))
2289 docstring const dstyles = css.str();
2290 if (!dstyles.empty()) {
2291 bool written = false;
2292 if (params().html_css_as_file) {
2293 // open a file for CSS info
2295 string const fcssname = addName(temppath(), "docstyle.css");
2296 FileName const fcssfile = FileName(fcssname);
2297 if (openFileWrite(ocss, fcssfile)) {
2301 // write link to header
2302 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2304 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2307 // we are here if the CSS is supposed to be written to the header
2308 // or if we failed to write it to an external file.
2310 os << "<style type='text/css'>\n"
2319 bool const output_body_tag = (output != IncludedFile);
2320 if (output_body_tag)
2321 os << "<body dir=\"auto\">\n";
2323 if (output != IncludedFile)
2324 // if we're an included file, the counters are in the master.
2325 params().documentClass().counters().reset();
2327 xhtmlParagraphs(text(), *this, xs, runparams);
2329 catch (ConversionException const &) { return ExportKilled; }
2330 if (output_body_tag)
2334 if (output_preamble)
2337 return ExportSuccess;
2341 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2342 // Other flags: -wall -v0 -x
2343 int Buffer::runChktex()
2347 // get LaTeX-Filename
2348 FileName const path(temppath());
2349 string const name = addName(path.absFileName(), latexName());
2350 string const org_path = filePath();
2352 PathChanger p(path); // path to LaTeX file
2353 message(_("Running chktex..."));
2355 // Generate the LaTeX file if neccessary
2356 OutputParams runparams(¶ms().encoding());
2357 runparams.flavor = OutputParams::LATEX;
2358 runparams.nice = false;
2359 runparams.linelen = lyxrc.plaintext_linelen;
2360 ExportStatus const retval =
2361 makeLaTeXFile(FileName(name), org_path, runparams);
2362 if (retval != ExportSuccess) {
2363 // error code on failure
2368 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2369 int const res = chktex.run(terr); // run chktex
2372 Alert::error(_("chktex failure"),
2373 _("Could not run chktex successfully."));
2375 ErrorList & errlist = d->errorLists["ChkTeX"];
2377 bufferErrors(terr, errlist);
2382 if (runparams.silent)
2383 d->errorLists["ChkTeX"].clear();
2391 void Buffer::validate(LaTeXFeatures & features) const
2393 // Validate the buffer params, but not for included
2394 // files, since they also use the parent buffer's
2396 if (!features.runparams().is_child)
2397 params().validate(features);
2399 for (Paragraph const & p : paragraphs())
2400 p.validate(features);
2402 if (lyxerr.debugging(Debug::LATEX)) {
2403 features.showStruct();
2408 void Buffer::getLabelList(vector<docstring> & list) const
2410 // If this is a child document, use the master's list instead.
2412 masterBuffer()->getLabelList(list);
2417 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2418 for (auto const & tocit : *toc) {
2419 if (tocit.depth() == 0)
2420 list.push_back(tocit.str());
2425 void Buffer::invalidateBibinfoCache() const
2427 d->bibinfo_cache_valid_ = false;
2428 d->cite_labels_valid_ = false;
2429 removeBiblioTempFiles();
2430 // also invalidate the cache for the parent buffer
2431 Buffer const * const pbuf = d->parent();
2433 pbuf->invalidateBibinfoCache();
2437 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2439 // FIXME This is probably unnecessary, given where we call this.
2440 // If this is a child document, use the master instead.
2441 Buffer const * const pbuf = masterBuffer();
2442 if (pbuf != this && scope != UpdateChildOnly)
2443 return pbuf->getBibfiles();
2445 // In 2.3.x, we have:
2446 //if (!d->bibfile_cache_valid_)
2447 // this->updateBibfilesCache(scope);
2448 // I think that is a leftover, but there have been so many back-
2449 // and-forths with this, due to Windows issues, that I am not sure.
2451 return d->bibfiles_cache_;
2455 BiblioInfo const & Buffer::masterBibInfo() const
2457 Buffer const * const tmp = masterBuffer();
2459 return tmp->masterBibInfo();
2464 BiblioInfo const & Buffer::bibInfo() const
2470 void Buffer::registerBibfiles(const docstring_list & bf) const
2472 // We register the bib files in the master buffer,
2473 // if there is one, but also in every single buffer,
2474 // in case a child is compiled alone.
2475 Buffer const * const tmp = masterBuffer();
2477 tmp->registerBibfiles(bf);
2479 for (auto const & p : bf) {
2480 docstring_list::const_iterator temp =
2481 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2482 if (temp == d->bibfiles_cache_.end())
2483 d->bibfiles_cache_.push_back(p);
2488 static map<docstring, FileName> bibfileCache;
2490 FileName Buffer::getBibfilePath(docstring const & bibid) const
2492 map<docstring, FileName>::const_iterator it =
2493 bibfileCache.find(bibid);
2494 if (it != bibfileCache.end()) {
2495 // i.e., return bibfileCache[bibid];
2499 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2500 string const texfile = changeExtension(to_utf8(bibid), "bib");
2501 // we need to check first if this file exists where it's said to be.
2502 // there's a weird bug that occurs otherwise: if the file is in the
2503 // Buffer's directory but has the same name as some file that would be
2504 // found by kpsewhich, then we find the latter, not the former.
2505 FileName const local_file = makeAbsPath(texfile, filePath());
2506 FileName file = local_file;
2507 if (!file.exists()) {
2508 // there's no need now to check whether the file can be found
2510 file = findtexfile(texfile, "bib", true);
2514 LYXERR(Debug::FILES, "Found at: " << file);
2516 bibfileCache[bibid] = file;
2517 return bibfileCache[bibid];
2521 void Buffer::checkIfBibInfoCacheIsValid() const
2523 // use the master's cache
2524 Buffer const * const tmp = masterBuffer();
2526 tmp->checkIfBibInfoCacheIsValid();
2530 // If we already know the cache is invalid, stop here.
2531 // This is important in the case when the bibliography
2532 // environment (rather than Bib[la]TeX) is used.
2533 // In that case, the timestamp check below gives no
2534 // sensible result. Rather than that, the cache will
2535 // be invalidated explicitly via invalidateBibInfoCache()
2536 // by the Bibitem inset.
2537 // Same applies for bib encoding changes, which trigger
2538 // invalidateBibInfoCache() by InsetBibtex.
2539 if (!d->bibinfo_cache_valid_)
2542 if (d->have_bibitems_) {
2543 // We have a bibliography environment.
2544 // Invalidate the bibinfo cache unconditionally.
2545 // Cite labels will get invalidated by the inset if needed.
2546 d->bibinfo_cache_valid_ = false;
2550 // OK. This is with Bib(la)tex. We'll assume the cache
2551 // is valid and change this if we find changes in the bibs.
2552 d->bibinfo_cache_valid_ = true;
2553 d->cite_labels_valid_ = true;
2555 // compare the cached timestamps with the actual ones.
2556 docstring_list const & bibfiles_cache = getBibfiles();
2557 for (auto const & bf : bibfiles_cache) {
2558 FileName const fn = getBibfilePath(bf);
2559 time_t lastw = fn.lastModified();
2560 time_t prevw = d->bibfile_status_[fn];
2561 if (lastw != prevw) {
2562 d->bibinfo_cache_valid_ = false;
2563 d->cite_labels_valid_ = false;
2564 d->bibfile_status_[fn] = lastw;
2570 void Buffer::clearBibFileCache() const
2572 bibfileCache.clear();
2576 void Buffer::reloadBibInfoCache(bool const force) const
2578 // we should not need to do this for internal buffers
2582 // use the master's cache
2583 Buffer const * const tmp = masterBuffer();
2585 tmp->reloadBibInfoCache(force);
2590 checkIfBibInfoCacheIsValid();
2591 if (d->bibinfo_cache_valid_)
2595 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2596 // re-read file locations when this info changes
2597 // FIXME Is this sufficient? Or should we also force that
2598 // in some other cases? If so, then it is easy enough to
2599 // add the following line in some other places.
2600 clearBibFileCache();
2601 d->bibinfo_.clear();
2602 FileNameList checkedFiles;
2603 d->have_bibitems_ = false;
2604 collectBibKeys(checkedFiles);
2605 d->bibinfo_cache_valid_ = true;
2609 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2611 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2612 it->collectBibKeys(it, checkedFiles);
2613 if (it->lyxCode() == BIBITEM_CODE) {
2615 parent()->d->have_bibitems_ = true;
2617 d->have_bibitems_ = true;
2623 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2625 // We add the biblio info to the master buffer,
2626 // if there is one, but also to every single buffer,
2627 // in case a child is compiled alone.
2628 BiblioInfo & bi = d->bibinfo_;
2629 bi.mergeBiblioInfo(bin);
2631 if (parent() != 0) {
2632 BiblioInfo & masterbi = parent()->d->bibinfo_;
2633 masterbi.mergeBiblioInfo(bin);
2638 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2640 // We add the bibtex info to the master buffer,
2641 // if there is one, but also to every single buffer,
2642 // in case a child is compiled alone.
2643 BiblioInfo & bi = d->bibinfo_;
2646 if (parent() != 0) {
2647 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2648 masterbi[key] = bin;
2653 void Buffer::makeCitationLabels() const
2655 Buffer const * const master = masterBuffer();
2656 return d->bibinfo_.makeCitationLabels(*master);
2660 void Buffer::invalidateCiteLabels() const
2662 masterBuffer()->d->cite_labels_valid_ = false;
2665 bool Buffer::citeLabelsValid() const
2667 return masterBuffer()->d->cite_labels_valid_;
2671 void Buffer::removeBiblioTempFiles() const
2673 // We remove files that contain LaTeX commands specific to the
2674 // particular bibliographic style being used, in order to avoid
2675 // LaTeX errors when we switch style.
2676 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2677 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2678 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2679 aux_file.removeFile();
2680 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2681 bbl_file.removeFile();
2682 // Also for the parent buffer
2683 Buffer const * const pbuf = parent();
2685 pbuf->removeBiblioTempFiles();
2689 bool Buffer::isDepClean(string const & name) const
2691 DepClean::const_iterator const it = d->dep_clean.find(name);
2692 if (it == d->dep_clean.end())
2698 void Buffer::markDepClean(string const & name)
2700 d->dep_clean[name] = true;
2704 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2707 // FIXME? if there is an Buffer LFUN that can be dispatched even
2708 // if internal, put a switch '(cmd.action)' here.
2714 switch (cmd.action()) {
2716 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2717 flag.setOnOff(hasReadonlyFlag());
2720 // FIXME: There is need for a command-line import.
2721 //case LFUN_BUFFER_IMPORT:
2723 case LFUN_BUFFER_AUTO_SAVE:
2726 case LFUN_BUFFER_EXPORT_CUSTOM:
2727 // FIXME: Nothing to check here?
2730 case LFUN_BUFFER_EXPORT: {
2731 docstring const arg = cmd.argument();
2732 if (arg == "custom") {
2736 string format = (arg.empty() || arg == "default") ?
2737 params().getDefaultOutputFormat() : to_utf8(arg);
2738 size_t pos = format.find(' ');
2739 if (pos != string::npos)
2740 format = format.substr(0, pos);
2741 enable = params().isExportable(format, false);
2743 flag.message(bformat(
2744 _("Don't know how to export to format: %1$s"), arg));
2748 case LFUN_BUILD_PROGRAM:
2749 enable = params().isExportable("program", false);
2752 case LFUN_BRANCH_ACTIVATE:
2753 case LFUN_BRANCH_DEACTIVATE:
2754 case LFUN_BRANCH_MASTER_ACTIVATE:
2755 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2756 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2757 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2758 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2759 : params().branchlist();
2760 docstring const branchName = cmd.argument();
2761 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2765 case LFUN_BRANCH_ADD:
2766 case LFUN_BRANCHES_RENAME:
2767 // if no Buffer is present, then of course we won't be called!
2770 case LFUN_BUFFER_LANGUAGE:
2771 enable = !isReadonly();
2774 case LFUN_BUFFER_VIEW_CACHE:
2775 (d->preview_file_).refresh();
2776 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2779 case LFUN_CHANGES_TRACK:
2780 flag.setEnabled(true);
2781 flag.setOnOff(params().track_changes);
2784 case LFUN_CHANGES_OUTPUT:
2785 flag.setEnabled(true);
2786 flag.setOnOff(params().output_changes);
2789 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2790 flag.setOnOff(params().compressed);
2793 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2794 flag.setOnOff(params().output_sync);
2797 case LFUN_BUFFER_ANONYMIZE:
2803 flag.setEnabled(enable);
2808 void Buffer::dispatch(string const & command, DispatchResult & result)
2810 return dispatch(lyxaction.lookupFunc(command), result);
2814 // NOTE We can end up here even if we have no GUI, because we are called
2815 // by LyX::exec to handled command-line requests. So we may need to check
2816 // whether we have a GUI or not. The boolean use_gui holds this information.
2817 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2820 // FIXME? if there is an Buffer LFUN that can be dispatched even
2821 // if internal, put a switch '(cmd.action())' here.
2822 dr.dispatched(false);
2825 string const argument = to_utf8(func.argument());
2826 // We'll set this back to false if need be.
2827 bool dispatched = true;
2828 // This handles undo groups automagically
2829 UndoGroupHelper ugh(this);
2831 switch (func.action()) {
2832 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2833 if (lyxvc().inUse()) {
2834 string log = lyxvc().toggleReadOnly();
2839 setReadonly(!hasReadonlyFlag());
2842 case LFUN_BUFFER_EXPORT: {
2843 string const format = (argument.empty() || argument == "default") ?
2844 params().getDefaultOutputFormat() : argument;
2845 ExportStatus const status = doExport(format, false);
2846 dr.setError(status != ExportSuccess);
2847 if (status != ExportSuccess)
2848 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2849 from_utf8(format)));
2853 case LFUN_BUILD_PROGRAM: {
2854 ExportStatus const status = doExport("program", true);
2855 dr.setError(status != ExportSuccess);
2856 if (status != ExportSuccess)
2857 dr.setMessage(_("Error generating literate programming code."));
2861 case LFUN_BUFFER_EXPORT_CUSTOM: {
2863 string command = split(argument, format_name, ' ');
2864 Format const * format = theFormats().getFormat(format_name);
2866 lyxerr << "Format \"" << format_name
2867 << "\" not recognized!"
2872 // The name of the file created by the conversion process
2875 // Output to filename
2876 if (format->name() == "lyx") {
2877 string const latexname = latexName(false);
2878 filename = changeExtension(latexname,
2879 format->extension());
2880 filename = addName(temppath(), filename);
2882 if (!writeFile(FileName(filename)))
2886 doExport(format_name, true, filename);
2889 // Substitute $$FName for filename
2890 if (!contains(command, "$$FName"))
2891 command = "( " + command + " ) < $$FName";
2892 command = subst(command, "$$FName", filename);
2894 // Execute the command in the background
2896 call.startscript(Systemcall::DontWait, command,
2897 filePath(), layoutPos());
2901 // FIXME: There is need for a command-line import.
2903 case LFUN_BUFFER_IMPORT:
2908 case LFUN_BUFFER_AUTO_SAVE:
2910 resetAutosaveTimers();
2913 case LFUN_BRANCH_ACTIVATE:
2914 case LFUN_BRANCH_DEACTIVATE:
2915 case LFUN_BRANCH_MASTER_ACTIVATE:
2916 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2917 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2918 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2919 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2922 docstring const branch_name = func.argument();
2923 // the case without a branch name is handled elsewhere
2924 if (branch_name.empty()) {
2928 Branch * branch = buf->params().branchlist().find(branch_name);
2930 LYXERR0("Branch " << branch_name << " does not exist.");
2932 docstring const msg =
2933 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2937 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2938 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2939 if (branch->isSelected() != activate) {
2940 buf->undo().recordUndoBufferParams(CursorData());
2941 branch->setSelected(activate);
2943 dr.screenUpdate(Update::Force);
2944 dr.forceBufferUpdate();
2949 case LFUN_BRANCH_ADD: {
2950 docstring branchnames = func.argument();
2951 if (branchnames.empty()) {
2955 BranchList & branch_list = params().branchlist();
2956 vector<docstring> const branches =
2957 getVectorFromString(branchnames, branch_list.separator());
2959 for (docstring const & branch_name : branches) {
2960 Branch * branch = branch_list.find(branch_name);
2962 LYXERR0("Branch " << branch_name << " already exists.");
2966 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2968 undo().recordUndoBufferParams(CursorData());
2969 branch_list.add(branch_name);
2970 branch = branch_list.find(branch_name);
2971 string const x11hexname = X11hexname(branch->color());
2972 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2973 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2975 dr.screenUpdate(Update::Force);
2983 case LFUN_BRANCHES_RENAME: {
2984 if (func.argument().empty())
2987 docstring const oldname = from_utf8(func.getArg(0));
2988 docstring const newname = from_utf8(func.getArg(1));
2989 InsetIterator it = inset_iterator_begin(inset());
2990 InsetIterator const end = inset_iterator_end(inset());
2991 bool success = false;
2992 for (; it != end; ++it) {
2993 if (it->lyxCode() == BRANCH_CODE) {
2994 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2995 if (ins.branch() == oldname) {
2996 undo().recordUndo(CursorData(it));
2997 ins.rename(newname);
3002 if (it->lyxCode() == INCLUDE_CODE) {
3003 // get buffer of external file
3004 InsetInclude const & ins =
3005 static_cast<InsetInclude const &>(*it);
3006 Buffer * child = ins.getChildBuffer();
3009 child->dispatch(func, dr);
3014 dr.screenUpdate(Update::Force);
3015 dr.forceBufferUpdate();
3020 case LFUN_BUFFER_VIEW_CACHE:
3021 if (!theFormats().view(*this, d->preview_file_,
3022 d->preview_format_))
3023 dr.setMessage(_("Error viewing the output file."));
3026 case LFUN_CHANGES_TRACK:
3027 if (params().save_transient_properties)
3028 undo().recordUndoBufferParams(CursorData());
3029 params().track_changes = !params().track_changes;
3030 if (!params().track_changes)
3031 dr.forceChangesUpdate();
3034 case LFUN_CHANGES_OUTPUT:
3035 if (params().save_transient_properties)
3036 undo().recordUndoBufferParams(CursorData());
3037 params().output_changes = !params().output_changes;
3038 if (params().output_changes) {
3039 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3040 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3041 LaTeXFeatures::isAvailable("xcolor");
3043 if (!dvipost && !xcolorulem) {
3044 Alert::warning(_("Changes not shown in LaTeX output"),
3045 _("Changes will not be highlighted in LaTeX output, "
3046 "because neither dvipost nor xcolor/ulem are installed.\n"
3047 "Please install these packages or redefine "
3048 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3049 } else if (!xcolorulem) {
3050 Alert::warning(_("Changes not shown in LaTeX output"),
3051 _("Changes will not be highlighted in LaTeX output "
3052 "when using pdflatex, because xcolor and ulem are not installed.\n"
3053 "Please install both packages or redefine "
3054 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3059 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3060 // turn compression on/off
3061 undo().recordUndoBufferParams(CursorData());
3062 params().compressed = !params().compressed;
3065 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3066 undo().recordUndoBufferParams(CursorData());
3067 params().output_sync = !params().output_sync;
3070 case LFUN_BUFFER_ANONYMIZE: {
3071 undo().recordUndoFullBuffer(CursorData());
3072 CursorData cur(doc_iterator_begin(this));
3073 for ( ; cur ; cur.forwardPar())
3074 cur.paragraph().anonymize();
3075 dr.forceBufferUpdate();
3076 dr.screenUpdate(Update::Force);
3084 dr.dispatched(dispatched);
3088 void Buffer::changeLanguage(Language const * from, Language const * to)
3090 LASSERT(from, return);
3091 LASSERT(to, return);
3093 for_each(par_iterator_begin(),
3095 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3099 bool Buffer::isMultiLingual() const
3101 ParConstIterator end = par_iterator_end();
3102 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3103 if (it->isMultiLingual(params()))
3110 std::set<Language const *> Buffer::getLanguages() const
3112 std::set<Language const *> langs;
3113 getLanguages(langs);
3118 void Buffer::getLanguages(std::set<Language const *> & langs) const
3120 ParConstIterator end = par_iterator_end();
3121 // add the buffer language, even if it's not actively used
3122 langs.insert(language());
3123 // iterate over the paragraphs
3124 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3125 it->getLanguages(langs);
3127 ListOfBuffers clist = getDescendents();
3128 for (auto const & cit : clist)
3129 cit->getLanguages(langs);
3133 DocIterator Buffer::getParFromID(int const id) const
3135 Buffer * buf = const_cast<Buffer *>(this);
3137 // This means non-existent
3138 return doc_iterator_end(buf);
3140 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3141 if (it.paragraph().id() == id)
3144 return doc_iterator_end(buf);
3148 bool Buffer::hasParWithID(int const id) const
3150 return !getParFromID(id).atEnd();
3154 ParIterator Buffer::par_iterator_begin()
3156 return ParIterator(doc_iterator_begin(this));
3160 ParIterator Buffer::par_iterator_end()
3162 return ParIterator(doc_iterator_end(this));
3166 ParConstIterator Buffer::par_iterator_begin() const
3168 return ParConstIterator(doc_iterator_begin(this));
3172 ParConstIterator Buffer::par_iterator_end() const
3174 return ParConstIterator(doc_iterator_end(this));
3178 Language const * Buffer::language() const
3180 return params().language;
3184 docstring const Buffer::B_(string const & l10n) const
3186 return params().B_(l10n);
3190 bool Buffer::isClean() const
3192 return d->lyx_clean;
3196 bool Buffer::isChecksumModified() const
3198 LASSERT(d->filename.exists(), return false);
3199 return d->checksum_ != d->filename.checksum();
3203 void Buffer::saveCheckSum() const
3205 FileName const & file = d->filename;
3207 d->checksum_ = file.exists() ? file.checksum()
3208 : 0; // in the case of save to a new file.
3212 void Buffer::markClean() const
3214 if (!d->lyx_clean) {
3215 d->lyx_clean = true;
3218 // if the .lyx file has been saved, we don't need an
3220 d->bak_clean = true;
3221 d->undo_.markDirty();
3222 clearExternalModification();
3226 void Buffer::setUnnamed(bool flag)
3232 bool Buffer::isUnnamed() const
3239 /// Don't check unnamed, here: isInternal() is used in
3240 /// newBuffer(), where the unnamed flag has not been set by anyone
3241 /// yet. Also, for an internal buffer, there should be no need for
3242 /// retrieving fileName() nor for checking if it is unnamed or not.
3243 bool Buffer::isInternal() const
3245 return d->internal_buffer;
3249 void Buffer::setInternal(bool flag)
3251 d->internal_buffer = flag;
3255 void Buffer::markDirty()
3258 d->lyx_clean = false;
3261 d->bak_clean = false;
3263 for (auto & depit : d->dep_clean)
3264 depit.second = false;
3268 FileName Buffer::fileName() const
3274 string Buffer::absFileName() const
3276 return d->filename.absFileName();
3280 string Buffer::filePath() const
3282 string const abs = d->filename.onlyPath().absFileName();
3285 int last = abs.length() - 1;
3287 return abs[last] == '/' ? abs : abs + '/';
3291 DocFileName Buffer::getReferencedFileName(string const & fn) const
3294 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3295 result.set(fn, filePath());
3297 // filePath() ends with a path separator
3298 FileName const test(filePath() + fn);
3300 result.set(fn, filePath());
3302 result.set(fn, params().origin);
3309 string const Buffer::prepareFileNameForLaTeX(string const & name,
3310 string const & ext, bool nice) const
3312 string const fname = makeAbsPath(name, filePath()).absFileName();
3313 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3319 return to_utf8(makeRelPath(from_utf8(fname),
3320 from_utf8(masterBuffer()->filePath())));
3324 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3325 docstring_list const & bibfilelist,
3326 bool const add_extension) const
3328 // If we are processing the LaTeX file in a temp directory then
3329 // copy the .bib databases to this temp directory, mangling their
3330 // names in the process. Store this mangled name in the list of
3332 // (We need to do all this because BibTeX *really*, *really*
3333 // can't handle "files with spaces" and Windows users tend to
3334 // use such filenames.)
3335 // Otherwise, store the (maybe absolute) path to the original,
3336 // unmangled database name.
3338 vector<pair<docstring, string>> res;
3340 // determine the export format
3341 string const tex_format = flavor2format(runparams.flavor);
3343 // check for spaces in paths
3344 bool found_space = false;
3346 for (auto const & bit : bibfilelist) {
3347 string utf8input = to_utf8(bit);
3349 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3350 FileName try_in_file =
3351 makeAbsPath(database + ".bib", filePath());
3352 bool not_from_texmf = try_in_file.isReadableFile();
3353 // If the file has not been found, try with the real file name
3354 // (it might come from a child in a sub-directory)
3355 if (!not_from_texmf) {
3356 try_in_file = getBibfilePath(bit);
3357 if (try_in_file.isReadableFile()) {
3358 // Check if the file is in texmf
3359 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3360 not_from_texmf = kpsefile.empty()
3361 || kpsefile.absFileName() != try_in_file.absFileName();
3363 // If this exists, make path relative to the master
3366 removeExtension(prepareFileNameForLaTeX(
3367 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3368 from_utf8(filePath()))),
3369 ".bib", runparams.nice));
3373 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3375 // mangledFileName() needs the extension
3376 DocFileName const in_file = DocFileName(try_in_file);
3377 database = removeExtension(in_file.mangledFileName());
3378 FileName const out_file = makeAbsPath(database + ".bib",
3379 masterBuffer()->temppath());
3380 bool const success = in_file.copyTo(out_file);
3382 LYXERR0("Failed to copy '" << in_file
3383 << "' to '" << out_file << "'");
3385 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3386 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3387 if (!isValidLaTeXFileName(database)) {
3388 frontend::Alert::warning(_("Invalid filename"),
3389 _("The following filename will cause troubles "
3390 "when running the exported file through LaTeX: ") +
3391 from_utf8(database));
3393 if (!isValidDVIFileName(database)) {
3394 frontend::Alert::warning(_("Problematic filename for DVI"),
3395 _("The following filename can cause troubles "
3396 "when running the exported file through LaTeX "
3397 "and opening the resulting DVI: ") +
3398 from_utf8(database), true);
3406 docstring const path = from_utf8(latex_path(database));
3408 if (contains(path, ' '))
3411 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3412 enc = params().bibFileEncoding(utf8input);
3414 bool recorded = false;
3415 for (pair<docstring, string> pe : res) {
3416 if (pe.first == path) {
3423 res.push_back(make_pair(path, enc));
3426 // Check if there are spaces in the path and warn BibTeX users, if so.
3427 // (biber can cope with such paths)
3428 if (!prefixIs(runparams.bibtex_command, "biber")) {
3429 // Post this warning only once.
3430 static bool warned_about_spaces = false;
3431 if (!warned_about_spaces &&
3432 runparams.nice && found_space) {
3433 warned_about_spaces = true;
3434 Alert::warning(_("Export Warning!"),
3435 _("There are spaces in the paths to your BibTeX databases.\n"
3436 "BibTeX will be unable to find them."));
3445 string Buffer::layoutPos() const
3447 return d->layout_position;
3451 void Buffer::setLayoutPos(string const & path)
3454 d->layout_position.clear();
3458 LATTEST(FileName::isAbsolute(path));
3460 d->layout_position =
3461 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3463 if (d->layout_position.empty())
3464 d->layout_position = ".";
3468 bool Buffer::hasReadonlyFlag() const
3470 return d->read_only;
3474 bool Buffer::isReadonly() const
3476 return hasReadonlyFlag() || notifiesExternalModification();
3480 void Buffer::setParent(Buffer const * buffer)
3482 // Avoids recursive include.
3483 d->setParent(buffer == this ? 0 : buffer);
3488 Buffer const * Buffer::parent() const
3494 ListOfBuffers Buffer::allRelatives() const
3496 ListOfBuffers lb = masterBuffer()->getDescendents();
3497 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3502 Buffer const * Buffer::masterBuffer() const
3504 // FIXME Should be make sure we are not in some kind
3505 // of recursive include? A -> B -> A will crash this.
3506 Buffer const * const pbuf = d->parent();
3510 return pbuf->masterBuffer();
3514 bool Buffer::isChild(Buffer * child) const
3516 return d->children_positions.find(child) != d->children_positions.end();
3520 DocIterator Buffer::firstChildPosition(Buffer const * child)
3522 Impl::BufferPositionMap::iterator it;
3523 it = d->children_positions.find(child);
3524 if (it == d->children_positions.end())
3525 return DocIterator(this);
3530 bool Buffer::hasChildren() const
3532 return !d->children_positions.empty();
3536 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3538 // loop over children
3539 for (auto const & p : d->children_positions) {
3540 Buffer * child = const_cast<Buffer *>(p.first);
3542 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3543 if (bit != clist.end())
3545 clist.push_back(child);
3547 // there might be grandchildren
3548 child->collectChildren(clist, true);
3553 ListOfBuffers Buffer::getChildren() const
3556 collectChildren(v, false);
3557 // Make sure we have not included ourselves.
3558 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3559 if (bit != v.end()) {
3560 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3567 ListOfBuffers Buffer::getDescendents() const
3570 collectChildren(v, true);
3571 // Make sure we have not included ourselves.
3572 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3573 if (bit != v.end()) {
3574 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3581 template<typename M>
3582 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3587 typename M::const_iterator it = m.lower_bound(x);
3588 if (it == m.begin())
3596 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3597 DocIterator const & pos) const
3599 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3601 // if paragraphs have no macro context set, pos will be empty
3605 // we haven't found anything yet
3606 DocIterator bestPos = owner_->par_iterator_begin();
3607 MacroData const * bestData = 0;
3609 // find macro definitions for name
3610 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3611 if (nameIt != macros.end()) {
3612 // find last definition in front of pos or at pos itself
3613 PositionScopeMacroMap::const_iterator it
3614 = greatest_below(nameIt->second, pos);
3615 if (it != nameIt->second.end()) {
3617 // scope ends behind pos?
3618 if (pos < it->second.scope) {
3619 // Looks good, remember this. If there
3620 // is no external macro behind this,
3621 // we found the right one already.
3622 bestPos = it->first;
3623 bestData = &it->second.macro;
3627 // try previous macro if there is one
3628 if (it == nameIt->second.begin())
3635 // find macros in included files
3636 PositionScopeBufferMap::const_iterator it
3637 = greatest_below(position_to_children, pos);
3638 if (it == position_to_children.end())
3639 // no children before
3643 // do we know something better (i.e. later) already?
3644 if (it->first < bestPos )
3647 // scope ends behind pos?
3648 if (pos < it->second.scope
3649 && (cloned_buffer_ ||
3650 theBufferList().isLoaded(it->second.buffer))) {
3651 // look for macro in external file
3653 MacroData const * data
3654 = it->second.buffer->getMacro(name, false);
3657 bestPos = it->first;
3663 // try previous file if there is one
3664 if (it == position_to_children.begin())
3669 // return the best macro we have found
3674 MacroData const * Buffer::getMacro(docstring const & name,
3675 DocIterator const & pos, bool global) const
3680 // query buffer macros
3681 MacroData const * data = d->getBufferMacro(name, pos);
3685 // If there is a master buffer, query that
3686 Buffer const * const pbuf = d->parent();
3688 d->macro_lock = true;
3689 MacroData const * macro = pbuf->getMacro(
3690 name, *this, false);
3691 d->macro_lock = false;
3697 data = MacroTable::globalMacros().get(name);
3706 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3708 // set scope end behind the last paragraph
3709 DocIterator scope = par_iterator_begin();
3710 scope.pit() = scope.lastpit() + 1;
3712 return getMacro(name, scope, global);
3716 MacroData const * Buffer::getMacro(docstring const & name,
3717 Buffer const & child, bool global) const
3719 // look where the child buffer is included first
3720 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3721 if (it == d->children_positions.end())
3724 // check for macros at the inclusion position
3725 return getMacro(name, it->second, global);
3729 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3731 pit_type const lastpit = it.lastpit();
3733 // look for macros in each paragraph
3734 while (it.pit() <= lastpit) {
3735 Paragraph & par = it.paragraph();
3737 // FIXME Can this be done with the new-style iterators?
3738 // iterate over the insets of the current paragraph
3739 for (auto const & insit : par.insetList()) {
3740 it.pos() = insit.pos;
3742 // is it a nested text inset?
3743 if (insit.inset->asInsetText()) {
3744 // Inset needs its own scope?
3745 InsetText const * itext = insit.inset->asInsetText();
3746 bool newScope = itext->isMacroScope();
3748 // scope which ends just behind the inset
3749 DocIterator insetScope = it;
3752 // collect macros in inset
3753 it.push_back(CursorSlice(*insit.inset));
3754 updateMacros(it, newScope ? insetScope : scope);
3759 if (insit.inset->asInsetTabular()) {
3760 CursorSlice slice(*insit.inset);
3761 size_t const numcells = slice.nargs();
3762 for (; slice.idx() < numcells; slice.forwardIdx()) {
3763 it.push_back(slice);
3764 updateMacros(it, scope);
3770 // is it an external file?
3771 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3772 // get buffer of external file
3773 InsetInclude const & incinset =
3774 static_cast<InsetInclude const &>(*insit.inset);
3776 Buffer * child = incinset.getChildBuffer();
3781 // register its position, but only when it is
3782 // included first in the buffer
3783 if (children_positions.find(child) ==
3784 children_positions.end())
3785 children_positions[child] = it;
3787 // register child with its scope
3788 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3792 InsetMath * im = insit.inset->asInsetMath();
3793 if (doing_export && im) {
3794 InsetMathHull * hull = im->asHullInset();
3796 hull->recordLocation(it);
3799 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3803 InsetMathMacroTemplate & macroTemplate =
3804 *insit.inset->asInsetMath()->asMacroTemplate();
3805 MacroContext mc(owner_, it);
3806 macroTemplate.updateToContext(mc);
3809 bool valid = macroTemplate.validMacro();
3810 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3811 // then the BufferView's cursor will be invalid in
3812 // some cases which leads to crashes.
3817 // FIXME (Abdel), I don't understand why we pass 'it' here
3818 // instead of 'macroTemplate' defined above... is this correct?
3819 macros[macroTemplate.name()][it] =
3820 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3830 void Buffer::updateMacros() const
3835 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3837 // start with empty table
3839 d->children_positions.clear();
3840 d->position_to_children.clear();
3842 // Iterate over buffer, starting with first paragraph
3843 // The scope must be bigger than any lookup DocIterator
3844 // later. For the global lookup, lastpit+1 is used, hence
3845 // we use lastpit+2 here.
3846 DocIterator it = par_iterator_begin();
3847 DocIterator outerScope = it;
3848 outerScope.pit() = outerScope.lastpit() + 2;
3849 d->updateMacros(it, outerScope);
3853 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3855 InsetIterator it = inset_iterator_begin(inset());
3856 InsetIterator const end = inset_iterator_end(inset());
3857 for (; it != end; ++it) {
3858 if (it->lyxCode() == BRANCH_CODE) {
3859 InsetBranch & br = static_cast<InsetBranch &>(*it);
3860 docstring const name = br.branch();
3861 if (!from_master && !params().branchlist().find(name))
3862 result.push_back(name);
3863 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3864 result.push_back(name);
3867 if (it->lyxCode() == INCLUDE_CODE) {
3868 // get buffer of external file
3869 InsetInclude const & ins =
3870 static_cast<InsetInclude const &>(*it);
3871 Buffer * child = ins.getChildBuffer();
3874 child->getUsedBranches(result, true);
3877 // remove duplicates
3882 void Buffer::updateMacroInstances(UpdateType utype) const
3884 LYXERR(Debug::MACROS, "updateMacroInstances for "
3885 << d->filename.onlyFileName());
3886 DocIterator it = doc_iterator_begin(this);
3888 DocIterator const end = doc_iterator_end(this);
3889 for (; it != end; it.forwardInset()) {
3890 // look for MathData cells in InsetMathNest insets
3891 InsetMath * minset = it.nextInset()->asInsetMath();
3895 // update macro in all cells of the InsetMathNest
3896 DocIterator::idx_type n = minset->nargs();
3897 MacroContext mc = MacroContext(this, it);
3898 for (DocIterator::idx_type i = 0; i < n; ++i) {
3899 MathData & data = minset->cell(i);
3900 data.updateMacros(0, mc, utype, 0);
3906 void Buffer::listMacroNames(MacroNameSet & macros) const
3911 d->macro_lock = true;
3913 // loop over macro names
3914 for (auto const & nameit : d->macros)
3915 macros.insert(nameit.first);
3917 // loop over children
3918 for (auto const & p : d->children_positions) {
3919 Buffer * child = const_cast<Buffer *>(p.first);
3920 // The buffer might have been closed (see #10766).
3921 if (theBufferList().isLoaded(child))
3922 child->listMacroNames(macros);
3926 Buffer const * const pbuf = d->parent();
3928 pbuf->listMacroNames(macros);
3930 d->macro_lock = false;
3934 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3936 Buffer const * const pbuf = d->parent();
3941 pbuf->listMacroNames(names);
3944 for (auto const & mit : names) {
3946 MacroData const * data = pbuf->getMacro(mit, *this, false);
3948 macros.insert(data);
3950 // we cannot access the original InsetMathMacroTemplate anymore
3951 // here to calls validate method. So we do its work here manually.
3952 // FIXME: somehow make the template accessible here.
3953 if (data->optionals() > 0)
3954 features.require("xargs");
3960 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3963 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3965 RefCache::iterator it = d->ref_cache_.find(label);
3966 if (it != d->ref_cache_.end())
3969 static References const dummy_refs = References();
3970 it = d->ref_cache_.insert(
3971 make_pair(label, dummy_refs)).first;
3976 Buffer::References const & Buffer::references(docstring const & label) const
3978 return const_cast<Buffer *>(this)->getReferenceCache(label);
3982 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3984 References & refs = getReferenceCache(label);
3985 refs.push_back(make_pair(inset, it));
3989 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3993 linfo.label = label;
3995 linfo.active = active;
3996 masterBuffer()->d->label_cache_.push_back(linfo);
4000 InsetLabel const * Buffer::insetLabel(docstring const & label,
4001 bool const active) const
4003 for (auto & rc : masterBuffer()->d->label_cache_) {
4004 if (rc.label == label && (rc.active || !active))
4011 bool Buffer::activeLabel(docstring const & label) const
4013 if (!insetLabel(label, true))
4020 void Buffer::clearReferenceCache() const
4023 d->ref_cache_.clear();
4024 d->label_cache_.clear();
4029 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4031 //FIXME: This does not work for child documents yet.
4032 reloadBibInfoCache();
4034 // Check if the label 'from' appears more than once
4035 vector<docstring> labels;
4036 for (auto const & bibit : masterBibInfo())
4037 labels.push_back(bibit.first);
4039 if (count(labels.begin(), labels.end(), from) > 1)
4042 string const paramName = "key";
4043 InsetIterator it = inset_iterator_begin(inset());
4045 if (it->lyxCode() != CITE_CODE)
4047 InsetCommand * inset = it->asInsetCommand();
4048 docstring const oldValue = inset->getParam(paramName);
4049 if (oldValue == from)
4050 inset->setParam(paramName, to);
4054 // returns NULL if id-to-row conversion is unsupported
4055 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4056 pit_type par_begin, pit_type par_end,
4057 OutputWhat output, bool master) const
4059 unique_ptr<TexRow> texrow;
4060 OutputParams runparams(¶ms().encoding());
4061 runparams.nice = true;
4062 runparams.flavor = params().getOutputFlavor(format);
4063 runparams.linelen = lyxrc.plaintext_linelen;
4064 // No side effect of file copying and image conversion
4065 runparams.dryrun = true;
4067 // Some macros rely on font encoding
4068 runparams.main_fontenc = params().main_font_encoding();
4070 if (output == CurrentParagraph) {
4071 runparams.par_begin = par_begin;
4072 runparams.par_end = par_end;
4073 if (par_begin + 1 == par_end) {
4075 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4079 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4080 convert<docstring>(par_begin),
4081 convert<docstring>(par_end - 1))
4084 // output paragraphs
4085 if (runparams.flavor == OutputParams::LYX) {
4086 Paragraph const & par = text().paragraphs()[par_begin];
4088 depth_type dt = par.getDepth();
4089 par.write(ods, params(), dt);
4090 os << from_utf8(ods.str());
4091 } else if (runparams.flavor == OutputParams::HTML) {
4093 setMathFlavor(runparams);
4094 xhtmlParagraphs(text(), *this, xs, runparams);
4095 } else if (runparams.flavor == OutputParams::TEXT) {
4097 // FIXME Handles only one paragraph, unlike the others.
4098 // Probably should have some routine with a signature like them.
4099 writePlaintextParagraph(*this,
4100 text().paragraphs()[par_begin], os, runparams, dummy);
4101 } else if (params().isDocBook()) {
4102 docbookParagraphs(text(), *this, os, runparams);
4104 // If we are previewing a paragraph, even if this is the
4105 // child of some other buffer, let's cut the link here,
4106 // so that no concurring settings from the master
4107 // (e.g. branch state) interfere (see #8101).
4109 d->ignore_parent = true;
4110 // We need to validate the Buffer params' features here
4111 // in order to know if we should output polyglossia
4112 // macros (instead of babel macros)
4113 LaTeXFeatures features(*this, params(), runparams);
4115 runparams.use_polyglossia = features.usePolyglossia();
4116 // latex or literate
4119 ots.texrow().newlines(2);
4121 latexParagraphs(*this, text(), ots, runparams);
4122 texrow = ots.releaseTexRow();
4124 // Restore the parenthood
4126 d->ignore_parent = false;
4130 if (output == FullSource)
4131 os << _("Preview source code");
4132 else if (output == OnlyPreamble)
4133 os << _("Preview preamble");
4134 else if (output == OnlyBody)
4135 os << _("Preview body");
4137 if (runparams.flavor == OutputParams::LYX) {
4139 if (output == FullSource)
4141 else if (output == OnlyPreamble)
4142 params().writeFile(ods, this);
4143 else if (output == OnlyBody)
4145 os << from_utf8(ods.str());
4146 } else if (runparams.flavor == OutputParams::HTML) {
4147 writeLyXHTMLSource(os, runparams, output);
4148 } else if (runparams.flavor == OutputParams::TEXT) {
4149 if (output == OnlyPreamble) {
4150 os << "% "<< _("Plain text does not have a preamble.");
4152 writePlaintextFile(*this, os, runparams);
4153 } else if (params().isDocBook()) {
4154 writeDocBookSource(os, absFileName(), runparams, output);
4156 // latex or literate
4159 ots.texrow().newlines(2);
4161 runparams.is_child = true;
4163 writeLaTeXSource(ots, string(), runparams, output);
4164 texrow = ots.releaseTexRow();
4171 ErrorList & Buffer::errorList(string const & type) const
4173 return d->errorLists[type];
4177 void Buffer::updateTocItem(std::string const & type,
4178 DocIterator const & dit) const
4181 d->gui_->updateTocItem(type, dit);
4185 void Buffer::structureChanged() const
4188 d->gui_->structureChanged();
4192 void Buffer::errors(string const & err, bool from_master) const
4195 d->gui_->errors(err, from_master);
4199 void Buffer::message(docstring const & msg) const
4202 d->gui_->message(msg);
4206 void Buffer::setBusy(bool on) const
4209 d->gui_->setBusy(on);
4213 void Buffer::updateTitles() const
4216 d->wa_->updateTitles();
4220 void Buffer::resetAutosaveTimers() const
4223 d->gui_->resetAutosaveTimers();
4227 bool Buffer::hasGuiDelegate() const
4233 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4242 class AutoSaveBuffer : public ForkedProcess {
4245 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4246 : buffer_(buffer), fname_(fname) {}
4248 virtual shared_ptr<ForkedProcess> clone() const
4250 return make_shared<AutoSaveBuffer>(*this);
4255 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4256 from_utf8(fname_.absFileName())));
4257 return run(DontWait);
4261 virtual int generateChild();
4263 Buffer const & buffer_;
4268 int AutoSaveBuffer::generateChild()
4270 #if defined(__APPLE__)
4271 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4272 * We should use something else like threads.
4274 * Since I do not know how to determine at run time what is the OS X
4275 * version, I just disable forking altogether for now (JMarc)
4277 pid_t const pid = -1;
4279 // tmp_ret will be located (usually) in /tmp
4280 // will that be a problem?
4281 // Note that this calls ForkedCalls::fork(), so it's
4282 // ok cross-platform.
4283 pid_t const pid = fork();
4284 // If you want to debug the autosave
4285 // you should set pid to -1, and comment out the fork.
4286 if (pid != 0 && pid != -1)
4290 // pid = -1 signifies that lyx was unable
4291 // to fork. But we will do the save
4293 bool failed = false;
4294 TempFile tempfile("lyxautoXXXXXX.lyx");
4295 tempfile.setAutoRemove(false);
4296 FileName const tmp_ret = tempfile.name();
4297 if (!tmp_ret.empty()) {
4298 if (!buffer_.writeFile(tmp_ret))
4300 else if (!tmp_ret.moveTo(fname_))
4306 // failed to write/rename tmp_ret so try writing direct
4307 if (!buffer_.writeFile(fname_)) {
4308 // It is dangerous to do this in the child,
4309 // but safe in the parent, so...
4310 if (pid == -1) // emit message signal.
4311 buffer_.message(_("Autosave failed!"));
4315 if (pid == 0) // we are the child so...
4324 FileName Buffer::getEmergencyFileName() const
4326 return FileName(d->filename.absFileName() + ".emergency");
4330 FileName Buffer::getAutosaveFileName() const
4332 // if the document is unnamed try to save in the backup dir, else
4333 // in the default document path, and as a last try in the filePath,
4334 // which will most often be the temporary directory
4337 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4338 : lyxrc.backupdir_path;
4339 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4342 string const fname = "#" + d->filename.onlyFileName() + "#";
4344 return makeAbsPath(fname, fpath);
4348 void Buffer::removeAutosaveFile() const
4350 FileName const f = getAutosaveFileName();
4356 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4358 FileName const newauto = getAutosaveFileName();
4360 if (newauto != oldauto && oldauto.exists())
4361 if (!oldauto.moveTo(newauto))
4362 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4366 bool Buffer::autoSave() const
4368 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4369 if (buf->d->bak_clean || hasReadonlyFlag())
4372 message(_("Autosaving current document..."));
4373 buf->d->bak_clean = true;
4375 FileName const fname = getAutosaveFileName();
4376 LASSERT(d->cloned_buffer_, return false);
4378 // If this buffer is cloned, we assume that
4379 // we are running in a separate thread already.
4380 TempFile tempfile("lyxautoXXXXXX.lyx");
4381 tempfile.setAutoRemove(false);
4382 FileName const tmp_ret = tempfile.name();
4383 if (!tmp_ret.empty()) {
4385 // assume successful write of tmp_ret
4386 if (tmp_ret.moveTo(fname))
4389 // failed to write/rename tmp_ret so try writing direct
4390 return writeFile(fname);
4394 void Buffer::setExportStatus(bool e) const
4396 d->doing_export = e;
4397 ListOfBuffers clist = getDescendents();
4398 for (auto const & bit : clist)
4399 bit->d->doing_export = e;
4403 bool Buffer::isExporting() const
4405 return d->doing_export;
4409 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4413 return doExport(target, put_in_tempdir, result_file);
4416 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4417 string & result_file) const
4419 bool const update_unincluded =
4420 params().maintain_unincluded_children
4421 && !params().getIncludedChildren().empty();
4423 // (1) export with all included children (omit \includeonly)
4424 if (update_unincluded) {
4425 ExportStatus const status =
4426 doExport(target, put_in_tempdir, true, result_file);
4427 if (status != ExportSuccess)
4430 // (2) export with included children only
4431 return doExport(target, put_in_tempdir, false, result_file);
4435 void Buffer::setMathFlavor(OutputParams & op) const
4437 switch (params().html_math_output) {
4438 case BufferParams::MathML:
4439 op.math_flavor = OutputParams::MathAsMathML;
4441 case BufferParams::HTML:
4442 op.math_flavor = OutputParams::MathAsHTML;
4444 case BufferParams::Images:
4445 op.math_flavor = OutputParams::MathAsImages;
4447 case BufferParams::LaTeX:
4448 op.math_flavor = OutputParams::MathAsLaTeX;
4454 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4455 bool includeall, string & result_file) const
4457 LYXERR(Debug::FILES, "target=" << target);
4458 OutputParams runparams(¶ms().encoding());
4459 string format = target;
4460 string dest_filename;
4461 size_t pos = target.find(' ');
4462 if (pos != string::npos) {
4463 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4464 format = target.substr(0, pos);
4465 if (format == "default")
4466 format = params().getDefaultOutputFormat();
4467 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4468 FileName(dest_filename).onlyPath().createPath();
4469 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4471 MarkAsExporting exporting(this);
4472 string backend_format;
4473 runparams.flavor = OutputParams::LATEX;
4474 runparams.linelen = lyxrc.plaintext_linelen;
4475 runparams.includeall = includeall;
4476 vector<string> backs = params().backends();
4477 Converters converters = theConverters();
4478 bool need_nice_file = false;
4479 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4480 // Get shortest path to format
4481 converters.buildGraph();
4482 Graph::EdgePath path;
4483 for (string const & sit : backs) {
4484 Graph::EdgePath p = converters.getPath(sit, format);
4485 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4486 backend_format = sit;
4491 if (!put_in_tempdir) {
4492 // Only show this alert if this is an export to a non-temporary
4493 // file (not for previewing).
4494 docstring s = bformat(_("No information for exporting the format %1$s."),
4495 theFormats().prettyName(format));
4496 if (format == "pdf4")
4498 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4499 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4500 Alert::error(_("Couldn't export file"), s);
4502 return ExportNoPathToFormat;
4504 runparams.flavor = converters.getFlavor(path, this);
4505 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4506 for (auto const & edge : path)
4507 if (theConverters().get(edge).nice()) {
4508 need_nice_file = true;
4513 backend_format = format;
4514 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4515 // FIXME: Don't hardcode format names here, but use a flag
4516 if (backend_format == "pdflatex")
4517 runparams.flavor = OutputParams::PDFLATEX;
4518 else if (backend_format == "luatex")
4519 runparams.flavor = OutputParams::LUATEX;
4520 else if (backend_format == "dviluatex")
4521 runparams.flavor = OutputParams::DVILUATEX;
4522 else if (backend_format == "xetex")
4523 runparams.flavor = OutputParams::XETEX;
4526 string filename = latexName(false);
4527 filename = addName(temppath(), filename);
4528 filename = changeExtension(filename,
4529 theFormats().extension(backend_format));
4530 LYXERR(Debug::FILES, "filename=" << filename);
4532 // Plain text backend
4533 if (backend_format == "text") {
4534 runparams.flavor = OutputParams::TEXT;
4536 writePlaintextFile(*this, FileName(filename), runparams);
4538 catch (ConversionException const &) { return ExportCancel; }
4541 else if (backend_format == "xhtml") {
4542 runparams.flavor = OutputParams::HTML;
4543 setMathFlavor(runparams);
4544 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4545 return ExportKilled;
4546 } else if (backend_format == "lyx")
4547 writeFile(FileName(filename));
4549 else if (params().isDocBook()) {
4550 runparams.nice = !put_in_tempdir;
4551 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4552 return ExportKilled;
4555 else if (backend_format == format || need_nice_file) {
4556 runparams.nice = true;
4557 ExportStatus const retval =
4558 makeLaTeXFile(FileName(filename), string(), runparams);
4559 if (retval == ExportKilled)
4560 return ExportKilled;
4561 if (d->cloned_buffer_)
4562 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4563 if (retval != ExportSuccess)
4565 } else if (!lyxrc.tex_allows_spaces
4566 && contains(filePath(), ' ')) {
4567 Alert::error(_("File name error"),
4568 bformat(_("The directory path to the document\n%1$s\n"
4569 "contains spaces, but your TeX installation does "
4570 "not allow them. You should save the file to a directory "
4571 "whose name does not contain spaces."), from_utf8(filePath())));
4572 return ExportTexPathHasSpaces;
4574 runparams.nice = false;
4575 ExportStatus const retval =
4576 makeLaTeXFile(FileName(filename), filePath(), runparams);
4577 if (retval == ExportKilled)
4578 return ExportKilled;
4579 if (d->cloned_buffer_)
4580 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4581 if (retval != ExportSuccess)
4585 string const error_type = (format == "program")
4586 ? "Build" : params().bufferFormat();
4587 ErrorList & error_list = d->errorLists[error_type];
4588 string const ext = theFormats().extension(format);
4589 FileName const tmp_result_file(changeExtension(filename, ext));
4590 Converters::RetVal const retval =
4591 converters.convert(this, FileName(filename), tmp_result_file,
4592 FileName(absFileName()), backend_format, format, error_list);
4593 if (retval == Converters::KILLED)
4594 return ExportCancel;
4595 bool success = (retval == Converters::SUCCESS);
4597 // Emit the signal to show the error list or copy it back to the
4598 // cloned Buffer so that it can be emitted afterwards.
4599 if (format != backend_format) {
4600 if (runparams.silent)
4602 else if (d->cloned_buffer_)
4603 d->cloned_buffer_->d->errorLists[error_type] =
4604 d->errorLists[error_type];
4607 // also to the children, in case of master-buffer-view
4608 ListOfBuffers clist = getDescendents();
4609 for (auto const & bit : clist) {
4610 if (runparams.silent)
4611 bit->d->errorLists[error_type].clear();
4612 else if (d->cloned_buffer_) {
4613 // Enable reverse search by copying back the
4614 // texrow object to the cloned buffer.
4615 // FIXME: this is not thread safe.
4616 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4617 bit->d->cloned_buffer_->d->errorLists[error_type] =
4618 bit->d->errorLists[error_type];
4620 bit->errors(error_type, true);
4624 if (d->cloned_buffer_) {
4625 // Enable reverse dvi or pdf to work by copying back the texrow
4626 // object to the cloned buffer.
4627 // FIXME: There is a possibility of concurrent access to texrow
4628 // here from the main GUI thread that should be securized.
4629 d->cloned_buffer_->d->texrow = d->texrow;
4630 string const err_type = params().bufferFormat();
4631 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4635 if (put_in_tempdir) {
4636 result_file = tmp_result_file.absFileName();
4637 return success ? ExportSuccess : ExportConverterError;
4640 if (dest_filename.empty())
4641 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4643 result_file = dest_filename;
4644 // We need to copy referenced files (e. g. included graphics
4645 // if format == "dvi") to the result dir.
4646 vector<ExportedFile> const extfiles =
4647 runparams.exportdata->externalFiles(format);
4648 string const dest = runparams.export_folder.empty() ?
4649 onlyPath(result_file) : runparams.export_folder;
4650 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4651 : force_overwrite == ALL_FILES;
4652 CopyStatus status = use_force ? FORCE : SUCCESS;
4654 for (ExportedFile const & exp : extfiles) {
4655 if (status == CANCEL) {
4656 message(_("Document export cancelled."));
4657 return ExportCancel;
4659 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4660 string fixedName = exp.exportName;
4661 if (!runparams.export_folder.empty()) {
4662 // Relative pathnames starting with ../ will be sanitized
4663 // if exporting to a different folder
4664 while (fixedName.substr(0, 3) == "../")
4665 fixedName = fixedName.substr(3, fixedName.length() - 3);
4667 FileName fixedFileName = makeAbsPath(fixedName, dest);
4668 fixedFileName.onlyPath().createPath();
4669 status = copyFile(fmt, exp.sourceName,
4671 exp.exportName, status == FORCE,
4672 runparams.export_folder.empty());
4676 if (tmp_result_file.exists()) {
4677 // Finally copy the main file
4678 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4679 : force_overwrite != NO_FILES;
4680 if (status == SUCCESS && use_force)
4682 status = copyFile(format, tmp_result_file,
4683 FileName(result_file), result_file,
4685 if (status == CANCEL) {
4686 message(_("Document export cancelled."));
4687 return ExportCancel;
4689 message(bformat(_("Document exported as %1$s "
4691 theFormats().prettyName(format),
4692 makeDisplayPath(result_file)));
4695 // This must be a dummy converter like fax (bug 1888)
4696 message(bformat(_("Document exported as %1$s"),
4697 theFormats().prettyName(format)));
4700 return success ? ExportSuccess : ExportConverterError;
4704 Buffer::ExportStatus Buffer::preview(string const & format) const
4706 bool const update_unincluded =
4707 params().maintain_unincluded_children
4708 && !params().getIncludedChildren().empty();
4709 return preview(format, update_unincluded);
4713 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4715 MarkAsExporting exporting(this);
4717 // (1) export with all included children (omit \includeonly)
4719 ExportStatus const status = doExport(format, true, true, result_file);
4720 if (status != ExportSuccess)
4723 // (2) export with included children only
4724 ExportStatus const status = doExport(format, true, false, result_file);
4725 FileName const previewFile(result_file);
4727 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4728 theimpl->preview_file_ = previewFile;
4729 theimpl->preview_format_ = format;
4730 theimpl->preview_error_ = (status != ExportSuccess);
4732 if (status != ExportSuccess)
4735 if (previewFile.exists())
4736 return theFormats().view(*this, previewFile, format) ?
4737 PreviewSuccess : PreviewError;
4739 // Successful export but no output file?
4740 // Probably a bug in error detection.
4741 LATTEST(status != ExportSuccess);
4746 Buffer::ReadStatus Buffer::extractFromVC()
4748 bool const found = LyXVC::file_not_found_hook(d->filename);
4750 return ReadFileNotFound;
4751 if (!d->filename.isReadableFile())
4757 Buffer::ReadStatus Buffer::loadEmergency()
4759 FileName const emergencyFile = getEmergencyFileName();
4760 if (!emergencyFile.exists()
4761 || emergencyFile.lastModified() <= d->filename.lastModified())
4762 return ReadFileNotFound;
4764 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4765 docstring const text = bformat(_("An emergency save of the document "
4766 "%1$s exists.\n\nRecover emergency save?"), file);
4768 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4769 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4775 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4776 bool const success = (ret_llf == ReadSuccess);
4778 if (hasReadonlyFlag()) {
4779 Alert::warning(_("File is read-only"),
4780 bformat(_("An emergency file is successfully loaded, "
4781 "but the original file %1$s is marked read-only. "
4782 "Please make sure to save the document as a different "
4783 "file."), from_utf8(d->filename.absFileName())));
4786 lyxvc().file_found_hook(d->filename);
4787 str = _("Document was successfully recovered.");
4789 str = _("Document was NOT successfully recovered.");
4790 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4791 makeDisplayPath(emergencyFile.absFileName()));
4793 int const del_emerg =
4794 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4795 _("&Remove"), _("&Keep"));
4796 if (del_emerg == 0) {
4797 emergencyFile.removeFile();
4799 Alert::warning(_("Emergency file deleted"),
4800 _("Do not forget to save your file now!"), true);
4802 return success ? ReadSuccess : ReadEmergencyFailure;
4805 int const del_emerg =
4806 Alert::prompt(_("Delete emergency file?"),
4807 _("Remove emergency file now?"), 1, 1,
4808 _("&Remove"), _("&Keep"));
4810 emergencyFile.removeFile();
4814 string const ename = emergencyFile.absFileName();
4816 // Surely we can find one in 100 tries?
4817 for (int i = 1; i < 100; ++i) {
4818 newname.set(ename + to_string(i) + ".lyx");
4819 if (!newname.exists()) {
4825 // renameTo returns true on success. So inverting that
4826 // will give us true if we fail.
4827 noname = !emergencyFile.renameTo(newname);
4830 Alert::warning(_("Can't rename emergency file!"),
4831 _("LyX was unable to rename the emergency file. "
4832 "You should do so manually. Otherwise, you will be "
4833 "asked about it again the next time you try to load "
4834 "this file, and may over-write your own work."));
4836 Alert::warning(_("Emergency File Renames"),
4837 bformat(_("Emergency file renamed as:\n %1$s"),
4838 from_utf8(newname.onlyFileName())));
4841 return ReadOriginal;
4851 Buffer::ReadStatus Buffer::loadAutosave()
4853 // Now check if autosave file is newer.
4854 FileName const autosaveFile = getAutosaveFileName();
4855 if (!autosaveFile.exists()
4856 || autosaveFile.lastModified() <= d->filename.lastModified())
4857 return ReadFileNotFound;
4859 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4860 docstring const text = bformat(_("The backup of the document %1$s "
4861 "is newer.\n\nLoad the backup instead?"), file);
4862 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4863 _("&Load backup"), _("Load &original"), _("&Cancel"));
4868 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4869 // the file is not saved if we load the autosave file.
4870 if (ret_llf == ReadSuccess) {
4871 if (hasReadonlyFlag()) {
4872 Alert::warning(_("File is read-only"),
4873 bformat(_("A backup file is successfully loaded, "
4874 "but the original file %1$s is marked read-only. "
4875 "Please make sure to save the document as a "
4877 from_utf8(d->filename.absFileName())));
4880 lyxvc().file_found_hook(d->filename);
4883 return ReadAutosaveFailure;
4886 // Here we delete the autosave
4887 autosaveFile.removeFile();
4888 return ReadOriginal;
4896 Buffer::ReadStatus Buffer::loadLyXFile()
4898 if (!d->filename.isReadableFile()) {
4899 ReadStatus const ret_rvc = extractFromVC();
4900 if (ret_rvc != ReadSuccess)
4904 ReadStatus const ret_re = loadEmergency();
4905 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4908 ReadStatus const ret_ra = loadAutosave();
4909 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4912 return loadThisLyXFile(d->filename);
4916 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4918 return readFile(fn);
4922 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4924 for (; err != end; ++err) {
4925 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4926 int errorRow = err->error_in_line;
4927 Buffer const * buf = 0;
4928 Impl const * p = this;
4929 if (err->child_name.empty())
4930 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4932 // The error occurred in a child
4933 for (Buffer const * child : owner_->getDescendents()) {
4934 string const child_name =
4935 DocFileName(changeExtension(child->absFileName(), "tex")).
4937 if (err->child_name != child_name)
4939 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4940 if (!TexRow::isNone(start)) {
4941 buf = this->cloned_buffer_
4942 ? child->d->cloned_buffer_->d->owner_
4949 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4955 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4957 TeXErrors::Errors::const_iterator err = terr.begin();
4958 TeXErrors::Errors::const_iterator end = terr.end();
4960 d->traverseErrors(err, end, errorList);
4964 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4966 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4967 TeXErrors::Errors::const_iterator end = terr.end_ref();
4969 d->traverseErrors(err, end, errorList);
4973 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4975 LBUFERR(!text().paragraphs().empty());
4977 // Use the master text class also for child documents
4978 Buffer const * const master = masterBuffer();
4979 DocumentClass const & textclass = master->params().documentClass();
4981 docstring_list old_bibfiles;
4982 // Do this only if we are the top-level Buffer. We also need to account
4983 // for the case of a previewed child with ignored parent here.
4984 if (master == this && !d->ignore_parent) {
4985 textclass.counters().reset(from_ascii("bibitem"));
4986 reloadBibInfoCache();
4987 // we will re-read this cache as we go through, but we need
4988 // to know whether it's changed to know whether we need to
4989 // update the bibinfo cache.
4990 old_bibfiles = d->bibfiles_cache_;
4991 d->bibfiles_cache_.clear();
4994 // keep the buffers to be children in this set. If the call from the
4995 // master comes back we can see which of them were actually seen (i.e.
4996 // via an InsetInclude). The remaining ones in the set need still be updated.
4997 static std::set<Buffer const *> bufToUpdate;
4998 if (scope == UpdateMaster) {
4999 // If this is a child document start with the master
5000 if (master != this) {
5001 bufToUpdate.insert(this);
5002 master->updateBuffer(UpdateMaster, utype);
5003 // If the master buffer has no gui associated with it, then the TocModel is
5004 // not updated during the updateBuffer call and TocModel::toc_ is invalid
5005 // (bug 5699). The same happens if the master buffer is open in a different
5006 // window. This test catches both possibilities.
5007 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5008 // There remains a problem here: If there is another child open in yet a third
5009 // window, that TOC is not updated. So some more general solution is needed at
5011 if (master->d->gui_ != d->gui_)
5014 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5015 if (bufToUpdate.find(this) == bufToUpdate.end())
5019 // start over the counters in the master
5020 textclass.counters().reset();
5023 // update will be done below for this buffer
5024 bufToUpdate.erase(this);
5026 // update all caches
5027 clearReferenceCache();
5029 setChangesPresent(false);
5031 Buffer & cbuf = const_cast<Buffer &>(*this);
5032 // if we are reloading, then we could have a dangling TOC,
5033 // in effect. so we need to go ahead and reset, even though
5034 // we will do so again when we rebuild the TOC later.
5035 cbuf.tocBackend().reset();
5038 ParIterator parit = cbuf.par_iterator_begin();
5039 updateBuffer(parit, utype);
5041 // If this document has siblings, then update the TocBackend later. The
5042 // reason is to ensure that later siblings are up to date when e.g. the
5043 // broken or not status of references is computed. The update is called
5044 // in InsetInclude::addToToc.
5048 // if the bibfiles changed, the cache of bibinfo is invalid
5049 docstring_list new_bibfiles = d->bibfiles_cache_;
5050 // this is a trick to determine whether the two vectors have
5051 // the same elements.
5052 sort(new_bibfiles.begin(), new_bibfiles.end());
5053 sort(old_bibfiles.begin(), old_bibfiles.end());
5054 if (old_bibfiles != new_bibfiles) {
5055 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5056 invalidateBibinfoCache();
5057 reloadBibInfoCache();
5058 // We relied upon the bibinfo cache when recalculating labels. But that
5059 // cache was invalid, although we didn't find that out until now. So we
5060 // have to do it all again.
5061 // That said, the only thing we really need to do is update the citation
5062 // labels. Nothing else will have changed. So we could create a new
5063 // UpdateType that would signal that fact, if we needed to do so.
5064 parit = cbuf.par_iterator_begin();
5065 // we will be re-doing the counters and references and such.
5066 textclass.counters().reset();
5067 clearReferenceCache();
5068 // we should not need to do this again?
5070 setChangesPresent(false);
5071 updateBuffer(parit, utype);
5072 // this will already have been done by reloadBibInfoCache();
5073 // d->bibinfo_cache_valid_ = true;
5076 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5077 // this is also set to true on the other path, by reloadBibInfoCache.
5078 d->bibinfo_cache_valid_ = true;
5080 d->cite_labels_valid_ = true;
5082 cbuf.tocBackend().update(true, utype);
5083 if (scope == UpdateMaster)
5084 cbuf.structureChanged();
5088 static depth_type getDepth(DocIterator const & it)
5090 depth_type depth = 0;
5091 for (size_t i = 0 ; i < it.depth() ; ++i)
5092 if (!it[i].inset().inMathed())
5093 depth += it[i].paragraph().getDepth() + 1;
5094 // remove 1 since the outer inset does not count
5095 // we should have at least one non-math inset, so
5096 // depth should nevery be 0. but maybe it is worth
5097 // marking this, just in case.
5099 // coverity[INTEGER_OVERFLOW]
5103 static depth_type getItemDepth(ParIterator const & it)
5105 Paragraph const & par = *it;
5106 LabelType const labeltype = par.layout().labeltype;
5108 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5111 // this will hold the lowest depth encountered up to now.
5112 depth_type min_depth = getDepth(it);
5113 ParIterator prev_it = it;
5116 --prev_it.top().pit();
5118 // start of nested inset: go to outer par
5120 if (prev_it.empty()) {
5121 // start of document: nothing to do
5126 // We search for the first paragraph with same label
5127 // that is not more deeply nested.
5128 Paragraph & prev_par = *prev_it;
5129 depth_type const prev_depth = getDepth(prev_it);
5130 if (labeltype == prev_par.layout().labeltype) {
5131 if (prev_depth < min_depth)
5132 return prev_par.itemdepth + 1;
5133 if (prev_depth == min_depth)
5134 return prev_par.itemdepth;
5136 min_depth = min(min_depth, prev_depth);
5137 // small optimization: if we are at depth 0, we won't
5138 // find anything else
5139 if (prev_depth == 0)
5145 static bool needEnumCounterReset(ParIterator const & it)
5147 Paragraph const & par = *it;
5148 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5149 depth_type const cur_depth = par.getDepth();
5150 ParIterator prev_it = it;
5151 while (prev_it.pit()) {
5152 --prev_it.top().pit();
5153 Paragraph const & prev_par = *prev_it;
5154 if (prev_par.getDepth() <= cur_depth)
5155 return prev_par.layout().name() != par.layout().name();
5157 // start of nested inset: reset
5162 // set the label of a paragraph. This includes the counters.
5163 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5165 BufferParams const & bp = owner_->masterBuffer()->params();
5166 DocumentClass const & textclass = bp.documentClass();
5167 Paragraph & par = it.paragraph();
5168 Layout const & layout = par.layout();
5169 Counters & counters = textclass.counters();
5171 if (par.params().startOfAppendix()) {
5172 // We want to reset the counter corresponding to toplevel sectioning
5173 Layout const & lay = textclass.getTOCLayout();
5174 docstring const cnt = lay.counter;
5176 counters.reset(cnt);
5177 counters.appendix(true);
5179 par.params().appendix(counters.appendix());
5181 // Compute the item depth of the paragraph
5182 par.itemdepth = getItemDepth(it);
5184 if (layout.margintype == MARGIN_MANUAL) {
5185 if (par.params().labelWidthString().empty())
5186 par.params().labelWidthString(par.expandLabel(layout, bp));
5187 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5188 // we do not need to do anything here, since the empty case is
5189 // handled during export.
5191 par.params().labelWidthString(docstring());
5194 switch(layout.labeltype) {
5195 case LABEL_ITEMIZE: {
5196 // At some point of time we should do something more
5197 // clever here, like:
5198 // par.params().labelString(
5199 // bp.user_defined_bullet(par.itemdepth).getText());
5200 // for now, use a simple hardcoded label
5201 docstring itemlabel;
5202 switch (par.itemdepth) {
5205 itemlabel = char_type(0x2022);
5209 itemlabel = char_type(0x2013);
5212 // ∗ U+2217 ASTERISK OPERATOR
5213 itemlabel = char_type(0x2217);
5216 // · U+00B7 MIDDLE DOT
5217 itemlabel = char_type(0x00b7);
5220 par.params().labelString(itemlabel);
5224 case LABEL_ENUMERATE: {
5225 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5227 switch (par.itemdepth) {
5238 enumcounter += "iv";
5241 // not a valid enumdepth...
5245 if (needEnumCounterReset(it)) {
5246 // Increase the master counter?
5247 if (layout.stepmastercounter)
5248 counters.stepMaster(enumcounter, utype);
5249 // Maybe we have to reset the enumeration counter.
5250 if (!layout.resumecounter)
5251 counters.reset(enumcounter);
5253 counters.step(enumcounter, utype);
5255 string const & lang = par.getParLanguage(bp)->code();
5256 par.params().labelString(counters.theCounter(enumcounter, lang));
5261 case LABEL_SENSITIVE: {
5262 string const & type = counters.current_float();
5263 docstring full_label;
5265 full_label = owner_->B_("Senseless!!! ");
5267 docstring name = owner_->B_(textclass.floats().getType(type).name());
5268 if (counters.hasCounter(from_utf8(type))) {
5269 string const & lang = par.getParLanguage(bp)->code();
5270 counters.step(from_utf8(type), utype);
5271 full_label = bformat(from_ascii("%1$s %2$s:"),
5273 counters.theCounter(from_utf8(type), lang));
5275 full_label = bformat(from_ascii("%1$s #:"), name);
5277 par.params().labelString(full_label);
5281 case LABEL_NO_LABEL:
5282 par.params().labelString(docstring());
5286 case LABEL_CENTERED:
5287 case LABEL_STATIC: {
5288 docstring const & lcounter = layout.counter;
5289 if (!lcounter.empty()) {
5290 if (layout.toclevel <= bp.secnumdepth
5291 && (layout.latextype != LATEX_ENVIRONMENT
5292 || it.text()->isFirstInSequence(it.pit()))) {
5293 if (counters.hasCounter(lcounter))
5294 counters.step(lcounter, utype);
5295 par.params().labelString(par.expandLabel(layout, bp));
5297 par.params().labelString(docstring());
5299 par.params().labelString(par.expandLabel(layout, bp));
5305 par.params().labelString(par.expandLabel(layout, bp));
5310 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5312 // LASSERT: Is it safe to continue here, or should we just return?
5313 LASSERT(parit.pit() == 0, /**/);
5315 // Set the position of the text in the buffer to be able
5316 // to resolve macros in it.
5317 parit.text()->setMacrocontextPosition(parit);
5319 // Reset bibitem counter in master (#8499)
5320 Buffer const * const master = masterBuffer();
5321 if (master == this && !d->ignore_parent)
5322 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5324 depth_type maxdepth = 0;
5325 pit_type const lastpit = parit.lastpit();
5326 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5327 // reduce depth if necessary
5328 if (parit->params().depth() > maxdepth) {
5329 /** FIXME: this function is const, but
5330 * nevertheless it modifies the buffer. To be
5331 * cleaner, one should modify the buffer in
5332 * another function, which is actually
5333 * non-const. This would however be costly in
5334 * terms of code duplication.
5336 CursorData(parit).recordUndo();
5337 parit->params().depth(maxdepth);
5339 maxdepth = parit->getMaxDepthAfter();
5341 if (utype == OutputUpdate) {
5342 // track the active counters
5343 // we have to do this for the master buffer, since the local
5344 // buffer isn't tracking anything.
5345 masterBuffer()->params().documentClass().counters().
5346 setActiveLayout(parit->layout());
5349 // set the counter for this paragraph
5350 d->setLabel(parit, utype);
5352 // update change-tracking flag
5353 parit->addChangesToBuffer(*this);
5356 for (auto const & insit : parit->insetList()) {
5357 parit.pos() = insit.pos;
5358 insit.inset->updateBuffer(parit, utype);
5364 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5365 WordLangTuple & word_lang, docstring_list & suggestions) const
5369 suggestions.clear();
5370 word_lang = WordLangTuple();
5371 bool const to_end = to.empty();
5372 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5373 // OK, we start from here.
5374 for (; from != end; from.forwardPos()) {
5375 // This skips all insets with spell check disabled.
5376 while (!from.allowSpellCheck()) {
5380 // If from is at the end of the document (which is possible
5381 // when "from" was changed above) LyX will crash later otherwise.
5382 if (from.atEnd() || (!to_end && from >= end))
5385 from.paragraph().spellCheck();
5386 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5387 if (SpellChecker::misspelled(res)) {
5391 // Do not increase progress when from == to, otherwise the word
5392 // count will be wrong.
5402 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5404 bool inword = false;
5409 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5410 if (!dit.inTexted()) {
5415 Paragraph const & par = dit.paragraph();
5416 pos_type const pos = dit.pos();
5418 // Copied and adapted from isWordSeparator() in Paragraph
5419 if (pos == dit.lastpos()) {
5422 Inset const * ins = par.getInset(pos);
5423 if (ins && skipNoOutput && !ins->producesOutput()) {
5426 // stop if end of range was skipped
5427 if (!to.atEnd() && dit >= to)
5430 } else if (!par.isDeleted(pos)) {
5431 if (par.isWordSeparator(pos))
5437 if (ins && ins->isLetter())
5439 else if (ins && ins->isSpace())
5442 char_type const c = par.getChar(pos);
5443 if (isPrintableNonspace(c))
5445 else if (isSpace(c))
5455 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5457 d->updateStatistics(from, to, skipNoOutput);
5461 int Buffer::wordCount() const
5463 return d->wordCount();
5467 int Buffer::charCount(bool with_blanks) const
5469 return d->charCount(with_blanks);
5473 Buffer::ReadStatus Buffer::reload()
5476 // c.f. bug https://www.lyx.org/trac/ticket/6587
5477 removeAutosaveFile();
5478 // e.g., read-only status could have changed due to version control
5479 d->filename.refresh();
5480 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5482 // clear parent. this will get reset if need be.
5484 ReadStatus const status = loadLyXFile();
5485 if (status == ReadSuccess) {
5490 message(bformat(_("Document %1$s reloaded."), disp_fn));
5493 message(bformat(_("Could not reload document %1$s."), disp_fn));
5503 bool Buffer::saveAs(FileName const & fn)
5505 FileName const old_name = fileName();
5506 FileName const old_auto = getAutosaveFileName();
5507 bool const old_unnamed = isUnnamed();
5508 bool success = true;
5509 d->old_position = filePath();
5516 // bring the autosave file with us, just in case.
5517 moveAutosaveFile(old_auto);
5518 // validate version control data and
5519 // correct buffer title
5520 lyxvc().file_found_hook(fileName());
5522 // the file has now been saved to the new location.
5523 // we need to check that the locations of child buffers
5525 checkChildBuffers();
5526 checkMasterBuffer();
5529 // reset the old filename and unnamed state
5530 setFileName(old_name);
5531 setUnnamed(old_unnamed);
5535 d->old_position.clear();
5540 void Buffer::checkChildBuffers()
5542 for (auto const & bit : d->children_positions) {
5543 DocIterator dit = bit.second;
5544 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5545 if (!cbuf || !theBufferList().isLoaded(cbuf))
5547 Inset * inset = dit.nextInset();
5548 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5549 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5550 docstring const & incfile = inset_inc->getParam("filename");
5551 string oldloc = cbuf->absFileName();
5552 string newloc = makeAbsPath(to_utf8(incfile),
5553 onlyPath(absFileName())).absFileName();
5554 if (oldloc == newloc)
5556 // the location of the child file is incorrect.
5558 inset_inc->setChildBuffer(0);
5560 // invalidate cache of children
5561 d->children_positions.clear();
5562 d->position_to_children.clear();
5566 // If a child has been saved under a different name/path, it might have been
5567 // orphaned. Therefore the master needs to be reset (bug 8161).
5568 void Buffer::checkMasterBuffer()
5570 Buffer const * const master = masterBuffer();
5574 // necessary to re-register the child (bug 5873)
5575 // FIXME: clean up updateMacros (here, only
5576 // child registering is needed).
5577 master->updateMacros();
5578 // (re)set master as master buffer, but only
5579 // if we are a real child
5580 if (master->isChild(this))
5587 string Buffer::includedFilePath(string const & name, string const & ext) const
5589 if (d->old_position.empty() ||
5590 equivalent(FileName(d->old_position), FileName(filePath())))
5593 bool isabsolute = FileName::isAbsolute(name);
5594 // both old_position and filePath() end with a path separator
5595 string absname = isabsolute ? name : d->old_position + name;
5597 // if old_position is set to origin, we need to do the equivalent of
5598 // getReferencedFileName() (see readDocument())
5599 if (!isabsolute && d->old_position == params().origin) {
5600 FileName const test(addExtension(filePath() + name, ext));
5602 absname = filePath() + name;
5605 if (!FileName(addExtension(absname, ext)).exists())
5609 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5611 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5612 from_utf8(filePath())));
5616 void Buffer::setChangesPresent(bool b) const
5618 d->tracked_changes_present_ = b;
5622 bool Buffer::areChangesPresent() const
5624 return d->tracked_changes_present_;
5628 void Buffer::updateChangesPresent() const
5630 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5631 setChangesPresent(false);
5632 ParConstIterator it = par_iterator_begin();
5633 ParConstIterator const end = par_iterator_end();
5634 for (; !areChangesPresent() && it != end; ++it)
5635 it->addChangesToBuffer(*this);
5639 void Buffer::Impl::refreshFileMonitor()
5641 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5642 file_monitor_->refresh();
5646 // The previous file monitor is invalid
5647 // This also destroys the previous file monitor and all its connections
5648 file_monitor_ = FileSystemWatcher::monitor(filename);
5649 // file_monitor_ will be destroyed with *this, so it is not going to call a
5650 // destroyed object method.
5651 file_monitor_->connect([this](bool exists) {
5652 fileExternallyModified(exists);
5657 void Buffer::Impl::fileExternallyModified(bool const exists)
5659 // ignore notifications after our own saving operations
5660 if (checksum_ == filename.checksum()) {
5661 LYXERR(Debug::FILES, "External modification but "
5662 "checksum unchanged: " << filename);
5665 // If the file has been deleted, only mark the file as dirty since it is
5666 // pointless to prompt for reloading. If later a file is moved into this
5667 // location, then the externally modified warning will appear then.
5669 externally_modified_ = true;
5670 // Update external modification notification.
5671 // Dirty buffers must be visible at all times.
5672 if (wa_ && wa_->unhide(owner_))
5673 wa_->updateTitles();
5675 // Unable to unhide the buffer (e.g. no GUI or not current View)
5680 bool Buffer::notifiesExternalModification() const
5682 return d->externally_modified_;
5686 void Buffer::clearExternalModification() const
5688 d->externally_modified_ = false;
5690 d->wa_->updateTitles();