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 detokenize = !isAscii(from_utf8(docdir))
1944 || contains(docdir, '~');
1945 bool const quote = contains(docdir, ' ');
1946 os << "\\makeatletter\n"
1947 << "\\def\\input@path{{";
1949 os << "\\detokenize{";
1958 << "\\makeatother\n";
1962 // get parent macros (if this buffer has a parent) which will be
1963 // written at the document begin further down.
1964 MacroSet parentMacros;
1965 listParentMacros(parentMacros, features);
1967 // Write the preamble
1968 runparams.use_babel = params().writeLaTeX(os, features,
1969 d->filename.onlyPath());
1971 // Active characters
1972 runparams.active_chars = features.getActiveChars();
1974 // Biblatex bibliographies are loaded here
1975 if (params().useBiblatex()) {
1976 vector<pair<docstring, string>> const bibfiles =
1977 prepareBibFilePaths(runparams, getBibfiles(), true);
1978 for (pair<docstring, string> const & file: bibfiles) {
1979 os << "\\addbibresource";
1980 if (!file.second.empty())
1981 os << "[bibencoding=" << file.second << "]";
1982 os << "{" << file.first << "}\n";
1986 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1987 && !features.hasOnlyPolyglossiaLanguages()) {
1990 vector<string> bll = features.getBabelExclusiveLanguages();
1991 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1994 for (string const & sit : bll) {
1999 blangs = bll.size() > 1 ?
2000 bformat(_("The languages %1$s are only supported by Babel."), langs)
2001 : bformat(_("The language %1$s is only supported by Babel."), langs);
2005 for (string const & pit : pll) {
2010 plangs = pll.size() > 1 ?
2011 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
2012 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
2013 if (!blangs.empty())
2017 frontend::Alert::warning(
2018 _("Incompatible Languages!"),
2020 _("You cannot use the following languages "
2021 "together in one LaTeX document because "
2022 "they require conflicting language packages:\n"
2027 // Japanese might be required only in some children of a document,
2028 // but once required, we must keep use_japanese true.
2029 runparams.use_japanese |= features.isRequired("japanese");
2032 // Restore the parenthood if needed
2033 if (!runparams.is_child)
2034 d->ignore_parent = false;
2035 return ExportSuccess;
2039 // mark the beginning of the body to separate it from InPreamble insets
2040 os.texrow().start(TexRow::beginDocument());
2041 os << "\\begin{document}\n";
2043 // mark the start of a new paragraph by simulating a newline,
2044 // so that os.afterParbreak() returns true at document start
2047 // output the parent macros
2048 for (auto const & mac : parentMacros) {
2049 int num_lines = mac->write(os.os(), true);
2050 os.texrow().newlines(num_lines);
2053 } // output_preamble
2055 LYXERR(Debug::INFO, "preamble finished, now the body.");
2059 latexParagraphs(*this, text(), os, runparams);
2061 catch (ConversionException const &) { return ExportKilled; }
2063 // Restore the parenthood if needed
2064 if (!runparams.is_child)
2065 d->ignore_parent = false;
2067 // add this just in case after all the paragraphs
2070 if (output_preamble) {
2071 os << "\\end{document}\n";
2072 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2074 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2076 runparams_in.encoding = runparams.encoding;
2078 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2079 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2080 return ExportSuccess;
2084 Buffer::ExportStatus Buffer::makeDocBookFile(FileName const & fname,
2085 OutputParams const & runparams,
2086 OutputWhat output) const
2088 LYXERR(Debug::LATEX, "makeDocBookFile...");
2091 if (!openFileWrite(ofs, fname))
2094 // make sure we are ready to export
2095 // this needs to be done before we validate
2097 updateMacroInstances(OutputUpdate);
2099 ExportStatus const retval =
2100 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2101 if (retval == ExportKilled)
2102 return ExportKilled;
2106 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2107 return ExportSuccess;
2111 Buffer::ExportStatus Buffer::writeDocBookSource(odocstream & os, string const & fname,
2112 OutputParams const & runparams,
2113 OutputWhat output) const
2115 LaTeXFeatures features(*this, params(), runparams);
2120 DocumentClass const & tclass = params().documentClass();
2121 string const & top_element = tclass.latexname();
2123 bool const output_preamble =
2124 output == FullSource || output == OnlyPreamble;
2125 bool const output_body =
2126 output == FullSource || output == OnlyBody;
2128 if (output_preamble) {
2129 if (runparams.flavor == OutputParams::XML)
2130 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2133 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2136 if (! tclass.class_header().empty())
2137 os << from_ascii(tclass.class_header());
2138 else if (runparams.flavor == OutputParams::XML)
2139 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2140 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2142 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2144 docstring preamble = params().preamble;
2145 if (runparams.flavor != OutputParams::XML ) {
2146 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2147 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2148 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2149 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2152 string const name = runparams.nice
2153 ? changeExtension(absFileName(), ".sgml") : fname;
2154 preamble += features.getIncludedFiles(name);
2155 preamble += features.getLyXSGMLEntities();
2157 if (!preamble.empty()) {
2158 os << "\n [ " << preamble << " ]";
2164 string top = top_element;
2166 if (runparams.flavor == OutputParams::XML)
2167 top += params().language->code();
2169 top += params().language->code().substr(0, 2);
2172 if (!params().options.empty()) {
2174 top += params().options;
2177 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2178 << " file was created by LyX " << lyx_version
2179 << "\n See https://www.lyx.org/ for more information -->\n";
2181 params().documentClass().counters().reset();
2183 sgml::openTag(os, top);
2186 docbookParagraphs(text(), *this, os, runparams);
2188 catch (ConversionException const &) { return ExportKilled; }
2189 sgml::closeTag(os, top_element);
2191 return ExportSuccess;
2195 Buffer::ExportStatus Buffer::makeLyXHTMLFile(FileName const & fname,
2196 OutputParams const & runparams) const
2198 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2201 if (!openFileWrite(ofs, fname))
2204 // make sure we are ready to export
2205 // this has to be done before we validate
2206 updateBuffer(UpdateMaster, OutputUpdate);
2207 updateMacroInstances(OutputUpdate);
2209 ExportStatus const retval = writeLyXHTMLSource(ofs, runparams, FullSource);
2210 if (retval == ExportKilled)
2215 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2220 Buffer::ExportStatus Buffer::writeLyXHTMLSource(odocstream & os,
2221 OutputParams const & runparams,
2222 OutputWhat output) const
2224 LaTeXFeatures features(*this, params(), runparams);
2226 d->bibinfo_.makeCitationLabels(*this);
2228 bool const output_preamble =
2229 output == FullSource || output == OnlyPreamble;
2230 bool const output_body =
2231 output == FullSource || output == OnlyBody || output == IncludedFile;
2233 if (output_preamble) {
2234 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2235 << "<!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"
2236 // FIXME Language should be set properly.
2237 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2239 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2240 // FIXME Presumably need to set this right
2241 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2243 docstring const & doctitle = features.htmlTitle();
2245 << (doctitle.empty() ?
2246 from_ascii("LyX Document") :
2247 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2250 docstring styles = features.getTClassHTMLPreamble();
2251 if (!styles.empty())
2252 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2254 styles = features.getPreambleSnippets().str;
2255 if (!styles.empty())
2256 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2258 // we will collect CSS information in a stream, and then output it
2259 // either here, as part of the header, or else in a separate file.
2260 odocstringstream css;
2261 styles = features.getCSSSnippets();
2262 if (!styles.empty())
2263 css << "/* LyX Provided Styles */\n" << styles << '\n';
2265 styles = features.getTClassHTMLStyles();
2266 if (!styles.empty())
2267 css << "/* Layout-provided Styles */\n" << styles << '\n';
2269 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2270 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2271 if (needfg || needbg) {
2272 css << "\nbody {\n";
2275 << from_ascii(X11hexname(params().fontcolor))
2278 css << " background-color: "
2279 << from_ascii(X11hexname(params().backgroundcolor))
2284 docstring const dstyles = css.str();
2285 if (!dstyles.empty()) {
2286 bool written = false;
2287 if (params().html_css_as_file) {
2288 // open a file for CSS info
2290 string const fcssname = addName(temppath(), "docstyle.css");
2291 FileName const fcssfile = FileName(fcssname);
2292 if (openFileWrite(ocss, fcssfile)) {
2296 // write link to header
2297 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2299 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2302 // we are here if the CSS is supposed to be written to the header
2303 // or if we failed to write it to an external file.
2305 os << "<style type='text/css'>\n"
2314 bool const output_body_tag = (output != IncludedFile);
2315 if (output_body_tag)
2316 os << "<body dir=\"auto\">\n";
2318 if (output != IncludedFile)
2319 // if we're an included file, the counters are in the master.
2320 params().documentClass().counters().reset();
2322 xhtmlParagraphs(text(), *this, xs, runparams);
2324 catch (ConversionException const &) { return ExportKilled; }
2325 if (output_body_tag)
2329 if (output_preamble)
2332 return ExportSuccess;
2336 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2337 // Other flags: -wall -v0 -x
2338 int Buffer::runChktex()
2342 // get LaTeX-Filename
2343 FileName const path(temppath());
2344 string const name = addName(path.absFileName(), latexName());
2345 string const org_path = filePath();
2347 PathChanger p(path); // path to LaTeX file
2348 message(_("Running chktex..."));
2350 // Generate the LaTeX file if neccessary
2351 OutputParams runparams(¶ms().encoding());
2352 runparams.flavor = OutputParams::LATEX;
2353 runparams.nice = false;
2354 runparams.linelen = lyxrc.plaintext_linelen;
2355 ExportStatus const retval =
2356 makeLaTeXFile(FileName(name), org_path, runparams);
2357 if (retval != ExportSuccess) {
2358 // error code on failure
2363 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2364 int const res = chktex.run(terr); // run chktex
2367 Alert::error(_("chktex failure"),
2368 _("Could not run chktex successfully."));
2370 ErrorList & errlist = d->errorLists["ChkTeX"];
2372 bufferErrors(terr, errlist);
2377 if (runparams.silent)
2378 d->errorLists["ChkTeX"].clear();
2386 void Buffer::validate(LaTeXFeatures & features) const
2388 // Validate the buffer params, but not for included
2389 // files, since they also use the parent buffer's
2391 if (!features.runparams().is_child)
2392 params().validate(features);
2394 for (Paragraph const & p : paragraphs())
2395 p.validate(features);
2397 if (lyxerr.debugging(Debug::LATEX)) {
2398 features.showStruct();
2403 void Buffer::getLabelList(vector<docstring> & list) const
2405 // If this is a child document, use the master's list instead.
2407 masterBuffer()->getLabelList(list);
2412 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2413 for (auto const & tocit : *toc) {
2414 if (tocit.depth() == 0)
2415 list.push_back(tocit.str());
2420 void Buffer::invalidateBibinfoCache() const
2422 d->bibinfo_cache_valid_ = false;
2423 d->cite_labels_valid_ = false;
2424 removeBiblioTempFiles();
2425 // also invalidate the cache for the parent buffer
2426 Buffer const * const pbuf = d->parent();
2428 pbuf->invalidateBibinfoCache();
2432 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2434 // FIXME This is probably unnecessary, given where we call this.
2435 // If this is a child document, use the master instead.
2436 Buffer const * const pbuf = masterBuffer();
2437 if (pbuf != this && scope != UpdateChildOnly)
2438 return pbuf->getBibfiles();
2440 // In 2.3.x, we have:
2441 //if (!d->bibfile_cache_valid_)
2442 // this->updateBibfilesCache(scope);
2443 // I think that is a leftover, but there have been so many back-
2444 // and-forths with this, due to Windows issues, that I am not sure.
2446 return d->bibfiles_cache_;
2450 BiblioInfo const & Buffer::masterBibInfo() const
2452 Buffer const * const tmp = masterBuffer();
2454 return tmp->masterBibInfo();
2459 BiblioInfo const & Buffer::bibInfo() const
2465 void Buffer::registerBibfiles(const docstring_list & bf) const
2467 // We register the bib files in the master buffer,
2468 // if there is one, but also in every single buffer,
2469 // in case a child is compiled alone.
2470 Buffer const * const tmp = masterBuffer();
2472 tmp->registerBibfiles(bf);
2474 for (auto const & p : bf) {
2475 docstring_list::const_iterator temp =
2476 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2477 if (temp == d->bibfiles_cache_.end())
2478 d->bibfiles_cache_.push_back(p);
2483 static map<docstring, FileName> bibfileCache;
2485 FileName Buffer::getBibfilePath(docstring const & bibid) const
2487 map<docstring, FileName>::const_iterator it =
2488 bibfileCache.find(bibid);
2489 if (it != bibfileCache.end()) {
2490 // i.e., return bibfileCache[bibid];
2494 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2495 string const texfile = changeExtension(to_utf8(bibid), "bib");
2496 // we need to check first if this file exists where it's said to be.
2497 // there's a weird bug that occurs otherwise: if the file is in the
2498 // Buffer's directory but has the same name as some file that would be
2499 // found by kpsewhich, then we find the latter, not the former.
2500 FileName const local_file = makeAbsPath(texfile, filePath());
2501 FileName file = local_file;
2502 if (!file.exists()) {
2503 // there's no need now to check whether the file can be found
2505 file = findtexfile(texfile, "bib", true);
2509 LYXERR(Debug::FILES, "Found at: " << file);
2511 bibfileCache[bibid] = file;
2512 return bibfileCache[bibid];
2516 void Buffer::checkIfBibInfoCacheIsValid() const
2518 // use the master's cache
2519 Buffer const * const tmp = masterBuffer();
2521 tmp->checkIfBibInfoCacheIsValid();
2525 // If we already know the cache is invalid, stop here.
2526 // This is important in the case when the bibliography
2527 // environment (rather than Bib[la]TeX) is used.
2528 // In that case, the timestamp check below gives no
2529 // sensible result. Rather than that, the cache will
2530 // be invalidated explicitly via invalidateBibInfoCache()
2531 // by the Bibitem inset.
2532 // Same applies for bib encoding changes, which trigger
2533 // invalidateBibInfoCache() by InsetBibtex.
2534 if (!d->bibinfo_cache_valid_)
2537 if (d->have_bibitems_) {
2538 // We have a bibliography environment.
2539 // Invalidate the bibinfo cache unconditionally.
2540 // Cite labels will get invalidated by the inset if needed.
2541 d->bibinfo_cache_valid_ = false;
2545 // OK. This is with Bib(la)tex. We'll assume the cache
2546 // is valid and change this if we find changes in the bibs.
2547 d->bibinfo_cache_valid_ = true;
2548 d->cite_labels_valid_ = true;
2550 // compare the cached timestamps with the actual ones.
2551 docstring_list const & bibfiles_cache = getBibfiles();
2552 for (auto const & bf : bibfiles_cache) {
2553 FileName const fn = getBibfilePath(bf);
2554 time_t lastw = fn.lastModified();
2555 time_t prevw = d->bibfile_status_[fn];
2556 if (lastw != prevw) {
2557 d->bibinfo_cache_valid_ = false;
2558 d->cite_labels_valid_ = false;
2559 d->bibfile_status_[fn] = lastw;
2565 void Buffer::clearBibFileCache() const
2567 bibfileCache.clear();
2571 void Buffer::reloadBibInfoCache(bool const force) const
2573 // we should not need to do this for internal buffers
2577 // use the master's cache
2578 Buffer const * const tmp = masterBuffer();
2580 tmp->reloadBibInfoCache(force);
2585 checkIfBibInfoCacheIsValid();
2586 if (d->bibinfo_cache_valid_)
2590 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2591 // re-read file locations when this info changes
2592 // FIXME Is this sufficient? Or should we also force that
2593 // in some other cases? If so, then it is easy enough to
2594 // add the following line in some other places.
2595 clearBibFileCache();
2596 d->bibinfo_.clear();
2597 FileNameList checkedFiles;
2598 d->have_bibitems_ = false;
2599 collectBibKeys(checkedFiles);
2600 d->bibinfo_cache_valid_ = true;
2604 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2606 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2607 it->collectBibKeys(it, checkedFiles);
2608 if (it->lyxCode() == BIBITEM_CODE) {
2610 parent()->d->have_bibitems_ = true;
2612 d->have_bibitems_ = true;
2618 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2620 // We add the biblio info to the master buffer,
2621 // if there is one, but also to every single buffer,
2622 // in case a child is compiled alone.
2623 BiblioInfo & bi = d->bibinfo_;
2624 bi.mergeBiblioInfo(bin);
2626 if (parent() != 0) {
2627 BiblioInfo & masterbi = parent()->d->bibinfo_;
2628 masterbi.mergeBiblioInfo(bin);
2633 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2635 // We add the bibtex info to the master buffer,
2636 // if there is one, but also to every single buffer,
2637 // in case a child is compiled alone.
2638 BiblioInfo & bi = d->bibinfo_;
2641 if (parent() != 0) {
2642 BiblioInfo & masterbi = masterBuffer()->d->bibinfo_;
2643 masterbi[key] = bin;
2648 void Buffer::makeCitationLabels() const
2650 Buffer const * const master = masterBuffer();
2651 return d->bibinfo_.makeCitationLabels(*master);
2655 void Buffer::invalidateCiteLabels() const
2657 masterBuffer()->d->cite_labels_valid_ = false;
2660 bool Buffer::citeLabelsValid() const
2662 return masterBuffer()->d->cite_labels_valid_;
2666 void Buffer::removeBiblioTempFiles() const
2668 // We remove files that contain LaTeX commands specific to the
2669 // particular bibliographic style being used, in order to avoid
2670 // LaTeX errors when we switch style.
2671 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2672 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2673 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2674 aux_file.removeFile();
2675 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2676 bbl_file.removeFile();
2677 // Also for the parent buffer
2678 Buffer const * const pbuf = parent();
2680 pbuf->removeBiblioTempFiles();
2684 bool Buffer::isDepClean(string const & name) const
2686 DepClean::const_iterator const it = d->dep_clean.find(name);
2687 if (it == d->dep_clean.end())
2693 void Buffer::markDepClean(string const & name)
2695 d->dep_clean[name] = true;
2699 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2702 // FIXME? if there is an Buffer LFUN that can be dispatched even
2703 // if internal, put a switch '(cmd.action)' here.
2709 switch (cmd.action()) {
2711 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2712 flag.setOnOff(hasReadonlyFlag());
2715 // FIXME: There is need for a command-line import.
2716 //case LFUN_BUFFER_IMPORT:
2718 case LFUN_BUFFER_AUTO_SAVE:
2721 case LFUN_BUFFER_EXPORT_CUSTOM:
2722 // FIXME: Nothing to check here?
2725 case LFUN_BUFFER_EXPORT: {
2726 docstring const arg = cmd.argument();
2727 if (arg == "custom") {
2731 string format = (arg.empty() || arg == "default") ?
2732 params().getDefaultOutputFormat() : to_utf8(arg);
2733 size_t pos = format.find(' ');
2734 if (pos != string::npos)
2735 format = format.substr(0, pos);
2736 enable = params().isExportable(format, false);
2738 flag.message(bformat(
2739 _("Don't know how to export to format: %1$s"), arg));
2743 case LFUN_BUILD_PROGRAM:
2744 enable = params().isExportable("program", false);
2747 case LFUN_BRANCH_ACTIVATE:
2748 case LFUN_BRANCH_DEACTIVATE:
2749 case LFUN_BRANCH_MASTER_ACTIVATE:
2750 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2751 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2752 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2753 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2754 : params().branchlist();
2755 docstring const branchName = cmd.argument();
2756 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2760 case LFUN_BRANCH_ADD:
2761 case LFUN_BRANCHES_RENAME:
2762 // if no Buffer is present, then of course we won't be called!
2765 case LFUN_BUFFER_LANGUAGE:
2766 enable = !isReadonly();
2769 case LFUN_BUFFER_VIEW_CACHE:
2770 (d->preview_file_).refresh();
2771 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2774 case LFUN_CHANGES_TRACK:
2775 flag.setEnabled(true);
2776 flag.setOnOff(params().track_changes);
2779 case LFUN_CHANGES_OUTPUT:
2780 flag.setEnabled(true);
2781 flag.setOnOff(params().output_changes);
2784 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2785 flag.setOnOff(params().compressed);
2788 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2789 flag.setOnOff(params().output_sync);
2792 case LFUN_BUFFER_ANONYMIZE:
2798 flag.setEnabled(enable);
2803 void Buffer::dispatch(string const & command, DispatchResult & result)
2805 return dispatch(lyxaction.lookupFunc(command), result);
2809 // NOTE We can end up here even if we have no GUI, because we are called
2810 // by LyX::exec to handled command-line requests. So we may need to check
2811 // whether we have a GUI or not. The boolean use_gui holds this information.
2812 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2815 // FIXME? if there is an Buffer LFUN that can be dispatched even
2816 // if internal, put a switch '(cmd.action())' here.
2817 dr.dispatched(false);
2820 string const argument = to_utf8(func.argument());
2821 // We'll set this back to false if need be.
2822 bool dispatched = true;
2823 // This handles undo groups automagically
2824 UndoGroupHelper ugh(this);
2826 switch (func.action()) {
2827 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2828 if (lyxvc().inUse()) {
2829 string log = lyxvc().toggleReadOnly();
2834 setReadonly(!hasReadonlyFlag());
2837 case LFUN_BUFFER_EXPORT: {
2838 string const format = (argument.empty() || argument == "default") ?
2839 params().getDefaultOutputFormat() : argument;
2840 ExportStatus const status = doExport(format, false);
2841 dr.setError(status != ExportSuccess);
2842 if (status != ExportSuccess)
2843 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2844 from_utf8(format)));
2848 case LFUN_BUILD_PROGRAM: {
2849 ExportStatus const status = doExport("program", true);
2850 dr.setError(status != ExportSuccess);
2851 if (status != ExportSuccess)
2852 dr.setMessage(_("Error generating literate programming code."));
2856 case LFUN_BUFFER_EXPORT_CUSTOM: {
2858 string command = split(argument, format_name, ' ');
2859 Format const * format = theFormats().getFormat(format_name);
2861 lyxerr << "Format \"" << format_name
2862 << "\" not recognized!"
2867 // The name of the file created by the conversion process
2870 // Output to filename
2871 if (format->name() == "lyx") {
2872 string const latexname = latexName(false);
2873 filename = changeExtension(latexname,
2874 format->extension());
2875 filename = addName(temppath(), filename);
2877 if (!writeFile(FileName(filename)))
2881 doExport(format_name, true, filename);
2884 // Substitute $$FName for filename
2885 if (!contains(command, "$$FName"))
2886 command = "( " + command + " ) < $$FName";
2887 command = subst(command, "$$FName", filename);
2889 // Execute the command in the background
2891 call.startscript(Systemcall::DontWait, command,
2892 filePath(), layoutPos());
2896 // FIXME: There is need for a command-line import.
2898 case LFUN_BUFFER_IMPORT:
2903 case LFUN_BUFFER_AUTO_SAVE:
2905 resetAutosaveTimers();
2908 case LFUN_BRANCH_ACTIVATE:
2909 case LFUN_BRANCH_DEACTIVATE:
2910 case LFUN_BRANCH_MASTER_ACTIVATE:
2911 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2912 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2913 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2914 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2917 docstring const branch_name = func.argument();
2918 // the case without a branch name is handled elsewhere
2919 if (branch_name.empty()) {
2923 Branch * branch = buf->params().branchlist().find(branch_name);
2925 LYXERR0("Branch " << branch_name << " does not exist.");
2927 docstring const msg =
2928 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2932 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2933 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2934 if (branch->isSelected() != activate) {
2935 buf->undo().recordUndoBufferParams(CursorData());
2936 branch->setSelected(activate);
2938 dr.screenUpdate(Update::Force);
2939 dr.forceBufferUpdate();
2944 case LFUN_BRANCH_ADD: {
2945 docstring branchnames = func.argument();
2946 if (branchnames.empty()) {
2950 BranchList & branch_list = params().branchlist();
2951 vector<docstring> const branches =
2952 getVectorFromString(branchnames, branch_list.separator());
2954 for (docstring const & branch_name : branches) {
2955 Branch * branch = branch_list.find(branch_name);
2957 LYXERR0("Branch " << branch_name << " already exists.");
2961 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2963 undo().recordUndoBufferParams(CursorData());
2964 branch_list.add(branch_name);
2965 branch = branch_list.find(branch_name);
2966 string const x11hexname = X11hexname(branch->color());
2967 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2968 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2970 dr.screenUpdate(Update::Force);
2978 case LFUN_BRANCHES_RENAME: {
2979 if (func.argument().empty())
2982 docstring const oldname = from_utf8(func.getArg(0));
2983 docstring const newname = from_utf8(func.getArg(1));
2984 InsetIterator it = inset_iterator_begin(inset());
2985 InsetIterator const end = inset_iterator_end(inset());
2986 bool success = false;
2987 for (; it != end; ++it) {
2988 if (it->lyxCode() == BRANCH_CODE) {
2989 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2990 if (ins.branch() == oldname) {
2991 undo().recordUndo(CursorData(it));
2992 ins.rename(newname);
2997 if (it->lyxCode() == INCLUDE_CODE) {
2998 // get buffer of external file
2999 InsetInclude const & ins =
3000 static_cast<InsetInclude const &>(*it);
3001 Buffer * child = ins.getChildBuffer();
3004 child->dispatch(func, dr);
3009 dr.screenUpdate(Update::Force);
3010 dr.forceBufferUpdate();
3015 case LFUN_BUFFER_VIEW_CACHE:
3016 if (!theFormats().view(*this, d->preview_file_,
3017 d->preview_format_))
3018 dr.setMessage(_("Error viewing the output file."));
3021 case LFUN_CHANGES_TRACK:
3022 if (params().save_transient_properties)
3023 undo().recordUndoBufferParams(CursorData());
3024 params().track_changes = !params().track_changes;
3025 if (!params().track_changes)
3026 dr.forceChangesUpdate();
3029 case LFUN_CHANGES_OUTPUT:
3030 if (params().save_transient_properties)
3031 undo().recordUndoBufferParams(CursorData());
3032 params().output_changes = !params().output_changes;
3033 if (params().output_changes) {
3034 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3035 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3036 LaTeXFeatures::isAvailable("xcolor");
3038 if (!dvipost && !xcolorulem) {
3039 Alert::warning(_("Changes not shown in LaTeX output"),
3040 _("Changes will not be highlighted in LaTeX output, "
3041 "because neither dvipost nor xcolor/ulem are installed.\n"
3042 "Please install these packages or redefine "
3043 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3044 } else if (!xcolorulem) {
3045 Alert::warning(_("Changes not shown in LaTeX output"),
3046 _("Changes will not be highlighted in LaTeX output "
3047 "when using pdflatex, because xcolor and ulem are not installed.\n"
3048 "Please install both packages or redefine "
3049 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3054 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3055 // turn compression on/off
3056 undo().recordUndoBufferParams(CursorData());
3057 params().compressed = !params().compressed;
3060 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3061 undo().recordUndoBufferParams(CursorData());
3062 params().output_sync = !params().output_sync;
3065 case LFUN_BUFFER_ANONYMIZE: {
3066 undo().recordUndoFullBuffer(CursorData());
3067 CursorData cur(doc_iterator_begin(this));
3068 for ( ; cur ; cur.forwardPar())
3069 cur.paragraph().anonymize();
3070 dr.forceBufferUpdate();
3071 dr.screenUpdate(Update::Force);
3079 dr.dispatched(dispatched);
3083 void Buffer::changeLanguage(Language const * from, Language const * to)
3085 LASSERT(from, return);
3086 LASSERT(to, return);
3088 for_each(par_iterator_begin(),
3090 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3094 bool Buffer::isMultiLingual() const
3096 ParConstIterator end = par_iterator_end();
3097 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3098 if (it->isMultiLingual(params()))
3105 std::set<Language const *> Buffer::getLanguages() const
3107 std::set<Language const *> langs;
3108 getLanguages(langs);
3113 void Buffer::getLanguages(std::set<Language const *> & langs) const
3115 ParConstIterator end = par_iterator_end();
3116 // add the buffer language, even if it's not actively used
3117 langs.insert(language());
3118 // iterate over the paragraphs
3119 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3120 it->getLanguages(langs);
3122 ListOfBuffers clist = getDescendents();
3123 for (auto const & cit : clist)
3124 cit->getLanguages(langs);
3128 DocIterator Buffer::getParFromID(int const id) const
3130 Buffer * buf = const_cast<Buffer *>(this);
3132 // This means non-existent
3133 return doc_iterator_end(buf);
3135 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3136 if (it.paragraph().id() == id)
3139 return doc_iterator_end(buf);
3143 bool Buffer::hasParWithID(int const id) const
3145 return !getParFromID(id).atEnd();
3149 ParIterator Buffer::par_iterator_begin()
3151 return ParIterator(doc_iterator_begin(this));
3155 ParIterator Buffer::par_iterator_end()
3157 return ParIterator(doc_iterator_end(this));
3161 ParConstIterator Buffer::par_iterator_begin() const
3163 return ParConstIterator(doc_iterator_begin(this));
3167 ParConstIterator Buffer::par_iterator_end() const
3169 return ParConstIterator(doc_iterator_end(this));
3173 Language const * Buffer::language() const
3175 return params().language;
3179 docstring const Buffer::B_(string const & l10n) const
3181 return params().B_(l10n);
3185 bool Buffer::isClean() const
3187 return d->lyx_clean;
3191 bool Buffer::isChecksumModified() const
3193 LASSERT(d->filename.exists(), return false);
3194 return d->checksum_ != d->filename.checksum();
3198 void Buffer::saveCheckSum() const
3200 FileName const & file = d->filename;
3202 d->checksum_ = file.exists() ? file.checksum()
3203 : 0; // in the case of save to a new file.
3207 void Buffer::markClean() const
3209 if (!d->lyx_clean) {
3210 d->lyx_clean = true;
3213 // if the .lyx file has been saved, we don't need an
3215 d->bak_clean = true;
3216 d->undo_.markDirty();
3217 clearExternalModification();
3221 void Buffer::setUnnamed(bool flag)
3227 bool Buffer::isUnnamed() const
3234 /// Don't check unnamed, here: isInternal() is used in
3235 /// newBuffer(), where the unnamed flag has not been set by anyone
3236 /// yet. Also, for an internal buffer, there should be no need for
3237 /// retrieving fileName() nor for checking if it is unnamed or not.
3238 bool Buffer::isInternal() const
3240 return d->internal_buffer;
3244 void Buffer::setInternal(bool flag)
3246 d->internal_buffer = flag;
3250 void Buffer::markDirty()
3253 d->lyx_clean = false;
3256 d->bak_clean = false;
3258 for (auto & depit : d->dep_clean)
3259 depit.second = false;
3263 FileName Buffer::fileName() const
3269 string Buffer::absFileName() const
3271 return d->filename.absFileName();
3275 string Buffer::filePath() const
3277 string const abs = d->filename.onlyPath().absFileName();
3280 int last = abs.length() - 1;
3282 return abs[last] == '/' ? abs : abs + '/';
3286 DocFileName Buffer::getReferencedFileName(string const & fn) const
3289 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3290 result.set(fn, filePath());
3292 // filePath() ends with a path separator
3293 FileName const test(filePath() + fn);
3295 result.set(fn, filePath());
3297 result.set(fn, params().origin);
3304 string const Buffer::prepareFileNameForLaTeX(string const & name,
3305 string const & ext, bool nice) const
3307 string const fname = makeAbsPath(name, filePath()).absFileName();
3308 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3314 return to_utf8(makeRelPath(from_utf8(fname),
3315 from_utf8(masterBuffer()->filePath())));
3319 vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3320 docstring_list const & bibfilelist,
3321 bool const add_extension) const
3323 // If we are processing the LaTeX file in a temp directory then
3324 // copy the .bib databases to this temp directory, mangling their
3325 // names in the process. Store this mangled name in the list of
3327 // (We need to do all this because BibTeX *really*, *really*
3328 // can't handle "files with spaces" and Windows users tend to
3329 // use such filenames.)
3330 // Otherwise, store the (maybe absolute) path to the original,
3331 // unmangled database name.
3333 vector<pair<docstring, string>> res;
3335 // determine the export format
3336 string const tex_format = flavor2format(runparams.flavor);
3338 // check for spaces in paths
3339 bool found_space = false;
3341 for (auto const & bit : bibfilelist) {
3342 string utf8input = to_utf8(bit);
3344 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3345 FileName try_in_file =
3346 makeAbsPath(database + ".bib", filePath());
3347 bool not_from_texmf = try_in_file.isReadableFile();
3348 // If the file has not been found, try with the real file name
3349 // (it might come from a child in a sub-directory)
3350 if (!not_from_texmf) {
3351 try_in_file = getBibfilePath(bit);
3352 if (try_in_file.isReadableFile()) {
3353 // Check if the file is in texmf
3354 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3355 not_from_texmf = kpsefile.empty()
3356 || kpsefile.absFileName() != try_in_file.absFileName();
3358 // If this exists, make path relative to the master
3361 removeExtension(prepareFileNameForLaTeX(
3362 to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3363 from_utf8(filePath()))),
3364 ".bib", runparams.nice));
3368 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3370 // mangledFileName() needs the extension
3371 DocFileName const in_file = DocFileName(try_in_file);
3372 database = removeExtension(in_file.mangledFileName());
3373 FileName const out_file = makeAbsPath(database + ".bib",
3374 masterBuffer()->temppath());
3375 bool const success = in_file.copyTo(out_file);
3377 LYXERR0("Failed to copy '" << in_file
3378 << "' to '" << out_file << "'");
3380 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3381 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3382 if (!isValidLaTeXFileName(database)) {
3383 frontend::Alert::warning(_("Invalid filename"),
3384 _("The following filename will cause troubles "
3385 "when running the exported file through LaTeX: ") +
3386 from_utf8(database));
3388 if (!isValidDVIFileName(database)) {
3389 frontend::Alert::warning(_("Problematic filename for DVI"),
3390 _("The following filename can cause troubles "
3391 "when running the exported file through LaTeX "
3392 "and opening the resulting DVI: ") +
3393 from_utf8(database), true);
3401 docstring const path = from_utf8(latex_path(database));
3403 if (contains(path, ' '))
3406 if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
3407 enc = params().bibFileEncoding(utf8input);
3409 bool recorded = false;
3410 for (pair<docstring, string> pe : res) {
3411 if (pe.first == path) {
3418 res.push_back(make_pair(path, enc));
3421 // Check if there are spaces in the path and warn BibTeX users, if so.
3422 // (biber can cope with such paths)
3423 if (!prefixIs(runparams.bibtex_command, "biber")) {
3424 // Post this warning only once.
3425 static bool warned_about_spaces = false;
3426 if (!warned_about_spaces &&
3427 runparams.nice && found_space) {
3428 warned_about_spaces = true;
3429 Alert::warning(_("Export Warning!"),
3430 _("There are spaces in the paths to your BibTeX databases.\n"
3431 "BibTeX will be unable to find them."));
3440 string Buffer::layoutPos() const
3442 return d->layout_position;
3446 void Buffer::setLayoutPos(string const & path)
3449 d->layout_position.clear();
3453 LATTEST(FileName::isAbsolute(path));
3455 d->layout_position =
3456 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3458 if (d->layout_position.empty())
3459 d->layout_position = ".";
3463 bool Buffer::hasReadonlyFlag() const
3465 return d->read_only;
3469 bool Buffer::isReadonly() const
3471 return hasReadonlyFlag() || notifiesExternalModification();
3475 void Buffer::setParent(Buffer const * buffer)
3477 // Avoids recursive include.
3478 d->setParent(buffer == this ? 0 : buffer);
3483 Buffer const * Buffer::parent() const
3489 ListOfBuffers Buffer::allRelatives() const
3491 ListOfBuffers lb = masterBuffer()->getDescendents();
3492 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3497 Buffer const * Buffer::masterBuffer() const
3499 // FIXME Should be make sure we are not in some kind
3500 // of recursive include? A -> B -> A will crash this.
3501 Buffer const * const pbuf = d->parent();
3505 return pbuf->masterBuffer();
3509 bool Buffer::isChild(Buffer * child) const
3511 return d->children_positions.find(child) != d->children_positions.end();
3515 DocIterator Buffer::firstChildPosition(Buffer const * child)
3517 Impl::BufferPositionMap::iterator it;
3518 it = d->children_positions.find(child);
3519 if (it == d->children_positions.end())
3520 return DocIterator(this);
3525 bool Buffer::hasChildren() const
3527 return !d->children_positions.empty();
3531 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3533 // loop over children
3534 for (auto const & p : d->children_positions) {
3535 Buffer * child = const_cast<Buffer *>(p.first);
3537 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3538 if (bit != clist.end())
3540 clist.push_back(child);
3542 // there might be grandchildren
3543 child->collectChildren(clist, true);
3548 ListOfBuffers Buffer::getChildren() const
3551 collectChildren(v, false);
3552 // Make sure we have not included ourselves.
3553 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3554 if (bit != v.end()) {
3555 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3562 ListOfBuffers Buffer::getDescendents() const
3565 collectChildren(v, true);
3566 // Make sure we have not included ourselves.
3567 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3568 if (bit != v.end()) {
3569 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3576 template<typename M>
3577 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3582 typename M::const_iterator it = m.lower_bound(x);
3583 if (it == m.begin())
3591 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3592 DocIterator const & pos) const
3594 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3596 // if paragraphs have no macro context set, pos will be empty
3600 // we haven't found anything yet
3601 DocIterator bestPos = owner_->par_iterator_begin();
3602 MacroData const * bestData = 0;
3604 // find macro definitions for name
3605 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3606 if (nameIt != macros.end()) {
3607 // find last definition in front of pos or at pos itself
3608 PositionScopeMacroMap::const_iterator it
3609 = greatest_below(nameIt->second, pos);
3610 if (it != nameIt->second.end()) {
3612 // scope ends behind pos?
3613 if (pos < it->second.scope) {
3614 // Looks good, remember this. If there
3615 // is no external macro behind this,
3616 // we found the right one already.
3617 bestPos = it->first;
3618 bestData = &it->second.macro;
3622 // try previous macro if there is one
3623 if (it == nameIt->second.begin())
3630 // find macros in included files
3631 PositionScopeBufferMap::const_iterator it
3632 = greatest_below(position_to_children, pos);
3633 if (it == position_to_children.end())
3634 // no children before
3638 // do we know something better (i.e. later) already?
3639 if (it->first < bestPos )
3642 // scope ends behind pos?
3643 if (pos < it->second.scope
3644 && (cloned_buffer_ ||
3645 theBufferList().isLoaded(it->second.buffer))) {
3646 // look for macro in external file
3648 MacroData const * data
3649 = it->second.buffer->getMacro(name, false);
3652 bestPos = it->first;
3658 // try previous file if there is one
3659 if (it == position_to_children.begin())
3664 // return the best macro we have found
3669 MacroData const * Buffer::getMacro(docstring const & name,
3670 DocIterator const & pos, bool global) const
3675 // query buffer macros
3676 MacroData const * data = d->getBufferMacro(name, pos);
3680 // If there is a master buffer, query that
3681 Buffer const * const pbuf = d->parent();
3683 d->macro_lock = true;
3684 MacroData const * macro = pbuf->getMacro(
3685 name, *this, false);
3686 d->macro_lock = false;
3692 data = MacroTable::globalMacros().get(name);
3701 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3703 // set scope end behind the last paragraph
3704 DocIterator scope = par_iterator_begin();
3705 scope.pit() = scope.lastpit() + 1;
3707 return getMacro(name, scope, global);
3711 MacroData const * Buffer::getMacro(docstring const & name,
3712 Buffer const & child, bool global) const
3714 // look where the child buffer is included first
3715 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3716 if (it == d->children_positions.end())
3719 // check for macros at the inclusion position
3720 return getMacro(name, it->second, global);
3724 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3726 pit_type const lastpit = it.lastpit();
3728 // look for macros in each paragraph
3729 while (it.pit() <= lastpit) {
3730 Paragraph & par = it.paragraph();
3732 // FIXME Can this be done with the new-style iterators?
3733 // iterate over the insets of the current paragraph
3734 for (auto const & insit : par.insetList()) {
3735 it.pos() = insit.pos;
3737 // is it a nested text inset?
3738 if (insit.inset->asInsetText()) {
3739 // Inset needs its own scope?
3740 InsetText const * itext = insit.inset->asInsetText();
3741 bool newScope = itext->isMacroScope();
3743 // scope which ends just behind the inset
3744 DocIterator insetScope = it;
3747 // collect macros in inset
3748 it.push_back(CursorSlice(*insit.inset));
3749 updateMacros(it, newScope ? insetScope : scope);
3754 if (insit.inset->asInsetTabular()) {
3755 CursorSlice slice(*insit.inset);
3756 size_t const numcells = slice.nargs();
3757 for (; slice.idx() < numcells; slice.forwardIdx()) {
3758 it.push_back(slice);
3759 updateMacros(it, scope);
3765 // is it an external file?
3766 if (insit.inset->lyxCode() == INCLUDE_CODE) {
3767 // get buffer of external file
3768 InsetInclude const & incinset =
3769 static_cast<InsetInclude const &>(*insit.inset);
3771 Buffer * child = incinset.getChildBuffer();
3776 // register its position, but only when it is
3777 // included first in the buffer
3778 if (children_positions.find(child) ==
3779 children_positions.end())
3780 children_positions[child] = it;
3782 // register child with its scope
3783 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3787 InsetMath * im = insit.inset->asInsetMath();
3788 if (doing_export && im) {
3789 InsetMathHull * hull = im->asHullInset();
3791 hull->recordLocation(it);
3794 if (insit.inset->lyxCode() != MATHMACRO_CODE)
3798 InsetMathMacroTemplate & macroTemplate =
3799 *insit.inset->asInsetMath()->asMacroTemplate();
3800 MacroContext mc(owner_, it);
3801 macroTemplate.updateToContext(mc);
3804 bool valid = macroTemplate.validMacro();
3805 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3806 // then the BufferView's cursor will be invalid in
3807 // some cases which leads to crashes.
3812 // FIXME (Abdel), I don't understand why we pass 'it' here
3813 // instead of 'macroTemplate' defined above... is this correct?
3814 macros[macroTemplate.name()][it] =
3815 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3825 void Buffer::updateMacros() const
3830 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3832 // start with empty table
3834 d->children_positions.clear();
3835 d->position_to_children.clear();
3837 // Iterate over buffer, starting with first paragraph
3838 // The scope must be bigger than any lookup DocIterator
3839 // later. For the global lookup, lastpit+1 is used, hence
3840 // we use lastpit+2 here.
3841 DocIterator it = par_iterator_begin();
3842 DocIterator outerScope = it;
3843 outerScope.pit() = outerScope.lastpit() + 2;
3844 d->updateMacros(it, outerScope);
3848 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3850 InsetIterator it = inset_iterator_begin(inset());
3851 InsetIterator const end = inset_iterator_end(inset());
3852 for (; it != end; ++it) {
3853 if (it->lyxCode() == BRANCH_CODE) {
3854 InsetBranch & br = static_cast<InsetBranch &>(*it);
3855 docstring const name = br.branch();
3856 if (!from_master && !params().branchlist().find(name))
3857 result.push_back(name);
3858 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3859 result.push_back(name);
3862 if (it->lyxCode() == INCLUDE_CODE) {
3863 // get buffer of external file
3864 InsetInclude const & ins =
3865 static_cast<InsetInclude const &>(*it);
3866 Buffer * child = ins.getChildBuffer();
3869 child->getUsedBranches(result, true);
3872 // remove duplicates
3877 void Buffer::updateMacroInstances(UpdateType utype) const
3879 LYXERR(Debug::MACROS, "updateMacroInstances for "
3880 << d->filename.onlyFileName());
3881 DocIterator it = doc_iterator_begin(this);
3883 DocIterator const end = doc_iterator_end(this);
3884 for (; it != end; it.forwardInset()) {
3885 // look for MathData cells in InsetMathNest insets
3886 InsetMath * minset = it.nextInset()->asInsetMath();
3890 // update macro in all cells of the InsetMathNest
3891 DocIterator::idx_type n = minset->nargs();
3892 MacroContext mc = MacroContext(this, it);
3893 for (DocIterator::idx_type i = 0; i < n; ++i) {
3894 MathData & data = minset->cell(i);
3895 data.updateMacros(0, mc, utype, 0);
3901 void Buffer::listMacroNames(MacroNameSet & macros) const
3906 d->macro_lock = true;
3908 // loop over macro names
3909 for (auto const & nameit : d->macros)
3910 macros.insert(nameit.first);
3912 // loop over children
3913 for (auto const & p : d->children_positions) {
3914 Buffer * child = const_cast<Buffer *>(p.first);
3915 // The buffer might have been closed (see #10766).
3916 if (theBufferList().isLoaded(child))
3917 child->listMacroNames(macros);
3921 Buffer const * const pbuf = d->parent();
3923 pbuf->listMacroNames(macros);
3925 d->macro_lock = false;
3929 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3931 Buffer const * const pbuf = d->parent();
3936 pbuf->listMacroNames(names);
3939 for (auto const & mit : names) {
3941 MacroData const * data = pbuf->getMacro(mit, *this, false);
3943 macros.insert(data);
3945 // we cannot access the original InsetMathMacroTemplate anymore
3946 // here to calls validate method. So we do its work here manually.
3947 // FIXME: somehow make the template accessible here.
3948 if (data->optionals() > 0)
3949 features.require("xargs");
3955 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3958 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3960 RefCache::iterator it = d->ref_cache_.find(label);
3961 if (it != d->ref_cache_.end())
3964 static References const dummy_refs = References();
3965 it = d->ref_cache_.insert(
3966 make_pair(label, dummy_refs)).first;
3971 Buffer::References const & Buffer::references(docstring const & label) const
3973 return const_cast<Buffer *>(this)->getReferenceCache(label);
3977 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3979 References & refs = getReferenceCache(label);
3980 refs.push_back(make_pair(inset, it));
3984 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3988 linfo.label = label;
3990 linfo.active = active;
3991 masterBuffer()->d->label_cache_.push_back(linfo);
3995 InsetLabel const * Buffer::insetLabel(docstring const & label,
3996 bool const active) const
3998 for (auto & rc : masterBuffer()->d->label_cache_) {
3999 if (rc.label == label && (rc.active || !active))
4006 bool Buffer::activeLabel(docstring const & label) const
4008 if (!insetLabel(label, true))
4015 void Buffer::clearReferenceCache() const
4018 d->ref_cache_.clear();
4019 d->label_cache_.clear();
4024 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4026 //FIXME: This does not work for child documents yet.
4027 reloadBibInfoCache();
4029 // Check if the label 'from' appears more than once
4030 vector<docstring> labels;
4031 for (auto const & bibit : masterBibInfo())
4032 labels.push_back(bibit.first);
4034 if (count(labels.begin(), labels.end(), from) > 1)
4037 string const paramName = "key";
4038 InsetIterator it = inset_iterator_begin(inset());
4040 if (it->lyxCode() != CITE_CODE)
4042 InsetCommand * inset = it->asInsetCommand();
4043 docstring const oldValue = inset->getParam(paramName);
4044 if (oldValue == from)
4045 inset->setParam(paramName, to);
4049 // returns NULL if id-to-row conversion is unsupported
4050 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4051 pit_type par_begin, pit_type par_end,
4052 OutputWhat output, bool master) const
4054 unique_ptr<TexRow> texrow;
4055 OutputParams runparams(¶ms().encoding());
4056 runparams.nice = true;
4057 runparams.flavor = params().getOutputFlavor(format);
4058 runparams.linelen = lyxrc.plaintext_linelen;
4059 // No side effect of file copying and image conversion
4060 runparams.dryrun = true;
4062 // Some macros rely on font encoding
4063 runparams.main_fontenc = params().main_font_encoding();
4065 if (output == CurrentParagraph) {
4066 runparams.par_begin = par_begin;
4067 runparams.par_end = par_end;
4068 if (par_begin + 1 == par_end) {
4070 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4074 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4075 convert<docstring>(par_begin),
4076 convert<docstring>(par_end - 1))
4079 // output paragraphs
4080 if (runparams.flavor == OutputParams::LYX) {
4081 Paragraph const & par = text().paragraphs()[par_begin];
4083 depth_type dt = par.getDepth();
4084 par.write(ods, params(), dt);
4085 os << from_utf8(ods.str());
4086 } else if (runparams.flavor == OutputParams::HTML) {
4088 setMathFlavor(runparams);
4089 xhtmlParagraphs(text(), *this, xs, runparams);
4090 } else if (runparams.flavor == OutputParams::TEXT) {
4092 // FIXME Handles only one paragraph, unlike the others.
4093 // Probably should have some routine with a signature like them.
4094 writePlaintextParagraph(*this,
4095 text().paragraphs()[par_begin], os, runparams, dummy);
4096 } else if (params().isDocBook()) {
4097 docbookParagraphs(text(), *this, os, runparams);
4099 // If we are previewing a paragraph, even if this is the
4100 // child of some other buffer, let's cut the link here,
4101 // so that no concurring settings from the master
4102 // (e.g. branch state) interfere (see #8101).
4104 d->ignore_parent = true;
4105 // We need to validate the Buffer params' features here
4106 // in order to know if we should output polyglossia
4107 // macros (instead of babel macros)
4108 LaTeXFeatures features(*this, params(), runparams);
4110 runparams.use_polyglossia = features.usePolyglossia();
4111 // latex or literate
4114 ots.texrow().newlines(2);
4116 latexParagraphs(*this, text(), ots, runparams);
4117 texrow = ots.releaseTexRow();
4119 // Restore the parenthood
4121 d->ignore_parent = false;
4125 if (output == FullSource)
4126 os << _("Preview source code");
4127 else if (output == OnlyPreamble)
4128 os << _("Preview preamble");
4129 else if (output == OnlyBody)
4130 os << _("Preview body");
4132 if (runparams.flavor == OutputParams::LYX) {
4134 if (output == FullSource)
4136 else if (output == OnlyPreamble)
4137 params().writeFile(ods, this);
4138 else if (output == OnlyBody)
4140 os << from_utf8(ods.str());
4141 } else if (runparams.flavor == OutputParams::HTML) {
4142 writeLyXHTMLSource(os, runparams, output);
4143 } else if (runparams.flavor == OutputParams::TEXT) {
4144 if (output == OnlyPreamble) {
4145 os << "% "<< _("Plain text does not have a preamble.");
4147 writePlaintextFile(*this, os, runparams);
4148 } else if (params().isDocBook()) {
4149 writeDocBookSource(os, absFileName(), runparams, output);
4151 // latex or literate
4154 ots.texrow().newlines(2);
4156 runparams.is_child = true;
4158 writeLaTeXSource(ots, string(), runparams, output);
4159 texrow = ots.releaseTexRow();
4166 ErrorList & Buffer::errorList(string const & type) const
4168 return d->errorLists[type];
4172 void Buffer::updateTocItem(std::string const & type,
4173 DocIterator const & dit) const
4176 d->gui_->updateTocItem(type, dit);
4180 void Buffer::structureChanged() const
4183 d->gui_->structureChanged();
4187 void Buffer::errors(string const & err, bool from_master) const
4190 d->gui_->errors(err, from_master);
4194 void Buffer::message(docstring const & msg) const
4197 d->gui_->message(msg);
4201 void Buffer::setBusy(bool on) const
4204 d->gui_->setBusy(on);
4208 void Buffer::updateTitles() const
4211 d->wa_->updateTitles();
4215 void Buffer::resetAutosaveTimers() const
4218 d->gui_->resetAutosaveTimers();
4222 bool Buffer::hasGuiDelegate() const
4228 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4237 class AutoSaveBuffer : public ForkedProcess {
4240 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4241 : buffer_(buffer), fname_(fname) {}
4243 virtual shared_ptr<ForkedProcess> clone() const
4245 return make_shared<AutoSaveBuffer>(*this);
4250 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4251 from_utf8(fname_.absFileName())));
4252 return run(DontWait);
4256 virtual int generateChild();
4258 Buffer const & buffer_;
4263 int AutoSaveBuffer::generateChild()
4265 #if defined(__APPLE__)
4266 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4267 * We should use something else like threads.
4269 * Since I do not know how to determine at run time what is the OS X
4270 * version, I just disable forking altogether for now (JMarc)
4272 pid_t const pid = -1;
4274 // tmp_ret will be located (usually) in /tmp
4275 // will that be a problem?
4276 // Note that this calls ForkedCalls::fork(), so it's
4277 // ok cross-platform.
4278 pid_t const pid = fork();
4279 // If you want to debug the autosave
4280 // you should set pid to -1, and comment out the fork.
4281 if (pid != 0 && pid != -1)
4285 // pid = -1 signifies that lyx was unable
4286 // to fork. But we will do the save
4288 bool failed = false;
4289 TempFile tempfile("lyxautoXXXXXX.lyx");
4290 tempfile.setAutoRemove(false);
4291 FileName const tmp_ret = tempfile.name();
4292 if (!tmp_ret.empty()) {
4293 if (!buffer_.writeFile(tmp_ret))
4295 else if (!tmp_ret.moveTo(fname_))
4301 // failed to write/rename tmp_ret so try writing direct
4302 if (!buffer_.writeFile(fname_)) {
4303 // It is dangerous to do this in the child,
4304 // but safe in the parent, so...
4305 if (pid == -1) // emit message signal.
4306 buffer_.message(_("Autosave failed!"));
4310 if (pid == 0) // we are the child so...
4319 FileName Buffer::getEmergencyFileName() const
4321 return FileName(d->filename.absFileName() + ".emergency");
4325 FileName Buffer::getAutosaveFileName() const
4327 // if the document is unnamed try to save in the backup dir, else
4328 // in the default document path, and as a last try in the filePath,
4329 // which will most often be the temporary directory
4332 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4333 : lyxrc.backupdir_path;
4334 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4337 string const fname = "#" + d->filename.onlyFileName() + "#";
4339 return makeAbsPath(fname, fpath);
4343 void Buffer::removeAutosaveFile() const
4345 FileName const f = getAutosaveFileName();
4351 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4353 FileName const newauto = getAutosaveFileName();
4355 if (newauto != oldauto && oldauto.exists())
4356 if (!oldauto.moveTo(newauto))
4357 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4361 bool Buffer::autoSave() const
4363 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4364 if (buf->d->bak_clean || hasReadonlyFlag())
4367 message(_("Autosaving current document..."));
4368 buf->d->bak_clean = true;
4370 FileName const fname = getAutosaveFileName();
4371 LASSERT(d->cloned_buffer_, return false);
4373 // If this buffer is cloned, we assume that
4374 // we are running in a separate thread already.
4375 TempFile tempfile("lyxautoXXXXXX.lyx");
4376 tempfile.setAutoRemove(false);
4377 FileName const tmp_ret = tempfile.name();
4378 if (!tmp_ret.empty()) {
4380 // assume successful write of tmp_ret
4381 if (tmp_ret.moveTo(fname))
4384 // failed to write/rename tmp_ret so try writing direct
4385 return writeFile(fname);
4389 void Buffer::setExportStatus(bool e) const
4391 d->doing_export = e;
4392 ListOfBuffers clist = getDescendents();
4393 for (auto const & bit : clist)
4394 bit->d->doing_export = e;
4398 bool Buffer::isExporting() const
4400 return d->doing_export;
4404 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4408 return doExport(target, put_in_tempdir, result_file);
4411 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4412 string & result_file) const
4414 bool const update_unincluded =
4415 params().maintain_unincluded_children
4416 && !params().getIncludedChildren().empty();
4418 // (1) export with all included children (omit \includeonly)
4419 if (update_unincluded) {
4420 ExportStatus const status =
4421 doExport(target, put_in_tempdir, true, result_file);
4422 if (status != ExportSuccess)
4425 // (2) export with included children only
4426 return doExport(target, put_in_tempdir, false, result_file);
4430 void Buffer::setMathFlavor(OutputParams & op) const
4432 switch (params().html_math_output) {
4433 case BufferParams::MathML:
4434 op.math_flavor = OutputParams::MathAsMathML;
4436 case BufferParams::HTML:
4437 op.math_flavor = OutputParams::MathAsHTML;
4439 case BufferParams::Images:
4440 op.math_flavor = OutputParams::MathAsImages;
4442 case BufferParams::LaTeX:
4443 op.math_flavor = OutputParams::MathAsLaTeX;
4449 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4450 bool includeall, string & result_file) const
4452 LYXERR(Debug::FILES, "target=" << target);
4453 OutputParams runparams(¶ms().encoding());
4454 string format = target;
4455 string dest_filename;
4456 size_t pos = target.find(' ');
4457 if (pos != string::npos) {
4458 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4459 format = target.substr(0, pos);
4460 if (format == "default")
4461 format = params().getDefaultOutputFormat();
4462 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4463 FileName(dest_filename).onlyPath().createPath();
4464 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4466 MarkAsExporting exporting(this);
4467 string backend_format;
4468 runparams.flavor = OutputParams::LATEX;
4469 runparams.linelen = lyxrc.plaintext_linelen;
4470 runparams.includeall = includeall;
4471 vector<string> backs = params().backends();
4472 Converters converters = theConverters();
4473 bool need_nice_file = false;
4474 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4475 // Get shortest path to format
4476 converters.buildGraph();
4477 Graph::EdgePath path;
4478 for (string const & sit : backs) {
4479 Graph::EdgePath p = converters.getPath(sit, format);
4480 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4481 backend_format = sit;
4486 if (!put_in_tempdir) {
4487 // Only show this alert if this is an export to a non-temporary
4488 // file (not for previewing).
4489 docstring s = bformat(_("No information for exporting the format %1$s."),
4490 theFormats().prettyName(format));
4491 if (format == "pdf4")
4493 + bformat(_("Hint: use non-TeX fonts or set input encoding "
4494 " to '%1$s'"), from_utf8(encodings.fromLyXName("ascii")->guiName()));
4495 Alert::error(_("Couldn't export file"), s);
4497 return ExportNoPathToFormat;
4499 runparams.flavor = converters.getFlavor(path, this);
4500 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4501 for (auto const & edge : path)
4502 if (theConverters().get(edge).nice()) {
4503 need_nice_file = true;
4508 backend_format = format;
4509 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4510 // FIXME: Don't hardcode format names here, but use a flag
4511 if (backend_format == "pdflatex")
4512 runparams.flavor = OutputParams::PDFLATEX;
4513 else if (backend_format == "luatex")
4514 runparams.flavor = OutputParams::LUATEX;
4515 else if (backend_format == "dviluatex")
4516 runparams.flavor = OutputParams::DVILUATEX;
4517 else if (backend_format == "xetex")
4518 runparams.flavor = OutputParams::XETEX;
4521 string filename = latexName(false);
4522 filename = addName(temppath(), filename);
4523 filename = changeExtension(filename,
4524 theFormats().extension(backend_format));
4525 LYXERR(Debug::FILES, "filename=" << filename);
4527 // Plain text backend
4528 if (backend_format == "text") {
4529 runparams.flavor = OutputParams::TEXT;
4531 writePlaintextFile(*this, FileName(filename), runparams);
4533 catch (ConversionException const &) { return ExportCancel; }
4536 else if (backend_format == "xhtml") {
4537 runparams.flavor = OutputParams::HTML;
4538 setMathFlavor(runparams);
4539 if (makeLyXHTMLFile(FileName(filename), runparams) == ExportKilled)
4540 return ExportKilled;
4541 } else if (backend_format == "lyx")
4542 writeFile(FileName(filename));
4544 else if (params().isDocBook()) {
4545 runparams.nice = !put_in_tempdir;
4546 if (makeDocBookFile(FileName(filename), runparams) == ExportKilled)
4547 return ExportKilled;
4550 else if (backend_format == format || need_nice_file) {
4551 runparams.nice = true;
4552 ExportStatus const retval =
4553 makeLaTeXFile(FileName(filename), string(), runparams);
4554 if (retval == ExportKilled)
4555 return ExportKilled;
4556 if (d->cloned_buffer_)
4557 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4558 if (retval != ExportSuccess)
4560 } else if (!lyxrc.tex_allows_spaces
4561 && contains(filePath(), ' ')) {
4562 Alert::error(_("File name error"),
4563 bformat(_("The directory path to the document\n%1$s\n"
4564 "contains spaces, but your TeX installation does "
4565 "not allow them. You should save the file to a directory "
4566 "whose name does not contain spaces."), from_utf8(filePath())));
4567 return ExportTexPathHasSpaces;
4569 runparams.nice = false;
4570 ExportStatus const retval =
4571 makeLaTeXFile(FileName(filename), filePath(), runparams);
4572 if (retval == ExportKilled)
4573 return ExportKilled;
4574 if (d->cloned_buffer_)
4575 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4576 if (retval != ExportSuccess)
4580 string const error_type = (format == "program")
4581 ? "Build" : params().bufferFormat();
4582 ErrorList & error_list = d->errorLists[error_type];
4583 string const ext = theFormats().extension(format);
4584 FileName const tmp_result_file(changeExtension(filename, ext));
4585 Converters::RetVal const retval =
4586 converters.convert(this, FileName(filename), tmp_result_file,
4587 FileName(absFileName()), backend_format, format, error_list);
4588 if (retval == Converters::KILLED)
4589 return ExportCancel;
4590 bool success = (retval == Converters::SUCCESS);
4592 // Emit the signal to show the error list or copy it back to the
4593 // cloned Buffer so that it can be emitted afterwards.
4594 if (format != backend_format) {
4595 if (runparams.silent)
4597 else if (d->cloned_buffer_)
4598 d->cloned_buffer_->d->errorLists[error_type] =
4599 d->errorLists[error_type];
4602 // also to the children, in case of master-buffer-view
4603 ListOfBuffers clist = getDescendents();
4604 for (auto const & bit : clist) {
4605 if (runparams.silent)
4606 bit->d->errorLists[error_type].clear();
4607 else if (d->cloned_buffer_) {
4608 // Enable reverse search by copying back the
4609 // texrow object to the cloned buffer.
4610 // FIXME: this is not thread safe.
4611 bit->d->cloned_buffer_->d->texrow = bit->d->texrow;
4612 bit->d->cloned_buffer_->d->errorLists[error_type] =
4613 bit->d->errorLists[error_type];
4615 bit->errors(error_type, true);
4619 if (d->cloned_buffer_) {
4620 // Enable reverse dvi or pdf to work by copying back the texrow
4621 // object to the cloned buffer.
4622 // FIXME: There is a possibility of concurrent access to texrow
4623 // here from the main GUI thread that should be securized.
4624 d->cloned_buffer_->d->texrow = d->texrow;
4625 string const err_type = params().bufferFormat();
4626 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[err_type];
4630 if (put_in_tempdir) {
4631 result_file = tmp_result_file.absFileName();
4632 return success ? ExportSuccess : ExportConverterError;
4635 if (dest_filename.empty())
4636 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4638 result_file = dest_filename;
4639 // We need to copy referenced files (e. g. included graphics
4640 // if format == "dvi") to the result dir.
4641 vector<ExportedFile> const extfiles =
4642 runparams.exportdata->externalFiles(format);
4643 string const dest = runparams.export_folder.empty() ?
4644 onlyPath(result_file) : runparams.export_folder;
4645 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4646 : force_overwrite == ALL_FILES;
4647 CopyStatus status = use_force ? FORCE : SUCCESS;
4649 for (ExportedFile const & exp : extfiles) {
4650 if (status == CANCEL) {
4651 message(_("Document export cancelled."));
4652 return ExportCancel;
4654 string const fmt = theFormats().getFormatFromFile(exp.sourceName);
4655 string fixedName = exp.exportName;
4656 if (!runparams.export_folder.empty()) {
4657 // Relative pathnames starting with ../ will be sanitized
4658 // if exporting to a different folder
4659 while (fixedName.substr(0, 3) == "../")
4660 fixedName = fixedName.substr(3, fixedName.length() - 3);
4662 FileName fixedFileName = makeAbsPath(fixedName, dest);
4663 fixedFileName.onlyPath().createPath();
4664 status = copyFile(fmt, exp.sourceName,
4666 exp.exportName, status == FORCE,
4667 runparams.export_folder.empty());
4671 if (tmp_result_file.exists()) {
4672 // Finally copy the main file
4673 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4674 : force_overwrite != NO_FILES;
4675 if (status == SUCCESS && use_force)
4677 status = copyFile(format, tmp_result_file,
4678 FileName(result_file), result_file,
4680 if (status == CANCEL) {
4681 message(_("Document export cancelled."));
4682 return ExportCancel;
4684 message(bformat(_("Document exported as %1$s "
4686 theFormats().prettyName(format),
4687 makeDisplayPath(result_file)));
4690 // This must be a dummy converter like fax (bug 1888)
4691 message(bformat(_("Document exported as %1$s"),
4692 theFormats().prettyName(format)));
4695 return success ? ExportSuccess : ExportConverterError;
4699 Buffer::ExportStatus Buffer::preview(string const & format) const
4701 bool const update_unincluded =
4702 params().maintain_unincluded_children
4703 && !params().getIncludedChildren().empty();
4704 return preview(format, update_unincluded);
4708 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4710 MarkAsExporting exporting(this);
4712 // (1) export with all included children (omit \includeonly)
4714 ExportStatus const status = doExport(format, true, true, result_file);
4715 if (status != ExportSuccess)
4718 // (2) export with included children only
4719 ExportStatus const status = doExport(format, true, false, result_file);
4720 FileName const previewFile(result_file);
4722 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4723 theimpl->preview_file_ = previewFile;
4724 theimpl->preview_format_ = format;
4725 theimpl->preview_error_ = (status != ExportSuccess);
4727 if (status != ExportSuccess)
4730 if (previewFile.exists())
4731 return theFormats().view(*this, previewFile, format) ?
4732 PreviewSuccess : PreviewError;
4734 // Successful export but no output file?
4735 // Probably a bug in error detection.
4736 LATTEST(status != ExportSuccess);
4741 Buffer::ReadStatus Buffer::extractFromVC()
4743 bool const found = LyXVC::file_not_found_hook(d->filename);
4745 return ReadFileNotFound;
4746 if (!d->filename.isReadableFile())
4752 Buffer::ReadStatus Buffer::loadEmergency()
4754 FileName const emergencyFile = getEmergencyFileName();
4755 if (!emergencyFile.exists()
4756 || emergencyFile.lastModified() <= d->filename.lastModified())
4757 return ReadFileNotFound;
4759 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4760 docstring const text = bformat(_("An emergency save of the document "
4761 "%1$s exists.\n\nRecover emergency save?"), file);
4763 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4764 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4770 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4771 bool const success = (ret_llf == ReadSuccess);
4773 if (hasReadonlyFlag()) {
4774 Alert::warning(_("File is read-only"),
4775 bformat(_("An emergency file is successfully loaded, "
4776 "but the original file %1$s is marked read-only. "
4777 "Please make sure to save the document as a different "
4778 "file."), from_utf8(d->filename.absFileName())));
4781 lyxvc().file_found_hook(d->filename);
4782 str = _("Document was successfully recovered.");
4784 str = _("Document was NOT successfully recovered.");
4785 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4786 makeDisplayPath(emergencyFile.absFileName()));
4788 int const del_emerg =
4789 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4790 _("&Remove"), _("&Keep"));
4791 if (del_emerg == 0) {
4792 emergencyFile.removeFile();
4794 Alert::warning(_("Emergency file deleted"),
4795 _("Do not forget to save your file now!"), true);
4797 return success ? ReadSuccess : ReadEmergencyFailure;
4800 int const del_emerg =
4801 Alert::prompt(_("Delete emergency file?"),
4802 _("Remove emergency file now?"), 1, 1,
4803 _("&Remove"), _("&Keep"));
4805 emergencyFile.removeFile();
4809 string const ename = emergencyFile.absFileName();
4811 // Surely we can find one in 100 tries?
4812 for (int i = 1; i < 100; ++i) {
4813 newname.set(ename + to_string(i) + ".lyx");
4814 if (!newname.exists()) {
4820 // renameTo returns true on success. So inverting that
4821 // will give us true if we fail.
4822 noname = !emergencyFile.renameTo(newname);
4825 Alert::warning(_("Can't rename emergency file!"),
4826 _("LyX was unable to rename the emergency file. "
4827 "You should do so manually. Otherwise, you will be "
4828 "asked about it again the next time you try to load "
4829 "this file, and may over-write your own work."));
4831 Alert::warning(_("Emergency File Renames"),
4832 bformat(_("Emergency file renamed as:\n %1$s"),
4833 from_utf8(newname.onlyFileName())));
4836 return ReadOriginal;
4846 Buffer::ReadStatus Buffer::loadAutosave()
4848 // Now check if autosave file is newer.
4849 FileName const autosaveFile = getAutosaveFileName();
4850 if (!autosaveFile.exists()
4851 || autosaveFile.lastModified() <= d->filename.lastModified())
4852 return ReadFileNotFound;
4854 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4855 docstring const text = bformat(_("The backup of the document %1$s "
4856 "is newer.\n\nLoad the backup instead?"), file);
4857 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4858 _("&Load backup"), _("Load &original"), _("&Cancel"));
4863 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4864 // the file is not saved if we load the autosave file.
4865 if (ret_llf == ReadSuccess) {
4866 if (hasReadonlyFlag()) {
4867 Alert::warning(_("File is read-only"),
4868 bformat(_("A backup file is successfully loaded, "
4869 "but the original file %1$s is marked read-only. "
4870 "Please make sure to save the document as a "
4872 from_utf8(d->filename.absFileName())));
4875 lyxvc().file_found_hook(d->filename);
4878 return ReadAutosaveFailure;
4881 // Here we delete the autosave
4882 autosaveFile.removeFile();
4883 return ReadOriginal;
4891 Buffer::ReadStatus Buffer::loadLyXFile()
4893 if (!d->filename.isReadableFile()) {
4894 ReadStatus const ret_rvc = extractFromVC();
4895 if (ret_rvc != ReadSuccess)
4899 ReadStatus const ret_re = loadEmergency();
4900 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4903 ReadStatus const ret_ra = loadAutosave();
4904 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4907 return loadThisLyXFile(d->filename);
4911 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4913 return readFile(fn);
4917 void Buffer::Impl::traverseErrors(TeXErrors::Errors::const_iterator err, TeXErrors::Errors::const_iterator end, ErrorList & errorList) const
4919 for (; err != end; ++err) {
4920 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4921 int errorRow = err->error_in_line;
4922 Buffer const * buf = 0;
4923 Impl const * p = this;
4924 if (err->child_name.empty())
4925 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4927 // The error occurred in a child
4928 for (Buffer const * child : owner_->getDescendents()) {
4929 string const child_name =
4930 DocFileName(changeExtension(child->absFileName(), "tex")).
4932 if (err->child_name != child_name)
4934 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4935 if (!TexRow::isNone(start)) {
4936 buf = this->cloned_buffer_
4937 ? child->d->cloned_buffer_->d->owner_
4944 errorList.push_back(ErrorItem(err->error_desc, err->error_text,
4950 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4952 TeXErrors::Errors::const_iterator err = terr.begin();
4953 TeXErrors::Errors::const_iterator end = terr.end();
4955 d->traverseErrors(err, end, errorList);
4959 void Buffer::bufferRefs(TeXErrors const & terr, ErrorList & errorList) const
4961 TeXErrors::Errors::const_iterator err = terr.begin_ref();
4962 TeXErrors::Errors::const_iterator end = terr.end_ref();
4964 d->traverseErrors(err, end, errorList);
4968 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4970 LBUFERR(!text().paragraphs().empty());
4972 // Use the master text class also for child documents
4973 Buffer const * const master = masterBuffer();
4974 DocumentClass const & textclass = master->params().documentClass();
4976 docstring_list old_bibfiles;
4977 // Do this only if we are the top-level Buffer. We also need to account
4978 // for the case of a previewed child with ignored parent here.
4979 if (master == this && !d->ignore_parent) {
4980 textclass.counters().reset(from_ascii("bibitem"));
4981 reloadBibInfoCache();
4982 // we will re-read this cache as we go through, but we need
4983 // to know whether it's changed to know whether we need to
4984 // update the bibinfo cache.
4985 old_bibfiles = d->bibfiles_cache_;
4986 d->bibfiles_cache_.clear();
4989 // keep the buffers to be children in this set. If the call from the
4990 // master comes back we can see which of them were actually seen (i.e.
4991 // via an InsetInclude). The remaining ones in the set need still be updated.
4992 static std::set<Buffer const *> bufToUpdate;
4993 if (scope == UpdateMaster) {
4994 // If this is a child document start with the master
4995 if (master != this) {
4996 bufToUpdate.insert(this);
4997 master->updateBuffer(UpdateMaster, utype);
4998 // If the master buffer has no gui associated with it, then the TocModel is
4999 // not updated during the updateBuffer call and TocModel::toc_ is invalid
5000 // (bug 5699). The same happens if the master buffer is open in a different
5001 // window. This test catches both possibilities.
5002 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
5003 // There remains a problem here: If there is another child open in yet a third
5004 // window, that TOC is not updated. So some more general solution is needed at
5006 if (master->d->gui_ != d->gui_)
5009 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
5010 if (bufToUpdate.find(this) == bufToUpdate.end())
5014 // start over the counters in the master
5015 textclass.counters().reset();
5018 // update will be done below for this buffer
5019 bufToUpdate.erase(this);
5021 // update all caches
5022 clearReferenceCache();
5024 setChangesPresent(false);
5026 Buffer & cbuf = const_cast<Buffer &>(*this);
5027 // if we are reloading, then we could have a dangling TOC,
5028 // in effect. so we need to go ahead and reset, even though
5029 // we will do so again when we rebuild the TOC later.
5030 cbuf.tocBackend().reset();
5033 ParIterator parit = cbuf.par_iterator_begin();
5034 updateBuffer(parit, utype);
5036 // If this document has siblings, then update the TocBackend later. The
5037 // reason is to ensure that later siblings are up to date when e.g. the
5038 // broken or not status of references is computed. The update is called
5039 // in InsetInclude::addToToc.
5043 // if the bibfiles changed, the cache of bibinfo is invalid
5044 docstring_list new_bibfiles = d->bibfiles_cache_;
5045 // this is a trick to determine whether the two vectors have
5046 // the same elements.
5047 sort(new_bibfiles.begin(), new_bibfiles.end());
5048 sort(old_bibfiles.begin(), old_bibfiles.end());
5049 if (old_bibfiles != new_bibfiles) {
5050 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5051 invalidateBibinfoCache();
5052 reloadBibInfoCache();
5053 // We relied upon the bibinfo cache when recalculating labels. But that
5054 // cache was invalid, although we didn't find that out until now. So we
5055 // have to do it all again.
5056 // That said, the only thing we really need to do is update the citation
5057 // labels. Nothing else will have changed. So we could create a new
5058 // UpdateType that would signal that fact, if we needed to do so.
5059 parit = cbuf.par_iterator_begin();
5060 // we will be re-doing the counters and references and such.
5061 textclass.counters().reset();
5062 clearReferenceCache();
5063 // we should not need to do this again?
5065 setChangesPresent(false);
5066 updateBuffer(parit, utype);
5067 // this will already have been done by reloadBibInfoCache();
5068 // d->bibinfo_cache_valid_ = true;
5071 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5072 // this is also set to true on the other path, by reloadBibInfoCache.
5073 d->bibinfo_cache_valid_ = true;
5075 d->cite_labels_valid_ = true;
5077 cbuf.tocBackend().update(true, utype);
5078 if (scope == UpdateMaster)
5079 cbuf.structureChanged();
5083 static depth_type getDepth(DocIterator const & it)
5085 depth_type depth = 0;
5086 for (size_t i = 0 ; i < it.depth() ; ++i)
5087 if (!it[i].inset().inMathed())
5088 depth += it[i].paragraph().getDepth() + 1;
5089 // remove 1 since the outer inset does not count
5090 // we should have at least one non-math inset, so
5091 // depth should nevery be 0. but maybe it is worth
5092 // marking this, just in case.
5094 // coverity[INTEGER_OVERFLOW]
5098 static depth_type getItemDepth(ParIterator const & it)
5100 Paragraph const & par = *it;
5101 LabelType const labeltype = par.layout().labeltype;
5103 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5106 // this will hold the lowest depth encountered up to now.
5107 depth_type min_depth = getDepth(it);
5108 ParIterator prev_it = it;
5111 --prev_it.top().pit();
5113 // start of nested inset: go to outer par
5115 if (prev_it.empty()) {
5116 // start of document: nothing to do
5121 // We search for the first paragraph with same label
5122 // that is not more deeply nested.
5123 Paragraph & prev_par = *prev_it;
5124 depth_type const prev_depth = getDepth(prev_it);
5125 if (labeltype == prev_par.layout().labeltype) {
5126 if (prev_depth < min_depth)
5127 return prev_par.itemdepth + 1;
5128 if (prev_depth == min_depth)
5129 return prev_par.itemdepth;
5131 min_depth = min(min_depth, prev_depth);
5132 // small optimization: if we are at depth 0, we won't
5133 // find anything else
5134 if (prev_depth == 0)
5140 static bool needEnumCounterReset(ParIterator const & it)
5142 Paragraph const & par = *it;
5143 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5144 depth_type const cur_depth = par.getDepth();
5145 ParIterator prev_it = it;
5146 while (prev_it.pit()) {
5147 --prev_it.top().pit();
5148 Paragraph const & prev_par = *prev_it;
5149 if (prev_par.getDepth() <= cur_depth)
5150 return prev_par.layout().name() != par.layout().name();
5152 // start of nested inset: reset
5157 // set the label of a paragraph. This includes the counters.
5158 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5160 BufferParams const & bp = owner_->masterBuffer()->params();
5161 DocumentClass const & textclass = bp.documentClass();
5162 Paragraph & par = it.paragraph();
5163 Layout const & layout = par.layout();
5164 Counters & counters = textclass.counters();
5166 if (par.params().startOfAppendix()) {
5167 // We want to reset the counter corresponding to toplevel sectioning
5168 Layout const & lay = textclass.getTOCLayout();
5169 docstring const cnt = lay.counter;
5171 counters.reset(cnt);
5172 counters.appendix(true);
5174 par.params().appendix(counters.appendix());
5176 // Compute the item depth of the paragraph
5177 par.itemdepth = getItemDepth(it);
5179 if (layout.margintype == MARGIN_MANUAL) {
5180 if (par.params().labelWidthString().empty())
5181 par.params().labelWidthString(par.expandLabel(layout, bp));
5182 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5183 // we do not need to do anything here, since the empty case is
5184 // handled during export.
5186 par.params().labelWidthString(docstring());
5189 switch(layout.labeltype) {
5190 case LABEL_ITEMIZE: {
5191 // At some point of time we should do something more
5192 // clever here, like:
5193 // par.params().labelString(
5194 // bp.user_defined_bullet(par.itemdepth).getText());
5195 // for now, use a simple hardcoded label
5196 docstring itemlabel;
5197 switch (par.itemdepth) {
5200 itemlabel = char_type(0x2022);
5204 itemlabel = char_type(0x2013);
5207 // ∗ U+2217 ASTERISK OPERATOR
5208 itemlabel = char_type(0x2217);
5211 // · U+00B7 MIDDLE DOT
5212 itemlabel = char_type(0x00b7);
5215 par.params().labelString(itemlabel);
5219 case LABEL_ENUMERATE: {
5220 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5222 switch (par.itemdepth) {
5233 enumcounter += "iv";
5236 // not a valid enumdepth...
5240 if (needEnumCounterReset(it)) {
5241 // Increase the master counter?
5242 if (layout.stepmastercounter)
5243 counters.stepMaster(enumcounter, utype);
5244 // Maybe we have to reset the enumeration counter.
5245 if (!layout.resumecounter)
5246 counters.reset(enumcounter);
5248 counters.step(enumcounter, utype);
5250 string const & lang = par.getParLanguage(bp)->code();
5251 par.params().labelString(counters.theCounter(enumcounter, lang));
5256 case LABEL_SENSITIVE: {
5257 string const & type = counters.current_float();
5258 docstring full_label;
5260 full_label = owner_->B_("Senseless!!! ");
5262 docstring name = owner_->B_(textclass.floats().getType(type).name());
5263 if (counters.hasCounter(from_utf8(type))) {
5264 string const & lang = par.getParLanguage(bp)->code();
5265 counters.step(from_utf8(type), utype);
5266 full_label = bformat(from_ascii("%1$s %2$s:"),
5268 counters.theCounter(from_utf8(type), lang));
5270 full_label = bformat(from_ascii("%1$s #:"), name);
5272 par.params().labelString(full_label);
5276 case LABEL_NO_LABEL:
5277 par.params().labelString(docstring());
5281 case LABEL_CENTERED:
5282 case LABEL_STATIC: {
5283 docstring const & lcounter = layout.counter;
5284 if (!lcounter.empty()) {
5285 if (layout.toclevel <= bp.secnumdepth
5286 && (layout.latextype != LATEX_ENVIRONMENT
5287 || it.text()->isFirstInSequence(it.pit()))) {
5288 if (counters.hasCounter(lcounter))
5289 counters.step(lcounter, utype);
5290 par.params().labelString(par.expandLabel(layout, bp));
5292 par.params().labelString(docstring());
5294 par.params().labelString(par.expandLabel(layout, bp));
5300 par.params().labelString(par.expandLabel(layout, bp));
5305 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5307 // LASSERT: Is it safe to continue here, or should we just return?
5308 LASSERT(parit.pit() == 0, /**/);
5310 // Set the position of the text in the buffer to be able
5311 // to resolve macros in it.
5312 parit.text()->setMacrocontextPosition(parit);
5314 // Reset bibitem counter in master (#8499)
5315 Buffer const * const master = masterBuffer();
5316 if (master == this && !d->ignore_parent)
5317 master->params().documentClass().counters().reset(from_ascii("bibitem"));
5319 depth_type maxdepth = 0;
5320 pit_type const lastpit = parit.lastpit();
5321 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5322 // reduce depth if necessary
5323 if (parit->params().depth() > maxdepth) {
5324 /** FIXME: this function is const, but
5325 * nevertheless it modifies the buffer. To be
5326 * cleaner, one should modify the buffer in
5327 * another function, which is actually
5328 * non-const. This would however be costly in
5329 * terms of code duplication.
5331 CursorData(parit).recordUndo();
5332 parit->params().depth(maxdepth);
5334 maxdepth = parit->getMaxDepthAfter();
5336 if (utype == OutputUpdate) {
5337 // track the active counters
5338 // we have to do this for the master buffer, since the local
5339 // buffer isn't tracking anything.
5340 masterBuffer()->params().documentClass().counters().
5341 setActiveLayout(parit->layout());
5344 // set the counter for this paragraph
5345 d->setLabel(parit, utype);
5347 // update change-tracking flag
5348 parit->addChangesToBuffer(*this);
5351 for (auto const & insit : parit->insetList()) {
5352 parit.pos() = insit.pos;
5353 insit.inset->updateBuffer(parit, utype);
5359 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5360 WordLangTuple & word_lang, docstring_list & suggestions) const
5364 suggestions.clear();
5365 word_lang = WordLangTuple();
5366 bool const to_end = to.empty();
5367 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5368 // OK, we start from here.
5369 for (; from != end; from.forwardPos()) {
5370 // This skips all insets with spell check disabled.
5371 while (!from.allowSpellCheck()) {
5375 // If from is at the end of the document (which is possible
5376 // when "from" was changed above) LyX will crash later otherwise.
5377 if (from.atEnd() || (!to_end && from >= end))
5380 from.paragraph().spellCheck();
5381 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5382 if (SpellChecker::misspelled(res)) {
5386 // Do not increase progress when from == to, otherwise the word
5387 // count will be wrong.
5397 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5399 bool inword = false;
5404 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5405 if (!dit.inTexted()) {
5410 Paragraph const & par = dit.paragraph();
5411 pos_type const pos = dit.pos();
5413 // Copied and adapted from isWordSeparator() in Paragraph
5414 if (pos == dit.lastpos()) {
5417 Inset const * ins = par.getInset(pos);
5418 if (ins && skipNoOutput && !ins->producesOutput()) {
5421 // stop if end of range was skipped
5422 if (!to.atEnd() && dit >= to)
5425 } else if (!par.isDeleted(pos)) {
5426 if (par.isWordSeparator(pos))
5432 if (ins && ins->isLetter())
5434 else if (ins && ins->isSpace())
5437 char_type const c = par.getChar(pos);
5438 if (isPrintableNonspace(c))
5440 else if (isSpace(c))
5450 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5452 d->updateStatistics(from, to, skipNoOutput);
5456 int Buffer::wordCount() const
5458 return d->wordCount();
5462 int Buffer::charCount(bool with_blanks) const
5464 return d->charCount(with_blanks);
5468 Buffer::ReadStatus Buffer::reload()
5471 // c.f. bug https://www.lyx.org/trac/ticket/6587
5472 removeAutosaveFile();
5473 // e.g., read-only status could have changed due to version control
5474 d->filename.refresh();
5475 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5477 // clear parent. this will get reset if need be.
5479 ReadStatus const status = loadLyXFile();
5480 if (status == ReadSuccess) {
5485 message(bformat(_("Document %1$s reloaded."), disp_fn));
5488 message(bformat(_("Could not reload document %1$s."), disp_fn));
5498 bool Buffer::saveAs(FileName const & fn)
5500 FileName const old_name = fileName();
5501 FileName const old_auto = getAutosaveFileName();
5502 bool const old_unnamed = isUnnamed();
5503 bool success = true;
5504 d->old_position = filePath();
5511 // bring the autosave file with us, just in case.
5512 moveAutosaveFile(old_auto);
5513 // validate version control data and
5514 // correct buffer title
5515 lyxvc().file_found_hook(fileName());
5517 // the file has now been saved to the new location.
5518 // we need to check that the locations of child buffers
5520 checkChildBuffers();
5521 checkMasterBuffer();
5524 // reset the old filename and unnamed state
5525 setFileName(old_name);
5526 setUnnamed(old_unnamed);
5530 d->old_position.clear();
5535 void Buffer::checkChildBuffers()
5537 for (auto const & bit : d->children_positions) {
5538 DocIterator dit = bit.second;
5539 Buffer * cbuf = const_cast<Buffer *>(bit.first);
5540 if (!cbuf || !theBufferList().isLoaded(cbuf))
5542 Inset * inset = dit.nextInset();
5543 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5544 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5545 docstring const & incfile = inset_inc->getParam("filename");
5546 string oldloc = cbuf->absFileName();
5547 string newloc = makeAbsPath(to_utf8(incfile),
5548 onlyPath(absFileName())).absFileName();
5549 if (oldloc == newloc)
5551 // the location of the child file is incorrect.
5553 inset_inc->setChildBuffer(0);
5555 // invalidate cache of children
5556 d->children_positions.clear();
5557 d->position_to_children.clear();
5561 // If a child has been saved under a different name/path, it might have been
5562 // orphaned. Therefore the master needs to be reset (bug 8161).
5563 void Buffer::checkMasterBuffer()
5565 Buffer const * const master = masterBuffer();
5569 // necessary to re-register the child (bug 5873)
5570 // FIXME: clean up updateMacros (here, only
5571 // child registering is needed).
5572 master->updateMacros();
5573 // (re)set master as master buffer, but only
5574 // if we are a real child
5575 if (master->isChild(this))
5582 string Buffer::includedFilePath(string const & name, string const & ext) const
5584 if (d->old_position.empty() ||
5585 equivalent(FileName(d->old_position), FileName(filePath())))
5588 bool isabsolute = FileName::isAbsolute(name);
5589 // both old_position and filePath() end with a path separator
5590 string absname = isabsolute ? name : d->old_position + name;
5592 // if old_position is set to origin, we need to do the equivalent of
5593 // getReferencedFileName() (see readDocument())
5594 if (!isabsolute && d->old_position == params().origin) {
5595 FileName const test(addExtension(filePath() + name, ext));
5597 absname = filePath() + name;
5600 if (!FileName(addExtension(absname, ext)).exists())
5604 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5606 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5607 from_utf8(filePath())));
5611 void Buffer::setChangesPresent(bool b) const
5613 d->tracked_changes_present_ = b;
5617 bool Buffer::areChangesPresent() const
5619 return d->tracked_changes_present_;
5623 void Buffer::updateChangesPresent() const
5625 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5626 setChangesPresent(false);
5627 ParConstIterator it = par_iterator_begin();
5628 ParConstIterator const end = par_iterator_end();
5629 for (; !areChangesPresent() && it != end; ++it)
5630 it->addChangesToBuffer(*this);
5634 void Buffer::Impl::refreshFileMonitor()
5636 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5637 file_monitor_->refresh();
5641 // The previous file monitor is invalid
5642 // This also destroys the previous file monitor and all its connections
5643 file_monitor_ = FileSystemWatcher::monitor(filename);
5644 // file_monitor_ will be destroyed with *this, so it is not going to call a
5645 // destroyed object method.
5646 file_monitor_->connect([this](bool exists) {
5647 fileExternallyModified(exists);
5652 void Buffer::Impl::fileExternallyModified(bool const exists)
5654 // ignore notifications after our own saving operations
5655 if (checksum_ == filename.checksum()) {
5656 LYXERR(Debug::FILES, "External modification but "
5657 "checksum unchanged: " << filename);
5660 // If the file has been deleted, only mark the file as dirty since it is
5661 // pointless to prompt for reloading. If later a file is moved into this
5662 // location, then the externally modified warning will appear then.
5664 externally_modified_ = true;
5665 // Update external modification notification.
5666 // Dirty buffers must be visible at all times.
5667 if (wa_ && wa_->unhide(owner_))
5668 wa_->updateTitles();
5670 // Unable to unhide the buffer (e.g. no GUI or not current View)
5675 bool Buffer::notifiesExternalModification() const
5677 return d->externally_modified_;
5681 void Buffer::clearExternalModification() const
5683 d->externally_modified_ = false;
5685 d->wa_->updateTitles();