3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
49 #include "output_docbook.h"
51 #include "output_latex.h"
52 #include "output_xhtml.h"
53 #include "output_plaintext.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
72 #include "insets/InsetBibtex.h"
73 #include "insets/InsetBranch.h"
74 #include "insets/InsetInclude.h"
75 #include "insets/InsetTabular.h"
76 #include "insets/InsetText.h"
78 #include "mathed/InsetMathHull.h"
79 #include "mathed/MacroTable.h"
80 #include "mathed/InsetMathMacroTemplate.h"
81 #include "mathed/MathSupport.h"
83 #include "graphics/GraphicsCache.h"
84 #include "graphics/PreviewLoader.h"
86 #include "frontends/alert.h"
87 #include "frontends/Delegates.h"
88 #include "frontends/WorkAreaManager.h"
90 #include "support/lassert.h"
91 #include "support/convert.h"
92 #include "support/debug.h"
93 #include "support/docstring_list.h"
94 #include "support/ExceptionMessage.h"
95 #include "support/FileMonitor.h"
96 #include "support/FileName.h"
97 #include "support/FileNameList.h"
98 #include "support/filetools.h"
99 #include "support/ForkedCalls.h"
100 #include "support/gettext.h"
101 #include "support/gzstream.h"
102 #include "support/lstrings.h"
103 #include "support/lyxalgo.h"
104 #include "support/mutex.h"
105 #include "support/os.h"
106 #include "support/Package.h"
107 #include "support/PathChanger.h"
108 #include "support/Systemcall.h"
109 #include "support/TempFile.h"
110 #include "support/textutils.h"
111 #include "support/types.h"
113 #include "support/bind.h"
125 using namespace lyx::support;
126 using namespace lyx::graphics;
130 namespace Alert = frontend::Alert;
131 namespace os = support::os;
135 int const LYX_FORMAT = LYX_FORMAT_LYX;
137 typedef map<string, bool> DepClean;
139 // Information about labels and their associated refs
144 InsetLabel const * inset;
145 /// associated references cache
146 Buffer::References references;
147 /// whether this label is active (i.e., not deleted)
151 typedef vector<LabelInfo> LabelCache;
153 typedef map<docstring, Buffer::References> RefCache;
158 // A storehouse for the cloned buffers.
159 list<CloneList *> cloned_buffers;
165 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
169 delete preview_loader_;
177 /// search for macro in local (buffer) table or in children
178 MacroData const * getBufferMacro(docstring const & name,
179 DocIterator const & pos) const;
181 /// Update macro table starting with position of it \param it in some
183 void updateMacros(DocIterator & it, DocIterator & scope);
185 void setLabel(ParIterator & it, UpdateType utype) const;
187 /** If we have branches that use the file suffix
188 feature, return the file name with suffix appended.
190 support::FileName exportFileName() const;
197 mutable TexRow texrow;
199 /// need to regenerate .tex?
203 mutable bool lyx_clean;
205 /// is autosave needed?
206 mutable bool bak_clean;
208 /// is this an unnamed file (New...)?
211 /// is this an internal bufffer?
212 bool internal_buffer;
217 /// name of the file the buffer is associated with.
220 /** Set to true only when the file is fully loaded.
221 * Used to prevent the premature generation of previews
222 * and by the citation inset.
224 bool file_fully_loaded;
226 /// original format of loaded file
229 /// if the file was originally loaded from an older format, do
230 /// we need to back it up still?
231 bool need_format_backup;
233 /// Ignore the parent (e.g. when exporting a child standalone)?
237 mutable TocBackend toc_backend;
242 ScopeMacro(DocIterator const & s, MacroData const & m)
243 : scope(s), macro(m) {}
247 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
248 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
249 /// map from the macro name to the position map,
250 /// which maps the macro definition position to the scope and the MacroData.
251 NamePositionScopeMacroMap macros;
252 /// This seem to change the way Buffer::getMacro() works
253 mutable bool macro_lock;
255 /// positions of child buffers in the buffer
256 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
258 ScopeBuffer() : buffer(0) {}
259 ScopeBuffer(DocIterator const & s, Buffer const * b)
260 : scope(s), buffer(b) {}
262 Buffer const * buffer;
264 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
265 /// position of children buffers in this buffer
266 BufferPositionMap children_positions;
267 /// map from children inclusion positions to their scope and their buffer
268 PositionScopeBufferMap position_to_children;
270 /// Contains the old buffer filePath() while saving-as, or the
271 /// directory where the document was last saved while loading.
274 /** Keeps track of the path of local layout files.
275 * If possible, it is always relative to the buffer path.
276 * Empty for layouts in system or user directory.
278 string layout_position;
280 /// Container for all sort of Buffer dependant errors.
281 map<string, ErrorList> errorLists;
283 /// checksum used to test if the file has been externally modified. Used to
284 /// double check whether the file had been externally modified when saving.
285 unsigned long checksum_;
288 frontend::WorkAreaManager * wa_;
290 frontend::GuiBufferDelegate * gui_;
295 /// A cache for the bibfiles (including bibfiles of loaded child
296 /// documents), needed for appropriate update of natbib labels.
297 mutable docstring_list bibfiles_cache_;
299 // FIXME The caching mechanism could be improved. At present, we have a
300 // cache for each Buffer, that caches all the bibliography info for that
301 // Buffer. A more efficient solution would be to have a global cache per
302 // file, and then to construct the Buffer's bibinfo from that.
303 /// A cache for bibliography info
304 mutable BiblioInfo bibinfo_;
305 /// whether the bibinfo cache is valid
306 mutable bool bibinfo_cache_valid_;
307 /// whether the bibfile cache is valid
308 mutable bool bibfile_cache_valid_;
309 /// Cache of timestamps of .bib files
310 map<FileName, time_t> bibfile_status_;
311 /// Indicates whether the bibinfo has changed since the last time
312 /// we ran updateBuffer(), i.e., whether citation labels may need
314 mutable bool cite_labels_valid_;
315 /// Do we have a bibliography environment?
316 mutable bool have_bibitems_;
318 /// These two hold the file name and format, written to by
319 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
320 FileName preview_file_;
321 string preview_format_;
322 /// If there was an error when previewing, on the next preview we do
323 /// a fresh compile (e.g. in case the user installed a package that
327 /// Cache the references associated to a label and their positions
329 mutable RefCache ref_cache_;
330 /// Cache the label insets and their activity status.
331 mutable LabelCache label_cache_;
333 /// our Text that should be wrapped in an InsetText
337 PreviewLoader * preview_loader_;
339 /// This is here to force the test to be done whenever parent_buffer
341 Buffer const * parent() const
343 // ignore_parent temporarily "orphans" a buffer
344 // (e.g. if a child is compiled standalone)
347 // if parent_buffer is not loaded, then it has been unloaded,
348 // which means that parent_buffer is an invalid pointer. So we
349 // set it to null in that case.
350 // however, the BufferList doesn't know about cloned buffers, so
351 // they will always be regarded as unloaded. in that case, we hope
353 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
355 return parent_buffer;
359 void setParent(Buffer const * pb)
361 if (parent_buffer == pb)
364 if (!cloned_buffer_ && parent_buffer && pb)
365 LYXERR0("Warning: a buffer should not have two parents!");
367 if (!cloned_buffer_ && parent_buffer) {
368 parent_buffer->invalidateBibinfoCache();
372 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
373 /// This one is useful for preview detached in a thread.
374 Buffer const * cloned_buffer_;
376 CloneList * clone_list_;
377 /// are we in the process of exporting this buffer?
378 mutable bool doing_export;
380 /// compute statistics
381 /// \p from initial position
382 /// \p to points to the end position
383 void updateStatistics(DocIterator & from, DocIterator & to,
384 bool skipNoOutput = true);
385 /// statistics accessor functions
386 int wordCount() const
390 int charCount(bool with_blanks) const
393 + (with_blanks ? blank_count_ : 0);
396 // does the buffer contain tracked changes? (if so, we automatically
397 // display the review toolbar, for instance)
398 mutable bool tracked_changes_present_;
400 // Make sure the file monitor monitors the good file.
401 void refreshFileMonitor();
403 /// Notify or clear of external modification
404 void fileExternallyModified(bool exists);
406 /// has been externally modified? Can be reset by the user.
407 mutable bool externally_modified_;
410 /// So we can force access via the accessors.
411 mutable Buffer const * parent_buffer;
417 FileMonitorPtr file_monitor_;
421 /// Creates the per buffer temporary directory
422 static FileName createBufferTmpDir()
424 // FIXME This would be the ideal application for a TempDir class (like
425 // TempFile but for directories)
430 Mutex::Locker locker(&mutex);
431 counter = convert<string>(count++);
433 // We are in our own directory. Why bother to mangle name?
434 // In fact I wrote this code to circumvent a problematic behaviour
435 // (bug?) of EMX mkstemp().
436 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
439 if (!tmpfl.createDirectory(0777)) {
440 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
441 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
442 from_utf8(tmpfl.absFileName())));
448 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
449 Buffer const * cloned_buffer)
450 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
451 internal_buffer(false), read_only(readonly_), filename(file),
452 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
453 ignore_parent(false), toc_backend(owner), macro_lock(false),
454 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
455 bibfile_cache_valid_(false), cite_labels_valid_(false), have_bibitems_(false),
456 preview_error_(false), inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
457 clone_list_(0), doing_export(false),
458 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
459 word_count_(0), char_count_(0), blank_count_(0)
461 refreshFileMonitor();
462 if (!cloned_buffer_) {
463 temppath = createBufferTmpDir();
464 lyxvc.setBuffer(owner_);
466 wa_ = new frontend::WorkAreaManager;
469 temppath = cloned_buffer_->d->temppath;
470 file_fully_loaded = true;
471 params = cloned_buffer_->d->params;
472 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
473 bibinfo_ = cloned_buffer_->d->bibinfo_;
474 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
475 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
476 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
477 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
478 have_bibitems_ = cloned_buffer_->d->have_bibitems_;
479 unnamed = cloned_buffer_->d->unnamed;
480 internal_buffer = cloned_buffer_->d->internal_buffer;
481 layout_position = cloned_buffer_->d->layout_position;
482 preview_file_ = cloned_buffer_->d->preview_file_;
483 preview_format_ = cloned_buffer_->d->preview_format_;
484 preview_error_ = cloned_buffer_->d->preview_error_;
485 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
489 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
490 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
492 LYXERR(Debug::INFO, "Buffer::Buffer()");
494 d->inset = new InsetText(*cloned_buffer->d->inset);
495 d->inset->setBuffer(*this);
496 // FIXME: optimize this loop somewhat, maybe by creating a new
497 // general recursive Inset::setId().
498 DocIterator it = doc_iterator_begin(this);
499 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
500 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
501 it.paragraph().setId(cloned_it.paragraph().id());
503 d->inset = new InsetText(this);
504 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
510 LYXERR(Debug::INFO, "Buffer::~Buffer()");
511 // here the buffer should take care that it is
512 // saved properly, before it goes into the void.
514 // GuiView already destroyed
518 // No need to do additional cleanups for internal buffer.
524 // this is in case of recursive includes: we won't try to delete
525 // ourselves as a child.
526 d->clone_list_->erase(this);
527 // loop over children
528 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
529 Impl::BufferPositionMap::iterator end = d->children_positions.end();
530 for (; it != end; ++it) {
531 Buffer * child = const_cast<Buffer *>(it->first);
532 if (d->clone_list_->erase(child))
535 // if we're the master buffer, then we should get rid of the list
538 // If this is not empty, we have leaked something. Worse, one of the
539 // children still has a reference to this list. But we will try to
540 // continue, rather than shut down.
541 LATTEST(d->clone_list_->empty());
542 list<CloneList *>::iterator it =
543 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
544 if (it == cloned_buffers.end()) {
545 // We will leak in this case, but it is safe to continue.
548 cloned_buffers.erase(it);
549 delete d->clone_list_;
551 // FIXME Do we really need to do this right before we delete d?
552 // clear references to children in macro tables
553 d->children_positions.clear();
554 d->position_to_children.clear();
556 // loop over children
557 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
558 Impl::BufferPositionMap::iterator end = d->children_positions.end();
559 for (; it != end; ++it) {
560 Buffer * child = const_cast<Buffer *>(it->first);
561 if (theBufferList().isLoaded(child)) {
562 if (theBufferList().isOthersChild(this, child))
565 theBufferList().release(child);
570 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
572 msg += emergencyWrite();
574 msg += " " + _("Save failed! Document is lost.");
576 Alert::warning(_("Attempting to close changed document!"), msg);
579 // FIXME Do we really need to do this right before we delete d?
580 // clear references to children in macro tables
581 d->children_positions.clear();
582 d->position_to_children.clear();
584 if (!d->temppath.destroyDirectory()) {
585 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
586 from_utf8(d->temppath.absFileName())));
595 Buffer * Buffer::cloneWithChildren() const
598 cloned_buffers.push_back(new CloneList);
599 CloneList * clones = cloned_buffers.back();
601 cloneWithChildren(bufmap, clones);
603 // make sure we got cloned
604 BufferMap::const_iterator bit = bufmap.find(this);
605 LASSERT(bit != bufmap.end(), return 0);
606 Buffer * cloned_buffer = bit->second;
608 return cloned_buffer;
612 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
614 // have we already been cloned?
615 if (bufmap.find(this) != bufmap.end())
618 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
620 // The clone needs its own DocumentClass, since running updateBuffer() will
621 // modify it, and we would otherwise be sharing it with the original Buffer.
622 buffer_clone->params().makeDocumentClass(true);
624 cap::switchBetweenClasses(
625 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
626 static_cast<InsetText &>(buffer_clone->inset()), el);
628 bufmap[this] = buffer_clone;
629 clones->insert(buffer_clone);
630 buffer_clone->d->clone_list_ = clones;
631 buffer_clone->d->macro_lock = true;
632 buffer_clone->d->children_positions.clear();
634 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
635 // math macro caches need to be rethought and simplified.
636 // I am not sure wether we should handle Buffer cloning here or in BufferList.
637 // Right now BufferList knows nothing about buffer clones.
638 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
639 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
640 for (; it != end; ++it) {
641 DocIterator dit = it->first.clone(buffer_clone);
642 dit.setBuffer(buffer_clone);
643 Buffer * child = const_cast<Buffer *>(it->second.buffer);
645 child->cloneWithChildren(bufmap, clones);
646 BufferMap::iterator const bit = bufmap.find(child);
647 LASSERT(bit != bufmap.end(), continue);
648 Buffer * child_clone = bit->second;
650 Inset * inset = dit.nextInset();
651 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
652 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
653 inset_inc->setChildBuffer(child_clone);
654 child_clone->d->setParent(buffer_clone);
655 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
656 buffer_clone->setChild(dit, child_clone);
658 buffer_clone->d->macro_lock = false;
663 Buffer * Buffer::cloneBufferOnly() const {
664 cloned_buffers.push_back(new CloneList);
665 CloneList * clones = cloned_buffers.back();
666 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
668 // The clone needs its own DocumentClass, since running updateBuffer() will
669 // modify it, and we would otherwise be sharing it with the original Buffer.
670 buffer_clone->params().makeDocumentClass(true);
672 cap::switchBetweenClasses(
673 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
674 static_cast<InsetText &>(buffer_clone->inset()), el);
676 clones->insert(buffer_clone);
677 buffer_clone->d->clone_list_ = clones;
679 // we won't be cloning the children
680 buffer_clone->d->children_positions.clear();
685 bool Buffer::isClone() const
687 return d->cloned_buffer_;
691 void Buffer::changed(bool update_metrics) const
694 d->wa_->redrawAll(update_metrics);
698 frontend::WorkAreaManager & Buffer::workAreaManager() const
705 Text & Buffer::text() const
707 return d->inset->text();
711 Inset & Buffer::inset() const
717 BufferParams & Buffer::params()
723 BufferParams const & Buffer::params() const
729 BufferParams const & Buffer::masterParams() const
731 if (masterBuffer() == this)
734 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
735 // Copy child authors to the params. We need those pointers.
736 AuthorList const & child_authors = params().authors();
737 AuthorList::Authors::const_iterator it = child_authors.begin();
738 for (; it != child_authors.end(); ++it)
739 mparams.authors().record(*it);
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().paperwidth.erase();
925 params().paperheight.erase();
926 params().leftmargin.erase();
927 params().rightmargin.erase();
928 params().topmargin.erase();
929 params().bottommargin.erase();
930 params().headheight.erase();
931 params().headsep.erase();
932 params().footskip.erase();
933 params().columnsep.erase();
934 params().fonts_cjk.erase();
935 params().listings_params.clear();
936 params().clearLayoutModules();
937 params().clearRemovedModules();
938 params().clearIncludedChildren();
939 params().pdfoptions().clear();
940 params().indiceslist().clear();
941 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
942 params().isbackgroundcolor = false;
943 params().fontcolor = RGBColor(0, 0, 0);
944 params().isfontcolor = false;
945 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
946 params().boxbgcolor = RGBColor(0xFF, 0, 0);
947 params().html_latex_start.clear();
948 params().html_latex_end.clear();
949 params().html_math_img_scale = 1.0;
950 params().output_sync_macro.erase();
951 params().setLocalLayout(docstring(), false);
952 params().setLocalLayout(docstring(), true);
953 params().biblio_opts.erase();
954 params().biblatex_bibstyle.erase();
955 params().biblatex_citestyle.erase();
956 params().multibib.erase();
958 for (int i = 0; i < 4; ++i) {
959 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
960 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
963 ErrorList & errorList = d->errorLists["Parse"];
972 if (token == "\\end_header")
976 if (token == "\\begin_header") {
977 begin_header_line = line;
981 LYXERR(Debug::PARSER, "Handling document header token: `"
984 string const result =
985 params().readToken(lex, token, d->filename.onlyPath());
986 if (!result.empty()) {
987 if (token == "\\textclass") {
988 d->layout_position = result;
991 docstring const s = bformat(_("Unknown token: "
995 errorList.push_back(ErrorItem(_("Document header error"), s));
999 if (begin_header_line) {
1000 docstring const s = _("\\begin_header is missing");
1001 errorList.push_back(ErrorItem(_("Document header error"), s));
1004 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
1006 params().makeDocumentClass();
1008 return unknown_tokens;
1013 // changed to be public and have one parameter
1014 // Returns true if "\end_document" is not read (Asger)
1015 bool Buffer::readDocument(Lexer & lex)
1017 ErrorList & errorList = d->errorLists["Parse"];
1020 // remove dummy empty par
1021 paragraphs().clear();
1023 if (!lex.checkFor("\\begin_document")) {
1024 docstring const s = _("\\begin_document is missing");
1025 errorList.push_back(ErrorItem(_("Document header error"), s));
1030 if (params().output_changes) {
1031 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1032 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1033 LaTeXFeatures::isAvailable("xcolor");
1035 if (!dvipost && !xcolorulem) {
1036 Alert::warning(_("Changes not shown in LaTeX output"),
1037 _("Changes will not be highlighted in LaTeX output, "
1038 "because neither dvipost nor xcolor/ulem are installed.\n"
1039 "Please install these packages or redefine "
1040 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1041 } else if (!xcolorulem) {
1042 Alert::warning(_("Changes not shown in LaTeX output"),
1043 _("Changes will not be highlighted in LaTeX output "
1044 "when using pdflatex, because xcolor and ulem are not installed.\n"
1045 "Please install both packages or redefine "
1046 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1050 if (!parent() && !params().master.empty()) {
1051 FileName const master_file = makeAbsPath(params().master,
1052 onlyPath(absFileName()));
1053 if (isLyXFileName(master_file.absFileName())) {
1055 checkAndLoadLyXFile(master_file, true);
1057 // necessary e.g. after a reload
1058 // to re-register the child (bug 5873)
1059 // FIXME: clean up updateMacros (here, only
1060 // child registering is needed).
1061 master->updateMacros();
1062 // set master as master buffer, but only
1063 // if we are a real child
1064 if (master->isChild(this))
1066 // if the master is not fully loaded
1067 // it is probably just loading this
1068 // child. No warning needed then.
1069 else if (master->isFullyLoaded())
1070 LYXERR0("The master '"
1072 << "' assigned to this document ("
1074 << ") does not include "
1075 "this document. Ignoring the master assignment.");
1076 // If the master has just been created, un-hide it (#11162)
1077 if (!master->fileName().exists())
1078 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
1079 master->absFileName()));
1084 // assure we have a default index
1085 params().indiceslist().addDefault(B_("Index"));
1088 if (FileName::isAbsolute(params().origin))
1089 d->old_position = params().origin;
1091 d->old_position = filePath();
1092 bool const res = text().read(lex, errorList, d->inset);
1093 d->old_position.clear();
1095 // inform parent buffer about local macros
1097 Buffer const * pbuf = parent();
1098 UserMacroSet::const_iterator cit = usermacros.begin();
1099 UserMacroSet::const_iterator end = usermacros.end();
1100 for (; cit != end; ++cit)
1101 pbuf->usermacros.insert(*cit);
1105 updateMacroInstances(InternalUpdate);
1110 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1112 Format const * fmt = theFormats().getFormat(format);
1115 // It is important to use the correct extension here, since some
1116 // converters create a wrong output file otherwise (e.g. html2latex)
1117 FileName const name = tempFileName("Buffer_importStringXXXXXX." + fmt->extension());
1118 ofdocstream os(name.toFilesystemEncoding().c_str());
1119 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1120 bool const success = !(os << contents).fail();
1123 bool converted = false;
1125 params().compressed = false;
1127 // remove dummy empty par
1128 paragraphs().clear();
1130 converted = importFile(format, name, errorList);
1133 removeTempFile(name);
1138 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1140 if (!theConverters().isReachable(format, "lyx"))
1143 FileName const lyx = tempFileName("Buffer_importFileXXXXXX.lyx");
1144 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList)) {
1145 bool const success = readFile(lyx) == ReadSuccess;
1146 removeTempFile(lyx);
1154 bool Buffer::readString(string const & s)
1156 params().compressed = false;
1159 istringstream is(s);
1161 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1162 FileName const fn = tempfile.name();
1165 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1167 if (success && file_format != LYX_FORMAT) {
1168 // We need to call lyx2lyx, so write the input to a file
1169 ofstream os(fn.toFilesystemEncoding().c_str());
1172 // lyxvc in readFile
1173 if (readFile(fn) != ReadSuccess)
1177 if (readDocument(lex))
1183 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1187 if (!lex.setFile(fname)) {
1188 Alert::error(_("File Not Found"),
1189 bformat(_("Unable to open file `%1$s'."),
1190 from_utf8(fn.absFileName())));
1191 return ReadFileNotFound;
1195 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1196 if (ret_plf != ReadSuccess)
1199 if (file_format != LYX_FORMAT) {
1201 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1202 if (ret_clf != ReadSuccess)
1204 ret_clf = readFile(tmpFile);
1205 if (ret_clf == ReadSuccess) {
1206 d->file_format = file_format;
1207 d->need_format_backup = true;
1212 // FIXME: InsetInfo needs to know whether the file is under VCS
1213 // during the parse process, so this has to be done before.
1214 lyxvc().file_found_hook(d->filename);
1216 if (readDocument(lex)) {
1217 Alert::error(_("Document format failure"),
1218 bformat(_("%1$s ended unexpectedly, which means"
1219 " that it is probably corrupted."),
1220 from_utf8(fn.absFileName())));
1221 return ReadDocumentFailure;
1224 d->file_fully_loaded = true;
1225 d->read_only = !d->filename.isWritable();
1226 params().compressed = theFormats().isZippedFile(d->filename);
1232 bool Buffer::isFullyLoaded() const
1234 return d->file_fully_loaded;
1238 void Buffer::setFullyLoaded(bool value)
1240 d->file_fully_loaded = value;
1244 bool Buffer::lastPreviewError() const
1246 return d->preview_error_;
1250 PreviewLoader * Buffer::loader() const
1252 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1254 if (!d->preview_loader_)
1255 d->preview_loader_ = new PreviewLoader(*this);
1256 return d->preview_loader_;
1260 void Buffer::removePreviews() const
1262 delete d->preview_loader_;
1263 d->preview_loader_ = 0;
1267 void Buffer::updatePreviews() const
1269 PreviewLoader * ploader = loader();
1273 InsetIterator it = inset_iterator_begin(*d->inset);
1274 InsetIterator const end = inset_iterator_end(*d->inset);
1275 for (; it != end; ++it)
1276 it->addPreview(it, *ploader);
1278 ploader->startLoading();
1282 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1283 FileName const & fn, int & file_format) const
1285 if(!lex.checkFor("\\lyxformat")) {
1286 Alert::error(_("Document format failure"),
1287 bformat(_("%1$s is not a readable LyX document."),
1288 from_utf8(fn.absFileName())));
1289 return ReadNoLyXFormat;
1295 // LyX formats 217 and earlier were written as 2.17. This corresponds
1296 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1297 // these cases. See also: www.lyx.org/trac/changeset/1313.
1298 size_t dot = tmp_format.find_first_of(".,");
1299 if (dot != string::npos)
1300 tmp_format.erase(dot, 1);
1302 file_format = convert<int>(tmp_format);
1307 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1308 FileName & tmpfile, int from_format)
1310 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1311 tempfile.setAutoRemove(false);
1312 tmpfile = tempfile.name();
1313 if(tmpfile.empty()) {
1314 Alert::error(_("Conversion failed"),
1315 bformat(_("%1$s is from a different"
1316 " version of LyX, but a temporary"
1317 " file for converting it could"
1318 " not be created."),
1319 from_utf8(fn.absFileName())));
1320 return LyX2LyXNoTempFile;
1323 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1324 if (lyx2lyx.empty()) {
1325 Alert::error(_("Conversion script not found"),
1326 bformat(_("%1$s is from a different"
1327 " version of LyX, but the"
1328 " conversion script lyx2lyx"
1329 " could not be found."),
1330 from_utf8(fn.absFileName())));
1331 return LyX2LyXNotFound;
1335 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1336 ostringstream command;
1337 command << os::python()
1338 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1339 << " -t " << convert<string>(LYX_FORMAT)
1340 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1341 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1342 string const command_str = command.str();
1344 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1346 cmd_ret const ret = runCommand(command_str);
1347 if (ret.first != 0) {
1348 if (from_format < LYX_FORMAT) {
1349 Alert::error(_("Conversion script failed"),
1350 bformat(_("%1$s is from an older version"
1351 " of LyX and the lyx2lyx script"
1352 " failed to convert it."),
1353 from_utf8(fn.absFileName())));
1354 return LyX2LyXOlderFormat;
1356 Alert::error(_("Conversion script failed"),
1357 bformat(_("%1$s is from a newer version"
1358 " of LyX and the lyx2lyx script"
1359 " failed to convert it."),
1360 from_utf8(fn.absFileName())));
1361 return LyX2LyXNewerFormat;
1368 FileName Buffer::getBackupName() const {
1369 FileName const & fn = fileName();
1370 string const fname = fn.onlyFileNameWithoutExt();
1371 string const fext = fn.extension() + "~";
1372 string const fpath = lyxrc.backupdir_path.empty() ?
1373 fn.onlyPath().absFileName() :
1374 lyxrc.backupdir_path;
1375 string const fform = convert<string>(d->file_format);
1376 string const backname = fname + "-lyxformat-" + fform;
1377 FileName backup(addName(fpath, addExtension(backname, fext)));
1379 // limit recursion, just in case
1381 unsigned long orig_checksum = 0;
1382 while (backup.exists() && v < 100) {
1383 if (orig_checksum == 0)
1384 orig_checksum = fn.checksum();
1385 unsigned long new_checksum = backup.checksum();
1386 if (orig_checksum == new_checksum) {
1387 LYXERR(Debug::FILES, "Not backing up " << fn <<
1388 "since " << backup << "has the same checksum.");
1389 // a bit of a hack, but we have to check this anyway
1390 // below, and setting this is simpler than introducing
1391 // a special boolean for this purpose.
1395 string const newbackname = backname + "-" + convert<string>(v);
1396 backup.set(addName(fpath, addExtension(newbackname, fext)));
1399 return v < 100 ? backup : FileName();
1403 // Should probably be moved to somewhere else: BufferView? GuiView?
1404 bool Buffer::save() const
1406 docstring const file = makeDisplayPath(absFileName(), 20);
1407 d->filename.refresh();
1409 // check the read-only status before moving the file as a backup
1410 if (d->filename.exists()) {
1411 bool const read_only = !d->filename.isWritable();
1413 Alert::warning(_("File is read-only"),
1414 bformat(_("The file %1$s cannot be written because it "
1415 "is marked as read-only."), file));
1420 // ask if the disk file has been externally modified (use checksum method)
1421 if (fileName().exists() && isChecksumModified()) {
1423 bformat(_("Document %1$s has been externally modified. "
1424 "Are you sure you want to overwrite this file?"), file);
1425 int const ret = Alert::prompt(_("Overwrite modified file?"),
1426 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1431 // We don't need autosaves in the immediate future. (Asger)
1432 resetAutosaveTimers();
1434 // if the file does not yet exist, none of the backup activity
1435 // that follows is necessary
1436 if (!fileName().exists()) {
1437 if (!writeFile(fileName()))
1443 // we first write the file to a new name, then move it to its
1444 // proper location once that has been done successfully. that
1445 // way we preserve the original file if something goes wrong.
1446 string const justname = fileName().onlyFileNameWithoutExt();
1447 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1448 justname + "-XXXXXX.lyx");
1449 bool const symlink = fileName().isSymLink();
1451 tempfile->setAutoRemove(false);
1453 FileName savefile(tempfile->name());
1454 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1455 if (!savefile.clonePermissions(fileName()))
1456 LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
1458 if (!writeFile(savefile))
1461 // we will set this to false if we fail
1462 bool made_backup = true;
1464 FileName backupName;
1465 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1467 if (d->need_format_backup)
1468 backupName = getBackupName();
1470 // If we for some reason failed to find a backup name in case of
1471 // a format change, this will still set one. It's the best we can
1473 if (backupName.empty()) {
1474 backupName.set(fileName().absFileName() + "~");
1475 if (!lyxrc.backupdir_path.empty()) {
1476 string const mangledName =
1477 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1478 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1482 LYXERR(Debug::FILES, "Backing up original file to " <<
1483 backupName.absFileName());
1484 // Except file is symlink do not copy because of #6587.
1485 // Hard links have bad luck.
1486 made_backup = symlink ?
1487 fileName().copyTo(backupName):
1488 fileName().moveTo(backupName);
1491 Alert::error(_("Backup failure"),
1492 bformat(_("Cannot create backup file %1$s.\n"
1493 "Please check whether the directory exists and is writable."),
1494 from_utf8(backupName.absFileName())));
1495 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1496 } else if (d->need_format_backup) {
1497 // the original file has been backed up successfully, so we
1498 // will not need to do that again
1499 d->need_format_backup = false;
1503 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1504 // Only do this if tempfile is not in autoremove mode
1507 // If we have no symlink, we can simply rename the temp file.
1508 // Otherwise, we need to copy it so the symlink stays intact.
1509 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1510 savefile.moveTo(fileName()))
1512 // saveCheckSum() was already called by writeFile(), but the
1513 // time stamp is invalidated by copying/moving
1516 if (d->file_format != LYX_FORMAT)
1517 // the file associated with this buffer is now in the current format
1518 d->file_format = LYX_FORMAT;
1521 // else we saved the file, but failed to move it to the right location.
1523 if (needBackup && made_backup && !symlink) {
1524 // the original file was moved to some new location, so it will look
1525 // to the user as if it was deleted. (see bug #9234.) we could try
1526 // to restore it, but that would basically mean trying to do again
1527 // what we just failed to do. better to leave things as they are.
1528 Alert::error(_("Write failure"),
1529 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1530 "But LyX could not move it to:\n %2$s.\n"
1531 "Your original file has been backed up to:\n %3$s"),
1532 from_utf8(savefile.absFileName()),
1533 from_utf8(fileName().absFileName()),
1534 from_utf8(backupName.absFileName())));
1536 // either we did not try to make a backup, or else we tried and failed,
1537 // or else the original file was a symlink, in which case it was copied,
1538 // not moved. so the original file is intact.
1539 Alert::error(_("Write failure"),
1540 bformat(_("Cannot move saved file to:\n %1$s.\n"
1541 "But the file has successfully been saved as:\n %2$s."),
1542 from_utf8(fileName().absFileName()),
1543 from_utf8(savefile.absFileName())));
1549 bool Buffer::writeFile(FileName const & fname) const
1551 if (d->read_only && fname == d->filename)
1554 bool retval = false;
1556 docstring const str = bformat(_("Saving document %1$s..."),
1557 makeDisplayPath(fname.absFileName()));
1560 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1562 if (params().compressed) {
1563 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1564 retval = ofs && write(ofs);
1566 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1567 retval = ofs && write(ofs);
1571 message(str + _(" could not write file!"));
1576 // removeAutosaveFile();
1579 message(str + _(" done."));
1585 docstring Buffer::emergencyWrite()
1587 // No need to save if the buffer has not changed.
1591 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1593 docstring user_message = bformat(
1594 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1596 // We try to save three places:
1597 // 1) Same place as document. Unless it is an unnamed doc.
1599 string s = absFileName();
1602 if (writeFile(FileName(s))) {
1604 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1605 return user_message;
1607 user_message += " " + _("Save failed! Trying again...\n");
1611 // 2) In HOME directory.
1612 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1614 lyxerr << ' ' << s << endl;
1615 if (writeFile(FileName(s))) {
1617 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1618 return user_message;
1621 user_message += " " + _("Save failed! Trying yet again...\n");
1623 // 3) In "/tmp" directory.
1624 // MakeAbsPath to prepend the current
1625 // drive letter on OS/2
1626 s = addName(package().temp_dir().absFileName(), absFileName());
1628 lyxerr << ' ' << s << endl;
1629 if (writeFile(FileName(s))) {
1631 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1632 return user_message;
1635 user_message += " " + _("Save failed! Document is lost.");
1638 return user_message;
1642 bool Buffer::write(ostream & ofs) const
1645 // Use the standard "C" locale for file output.
1646 ofs.imbue(locale::classic());
1649 // The top of the file should not be written by params().
1651 // write out a comment in the top of the file
1652 // Important: Keep the version formatting in sync with lyx2lyx and
1653 // tex2lyx (bug 7951)
1654 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1655 << " created this file. For more info see http://www.lyx.org/\n"
1656 << "\\lyxformat " << LYX_FORMAT << "\n"
1657 << "\\begin_document\n";
1659 /// For each author, set 'used' to true if there is a change
1660 /// by this author in the document; otherwise set it to 'false'.
1661 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1662 AuthorList::Authors::const_iterator a_end = params().authors().end();
1663 for (; a_it != a_end; ++a_it)
1664 a_it->setUsed(false);
1666 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1667 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1668 for ( ; it != end; ++it)
1669 it->checkAuthors(params().authors());
1671 // now write out the buffer parameters.
1672 ofs << "\\begin_header\n";
1673 params().writeFile(ofs, this);
1674 ofs << "\\end_header\n";
1677 ofs << "\n\\begin_body\n";
1679 ofs << "\n\\end_body\n";
1681 // Write marker that shows file is complete
1682 ofs << "\\end_document" << endl;
1684 // Shouldn't really be needed....
1687 // how to check if close went ok?
1688 // Following is an attempt... (BE 20001011)
1690 // good() returns false if any error occurred, including some
1691 // formatting error.
1692 // bad() returns true if something bad happened in the buffer,
1693 // which should include file system full errors.
1698 lyxerr << "File was not closed properly." << endl;
1705 bool Buffer::makeLaTeXFile(FileName const & fname,
1706 string const & original_path,
1707 OutputParams const & runparams_in,
1708 OutputWhat output) const
1710 OutputParams runparams = runparams_in;
1712 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1713 // Check here, because the "flavor" is not known in BufferParams::encoding()
1714 // (power users can override this safety measure selecting "utf8-plain").
1715 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1716 && (runparams.encoding->name() != "utf8-plain"))
1717 runparams.encoding = encodings.fromLyXName("ascii");
1719 string const encoding = runparams.encoding->iconvName();
1720 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1723 try { ofs.reset(encoding); }
1724 catch (iconv_codecvt_facet_exception const & e) {
1725 lyxerr << "Caught iconv exception: " << e.what() << endl;
1726 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1727 "verify that the support software for your encoding (%1$s) is "
1728 "properly installed"), from_ascii(encoding)));
1731 if (!openFileWrite(ofs, fname))
1734 ErrorList & errorList = d->errorLists["Export"];
1736 bool failed_export = false;
1739 // make sure we are ready to export
1740 // this needs to be done before we validate
1741 // FIXME Do we need to do this all the time? I.e., in children
1742 // of a master we are exporting?
1744 updateMacroInstances(OutputUpdate);
1747 writeLaTeXSource(os, original_path, runparams, output);
1749 catch (EncodingException const & e) {
1750 docstring const failed(1, e.failed_char);
1752 oss << "0x" << hex << e.failed_char << dec;
1753 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1754 " (code point %2$s)"),
1755 failed, from_utf8(oss.str()));
1756 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1757 "representable in the chosen encoding.\n"
1758 "Changing the document encoding to utf8 could help."),
1759 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1760 failed_export = true;
1762 catch (iconv_codecvt_facet_exception const & e) {
1763 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1765 failed_export = true;
1767 catch (exception const & e) {
1768 errorList.push_back(ErrorItem(_("conversion failed"),
1770 lyxerr << e.what() << endl;
1771 failed_export = true;
1774 lyxerr << "Caught some really weird exception..." << endl;
1778 d->texrow = move(os.texrow());
1782 failed_export = true;
1783 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1786 if (runparams_in.silent)
1790 return !failed_export;
1794 void Buffer::writeLaTeXSource(otexstream & os,
1795 string const & original_path,
1796 OutputParams const & runparams_in,
1797 OutputWhat output) const
1799 // The child documents, if any, shall be already loaded at this point.
1801 OutputParams runparams = runparams_in;
1803 // XeTeX with TeX fonts is only safe with ASCII encoding,
1804 // Check here, because the "flavor" is not known in BufferParams::encoding()
1805 // (power users can override this safety measure selecting "utf8-plain").
1806 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1807 && (runparams.encoding->name() != "utf8-plain"))
1808 runparams.encoding = encodings.fromLyXName("ascii");
1809 // FIXME: when only the current paragraph is shown, this is ignored
1810 // (or not reached) and characters encodable in the current
1811 // encoding are not converted to ASCII-representation.
1813 // If we are compiling a file standalone, even if this is the
1814 // child of some other buffer, let's cut the link here, so the
1815 // file is really independent and no concurring settings from
1816 // the master (e.g. branch state) interfere (see #8100).
1817 if (!runparams.is_child)
1818 d->ignore_parent = true;
1820 // Classify the unicode characters appearing in math insets
1821 BufferEncodings::initUnicodeMath(*this);
1823 // validate the buffer.
1824 LYXERR(Debug::LATEX, " Validating buffer...");
1825 LaTeXFeatures features(*this, params(), runparams);
1827 // This is only set once per document (in master)
1828 if (!runparams.is_child) {
1829 runparams.use_polyglossia = features.usePolyglossia();
1830 runparams.use_hyperref = features.isRequired("hyperref");
1832 LYXERR(Debug::LATEX, " Buffer validation done.");
1834 bool const output_preamble =
1835 output == FullSource || output == OnlyPreamble;
1836 bool const output_body =
1837 output == FullSource || output == OnlyBody;
1839 // The starting paragraph of the coming rows is the
1840 // first paragraph of the document. (Asger)
1841 if (output_preamble && runparams.nice) {
1842 os << "%% LyX " << lyx_version << " created this file. "
1843 "For more info, see http://www.lyx.org/.\n"
1844 "%% Do not edit unless you really know what "
1847 LYXERR(Debug::INFO, "lyx document header finished");
1849 // There are a few differences between nice LaTeX and usual files:
1850 // usual files have \batchmode and special input@path to allow
1851 // inclusion of figures specified by an explicitly relative path
1852 // (i.e., a path starting with './' or '../') with either \input or
1853 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1854 // input@path is set when the actual parameter original_path is set.
1855 // This is done for usual tex-file, but not for nice-latex-file.
1856 // (Matthias 250696)
1857 // Note that input@path is only needed for something the user does
1858 // in the preamble, included .tex files or ERT, files included by
1859 // LyX work without it.
1860 if (output_preamble) {
1861 if (!runparams.nice) {
1862 // code for usual, NOT nice-latex-file
1863 os << "\\batchmode\n"; // changed from \nonstopmode
1865 if (!original_path.empty()) {
1867 // We don't know the encoding of inputpath
1868 docstring const inputpath = from_utf8(original_path);
1869 docstring uncodable_glyphs;
1870 Encoding const * const enc = runparams.encoding;
1872 for (size_t n = 0; n < inputpath.size(); ++n) {
1873 if (!enc->encodable(inputpath[n])) {
1874 docstring const glyph(1, inputpath[n]);
1875 LYXERR0("Uncodable character '"
1877 << "' in input path!");
1878 uncodable_glyphs += glyph;
1883 // warn user if we found uncodable glyphs.
1884 if (!uncodable_glyphs.empty()) {
1885 frontend::Alert::warning(
1886 _("Uncodable character in file path"),
1888 _("The path of your document\n"
1890 "contains glyphs that are unknown "
1891 "in the current document encoding "
1892 "(namely %2$s). This may result in "
1893 "incomplete output, unless "
1894 "TEXINPUTS contains the document "
1895 "directory and you don't use "
1896 "explicitly relative paths (i.e., "
1897 "paths starting with './' or "
1898 "'../') in the preamble or in ERT."
1899 "\n\nIn case of problems, choose "
1900 "an appropriate document encoding\n"
1901 "(such as utf8) or change the "
1903 inputpath, uncodable_glyphs));
1905 string docdir = os::latex_path(original_path);
1906 if (contains(docdir, '#')) {
1907 docdir = subst(docdir, "#", "\\#");
1908 os << "\\catcode`\\#=11"
1909 "\\def\\#{#}\\catcode`\\#=6\n";
1911 if (contains(docdir, '%')) {
1912 docdir = subst(docdir, "%", "\\%");
1913 os << "\\catcode`\\%=11"
1914 "\\def\\%{%}\\catcode`\\%=14\n";
1916 if (contains(docdir, '~'))
1917 docdir = subst(docdir, "~", "\\string~");
1918 bool const nonascii = !isAscii(from_utf8(docdir));
1919 // LaTeX 2019/10/01 handles non-ascii path without detokenize
1920 bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
1921 bool const detokenize = !utfpathlatex && nonascii;
1922 bool const quote = contains(docdir, ' ');
1923 if (utfpathlatex && nonascii)
1924 os << "\\UseRawInputEncoding\n";
1925 os << "\\makeatletter\n"
1926 << "\\def\\input@path{{";
1928 os << "\\detokenize{";
1937 << "\\makeatother\n";
1941 // get parent macros (if this buffer has a parent) which will be
1942 // written at the document begin further down.
1943 MacroSet parentMacros;
1944 listParentMacros(parentMacros, features);
1946 // Write the preamble
1947 runparams.use_babel = params().writeLaTeX(os, features,
1948 d->filename.onlyPath());
1950 // Biblatex bibliographies are loaded here
1951 if (params().useBiblatex()) {
1952 vector<docstring> const bibfiles =
1953 prepareBibFilePaths(runparams, getBibfiles(), true);
1954 for (docstring const & file: bibfiles)
1955 os << "\\addbibresource{" << file << "}\n";
1958 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1959 && !features.hasOnlyPolyglossiaLanguages()) {
1962 vector<string> bll = features.getBabelExclusiveLanguages();
1963 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1966 for (vector<string>::const_iterator it = bll.begin(); it != bll.end(); ++it) {
1971 blangs = bll.size() > 1 ?
1972 support::bformat(_("The languages %1$s are only supported by Babel."), langs)
1973 : support::bformat(_("The language %1$s is only supported by Babel."), langs);
1977 for (vector<string>::const_iterator it = pll.begin(); it != pll.end(); ++it) {
1982 plangs = pll.size() > 1 ?
1983 support::bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
1984 : support::bformat(_("The language %1$s is only supported by Polyglossia."), langs);
1985 if (!blangs.empty())
1989 frontend::Alert::warning(
1990 _("Incompatible Languages!"),
1992 _("You cannot use the following languages "
1993 "together in one LaTeX document because "
1994 "they require conflicting language packages:\n"
1999 // Japanese might be required only in some children of a document,
2000 // but once required, we must keep use_japanese true.
2001 runparams.use_japanese |= features.isRequired("japanese");
2004 // Restore the parenthood if needed
2005 if (!runparams.is_child)
2006 d->ignore_parent = false;
2011 // mark the beginning of the body to separate it from InPreamble insets
2012 os.texrow().start(TexRow::beginDocument());
2013 os << "\\begin{document}\n";
2015 // mark the start of a new paragraph by simulating a newline,
2016 // so that os.afterParbreak() returns true at document start
2019 // output the parent macros
2020 MacroSet::iterator it = parentMacros.begin();
2021 MacroSet::iterator end = parentMacros.end();
2022 for (; it != end; ++it) {
2023 int num_lines = (*it)->write(os.os(), true);
2024 os.texrow().newlines(num_lines);
2027 } // output_preamble
2029 LYXERR(Debug::INFO, "preamble finished, now the body.");
2032 latexParagraphs(*this, text(), os, runparams);
2034 // Restore the parenthood if needed
2035 if (!runparams.is_child)
2036 d->ignore_parent = false;
2038 // add this just in case after all the paragraphs
2041 if (output_preamble) {
2042 os << "\\end{document}\n";
2043 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
2045 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2047 runparams_in.encoding = runparams.encoding;
2049 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2050 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2054 void Buffer::makeDocBookFile(FileName const & fname,
2055 OutputParams const & runparams,
2056 OutputWhat output) const
2058 LYXERR(Debug::LATEX, "makeDocBookFile...");
2061 if (!openFileWrite(ofs, fname))
2064 // make sure we are ready to export
2065 // this needs to be done before we validate
2067 updateMacroInstances(OutputUpdate);
2069 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2073 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2077 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
2078 OutputParams const & runparams,
2079 OutputWhat output) const
2081 LaTeXFeatures features(*this, params(), runparams);
2086 DocumentClass const & tclass = params().documentClass();
2087 string const & top_element = tclass.latexname();
2089 bool const output_preamble =
2090 output == FullSource || output == OnlyPreamble;
2091 bool const output_body =
2092 output == FullSource || output == OnlyBody;
2094 if (output_preamble) {
2095 if (runparams.flavor == OutputParams::XML)
2096 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2099 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2102 if (! tclass.class_header().empty())
2103 os << from_ascii(tclass.class_header());
2104 else if (runparams.flavor == OutputParams::XML)
2105 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2106 << "\"https://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2108 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2110 docstring preamble = params().preamble;
2111 if (runparams.flavor != OutputParams::XML ) {
2112 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2113 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2114 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2115 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2118 string const name = runparams.nice
2119 ? changeExtension(absFileName(), ".sgml") : fname;
2120 preamble += features.getIncludedFiles(name);
2121 preamble += features.getLyXSGMLEntities();
2123 if (!preamble.empty()) {
2124 os << "\n [ " << preamble << " ]";
2130 string top = top_element;
2132 if (runparams.flavor == OutputParams::XML)
2133 top += params().language->code();
2135 top += params().language->code().substr(0, 2);
2138 if (!params().options.empty()) {
2140 top += params().options;
2143 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2144 << " file was created by LyX " << lyx_version
2145 << "\n See http://www.lyx.org/ for more information -->\n";
2147 params().documentClass().counters().reset();
2149 sgml::openTag(os, top);
2151 docbookParagraphs(text(), *this, os, runparams);
2152 sgml::closeTag(os, top_element);
2157 void Buffer::makeLyXHTMLFile(FileName const & fname,
2158 OutputParams const & runparams) const
2160 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2163 if (!openFileWrite(ofs, fname))
2166 // make sure we are ready to export
2167 // this has to be done before we validate
2168 updateBuffer(UpdateMaster, OutputUpdate);
2169 updateMacroInstances(OutputUpdate);
2171 writeLyXHTMLSource(ofs, runparams, FullSource);
2175 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2179 void Buffer::writeLyXHTMLSource(odocstream & os,
2180 OutputParams const & runparams,
2181 OutputWhat output) const
2183 LaTeXFeatures features(*this, params(), runparams);
2185 d->bibinfo_.makeCitationLabels(*this);
2187 bool const output_preamble =
2188 output == FullSource || output == OnlyPreamble;
2189 bool const output_body =
2190 output == FullSource || output == OnlyBody || output == IncludedFile;
2192 if (output_preamble) {
2193 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2194 << "<!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"
2195 // FIXME Language should be set properly.
2196 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2198 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2199 // FIXME Presumably need to set this right
2200 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2202 docstring const & doctitle = features.htmlTitle();
2204 << (doctitle.empty() ?
2205 from_ascii("LyX Document") :
2206 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2209 docstring styles = features.getTClassHTMLPreamble();
2210 if (!styles.empty())
2211 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2213 // we will collect CSS information in a stream, and then output it
2214 // either here, as part of the header, or else in a separate file.
2215 odocstringstream css;
2216 styles = features.getCSSSnippets();
2217 if (!styles.empty())
2218 css << "/* LyX Provided Styles */\n" << styles << '\n';
2220 styles = features.getTClassHTMLStyles();
2221 if (!styles.empty())
2222 css << "/* Layout-provided Styles */\n" << styles << '\n';
2224 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2225 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2226 if (needfg || needbg) {
2227 css << "\nbody {\n";
2230 << from_ascii(X11hexname(params().fontcolor))
2233 css << " background-color: "
2234 << from_ascii(X11hexname(params().backgroundcolor))
2239 docstring const dstyles = css.str();
2240 if (!dstyles.empty()) {
2241 bool written = false;
2242 if (params().html_css_as_file) {
2243 // open a file for CSS info
2245 string const fcssname = addName(temppath(), "docstyle.css");
2246 FileName const fcssfile = FileName(fcssname);
2247 if (openFileWrite(ocss, fcssfile)) {
2251 // write link to header
2252 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2254 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2257 // we are here if the CSS is supposed to be written to the header
2258 // or if we failed to write it to an external file.
2260 os << "<style type='text/css'>\n"
2269 bool const output_body_tag = (output != IncludedFile);
2270 if (output_body_tag)
2271 os << "<body dir=\"auto\">\n";
2273 if (output != IncludedFile)
2274 // if we're an included file, the counters are in the master.
2275 params().documentClass().counters().reset();
2276 xhtmlParagraphs(text(), *this, xs, runparams);
2277 if (output_body_tag)
2281 if (output_preamble)
2286 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2287 // Other flags: -wall -v0 -x
2288 int Buffer::runChktex()
2292 // get LaTeX-Filename
2293 FileName const path(temppath());
2294 string const name = addName(path.absFileName(), latexName());
2295 string const org_path = filePath();
2297 PathChanger p(path); // path to LaTeX file
2298 message(_("Running chktex..."));
2300 // Generate the LaTeX file if neccessary
2301 OutputParams runparams(¶ms().encoding());
2302 runparams.flavor = OutputParams::LATEX;
2303 runparams.nice = false;
2304 runparams.linelen = lyxrc.plaintext_linelen;
2305 makeLaTeXFile(FileName(name), org_path, runparams);
2308 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2309 int const res = chktex.run(terr); // run chktex
2312 Alert::error(_("chktex failure"),
2313 _("Could not run chktex successfully."));
2315 ErrorList & errlist = d->errorLists["ChkTeX"];
2317 bufferErrors(terr, errlist);
2322 if (runparams.silent)
2323 d->errorLists["ChkTeX"].clear();
2331 void Buffer::validate(LaTeXFeatures & features) const
2333 // Validate the buffer params, but not for included
2334 // files, since they also use the parent buffer's
2336 if (!features.runparams().is_child)
2337 params().validate(features);
2339 for (Paragraph const & p : paragraphs())
2340 p.validate(features);
2342 if (lyxerr.debugging(Debug::LATEX)) {
2343 features.showStruct();
2348 void Buffer::getLabelList(vector<docstring> & list) const
2350 // If this is a child document, use the master's list instead.
2352 masterBuffer()->getLabelList(list);
2357 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2358 Toc::const_iterator toc_it = toc->begin();
2359 Toc::const_iterator end = toc->end();
2360 for (; toc_it != end; ++toc_it) {
2361 if (toc_it->depth() == 0)
2362 list.push_back(toc_it->str());
2367 // This is not in master, so it has been removed at 2126d5a3, on
2368 // 14 December 2018, so as to test whether it's needed. If there
2369 // aren't any complaints, it can be fully removed.
2371 void Buffer::updateBibfilesCache(UpdateScope scope) const
2373 // FIXME This is probably unnecssary, given where we call this.
2374 // If this is a child document, use the parent's cache instead.
2375 if (parent() && scope != UpdateChildOnly) {
2376 masterBuffer()->updateBibfilesCache();
2380 docstring_list old_cache = d->bibfiles_cache_;
2381 d->bibfiles_cache_.clear();
2382 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2383 if (it->lyxCode() == BIBTEX_CODE) {
2384 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2385 docstring_list const bibfiles = inset.getBibFiles();
2386 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2389 } else if (it->lyxCode() == INCLUDE_CODE) {
2390 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2391 Buffer const * const incbuf = inset.getChildBuffer();
2394 docstring_list const & bibfiles =
2395 incbuf->getBibfiles(UpdateChildOnly);
2396 if (!bibfiles.empty()) {
2397 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2403 d->bibfile_cache_valid_ = true;
2404 d->cite_labels_valid_ = false;
2405 if (d->bibfiles_cache_ != old_cache)
2406 d->bibinfo_cache_valid_ = false;
2411 void Buffer::invalidateBibinfoCache() const
2413 d->bibinfo_cache_valid_ = false;
2414 d->cite_labels_valid_ = false;
2415 removeBiblioTempFiles();
2416 // also invalidate the cache for the parent buffer
2417 Buffer const * const pbuf = d->parent();
2419 pbuf->invalidateBibinfoCache();
2423 docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
2425 // FIXME This is probably unnecessary, given where we call this.
2426 // If this is a child document, use the master's cache instead.
2427 Buffer const * const pbuf = masterBuffer();
2428 if (pbuf != this && scope != UpdateChildOnly)
2429 return pbuf->getBibfiles();
2431 return d->bibfiles_cache_;
2435 BiblioInfo const & Buffer::masterBibInfo() const
2437 Buffer const * const tmp = masterBuffer();
2439 return tmp->masterBibInfo();
2444 BiblioInfo const & Buffer::bibInfo() const
2450 void Buffer::registerBibfiles(const docstring_list & bf) const
2452 // We register the bib files in the master buffer,
2453 // if there is one, but also in every single buffer,
2454 // in case a child is compiled alone.
2455 Buffer const * const tmp = masterBuffer();
2457 tmp->registerBibfiles(bf);
2459 for (auto const & p : bf) {
2460 docstring_list::const_iterator temp =
2461 find(d->bibfiles_cache_.begin(), d->bibfiles_cache_.end(), p);
2462 if (temp == d->bibfiles_cache_.end())
2463 d->bibfiles_cache_.push_back(p);
2468 static map<docstring, FileName> bibfileCache;
2470 FileName Buffer::getBibfilePath(docstring const & bibid) const
2472 map<docstring, FileName>::const_iterator it =
2473 bibfileCache.find(bibid);
2474 if (it != bibfileCache.end()) {
2475 // i.e., return bibfileCache[bibid];
2479 LYXERR(Debug::FILES, "Reading file location for " << bibid);
2480 string const texfile = changeExtension(to_utf8(bibid), "bib");
2481 // we need to check first if this file exists where it's said to be.
2482 // there's a weird bug that occurs otherwise: if the file is in the
2483 // Buffer's directory but has the same name as some file that would be
2484 // found by kpsewhich, then we find the latter, not the former.
2485 FileName const local_file = makeAbsPath(texfile, filePath());
2486 FileName file = local_file;
2487 if (!file.exists()) {
2488 // there's no need now to check whether the file can be found
2490 file = findtexfile(texfile, "bib", true);
2494 LYXERR(Debug::FILES, "Found at: " << file);
2496 bibfileCache[bibid] = file;
2497 return bibfileCache[bibid];
2501 void Buffer::checkIfBibInfoCacheIsValid() const
2503 // use the master's cache
2504 Buffer const * const tmp = masterBuffer();
2506 tmp->checkIfBibInfoCacheIsValid();
2510 // If we already know the cache is invalid, stop here.
2511 // This is important in the case when the bibliography
2512 // environment (rather than Bib[la]TeX) is used.
2513 // In that case, the timestamp check below gives no
2514 // sensible result. Rather than that, the cache will
2515 // be invalidated explicitly via invalidateBibInfoCache()
2516 // by the Bibitem inset.
2517 // Same applies for bib encoding changes, which trigger
2518 // invalidateBibInfoCache() by InsetBibtex.
2519 if (!d->bibinfo_cache_valid_)
2522 if (d->have_bibitems_) {
2523 // We have a bibliography environment.
2524 // Invalidate the bibinfo cache unconditionally.
2525 // Cite labels will get invalidated by the inset if needed.
2526 d->bibinfo_cache_valid_ = false;
2530 // OK. This is with Bib(la)tex. We'll assume the cache
2531 // is valid and change this if we find changes in the bibs.
2532 d->bibinfo_cache_valid_ = true;
2533 d->cite_labels_valid_ = true;
2534 // compare the cached timestamps with the actual ones.
2535 docstring_list const & bibfiles_cache = getBibfiles();
2536 for (auto const & bf : bibfiles_cache) {
2537 FileName const fn = getBibfilePath(bf);
2538 time_t lastw = fn.lastModified();
2539 time_t prevw = d->bibfile_status_[fn];
2540 if (lastw != prevw) {
2541 d->bibinfo_cache_valid_ = false;
2542 d->cite_labels_valid_ = false;
2543 d->bibfile_status_[fn] = lastw;
2549 void Buffer::clearBibFileCache() const
2551 bibfileCache.clear();
2555 void Buffer::reloadBibInfoCache() const
2560 // use the master's cache
2561 Buffer const * const tmp = masterBuffer();
2563 tmp->reloadBibInfoCache();
2567 checkIfBibInfoCacheIsValid();
2568 if (d->bibinfo_cache_valid_)
2570 LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
2572 // re-read file locations when this info changes
2573 // FIXME Is this sufficient? Or should we also force that
2574 // in some other cases? If so, then it is easy enough to
2575 // add the following line in some other places.
2576 clearBibFileCache();
2577 d->bibinfo_.clear();
2578 FileNameList checkedFiles;
2579 d->have_bibitems_ = false;
2580 collectBibKeys(checkedFiles);
2581 d->bibinfo_cache_valid_ = true;
2585 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
2587 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2588 it->collectBibKeys(it, checkedFiles);
2589 if (it->lyxCode() == BIBITEM_CODE) {
2591 parent()->d->have_bibitems_ = true;
2593 d->have_bibitems_ = true;
2599 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
2601 // We add the biblio info to the parent buffer,
2602 // if there is one, but also to this buffer, in case
2603 // it is compiled alone.
2604 BiblioInfo & bi = d->bibinfo_;
2605 bi.mergeBiblioInfo(bin);
2608 parent()->addBiblioInfo(bin);
2612 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bin) const
2614 // We add the bibtex info to the master buffer,
2615 // if there is one, but also to every single buffer,
2616 // in case a child is compiled alone.
2617 BiblioInfo & bi = d->bibinfo_;
2620 if (parent() != 0) {
2621 BiblioInfo & masterbi = parent()->d->bibinfo_;
2622 masterbi[key] = bin;
2627 void Buffer::makeCitationLabels() const
2629 Buffer const * const master = masterBuffer();
2630 return d->bibinfo_.makeCitationLabels(*master);
2634 void Buffer::invalidateCiteLabels() const
2636 masterBuffer()->d->cite_labels_valid_ = false;
2639 bool Buffer::citeLabelsValid() const
2641 return masterBuffer()->d->cite_labels_valid_;
2645 void Buffer::removeBiblioTempFiles() const
2647 // We remove files that contain LaTeX commands specific to the
2648 // particular bibliographic style being used, in order to avoid
2649 // LaTeX errors when we switch style.
2650 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2651 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2652 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2653 aux_file.removeFile();
2654 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2655 bbl_file.removeFile();
2656 // Also for the parent buffer
2657 Buffer const * const pbuf = parent();
2659 pbuf->removeBiblioTempFiles();
2663 bool Buffer::isDepClean(string const & name) const
2665 DepClean::const_iterator const it = d->dep_clean.find(name);
2666 if (it == d->dep_clean.end())
2672 void Buffer::markDepClean(string const & name)
2674 d->dep_clean[name] = true;
2678 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2681 // FIXME? if there is an Buffer LFUN that can be dispatched even
2682 // if internal, put a switch '(cmd.action)' here.
2688 switch (cmd.action()) {
2690 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2691 flag.setOnOff(hasReadonlyFlag());
2694 // FIXME: There is need for a command-line import.
2695 //case LFUN_BUFFER_IMPORT:
2697 case LFUN_BUFFER_AUTO_SAVE:
2700 case LFUN_BUFFER_EXPORT_CUSTOM:
2701 // FIXME: Nothing to check here?
2704 case LFUN_BUFFER_EXPORT: {
2705 docstring const arg = cmd.argument();
2706 if (arg == "custom") {
2710 string format = (arg.empty() || arg == "default") ?
2711 params().getDefaultOutputFormat() : to_utf8(arg);
2712 size_t pos = format.find(' ');
2713 if (pos != string::npos)
2714 format = format.substr(0, pos);
2715 enable = params().isExportable(format, false);
2717 flag.message(bformat(
2718 _("Don't know how to export to format: %1$s"), arg));
2722 case LFUN_BUILD_PROGRAM:
2723 enable = params().isExportable("program", false);
2726 case LFUN_BRANCH_ACTIVATE:
2727 case LFUN_BRANCH_DEACTIVATE:
2728 case LFUN_BRANCH_MASTER_ACTIVATE:
2729 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2730 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2731 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2732 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2733 : params().branchlist();
2734 docstring const branchName = cmd.argument();
2735 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2739 case LFUN_BRANCH_ADD:
2740 case LFUN_BRANCHES_RENAME:
2741 // if no Buffer is present, then of course we won't be called!
2744 case LFUN_BUFFER_LANGUAGE:
2745 enable = !isReadonly();
2748 case LFUN_BUFFER_VIEW_CACHE:
2749 (d->preview_file_).refresh();
2750 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2753 case LFUN_CHANGES_TRACK:
2754 flag.setEnabled(true);
2755 flag.setOnOff(params().track_changes);
2758 case LFUN_CHANGES_OUTPUT:
2759 flag.setEnabled(true);
2760 flag.setOnOff(params().output_changes);
2763 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2764 flag.setOnOff(params().compressed);
2767 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2768 flag.setOnOff(params().output_sync);
2771 case LFUN_BUFFER_ANONYMIZE:
2777 flag.setEnabled(enable);
2782 void Buffer::dispatch(string const & command, DispatchResult & result)
2784 return dispatch(lyxaction.lookupFunc(command), result);
2788 // NOTE We can end up here even if we have no GUI, because we are called
2789 // by LyX::exec to handled command-line requests. So we may need to check
2790 // whether we have a GUI or not. The boolean use_gui holds this information.
2791 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2794 // FIXME? if there is an Buffer LFUN that can be dispatched even
2795 // if internal, put a switch '(cmd.action())' here.
2796 dr.dispatched(false);
2799 string const argument = to_utf8(func.argument());
2800 // We'll set this back to false if need be.
2801 bool dispatched = true;
2802 // This handles undo groups automagically
2803 UndoGroupHelper ugh(this);
2805 switch (func.action()) {
2806 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2807 if (lyxvc().inUse()) {
2808 string log = lyxvc().toggleReadOnly();
2813 setReadonly(!hasReadonlyFlag());
2816 case LFUN_BUFFER_EXPORT: {
2817 string const format = (argument.empty() || argument == "default") ?
2818 params().getDefaultOutputFormat() : argument;
2819 ExportStatus const status = doExport(format, false);
2820 dr.setError(status != ExportSuccess);
2821 if (status != ExportSuccess)
2822 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2823 from_utf8(format)));
2827 case LFUN_BUILD_PROGRAM: {
2828 ExportStatus const status = doExport("program", true);
2829 dr.setError(status != ExportSuccess);
2830 if (status != ExportSuccess)
2831 dr.setMessage(_("Error generating literate programming code."));
2835 case LFUN_BUFFER_EXPORT_CUSTOM: {
2837 string command = split(argument, format_name, ' ');
2838 Format const * format = theFormats().getFormat(format_name);
2840 lyxerr << "Format \"" << format_name
2841 << "\" not recognized!"
2846 // The name of the file created by the conversion process
2849 // Output to filename
2850 if (format->name() == "lyx") {
2851 string const latexname = latexName(false);
2852 filename = changeExtension(latexname,
2853 format->extension());
2854 filename = addName(temppath(), filename);
2856 if (!writeFile(FileName(filename)))
2860 doExport(format_name, true, filename);
2863 // Substitute $$FName for filename
2864 if (!contains(command, "$$FName"))
2865 command = "( " + command + " ) < $$FName";
2866 command = subst(command, "$$FName", filename);
2868 // Execute the command in the background
2870 call.startscript(Systemcall::DontWait, command,
2871 filePath(), layoutPos());
2875 // FIXME: There is need for a command-line import.
2877 case LFUN_BUFFER_IMPORT:
2882 case LFUN_BUFFER_AUTO_SAVE:
2884 resetAutosaveTimers();
2887 case LFUN_BRANCH_ACTIVATE:
2888 case LFUN_BRANCH_DEACTIVATE:
2889 case LFUN_BRANCH_MASTER_ACTIVATE:
2890 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2891 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2892 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2893 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2896 docstring const branch_name = func.argument();
2897 // the case without a branch name is handled elsewhere
2898 if (branch_name.empty()) {
2902 Branch * branch = buf->params().branchlist().find(branch_name);
2904 LYXERR0("Branch " << branch_name << " does not exist.");
2906 docstring const msg =
2907 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2911 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2912 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2913 if (branch->isSelected() != activate) {
2914 buf->undo().recordUndoBufferParams(CursorData());
2915 branch->setSelected(activate);
2917 dr.screenUpdate(Update::Force);
2918 dr.forceBufferUpdate();
2923 case LFUN_BRANCH_ADD: {
2924 docstring branch_name = func.argument();
2925 if (branch_name.empty()) {
2929 BranchList & branch_list = params().branchlist();
2930 vector<docstring> const branches =
2931 getVectorFromString(branch_name, branch_list.separator());
2933 for (vector<docstring>::const_iterator it = branches.begin();
2934 it != branches.end(); ++it) {
2936 Branch * branch = branch_list.find(branch_name);
2938 LYXERR0("Branch " << branch_name << " already exists.");
2942 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2944 undo().recordUndoBufferParams(CursorData());
2945 branch_list.add(branch_name);
2946 branch = branch_list.find(branch_name);
2947 string const x11hexname = X11hexname(branch->color());
2948 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2949 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2951 dr.screenUpdate(Update::Force);
2959 case LFUN_BRANCHES_RENAME: {
2960 if (func.argument().empty())
2963 docstring const oldname = from_utf8(func.getArg(0));
2964 docstring const newname = from_utf8(func.getArg(1));
2965 InsetIterator it = inset_iterator_begin(inset());
2966 InsetIterator const end = inset_iterator_end(inset());
2967 bool success = false;
2968 for (; it != end; ++it) {
2969 if (it->lyxCode() == BRANCH_CODE) {
2970 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2971 if (ins.branch() == oldname) {
2972 undo().recordUndo(CursorData(it));
2973 ins.rename(newname);
2978 if (it->lyxCode() == INCLUDE_CODE) {
2979 // get buffer of external file
2980 InsetInclude const & ins =
2981 static_cast<InsetInclude const &>(*it);
2982 Buffer * child = ins.getChildBuffer();
2985 child->dispatch(func, dr);
2990 dr.screenUpdate(Update::Force);
2991 dr.forceBufferUpdate();
2996 case LFUN_BUFFER_VIEW_CACHE:
2997 if (!theFormats().view(*this, d->preview_file_,
2998 d->preview_format_))
2999 dr.setMessage(_("Error viewing the output file."));
3002 case LFUN_CHANGES_TRACK:
3003 if (params().save_transient_properties)
3004 undo().recordUndoBufferParams(CursorData());
3005 params().track_changes = !params().track_changes;
3006 if (!params().track_changes)
3007 dr.forceChangesUpdate();
3010 case LFUN_CHANGES_OUTPUT:
3011 if (params().save_transient_properties)
3012 undo().recordUndoBufferParams(CursorData());
3013 params().output_changes = !params().output_changes;
3014 if (params().output_changes) {
3015 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
3016 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
3017 LaTeXFeatures::isAvailable("xcolor");
3019 if (!dvipost && !xcolorulem) {
3020 Alert::warning(_("Changes not shown in LaTeX output"),
3021 _("Changes will not be highlighted in LaTeX output, "
3022 "because neither dvipost nor xcolor/ulem are installed.\n"
3023 "Please install these packages or redefine "
3024 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3025 } else if (!xcolorulem) {
3026 Alert::warning(_("Changes not shown in LaTeX output"),
3027 _("Changes will not be highlighted in LaTeX output "
3028 "when using pdflatex, because xcolor and ulem are not installed.\n"
3029 "Please install both packages or redefine "
3030 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
3035 case LFUN_BUFFER_TOGGLE_COMPRESSION:
3036 // turn compression on/off
3037 undo().recordUndoBufferParams(CursorData());
3038 params().compressed = !params().compressed;
3041 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
3042 undo().recordUndoBufferParams(CursorData());
3043 params().output_sync = !params().output_sync;
3046 case LFUN_BUFFER_ANONYMIZE: {
3047 undo().recordUndoFullBuffer(CursorData());
3048 CursorData cur(doc_iterator_begin(this));
3049 for ( ; cur ; cur.forwardPar())
3050 cur.paragraph().anonymize();
3051 dr.forceBufferUpdate();
3052 dr.screenUpdate(Update::Force);
3060 dr.dispatched(dispatched);
3064 void Buffer::changeLanguage(Language const * from, Language const * to)
3066 LASSERT(from, return);
3067 LASSERT(to, return);
3069 for_each(par_iterator_begin(),
3071 bind(&Paragraph::changeLanguage, _1, params(), from, to));
3075 bool Buffer::isMultiLingual() const
3077 ParConstIterator end = par_iterator_end();
3078 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3079 if (it->isMultiLingual(params()))
3086 std::set<Language const *> Buffer::getLanguages() const
3088 std::set<Language const *> languages;
3089 getLanguages(languages);
3094 void Buffer::getLanguages(std::set<Language const *> & languages) const
3096 ParConstIterator end = par_iterator_end();
3097 // add the buffer language, even if it's not actively used
3098 languages.insert(language());
3099 // iterate over the paragraphs
3100 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
3101 it->getLanguages(languages);
3103 ListOfBuffers clist = getDescendents();
3104 ListOfBuffers::const_iterator cit = clist.begin();
3105 ListOfBuffers::const_iterator const cen = clist.end();
3106 for (; cit != cen; ++cit)
3107 (*cit)->getLanguages(languages);
3111 DocIterator Buffer::getParFromID(int const id) const
3113 Buffer * buf = const_cast<Buffer *>(this);
3115 // This means non-existent
3116 return doc_iterator_end(buf);
3118 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
3119 if (it.paragraph().id() == id)
3122 return doc_iterator_end(buf);
3126 bool Buffer::hasParWithID(int const id) const
3128 return !getParFromID(id).atEnd();
3132 ParIterator Buffer::par_iterator_begin()
3134 return ParIterator(doc_iterator_begin(this));
3138 ParIterator Buffer::par_iterator_end()
3140 return ParIterator(doc_iterator_end(this));
3144 ParConstIterator Buffer::par_iterator_begin() const
3146 return ParConstIterator(doc_iterator_begin(this));
3150 ParConstIterator Buffer::par_iterator_end() const
3152 return ParConstIterator(doc_iterator_end(this));
3156 Language const * Buffer::language() const
3158 return params().language;
3162 docstring const Buffer::B_(string const & l10n) const
3164 return params().B_(l10n);
3168 bool Buffer::isClean() const
3170 return d->lyx_clean;
3174 bool Buffer::isChecksumModified() const
3176 LASSERT(d->filename.exists(), return false);
3177 return d->checksum_ != d->filename.checksum();
3181 void Buffer::saveCheckSum() const
3183 FileName const & file = d->filename;
3185 d->checksum_ = file.exists() ? file.checksum()
3186 : 0; // in the case of save to a new file.
3190 void Buffer::markClean() const
3192 if (!d->lyx_clean) {
3193 d->lyx_clean = true;
3196 // if the .lyx file has been saved, we don't need an
3198 d->bak_clean = true;
3199 d->undo_.markDirty();
3200 clearExternalModification();
3204 void Buffer::setUnnamed(bool flag)
3210 bool Buffer::isUnnamed() const
3217 /// Don't check unnamed, here: isInternal() is used in
3218 /// newBuffer(), where the unnamed flag has not been set by anyone
3219 /// yet. Also, for an internal buffer, there should be no need for
3220 /// retrieving fileName() nor for checking if it is unnamed or not.
3221 bool Buffer::isInternal() const
3223 return d->internal_buffer;
3227 void Buffer::setInternal(bool flag)
3229 d->internal_buffer = flag;
3233 void Buffer::markDirty()
3236 d->lyx_clean = false;
3239 d->bak_clean = false;
3241 DepClean::iterator it = d->dep_clean.begin();
3242 DepClean::const_iterator const end = d->dep_clean.end();
3244 for (; it != end; ++it)
3249 FileName Buffer::fileName() const
3255 string Buffer::absFileName() const
3257 return d->filename.absFileName();
3261 string Buffer::filePath() const
3263 string const abs = d->filename.onlyPath().absFileName();
3266 int last = abs.length() - 1;
3268 return abs[last] == '/' ? abs : abs + '/';
3272 DocFileName Buffer::getReferencedFileName(string const & fn) const
3275 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3276 result.set(fn, filePath());
3278 // filePath() ends with a path separator
3279 FileName const test(filePath() + fn);
3281 result.set(fn, filePath());
3283 result.set(fn, params().origin);
3290 string const Buffer::prepareFileNameForLaTeX(string const & name,
3291 string const & ext, bool nice) const
3293 string const fname = makeAbsPath(name, filePath()).absFileName();
3294 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3300 return to_utf8(makeRelPath(from_utf8(fname),
3301 from_utf8(masterBuffer()->filePath())));
3305 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3306 docstring_list const & bibfilelist,
3307 bool const add_extension) const
3309 // If we are processing the LaTeX file in a temp directory then
3310 // copy the .bib databases to this temp directory, mangling their
3311 // names in the process. Store this mangled name in the list of
3313 // (We need to do all this because BibTeX *really*, *really*
3314 // can't handle "files with spaces" and Windows users tend to
3315 // use such filenames.)
3316 // Otherwise, store the (maybe absolute) path to the original,
3317 // unmangled database name.
3319 vector<docstring> res;
3321 // determine the export format
3322 string const tex_format = flavor2format(runparams.flavor);
3324 // check for spaces in paths
3325 bool found_space = false;
3327 for (auto const & bit : bibfilelist) {
3328 string utf8input = to_utf8(bit);
3330 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3331 FileName try_in_file =
3332 makeAbsPath(database + ".bib", filePath());
3333 bool not_from_texmf = try_in_file.isReadableFile();
3334 // If the file has not been found, try with the real file name
3335 // (it might come from a child in a sub-directory)
3336 if (!not_from_texmf) {
3337 try_in_file = getBibfilePath(bit);
3338 if (try_in_file.isReadableFile()) {
3339 // Check if the file is in texmf
3340 FileName kpsefile(findtexfile(changeExtension(utf8input, "bib"), "bib", true));
3341 not_from_texmf = kpsefile.empty()
3342 || kpsefile.absFileName() != try_in_file.absFileName();
3344 // If this exists, make path relative to the master
3346 database = removeExtension(
3347 prepareFileNameForLaTeX(to_utf8(makeRelPath(from_utf8(try_in_file.absFileName()),
3348 from_utf8(filePath()))),
3349 ".bib", runparams.nice));
3353 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3355 // mangledFileName() needs the extension
3356 DocFileName const in_file = DocFileName(try_in_file);
3357 database = removeExtension(in_file.mangledFileName());
3358 FileName const out_file = makeAbsPath(database + ".bib",
3359 masterBuffer()->temppath());
3360 bool const success = in_file.copyTo(out_file);
3362 LYXERR0("Failed to copy '" << in_file
3363 << "' to '" << out_file << "'");
3365 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3366 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3367 if (!isValidLaTeXFileName(database)) {
3368 frontend::Alert::warning(_("Invalid filename"),
3369 _("The following filename will cause troubles "
3370 "when running the exported file through LaTeX: ") +
3371 from_utf8(database));
3373 if (!isValidDVIFileName(database)) {
3374 frontend::Alert::warning(_("Problematic filename for DVI"),
3375 _("The following filename can cause troubles "
3376 "when running the exported file through LaTeX "
3377 "and opening the resulting DVI: ") +
3378 from_utf8(database), true);
3386 docstring const path = from_utf8(latex_path(database));
3388 if (contains(path, ' '))
3391 if (find(res.begin(), res.end(), path) == res.end())
3392 res.push_back(path);
3395 // Check if there are spaces in the path and warn BibTeX users, if so.
3396 // (biber can cope with such paths)
3397 if (!prefixIs(runparams.bibtex_command, "biber")) {
3398 // Post this warning only once.
3399 static bool warned_about_spaces = false;
3400 if (!warned_about_spaces &&
3401 runparams.nice && found_space) {
3402 warned_about_spaces = true;
3403 Alert::warning(_("Export Warning!"),
3404 _("There are spaces in the paths to your BibTeX databases.\n"
3405 "BibTeX will be unable to find them."));
3414 string Buffer::layoutPos() const
3416 return d->layout_position;
3420 void Buffer::setLayoutPos(string const & path)
3423 d->layout_position.clear();
3427 LATTEST(FileName::isAbsolute(path));
3429 d->layout_position =
3430 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3432 if (d->layout_position.empty())
3433 d->layout_position = ".";
3437 bool Buffer::hasReadonlyFlag() const
3439 return d->read_only;
3443 bool Buffer::isReadonly() const
3445 return hasReadonlyFlag() || notifiesExternalModification();
3449 void Buffer::setParent(Buffer const * buffer)
3451 // Avoids recursive include.
3452 d->setParent(buffer == this ? 0 : buffer);
3457 Buffer const * Buffer::parent() const
3463 ListOfBuffers Buffer::allRelatives() const
3465 ListOfBuffers lb = masterBuffer()->getDescendents();
3466 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3471 Buffer const * Buffer::masterBuffer() const
3473 // FIXME Should be make sure we are not in some kind
3474 // of recursive include? A -> B -> A will crash this.
3475 Buffer const * const pbuf = d->parent();
3479 return pbuf->masterBuffer();
3483 bool Buffer::isChild(Buffer * child) const
3485 return d->children_positions.find(child) != d->children_positions.end();
3489 DocIterator Buffer::firstChildPosition(Buffer const * child)
3491 Impl::BufferPositionMap::iterator it;
3492 it = d->children_positions.find(child);
3493 if (it == d->children_positions.end())
3494 return DocIterator(this);
3499 bool Buffer::hasChildren() const
3501 return !d->children_positions.empty();
3505 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3507 // loop over children
3508 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3509 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3510 for (; it != end; ++it) {
3511 Buffer * child = const_cast<Buffer *>(it->first);
3513 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3514 if (bit != clist.end())
3516 clist.push_back(child);
3518 // there might be grandchildren
3519 child->collectChildren(clist, true);
3524 ListOfBuffers Buffer::getChildren() const
3527 collectChildren(v, false);
3528 // Make sure we have not included ourselves.
3529 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3530 if (bit != v.end()) {
3531 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3538 ListOfBuffers Buffer::getDescendents() const
3541 collectChildren(v, true);
3542 // Make sure we have not included ourselves.
3543 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3544 if (bit != v.end()) {
3545 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3552 template<typename M>
3553 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3558 typename M::const_iterator it = m.lower_bound(x);
3559 if (it == m.begin())
3567 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3568 DocIterator const & pos) const
3570 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3572 // if paragraphs have no macro context set, pos will be empty
3576 // we haven't found anything yet
3577 DocIterator bestPos = owner_->par_iterator_begin();
3578 MacroData const * bestData = 0;
3580 // find macro definitions for name
3581 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3582 if (nameIt != macros.end()) {
3583 // find last definition in front of pos or at pos itself
3584 PositionScopeMacroMap::const_iterator it
3585 = greatest_below(nameIt->second, pos);
3586 if (it != nameIt->second.end()) {
3588 // scope ends behind pos?
3589 if (pos < it->second.scope) {
3590 // Looks good, remember this. If there
3591 // is no external macro behind this,
3592 // we found the right one already.
3593 bestPos = it->first;
3594 bestData = &it->second.macro;
3598 // try previous macro if there is one
3599 if (it == nameIt->second.begin())
3606 // find macros in included files
3607 PositionScopeBufferMap::const_iterator it
3608 = greatest_below(position_to_children, pos);
3609 if (it == position_to_children.end())
3610 // no children before
3614 // do we know something better (i.e. later) already?
3615 if (it->first < bestPos )
3618 // scope ends behind pos?
3619 if (pos < it->second.scope
3620 && (cloned_buffer_ ||
3621 theBufferList().isLoaded(it->second.buffer))) {
3622 // look for macro in external file
3624 MacroData const * data
3625 = it->second.buffer->getMacro(name, false);
3628 bestPos = it->first;
3634 // try previous file if there is one
3635 if (it == position_to_children.begin())
3640 // return the best macro we have found
3645 MacroData const * Buffer::getMacro(docstring const & name,
3646 DocIterator const & pos, bool global) const
3651 // query buffer macros
3652 MacroData const * data = d->getBufferMacro(name, pos);
3656 // If there is a master buffer, query that
3657 Buffer const * const pbuf = d->parent();
3659 d->macro_lock = true;
3660 MacroData const * macro = pbuf->getMacro(
3661 name, *this, false);
3662 d->macro_lock = false;
3668 data = MacroTable::globalMacros().get(name);
3677 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3679 // set scope end behind the last paragraph
3680 DocIterator scope = par_iterator_begin();
3681 scope.pit() = scope.lastpit() + 1;
3683 return getMacro(name, scope, global);
3687 MacroData const * Buffer::getMacro(docstring const & name,
3688 Buffer const & child, bool global) const
3690 // look where the child buffer is included first
3691 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3692 if (it == d->children_positions.end())
3695 // check for macros at the inclusion position
3696 return getMacro(name, it->second, global);
3700 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3702 pit_type const lastpit = it.lastpit();
3704 // look for macros in each paragraph
3705 while (it.pit() <= lastpit) {
3706 Paragraph & par = it.paragraph();
3708 // iterate over the insets of the current paragraph
3709 InsetList const & insets = par.insetList();
3710 InsetList::const_iterator iit = insets.begin();
3711 InsetList::const_iterator end = insets.end();
3712 for (; iit != end; ++iit) {
3713 it.pos() = iit->pos;
3715 // is it a nested text inset?
3716 if (iit->inset->asInsetText()) {
3717 // Inset needs its own scope?
3718 InsetText const * itext = iit->inset->asInsetText();
3719 bool newScope = itext->isMacroScope();
3721 // scope which ends just behind the inset
3722 DocIterator insetScope = it;
3725 // collect macros in inset
3726 it.push_back(CursorSlice(*iit->inset));
3727 updateMacros(it, newScope ? insetScope : scope);
3732 if (iit->inset->asInsetTabular()) {
3733 CursorSlice slice(*iit->inset);
3734 size_t const numcells = slice.nargs();
3735 for (; slice.idx() < numcells; slice.forwardIdx()) {
3736 it.push_back(slice);
3737 updateMacros(it, scope);
3743 // is it an external file?
3744 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3745 // get buffer of external file
3746 InsetInclude const & inset =
3747 static_cast<InsetInclude const &>(*iit->inset);
3749 Buffer * child = inset.getChildBuffer();
3754 // register its position, but only when it is
3755 // included first in the buffer
3756 if (children_positions.find(child) ==
3757 children_positions.end())
3758 children_positions[child] = it;
3760 // register child with its scope
3761 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3765 InsetMath * im = iit->inset->asInsetMath();
3766 if (doing_export && im) {
3767 InsetMathHull * hull = im->asHullInset();
3769 hull->recordLocation(it);
3772 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3776 InsetMathMacroTemplate & macroTemplate =
3777 *iit->inset->asInsetMath()->asMacroTemplate();
3778 MacroContext mc(owner_, it);
3779 macroTemplate.updateToContext(mc);
3782 bool valid = macroTemplate.validMacro();
3783 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3784 // then the BufferView's cursor will be invalid in
3785 // some cases which leads to crashes.
3790 // FIXME (Abdel), I don't understand why we pass 'it' here
3791 // instead of 'macroTemplate' defined above... is this correct?
3792 macros[macroTemplate.name()][it] =
3793 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3803 void Buffer::updateMacros() const
3808 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3810 // start with empty table
3812 d->children_positions.clear();
3813 d->position_to_children.clear();
3815 // Iterate over buffer, starting with first paragraph
3816 // The scope must be bigger than any lookup DocIterator
3817 // later. For the global lookup, lastpit+1 is used, hence
3818 // we use lastpit+2 here.
3819 DocIterator it = par_iterator_begin();
3820 DocIterator outerScope = it;
3821 outerScope.pit() = outerScope.lastpit() + 2;
3822 d->updateMacros(it, outerScope);
3826 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3828 InsetIterator it = inset_iterator_begin(inset());
3829 InsetIterator const end = inset_iterator_end(inset());
3830 for (; it != end; ++it) {
3831 if (it->lyxCode() == BRANCH_CODE) {
3832 InsetBranch & br = static_cast<InsetBranch &>(*it);
3833 docstring const name = br.branch();
3834 if (!from_master && !params().branchlist().find(name))
3835 result.push_back(name);
3836 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3837 result.push_back(name);
3840 if (it->lyxCode() == INCLUDE_CODE) {
3841 // get buffer of external file
3842 InsetInclude const & ins =
3843 static_cast<InsetInclude const &>(*it);
3844 Buffer * child = ins.getChildBuffer();
3847 child->getUsedBranches(result, true);
3850 // remove duplicates
3855 void Buffer::updateMacroInstances(UpdateType utype) const
3857 LYXERR(Debug::MACROS, "updateMacroInstances for "
3858 << d->filename.onlyFileName());
3859 DocIterator it = doc_iterator_begin(this);
3861 DocIterator const end = doc_iterator_end(this);
3862 for (; it != end; it.forwardInset()) {
3863 // look for MathData cells in InsetMathNest insets
3864 InsetMath * minset = it.nextInset()->asInsetMath();
3868 // update macro in all cells of the InsetMathNest
3869 DocIterator::idx_type n = minset->nargs();
3870 MacroContext mc = MacroContext(this, it);
3871 for (DocIterator::idx_type i = 0; i < n; ++i) {
3872 MathData & data = minset->cell(i);
3873 data.updateMacros(0, mc, utype, 0);
3879 void Buffer::listMacroNames(MacroNameSet & macros) const
3884 d->macro_lock = true;
3886 // loop over macro names
3887 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3888 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3889 for (; nameIt != nameEnd; ++nameIt)
3890 macros.insert(nameIt->first);
3892 // loop over children
3893 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3894 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3895 for (; it != end; ++it) {
3896 Buffer * child = const_cast<Buffer *>(it->first);
3897 // The buffer might have been closed (see #10766).
3898 if (theBufferList().isLoaded(child))
3899 child->listMacroNames(macros);
3903 Buffer const * const pbuf = d->parent();
3905 pbuf->listMacroNames(macros);
3907 d->macro_lock = false;
3911 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3913 Buffer const * const pbuf = d->parent();
3918 pbuf->listMacroNames(names);
3921 MacroNameSet::iterator it = names.begin();
3922 MacroNameSet::iterator end = names.end();
3923 for (; it != end; ++it) {
3925 MacroData const * data =
3926 pbuf->getMacro(*it, *this, false);
3928 macros.insert(data);
3930 // we cannot access the original InsetMathMacroTemplate anymore
3931 // here to calls validate method. So we do its work here manually.
3932 // FIXME: somehow make the template accessible here.
3933 if (data->optionals() > 0)
3934 features.require("xargs");
3940 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3943 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3945 RefCache::iterator it = d->ref_cache_.find(label);
3946 if (it != d->ref_cache_.end())
3949 static References const dummy_refs = References();
3950 it = d->ref_cache_.insert(
3951 make_pair(label, dummy_refs)).first;
3956 Buffer::References const & Buffer::references(docstring const & label) const
3958 return const_cast<Buffer *>(this)->getReferenceCache(label);
3962 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3964 References & refs = getReferenceCache(label);
3965 refs.push_back(make_pair(inset, it));
3969 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
3973 linfo.label = label;
3975 linfo.active = active;
3976 masterBuffer()->d->label_cache_.push_back(linfo);
3980 InsetLabel const * Buffer::insetLabel(docstring const & label,
3981 bool const active) const
3983 for (auto & rc : masterBuffer()->d->label_cache_) {
3984 if (rc.label == label && (rc.active || !active))
3991 bool Buffer::activeLabel(docstring const & label) const
3993 if (!insetLabel(label, true))
4000 void Buffer::clearReferenceCache() const
4003 d->ref_cache_.clear();
4004 d->label_cache_.clear();
4009 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
4011 //FIXME: This does not work for child documents yet.
4012 reloadBibInfoCache();
4014 // Check if the label 'from' appears more than once
4015 BiblioInfo const & keys = masterBibInfo();
4016 BiblioInfo::const_iterator bit = keys.begin();
4017 BiblioInfo::const_iterator bend = keys.end();
4018 vector<docstring> labels;
4020 for (; bit != bend; ++bit)
4022 labels.push_back(bit->first);
4024 if (count(labels.begin(), labels.end(), from) > 1)
4027 string const paramName = "key";
4028 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
4029 if (it->lyxCode() != CITE_CODE)
4031 InsetCommand * inset = it->asInsetCommand();
4032 docstring const oldValue = inset->getParam(paramName);
4033 if (oldValue == from)
4034 inset->setParam(paramName, to);
4038 // returns NULL if id-to-row conversion is unsupported
4039 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
4040 pit_type par_begin, pit_type par_end,
4041 OutputWhat output, bool master) const
4043 unique_ptr<TexRow> texrow;
4044 OutputParams runparams(¶ms().encoding());
4045 runparams.nice = true;
4046 runparams.flavor = params().getOutputFlavor(format);
4047 runparams.linelen = lyxrc.plaintext_linelen;
4048 // No side effect of file copying and image conversion
4049 runparams.dryrun = true;
4051 if (output == CurrentParagraph) {
4052 runparams.par_begin = par_begin;
4053 runparams.par_end = par_end;
4054 if (par_begin + 1 == par_end) {
4056 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
4060 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
4061 convert<docstring>(par_begin),
4062 convert<docstring>(par_end - 1))
4065 // output paragraphs
4066 if (runparams.flavor == OutputParams::LYX) {
4067 Paragraph const & par = text().paragraphs()[par_begin];
4069 depth_type dt = par.getDepth();
4070 par.write(ods, params(), dt);
4071 os << from_utf8(ods.str());
4072 } else if (runparams.flavor == OutputParams::HTML) {
4074 setMathFlavor(runparams);
4075 xhtmlParagraphs(text(), *this, xs, runparams);
4076 } else if (runparams.flavor == OutputParams::TEXT) {
4078 // FIXME Handles only one paragraph, unlike the others.
4079 // Probably should have some routine with a signature like them.
4080 writePlaintextParagraph(*this,
4081 text().paragraphs()[par_begin], os, runparams, dummy);
4082 } else if (params().isDocBook()) {
4083 docbookParagraphs(text(), *this, os, runparams);
4085 // If we are previewing a paragraph, even if this is the
4086 // child of some other buffer, let's cut the link here,
4087 // so that no concurring settings from the master
4088 // (e.g. branch state) interfere (see #8101).
4090 d->ignore_parent = true;
4091 // We need to validate the Buffer params' features here
4092 // in order to know if we should output polyglossia
4093 // macros (instead of babel macros)
4094 LaTeXFeatures features(*this, params(), runparams);
4096 runparams.use_polyglossia = features.usePolyglossia();
4097 runparams.use_hyperref = features.isRequired("hyperref");
4098 // latex or literate
4101 ots.texrow().newlines(2);
4103 latexParagraphs(*this, text(), ots, runparams);
4104 texrow = ots.releaseTexRow();
4106 // Restore the parenthood
4108 d->ignore_parent = false;
4112 if (output == FullSource)
4113 os << _("Preview source code");
4114 else if (output == OnlyPreamble)
4115 os << _("Preview preamble");
4116 else if (output == OnlyBody)
4117 os << _("Preview body");
4119 if (runparams.flavor == OutputParams::LYX) {
4121 if (output == FullSource)
4123 else if (output == OnlyPreamble)
4124 params().writeFile(ods, this);
4125 else if (output == OnlyBody)
4127 os << from_utf8(ods.str());
4128 } else if (runparams.flavor == OutputParams::HTML) {
4129 writeLyXHTMLSource(os, runparams, output);
4130 } else if (runparams.flavor == OutputParams::TEXT) {
4131 if (output == OnlyPreamble) {
4132 os << "% "<< _("Plain text does not have a preamble.");
4134 writePlaintextFile(*this, os, runparams);
4135 } else if (params().isDocBook()) {
4136 writeDocBookSource(os, absFileName(), runparams, output);
4138 // latex or literate
4141 ots.texrow().newlines(2);
4143 runparams.is_child = true;
4145 writeLaTeXSource(ots, string(), runparams, output);
4146 texrow = ots.releaseTexRow();
4153 ErrorList & Buffer::errorList(string const & type) const
4155 return d->errorLists[type];
4159 void Buffer::updateTocItem(std::string const & type,
4160 DocIterator const & dit) const
4163 d->gui_->updateTocItem(type, dit);
4167 void Buffer::structureChanged() const
4170 d->gui_->structureChanged();
4174 void Buffer::errors(string const & err, bool from_master) const
4177 d->gui_->errors(err, from_master);
4181 void Buffer::message(docstring const & msg) const
4184 d->gui_->message(msg);
4188 void Buffer::setBusy(bool on) const
4191 d->gui_->setBusy(on);
4195 void Buffer::updateTitles() const
4198 d->wa_->updateTitles();
4202 void Buffer::resetAutosaveTimers() const
4205 d->gui_->resetAutosaveTimers();
4209 bool Buffer::hasGuiDelegate() const
4215 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4224 class AutoSaveBuffer : public ForkedProcess {
4227 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4228 : buffer_(buffer), fname_(fname) {}
4230 virtual shared_ptr<ForkedProcess> clone() const
4232 return make_shared<AutoSaveBuffer>(*this);
4237 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4238 from_utf8(fname_.absFileName())));
4239 return run(DontWait);
4243 virtual int generateChild();
4245 Buffer const & buffer_;
4250 int AutoSaveBuffer::generateChild()
4252 #if defined(__APPLE__)
4253 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4254 * We should use something else like threads.
4256 * Since I do not know how to determine at run time what is the OS X
4257 * version, I just disable forking altogether for now (JMarc)
4259 pid_t const pid = -1;
4261 // tmp_ret will be located (usually) in /tmp
4262 // will that be a problem?
4263 // Note that this calls ForkedCalls::fork(), so it's
4264 // ok cross-platform.
4265 pid_t const pid = fork();
4266 // If you want to debug the autosave
4267 // you should set pid to -1, and comment out the fork.
4268 if (pid != 0 && pid != -1)
4272 // pid = -1 signifies that lyx was unable
4273 // to fork. But we will do the save
4275 bool failed = false;
4276 TempFile tempfile("lyxautoXXXXXX.lyx");
4277 tempfile.setAutoRemove(false);
4278 FileName const tmp_ret = tempfile.name();
4279 if (!tmp_ret.empty()) {
4280 if (!buffer_.writeFile(tmp_ret))
4282 else if (!tmp_ret.moveTo(fname_))
4288 // failed to write/rename tmp_ret so try writing direct
4289 if (!buffer_.writeFile(fname_)) {
4290 // It is dangerous to do this in the child,
4291 // but safe in the parent, so...
4292 if (pid == -1) // emit message signal.
4293 buffer_.message(_("Autosave failed!"));
4297 if (pid == 0) // we are the child so...
4306 FileName Buffer::getEmergencyFileName() const
4308 return FileName(d->filename.absFileName() + ".emergency");
4312 FileName Buffer::getAutosaveFileName() const
4314 // if the document is unnamed try to save in the backup dir, else
4315 // in the default document path, and as a last try in the filePath,
4316 // which will most often be the temporary directory
4319 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4320 : lyxrc.backupdir_path;
4321 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4324 string const fname = "#" + d->filename.onlyFileName() + "#";
4326 return makeAbsPath(fname, fpath);
4330 void Buffer::removeAutosaveFile() const
4332 FileName const f = getAutosaveFileName();
4338 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
4340 FileName const newauto = getAutosaveFileName();
4342 if (newauto != oldauto && oldauto.exists())
4343 if (!oldauto.moveTo(newauto))
4344 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4348 bool Buffer::autoSave() const
4350 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4351 if (buf->d->bak_clean || hasReadonlyFlag())
4354 message(_("Autosaving current document..."));
4355 buf->d->bak_clean = true;
4357 FileName const fname = getAutosaveFileName();
4358 LASSERT(d->cloned_buffer_, return false);
4360 // If this buffer is cloned, we assume that
4361 // we are running in a separate thread already.
4362 TempFile tempfile("lyxautoXXXXXX.lyx");
4363 tempfile.setAutoRemove(false);
4364 FileName const tmp_ret = tempfile.name();
4365 if (!tmp_ret.empty()) {
4367 // assume successful write of tmp_ret
4368 if (tmp_ret.moveTo(fname))
4371 // failed to write/rename tmp_ret so try writing direct
4372 return writeFile(fname);
4376 void Buffer::setExportStatus(bool e) const
4378 d->doing_export = e;
4379 ListOfBuffers clist = getDescendents();
4380 ListOfBuffers::const_iterator cit = clist.begin();
4381 ListOfBuffers::const_iterator const cen = clist.end();
4382 for (; cit != cen; ++cit)
4383 (*cit)->d->doing_export = e;
4387 bool Buffer::isExporting() const
4389 return d->doing_export;
4393 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4397 return doExport(target, put_in_tempdir, result_file);
4400 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4401 string & result_file) const
4403 bool const update_unincluded =
4404 params().maintain_unincluded_children
4405 && !params().getIncludedChildren().empty();
4407 // (1) export with all included children (omit \includeonly)
4408 if (update_unincluded) {
4409 ExportStatus const status =
4410 doExport(target, put_in_tempdir, true, result_file);
4411 if (status != ExportSuccess)
4414 // (2) export with included children only
4415 return doExport(target, put_in_tempdir, false, result_file);
4419 void Buffer::setMathFlavor(OutputParams & op) const
4421 switch (params().html_math_output) {
4422 case BufferParams::MathML:
4423 op.math_flavor = OutputParams::MathAsMathML;
4425 case BufferParams::HTML:
4426 op.math_flavor = OutputParams::MathAsHTML;
4428 case BufferParams::Images:
4429 op.math_flavor = OutputParams::MathAsImages;
4431 case BufferParams::LaTeX:
4432 op.math_flavor = OutputParams::MathAsLaTeX;
4438 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4439 bool includeall, string & result_file) const
4441 LYXERR(Debug::FILES, "target=" << target);
4442 OutputParams runparams(¶ms().encoding());
4443 string format = target;
4444 string dest_filename;
4445 size_t pos = target.find(' ');
4446 if (pos != string::npos) {
4447 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4448 format = target.substr(0, pos);
4449 if (format == "default")
4450 format = params().getDefaultOutputFormat();
4451 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4452 FileName(dest_filename).onlyPath().createPath();
4453 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4455 MarkAsExporting exporting(this);
4456 string backend_format;
4457 runparams.flavor = OutputParams::LATEX;
4458 runparams.linelen = lyxrc.plaintext_linelen;
4459 runparams.includeall = includeall;
4460 vector<string> backs = params().backends();
4461 Converters converters = theConverters();
4462 bool need_nice_file = false;
4463 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4464 // Get shortest path to format
4465 converters.buildGraph();
4466 Graph::EdgePath path;
4467 for (vector<string>::const_iterator it = backs.begin();
4468 it != backs.end(); ++it) {
4469 Graph::EdgePath p = converters.getPath(*it, format);
4470 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4471 backend_format = *it;
4476 if (!put_in_tempdir) {
4477 // Only show this alert if this is an export to a non-temporary
4478 // file (not for previewing).
4479 Alert::error(_("Couldn't export file"), bformat(
4480 _("No information for exporting the format %1$s."),
4481 translateIfPossible(theFormats().prettyName(format))));
4483 return ExportNoPathToFormat;
4485 runparams.flavor = converters.getFlavor(path, this);
4486 runparams.hyperref_driver = converters.getHyperrefDriver(path);
4487 Graph::EdgePath::const_iterator it = path.begin();
4488 Graph::EdgePath::const_iterator en = path.end();
4489 for (; it != en; ++it)
4490 if (theConverters().get(*it).nice()) {
4491 need_nice_file = true;
4496 backend_format = format;
4497 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4498 // FIXME: Don't hardcode format names here, but use a flag
4499 if (backend_format == "pdflatex")
4500 runparams.flavor = OutputParams::PDFLATEX;
4501 else if (backend_format == "luatex")
4502 runparams.flavor = OutputParams::LUATEX;
4503 else if (backend_format == "dviluatex")
4504 runparams.flavor = OutputParams::DVILUATEX;
4505 else if (backend_format == "xetex")
4506 runparams.flavor = OutputParams::XETEX;
4509 string filename = latexName(false);
4510 filename = addName(temppath(), filename);
4511 filename = changeExtension(filename,
4512 theFormats().extension(backend_format));
4513 LYXERR(Debug::FILES, "filename=" << filename);
4515 // Plain text backend
4516 if (backend_format == "text") {
4517 runparams.flavor = OutputParams::TEXT;
4518 writePlaintextFile(*this, FileName(filename), runparams);
4521 else if (backend_format == "xhtml") {
4522 runparams.flavor = OutputParams::HTML;
4523 setMathFlavor(runparams);
4524 makeLyXHTMLFile(FileName(filename), runparams);
4525 } else if (backend_format == "lyx")
4526 writeFile(FileName(filename));
4528 else if (params().isDocBook()) {
4529 runparams.nice = !put_in_tempdir;
4530 makeDocBookFile(FileName(filename), runparams);
4533 else if (backend_format == format || need_nice_file) {
4534 runparams.nice = true;
4535 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4536 if (d->cloned_buffer_)
4537 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4540 } else if (!lyxrc.tex_allows_spaces
4541 && contains(filePath(), ' ')) {
4542 Alert::error(_("File name error"),
4543 bformat(_("The directory path to the document\n%1$s\n"
4544 "contains spaces, but your TeX installation does "
4545 "not allow them. You should save the file to a directory "
4546 "whose name does not contain spaces."), from_utf8(filePath())));
4547 return ExportTexPathHasSpaces;
4549 runparams.nice = false;
4550 bool const success = makeLaTeXFile(
4551 FileName(filename), filePath(), runparams);
4552 if (d->cloned_buffer_)
4553 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4558 string const error_type = (format == "program")
4559 ? "Build" : params().bufferFormat();
4560 ErrorList & error_list = d->errorLists[error_type];
4561 string const ext = theFormats().extension(format);
4562 FileName const tmp_result_file(changeExtension(filename, ext));
4563 bool const success = converters.convert(this, FileName(filename),
4564 tmp_result_file, FileName(absFileName()), backend_format, format,
4567 // Emit the signal to show the error list or copy it back to the
4568 // cloned Buffer so that it can be emitted afterwards.
4569 if (format != backend_format) {
4570 if (runparams.silent)
4572 else if (d->cloned_buffer_)
4573 d->cloned_buffer_->d->errorLists[error_type] =
4574 d->errorLists[error_type];
4577 // also to the children, in case of master-buffer-view
4578 ListOfBuffers clist = getDescendents();
4579 ListOfBuffers::const_iterator cit = clist.begin();
4580 ListOfBuffers::const_iterator const cen = clist.end();
4581 for (; cit != cen; ++cit) {
4582 if (runparams.silent)
4583 (*cit)->d->errorLists[error_type].clear();
4584 else if (d->cloned_buffer_) {
4585 // Enable reverse search by copying back the
4586 // texrow object to the cloned buffer.
4587 // FIXME: this is not thread safe.
4588 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4589 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4590 (*cit)->d->errorLists[error_type];
4592 (*cit)->errors(error_type, true);
4596 if (d->cloned_buffer_) {
4597 // Enable reverse dvi or pdf to work by copying back the texrow
4598 // object to the cloned buffer.
4599 // FIXME: There is a possibility of concurrent access to texrow
4600 // here from the main GUI thread that should be securized.
4601 d->cloned_buffer_->d->texrow = d->texrow;
4602 string const error_type = params().bufferFormat();
4603 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4607 if (put_in_tempdir) {
4608 result_file = tmp_result_file.absFileName();
4609 return success ? ExportSuccess : ExportConverterError;
4612 if (dest_filename.empty())
4613 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4615 result_file = dest_filename;
4616 // We need to copy referenced files (e. g. included graphics
4617 // if format == "dvi") to the result dir.
4618 vector<ExportedFile> const files =
4619 runparams.exportdata->externalFiles(format);
4620 string const dest = runparams.export_folder.empty() ?
4621 onlyPath(result_file) : runparams.export_folder;
4622 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4623 : force_overwrite == ALL_FILES;
4624 CopyStatus status = use_force ? FORCE : SUCCESS;
4626 vector<ExportedFile>::const_iterator it = files.begin();
4627 vector<ExportedFile>::const_iterator const en = files.end();
4628 for (; it != en && status != CANCEL; ++it) {
4629 string const fmt = theFormats().getFormatFromFile(it->sourceName);
4630 string fixedName = it->exportName;
4631 if (!runparams.export_folder.empty()) {
4632 // Relative pathnames starting with ../ will be sanitized
4633 // if exporting to a different folder
4634 while (fixedName.substr(0, 3) == "../")
4635 fixedName = fixedName.substr(3, fixedName.length() - 3);
4637 FileName fixedFileName = makeAbsPath(fixedName, dest);
4638 fixedFileName.onlyPath().createPath();
4639 status = copyFile(fmt, it->sourceName,
4641 it->exportName, status == FORCE,
4642 runparams.export_folder.empty());
4645 if (status == CANCEL) {
4646 message(_("Document export cancelled."));
4647 return ExportCancel;
4650 if (tmp_result_file.exists()) {
4651 // Finally copy the main file
4652 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4653 : force_overwrite != NO_FILES;
4654 if (status == SUCCESS && use_force)
4656 status = copyFile(format, tmp_result_file,
4657 FileName(result_file), result_file,
4659 if (status == CANCEL) {
4660 message(_("Document export cancelled."));
4661 return ExportCancel;
4663 message(bformat(_("Document exported as %1$s "
4665 translateIfPossible(theFormats().prettyName(format)),
4666 makeDisplayPath(result_file)));
4669 // This must be a dummy converter like fax (bug 1888)
4670 message(bformat(_("Document exported as %1$s"),
4671 translateIfPossible(theFormats().prettyName(format))));
4674 return success ? ExportSuccess : ExportConverterError;
4678 Buffer::ExportStatus Buffer::preview(string const & format) const
4680 bool const update_unincluded =
4681 params().maintain_unincluded_children
4682 && !params().getIncludedChildren().empty();
4683 return preview(format, update_unincluded);
4687 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4689 MarkAsExporting exporting(this);
4691 // (1) export with all included children (omit \includeonly)
4693 ExportStatus const status = doExport(format, true, true, result_file);
4694 if (status != ExportSuccess)
4697 // (2) export with included children only
4698 ExportStatus const status = doExport(format, true, false, result_file);
4699 FileName const previewFile(result_file);
4701 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4702 theimpl->preview_file_ = previewFile;
4703 theimpl->preview_format_ = format;
4704 theimpl->preview_error_ = (status != ExportSuccess);
4706 if (status != ExportSuccess)
4709 if (previewFile.exists())
4710 return theFormats().view(*this, previewFile, format) ?
4711 PreviewSuccess : PreviewError;
4713 // Successful export but no output file?
4714 // Probably a bug in error detection.
4715 LATTEST(status != ExportSuccess);
4720 Buffer::ReadStatus Buffer::extractFromVC()
4722 bool const found = LyXVC::file_not_found_hook(d->filename);
4724 return ReadFileNotFound;
4725 if (!d->filename.isReadableFile())
4731 Buffer::ReadStatus Buffer::loadEmergency()
4733 FileName const emergencyFile = getEmergencyFileName();
4734 if (!emergencyFile.exists()
4735 || emergencyFile.lastModified() <= d->filename.lastModified())
4736 return ReadFileNotFound;
4738 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4739 docstring const text = bformat(_("An emergency save of the document "
4740 "%1$s exists.\n\nRecover emergency save?"), file);
4742 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4743 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4749 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4750 bool const success = (ret_llf == ReadSuccess);
4752 if (hasReadonlyFlag()) {
4753 Alert::warning(_("File is read-only"),
4754 bformat(_("An emergency file is successfully loaded, "
4755 "but the original file %1$s is marked read-only. "
4756 "Please make sure to save the document as a different "
4757 "file."), from_utf8(d->filename.absFileName())));
4760 lyxvc().file_found_hook(d->filename);
4761 str = _("Document was successfully recovered.");
4763 str = _("Document was NOT successfully recovered.");
4764 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4765 makeDisplayPath(emergencyFile.absFileName()));
4767 int const del_emerg =
4768 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4769 _("&Remove"), _("&Keep"));
4770 if (del_emerg == 0) {
4771 emergencyFile.removeFile();
4773 Alert::warning(_("Emergency file deleted"),
4774 _("Do not forget to save your file now!"), true);
4776 return success ? ReadSuccess : ReadEmergencyFailure;
4779 int const del_emerg =
4780 Alert::prompt(_("Delete emergency file?"),
4781 _("Remove emergency file now?"), 1, 1,
4782 _("&Remove"), _("&Keep"));
4784 emergencyFile.removeFile();
4788 string const ename = emergencyFile.absFileName();
4790 // Surely we can find one in 100 tries?
4791 for (int i = 1; i < 100; ++i) {
4792 newname.set(ename + to_string(i) + ".lyx");
4793 if (!newname.exists()) {
4799 // renameTo returns true on success. So inverting that
4800 // will give us true if we fail.
4801 noname = !emergencyFile.renameTo(newname);
4804 Alert::warning(_("Can't rename emergency file!"),
4805 _("LyX was unable to rename the emergency file. "
4806 "You should do so manually. Otherwise, you will be"
4807 "asked about it again the next time you try to load"
4808 "this file, and may over-write your own work."));
4811 return ReadOriginal;
4821 Buffer::ReadStatus Buffer::loadAutosave()
4823 // Now check if autosave file is newer.
4824 FileName const autosaveFile = getAutosaveFileName();
4825 if (!autosaveFile.exists()
4826 || autosaveFile.lastModified() <= d->filename.lastModified())
4827 return ReadFileNotFound;
4829 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4830 docstring const text = bformat(_("The backup of the document %1$s "
4831 "is newer.\n\nLoad the backup instead?"), file);
4832 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4833 _("&Load backup"), _("Load &original"), _("&Cancel"));
4838 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4839 // the file is not saved if we load the autosave file.
4840 if (ret_llf == ReadSuccess) {
4841 if (hasReadonlyFlag()) {
4842 Alert::warning(_("File is read-only"),
4843 bformat(_("A backup file is successfully loaded, "
4844 "but the original file %1$s is marked read-only. "
4845 "Please make sure to save the document as a "
4847 from_utf8(d->filename.absFileName())));
4850 lyxvc().file_found_hook(d->filename);
4853 return ReadAutosaveFailure;
4856 // Here we delete the autosave
4857 autosaveFile.removeFile();
4858 return ReadOriginal;
4866 Buffer::ReadStatus Buffer::loadLyXFile()
4868 if (!d->filename.isReadableFile()) {
4869 ReadStatus const ret_rvc = extractFromVC();
4870 if (ret_rvc != ReadSuccess)
4874 ReadStatus const ret_re = loadEmergency();
4875 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4878 ReadStatus const ret_ra = loadAutosave();
4879 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4882 return loadThisLyXFile(d->filename);
4886 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4888 return readFile(fn);
4892 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4894 for (auto const & err : terr) {
4895 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4896 int errorRow = err.error_in_line;
4897 Buffer const * buf = 0;
4899 if (err.child_name.empty())
4900 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4902 // The error occurred in a child
4903 for (Buffer const * child : getDescendents()) {
4904 string const child_name =
4905 DocFileName(changeExtension(child->absFileName(), "tex")).
4907 if (err.child_name != child_name)
4909 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4910 if (!TexRow::isNone(start)) {
4911 buf = d->cloned_buffer_
4912 ? child->d->cloned_buffer_->d->owner_
4919 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4925 void Buffer::setBuffersForInsets() const
4927 inset().setBuffer(const_cast<Buffer &>(*this));
4931 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4933 LBUFERR(!text().paragraphs().empty());
4935 // Use the master text class also for child documents
4936 Buffer const * const master = masterBuffer();
4937 DocumentClass const & textclass = master->params().documentClass();
4939 docstring_list old_bibfiles;
4940 // Do this only if we are the top-level Buffer. We also need to account
4941 // for the case of a previewed child with ignored parent here.
4942 if (master == this && !d->ignore_parent) {
4943 textclass.counters().reset(from_ascii("bibitem"));
4944 reloadBibInfoCache();
4945 // we will re-read this cache as we go through, but we need
4946 // to know whether it's changed to know whether we need to
4947 // update the bibinfo cache.
4948 old_bibfiles = d->bibfiles_cache_;
4949 d->bibfiles_cache_.clear();
4952 // keep the buffers to be children in this set. If the call from the
4953 // master comes back we can see which of them were actually seen (i.e.
4954 // via an InsetInclude). The remaining ones in the set need still be updated.
4955 static std::set<Buffer const *> bufToUpdate;
4956 if (scope == UpdateMaster) {
4957 // If this is a child document start with the master
4958 if (master != this) {
4959 bufToUpdate.insert(this);
4960 master->updateBuffer(UpdateMaster, utype);
4961 // If the master buffer has no gui associated with it, then the TocModel is
4962 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4963 // (bug 5699). The same happens if the master buffer is open in a different
4964 // window. This test catches both possibilities.
4965 // See: https://marc.info/?l=lyx-devel&m=138590578911716&w=2
4966 // There remains a problem here: If there is another child open in yet a third
4967 // window, that TOC is not updated. So some more general solution is needed at
4969 if (master->d->gui_ != d->gui_)
4972 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4973 if (bufToUpdate.find(this) == bufToUpdate.end())
4977 // start over the counters in the master
4978 textclass.counters().reset();
4981 // update will be done below for this buffer
4982 bufToUpdate.erase(this);
4984 // update all caches
4985 clearReferenceCache();
4987 setChangesPresent(false);
4989 Buffer & cbuf = const_cast<Buffer &>(*this);
4992 ParIterator parit = cbuf.par_iterator_begin();
4993 updateBuffer(parit, utype);
4996 // If this document has siblings, then update the TocBackend later. The
4997 // reason is to ensure that later siblings are up to date when e.g. the
4998 // broken or not status of references is computed. The update is called
4999 // in InsetInclude::addToToc.
5002 // if the bibfiles changed, the cache of bibinfo is invalid
5003 docstring_list new_bibfiles = d->bibfiles_cache_;
5004 // this is a trick to determine whether the two vectors have
5005 // the same elements.
5006 sort(new_bibfiles.begin(), new_bibfiles.end());
5007 sort(old_bibfiles.begin(), old_bibfiles.end());
5008 if (old_bibfiles != new_bibfiles) {
5009 LYXERR(Debug::FILES, "Reloading bibinfo cache.");
5010 invalidateBibinfoCache();
5011 reloadBibInfoCache();
5012 // We relied upon the bibinfo cache when recalculating labels. But that
5013 // cache was invalid, although we didn't find that out until now. So we
5014 // have to do it all again.
5015 // That said, the only thing we really need to do is update the citation
5016 // labels. Nothing else will have changed. So we could create a new
5017 // UpdateType that would signal that fact, if we needed to do so.
5018 parit = cbuf.par_iterator_begin();
5019 // we will be re-doing the counters and references and such.
5020 textclass.counters().reset();
5021 clearReferenceCache();
5022 // we should not need to do this again?
5024 setChangesPresent(false);
5025 updateBuffer(parit, utype);
5026 // this will already have been done by reloadBibInfoCache();
5027 // d->bibinfo_cache_valid_ = true;
5030 LYXERR(Debug::FILES, "Bibfiles unchanged.");
5031 // this is also set to true on the other path, by reloadBibInfoCache.
5032 d->bibinfo_cache_valid_ = true;
5034 d->cite_labels_valid_ = true;
5036 cbuf.tocBackend().update(true, utype);
5037 if (scope == UpdateMaster)
5038 cbuf.structureChanged();
5042 static depth_type getDepth(DocIterator const & it)
5044 depth_type depth = 0;
5045 for (size_t i = 0 ; i < it.depth() ; ++i)
5046 if (!it[i].inset().inMathed())
5047 depth += it[i].paragraph().getDepth() + 1;
5048 // remove 1 since the outer inset does not count
5049 // we should have at least one non-math inset, so
5050 // depth should nevery be 0. but maybe it is worth
5051 // marking this, just in case.
5053 // coverity[INTEGER_OVERFLOW]
5057 static depth_type getItemDepth(ParIterator const & it)
5059 Paragraph const & par = *it;
5060 LabelType const labeltype = par.layout().labeltype;
5062 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
5065 // this will hold the lowest depth encountered up to now.
5066 depth_type min_depth = getDepth(it);
5067 ParIterator prev_it = it;
5070 --prev_it.top().pit();
5072 // start of nested inset: go to outer par
5074 if (prev_it.empty()) {
5075 // start of document: nothing to do
5080 // We search for the first paragraph with same label
5081 // that is not more deeply nested.
5082 Paragraph & prev_par = *prev_it;
5083 depth_type const prev_depth = getDepth(prev_it);
5084 if (labeltype == prev_par.layout().labeltype) {
5085 if (prev_depth < min_depth)
5086 return prev_par.itemdepth + 1;
5087 if (prev_depth == min_depth)
5088 return prev_par.itemdepth;
5090 min_depth = min(min_depth, prev_depth);
5091 // small optimization: if we are at depth 0, we won't
5092 // find anything else
5093 if (prev_depth == 0)
5099 static bool needEnumCounterReset(ParIterator const & it)
5101 Paragraph const & par = *it;
5102 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
5103 depth_type const cur_depth = par.getDepth();
5104 ParIterator prev_it = it;
5105 while (prev_it.pit()) {
5106 --prev_it.top().pit();
5107 Paragraph const & prev_par = *prev_it;
5108 if (prev_par.getDepth() <= cur_depth)
5109 return prev_par.layout().name() != par.layout().name();
5111 // start of nested inset: reset
5116 // set the label of a paragraph. This includes the counters.
5117 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
5119 BufferParams const & bp = owner_->masterBuffer()->params();
5120 DocumentClass const & textclass = bp.documentClass();
5121 Paragraph & par = it.paragraph();
5122 Layout const & layout = par.layout();
5123 Counters & counters = textclass.counters();
5125 if (par.params().startOfAppendix()) {
5126 // We want to reset the counter corresponding to toplevel sectioning
5127 Layout const & lay = textclass.getTOCLayout();
5128 docstring const cnt = lay.counter;
5130 counters.reset(cnt);
5131 counters.appendix(true);
5133 par.params().appendix(counters.appendix());
5135 // Compute the item depth of the paragraph
5136 par.itemdepth = getItemDepth(it);
5138 if (layout.margintype == MARGIN_MANUAL) {
5139 if (par.params().labelWidthString().empty())
5140 par.params().labelWidthString(par.expandLabel(layout, bp));
5141 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
5142 // we do not need to do anything here, since the empty case is
5143 // handled during export.
5145 par.params().labelWidthString(docstring());
5148 switch(layout.labeltype) {
5149 case LABEL_ITEMIZE: {
5150 // At some point of time we should do something more
5151 // clever here, like:
5152 // par.params().labelString(
5153 // bp.user_defined_bullet(par.itemdepth).getText());
5154 // for now, use a simple hardcoded label
5155 docstring itemlabel;
5156 switch (par.itemdepth) {
5158 itemlabel = char_type(0x2022);
5161 itemlabel = char_type(0x2013);
5164 itemlabel = char_type(0x2217);
5167 itemlabel = char_type(0x2219); // or 0x00b7
5170 par.params().labelString(itemlabel);
5174 case LABEL_ENUMERATE: {
5175 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
5177 switch (par.itemdepth) {
5188 enumcounter += "iv";
5191 // not a valid enumdepth...
5195 // Increase the master counter?
5196 if (layout.stepmastercounter && needEnumCounterReset(it))
5197 counters.stepMaster(enumcounter, utype);
5199 // Maybe we have to reset the enumeration counter.
5200 if (!layout.resumecounter && needEnumCounterReset(it))
5201 counters.reset(enumcounter);
5202 counters.step(enumcounter, utype);
5204 string const & lang = par.getParLanguage(bp)->code();
5205 par.params().labelString(counters.theCounter(enumcounter, lang));
5210 case LABEL_SENSITIVE: {
5211 string const & type = counters.current_float();
5212 docstring full_label;
5214 full_label = owner_->B_("Senseless!!! ");
5216 docstring name = owner_->B_(textclass.floats().getType(type).name());
5217 if (counters.hasCounter(from_utf8(type))) {
5218 string const & lang = par.getParLanguage(bp)->code();
5219 counters.step(from_utf8(type), utype);
5220 full_label = bformat(from_ascii("%1$s %2$s:"),
5222 counters.theCounter(from_utf8(type), lang));
5224 full_label = bformat(from_ascii("%1$s #:"), name);
5226 par.params().labelString(full_label);
5230 case LABEL_NO_LABEL:
5231 par.params().labelString(docstring());
5235 case LABEL_CENTERED:
5236 case LABEL_STATIC: {
5237 docstring const & lcounter = layout.counter;
5238 if (!lcounter.empty()) {
5239 if (layout.toclevel <= bp.secnumdepth
5240 && (layout.latextype != LATEX_ENVIRONMENT
5241 || it.text()->isFirstInSequence(it.pit()))) {
5242 if (counters.hasCounter(lcounter))
5243 counters.step(lcounter, utype);
5244 par.params().labelString(par.expandLabel(layout, bp));
5246 par.params().labelString(docstring());
5248 par.params().labelString(par.expandLabel(layout, bp));
5254 par.params().labelString(par.expandLabel(layout, bp));
5259 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
5261 // LASSERT: Is it safe to continue here, or should we just return?
5262 LASSERT(parit.pit() == 0, /**/);
5264 // Set the position of the text in the buffer to be able
5265 // to resolve macros in it.
5266 parit.text()->setMacrocontextPosition(parit);
5268 depth_type maxdepth = 0;
5269 pit_type const lastpit = parit.lastpit();
5270 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5271 // reduce depth if necessary
5272 if (parit->params().depth() > maxdepth) {
5273 /** FIXME: this function is const, but
5274 * nevertheless it modifies the buffer. To be
5275 * cleaner, one should modify the buffer in
5276 * another function, which is actually
5277 * non-const. This would however be costly in
5278 * terms of code duplication.
5280 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
5281 parit->params().depth(maxdepth);
5283 maxdepth = parit->getMaxDepthAfter();
5285 if (utype == OutputUpdate) {
5286 // track the active counters
5287 // we have to do this for the master buffer, since the local
5288 // buffer isn't tracking anything.
5289 masterBuffer()->params().documentClass().counters().
5290 setActiveLayout(parit->layout());
5293 // set the counter for this paragraph
5294 d->setLabel(parit, utype);
5296 // update change-tracking flag
5297 parit->addChangesToBuffer(*this);
5300 InsetList::const_iterator iit = parit->insetList().begin();
5301 InsetList::const_iterator end = parit->insetList().end();
5302 for (; iit != end; ++iit) {
5303 parit.pos() = iit->pos;
5304 iit->inset->updateBuffer(parit, utype);
5310 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5311 WordLangTuple & word_lang, docstring_list & suggestions) const
5315 suggestions.clear();
5316 word_lang = WordLangTuple();
5317 bool const to_end = to.empty();
5318 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5319 // OK, we start from here.
5320 for (; from != end; from.forwardPos()) {
5321 // This skips all insets with spell check disabled.
5322 while (!from.allowSpellCheck()) {
5326 // If from is at the end of the document (which is possible
5327 // when "from" was changed above) LyX will crash later otherwise.
5328 if (from.atEnd() || (!to_end && from >= end))
5331 from.paragraph().spellCheck();
5332 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5333 if (SpellChecker::misspelled(res)) {
5337 // Do not increase progress when from == to, otherwise the word
5338 // count will be wrong.
5348 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5350 bool inword = false;
5355 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5356 if (!dit.inTexted()) {
5361 Paragraph const & par = dit.paragraph();
5362 pos_type const pos = dit.pos();
5364 // Copied and adapted from isWordSeparator() in Paragraph
5365 if (pos == dit.lastpos()) {
5368 Inset const * ins = par.getInset(pos);
5369 if (ins && skipNoOutput && !ins->producesOutput()) {
5372 // stop if end of range was skipped
5373 if (!to.atEnd() && dit >= to)
5376 } else if (!par.isDeleted(pos)) {
5377 if (par.isWordSeparator(pos))
5383 if (ins && ins->isLetter())
5385 else if (ins && ins->isSpace())
5388 char_type const c = par.getChar(pos);
5389 if (isPrintableNonspace(c))
5391 else if (isSpace(c))
5401 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5403 d->updateStatistics(from, to, skipNoOutput);
5407 int Buffer::wordCount() const
5409 return d->wordCount();
5413 int Buffer::charCount(bool with_blanks) const
5415 return d->charCount(with_blanks);
5419 Buffer::ReadStatus Buffer::reload()
5422 // c.f. bug https://www.lyx.org/trac/ticket/6587
5423 removeAutosaveFile();
5424 // e.g., read-only status could have changed due to version control
5425 d->filename.refresh();
5426 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5428 // clear parent. this will get reset if need be.
5430 ReadStatus const status = loadLyXFile();
5431 if (status == ReadSuccess) {
5436 message(bformat(_("Document %1$s reloaded."), disp_fn));
5439 message(bformat(_("Could not reload document %1$s."), disp_fn));
5449 bool Buffer::saveAs(FileName const & fn)
5451 FileName const old_name = fileName();
5452 FileName const old_auto = getAutosaveFileName();
5453 bool const old_unnamed = isUnnamed();
5454 bool success = true;
5455 d->old_position = filePath();
5462 // bring the autosave file with us, just in case.
5463 moveAutosaveFile(old_auto);
5464 // validate version control data and
5465 // correct buffer title
5466 lyxvc().file_found_hook(fileName());
5468 // the file has now been saved to the new location.
5469 // we need to check that the locations of child buffers
5471 checkChildBuffers();
5472 checkMasterBuffer();
5475 // reset the old filename and unnamed state
5476 setFileName(old_name);
5477 setUnnamed(old_unnamed);
5481 d->old_position.clear();
5486 void Buffer::checkChildBuffers()
5488 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5489 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5490 for (; it != en; ++it) {
5491 DocIterator dit = it->second;
5492 Buffer * cbuf = const_cast<Buffer *>(it->first);
5493 if (!cbuf || !theBufferList().isLoaded(cbuf))
5495 Inset * inset = dit.nextInset();
5496 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5497 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5498 docstring const & incfile = inset_inc->getParam("filename");
5499 string oldloc = cbuf->absFileName();
5500 string newloc = makeAbsPath(to_utf8(incfile),
5501 onlyPath(absFileName())).absFileName();
5502 if (oldloc == newloc)
5504 // the location of the child file is incorrect.
5506 inset_inc->setChildBuffer(0);
5508 // invalidate cache of children
5509 d->children_positions.clear();
5510 d->position_to_children.clear();
5514 // If a child has been saved under a different name/path, it might have been
5515 // orphaned. Therefore the master needs to be reset (bug 8161).
5516 void Buffer::checkMasterBuffer()
5518 Buffer const * const master = masterBuffer();
5522 // necessary to re-register the child (bug 5873)
5523 // FIXME: clean up updateMacros (here, only
5524 // child registering is needed).
5525 master->updateMacros();
5526 // (re)set master as master buffer, but only
5527 // if we are a real child
5528 if (master->isChild(this))
5535 string Buffer::includedFilePath(string const & name, string const & ext) const
5537 if (d->old_position.empty() ||
5538 equivalent(FileName(d->old_position), FileName(filePath())))
5541 bool isabsolute = FileName::isAbsolute(name);
5542 // both old_position and filePath() end with a path separator
5543 string absname = isabsolute ? name : d->old_position + name;
5545 // if old_position is set to origin, we need to do the equivalent of
5546 // getReferencedFileName() (see readDocument())
5547 if (!isabsolute && d->old_position == params().origin) {
5548 FileName const test(addExtension(filePath() + name, ext));
5550 absname = filePath() + name;
5553 if (!FileName(addExtension(absname, ext)).exists())
5557 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5559 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5560 from_utf8(filePath())));
5564 void Buffer::setChangesPresent(bool b) const
5566 d->tracked_changes_present_ = b;
5570 bool Buffer::areChangesPresent() const
5572 return d->tracked_changes_present_;
5576 void Buffer::updateChangesPresent() const
5578 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5579 setChangesPresent(false);
5580 ParConstIterator it = par_iterator_begin();
5581 ParConstIterator const end = par_iterator_end();
5582 for (; !areChangesPresent() && it != end; ++it)
5583 it->addChangesToBuffer(*this);
5587 void Buffer::Impl::refreshFileMonitor()
5589 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5590 file_monitor_->refresh();
5594 // The previous file monitor is invalid
5595 // This also destroys the previous file monitor and all its connections
5596 file_monitor_ = FileSystemWatcher::monitor(filename);
5597 // file_monitor_ will be destroyed with *this, so it is not going to call a
5598 // destroyed object method.
5599 file_monitor_->connect([this](bool exists) {
5600 fileExternallyModified(exists);
5605 void Buffer::Impl::fileExternallyModified(bool const exists)
5607 // ignore notifications after our own saving operations
5608 if (checksum_ == filename.checksum()) {
5609 LYXERR(Debug::FILES, "External modification but "
5610 "checksum unchanged: " << filename);
5613 // If the file has been deleted, only mark the file as dirty since it is
5614 // pointless to prompt for reloading. If later a file is moved into this
5615 // location, then the externally modified warning will appear then.
5617 externally_modified_ = true;
5618 // Update external modification notification.
5619 // Dirty buffers must be visible at all times.
5620 if (wa_ && wa_->unhide(owner_))
5621 wa_->updateTitles();
5623 // Unable to unhide the buffer (e.g. no GUI or not current View)
5628 bool Buffer::notifiesExternalModification() const
5630 return d->externally_modified_;
5634 void Buffer::clearExternalModification() const
5636 d->externally_modified_ = false;
5638 d->wa_->updateTitles();