3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
49 #include "output_docbook.h"
51 #include "output_latex.h"
52 #include "output_xhtml.h"
53 #include "output_plaintext.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
59 #include "SpellChecker.h"
61 #include "texstream.h"
64 #include "TextClass.h"
65 #include "TocBackend.h"
67 #include "VCBackend.h"
69 #include "WordLangTuple.h"
72 #include "insets/InsetBibtex.h"
73 #include "insets/InsetBranch.h"
74 #include "insets/InsetInclude.h"
75 #include "insets/InsetTabular.h"
76 #include "insets/InsetText.h"
78 #include "mathed/InsetMathHull.h"
79 #include "mathed/MacroTable.h"
80 #include "mathed/InsetMathMacroTemplate.h"
81 #include "mathed/MathSupport.h"
83 #include "graphics/GraphicsCache.h"
84 #include "graphics/PreviewLoader.h"
86 #include "frontends/alert.h"
87 #include "frontends/Delegates.h"
88 #include "frontends/WorkAreaManager.h"
90 #include "support/lassert.h"
91 #include "support/convert.h"
92 #include "support/debug.h"
93 #include "support/docstring_list.h"
94 #include "support/ExceptionMessage.h"
95 #include "support/FileMonitor.h"
96 #include "support/FileName.h"
97 #include "support/FileNameList.h"
98 #include "support/filetools.h"
99 #include "support/ForkedCalls.h"
100 #include "support/gettext.h"
101 #include "support/gzstream.h"
102 #include "support/lstrings.h"
103 #include "support/lyxalgo.h"
104 #include "support/mutex.h"
105 #include "support/os.h"
106 #include "support/Package.h"
107 #include "support/PathChanger.h"
108 #include "support/Systemcall.h"
109 #include "support/TempFile.h"
110 #include "support/textutils.h"
111 #include "support/types.h"
113 #include "support/bind.h"
125 using namespace lyx::support;
126 using namespace lyx::graphics;
130 namespace Alert = frontend::Alert;
131 namespace os = support::os;
135 int const LYX_FORMAT = LYX_FORMAT_LYX;
137 typedef map<string, bool> DepClean;
138 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
143 // A storehouse for the cloned buffers.
144 list<CloneList *> cloned_buffers;
150 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
154 delete preview_loader_;
162 /// search for macro in local (buffer) table or in children
163 MacroData const * getBufferMacro(docstring const & name,
164 DocIterator const & pos) const;
166 /// Update macro table starting with position of it \param it in some
168 void updateMacros(DocIterator & it, DocIterator & scope);
170 void setLabel(ParIterator & it, UpdateType utype) const;
172 /** If we have branches that use the file suffix
173 feature, return the file name with suffix appended.
175 FileName exportFileName() const;
182 mutable TexRow texrow;
184 /// need to regenerate .tex?
188 mutable bool lyx_clean;
190 /// is autosave needed?
191 mutable bool bak_clean;
193 /// is this an unnamed file (New...)?
196 /// is this an internal bufffer?
197 bool internal_buffer;
202 /// name of the file the buffer is associated with.
205 /** Set to true only when the file is fully loaded.
206 * Used to prevent the premature generation of previews
207 * and by the citation inset.
209 bool file_fully_loaded;
211 /// original format of loaded file
214 /// if the file was originally loaded from an older format, do
215 /// we need to back it up still?
216 bool need_format_backup;
218 /// Ignore the parent (e.g. when exporting a child standalone)?
222 mutable TocBackend toc_backend;
227 ScopeMacro(DocIterator const & s, MacroData const & m)
228 : scope(s), macro(m) {}
232 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
233 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
234 /// map from the macro name to the position map,
235 /// which maps the macro definition position to the scope and the MacroData.
236 NamePositionScopeMacroMap macros;
237 /// This seem to change the way Buffer::getMacro() works
238 mutable bool macro_lock;
240 /// positions of child buffers in the buffer
241 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
243 ScopeBuffer() : buffer(0) {}
244 ScopeBuffer(DocIterator const & s, Buffer const * b)
245 : scope(s), buffer(b) {}
247 Buffer const * buffer;
249 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
250 /// position of children buffers in this buffer
251 BufferPositionMap children_positions;
252 /// map from children inclusion positions to their scope and their buffer
253 PositionScopeBufferMap position_to_children;
255 /// Contains the old buffer filePath() while saving-as, or the
256 /// directory where the document was last saved while loading.
259 /** Keeps track of the path of local layout files.
260 * If possible, it is always relative to the buffer path.
261 * Empty for layouts in system or user directory.
263 string layout_position;
265 /// Container for all sort of Buffer dependant errors.
266 map<string, ErrorList> errorLists;
268 /// checksum used to test if the file has been externally modified. Used to
269 /// double check whether the file had been externally modified when saving.
270 unsigned long checksum_;
273 frontend::WorkAreaManager * wa_;
275 frontend::GuiBufferDelegate * gui_;
280 /// A cache for the bibfiles (including bibfiles of loaded child
281 /// documents), needed for appropriate update of natbib labels.
282 mutable FileNamePairList bibfiles_cache_;
284 // FIXME The caching mechanism could be improved. At present, we have a
285 // cache for each Buffer, that caches all the bibliography info for that
286 // Buffer. A more efficient solution would be to have a global cache per
287 // file, and then to construct the Buffer's bibinfo from that.
288 /// A cache for bibliography info
289 mutable BiblioInfo bibinfo_;
290 /// whether the bibinfo cache is valid
291 mutable bool bibinfo_cache_valid_;
292 /// whether the bibfile cache is valid
293 mutable bool bibfile_cache_valid_;
294 /// Cache of timestamps of .bib files
295 map<FileName, time_t> bibfile_status_;
296 /// Indicates whether the bibinfo has changed since the last time
297 /// we ran updateBuffer(), i.e., whether citation labels may need
299 mutable bool cite_labels_valid_;
301 /// These two hold the file name and format, written to by
302 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
303 FileName preview_file_;
304 string preview_format_;
305 /// If there was an error when previewing, on the next preview we do
306 /// a fresh compile (e.g. in case the user installed a package that
310 mutable RefCache ref_cache_;
312 /// our Text that should be wrapped in an InsetText
316 PreviewLoader * preview_loader_;
318 /// This is here to force the test to be done whenever parent_buffer
320 Buffer const * parent() const
322 // ignore_parent temporarily "orphans" a buffer
323 // (e.g. if a child is compiled standalone)
326 // if parent_buffer is not loaded, then it has been unloaded,
327 // which means that parent_buffer is an invalid pointer. So we
328 // set it to null in that case.
329 // however, the BufferList doesn't know about cloned buffers, so
330 // they will always be regarded as unloaded. in that case, we hope
332 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
334 return parent_buffer;
338 void setParent(Buffer const * pb)
340 if (parent_buffer == pb)
343 if (!cloned_buffer_ && parent_buffer && pb)
344 LYXERR0("Warning: a buffer should not have two parents!");
346 if (!cloned_buffer_ && parent_buffer) {
347 parent_buffer->invalidateBibfileCache();
348 parent_buffer->invalidateBibinfoCache();
352 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
353 /// This one is useful for preview detached in a thread.
354 Buffer const * cloned_buffer_;
356 CloneList * clone_list_;
357 /// are we in the process of exporting this buffer?
358 mutable bool doing_export;
360 /// compute statistics
361 /// \p from initial position
362 /// \p to points to the end position
363 void updateStatistics(DocIterator & from, DocIterator & to,
364 bool skipNoOutput = true);
365 /// statistics accessor functions
366 int wordCount() const
370 int charCount(bool with_blanks) const
373 + (with_blanks ? blank_count_ : 0);
376 // does the buffer contain tracked changes? (if so, we automatically
377 // display the review toolbar, for instance)
378 mutable bool tracked_changes_present_;
380 // Make sure the file monitor monitors the good file.
381 void refreshFileMonitor();
383 /// Notify or clear of external modification
384 void fileExternallyModified(bool exists);
386 /// has been externally modified? Can be reset by the user.
387 mutable bool externally_modified_;
390 /// So we can force access via the accessors.
391 mutable Buffer const * parent_buffer;
397 FileMonitorPtr file_monitor_;
401 /// Creates the per buffer temporary directory
402 static FileName createBufferTmpDir()
404 // FIXME This would be the ideal application for a TempDir class (like
405 // TempFile but for directories)
410 Mutex::Locker locker(&mutex);
411 counter = convert<string>(count++);
413 // We are in our own directory. Why bother to mangle name?
414 // In fact I wrote this code to circumvent a problematic behaviour
415 // (bug?) of EMX mkstemp().
416 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
419 if (!tmpfl.createDirectory(0777)) {
420 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
421 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
422 from_utf8(tmpfl.absFileName())));
428 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
429 Buffer const * cloned_buffer)
430 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
431 internal_buffer(false), read_only(readonly_), filename(file),
432 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
433 ignore_parent(false), toc_backend(owner), macro_lock(false),
434 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
435 bibfile_cache_valid_(false), cite_labels_valid_(false), preview_error_(false),
436 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
437 clone_list_(0), doing_export(false),
438 tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
439 word_count_(0), char_count_(0), blank_count_(0)
441 refreshFileMonitor();
442 if (!cloned_buffer_) {
443 temppath = createBufferTmpDir();
444 lyxvc.setBuffer(owner_);
446 wa_ = new frontend::WorkAreaManager;
449 temppath = cloned_buffer_->d->temppath;
450 file_fully_loaded = true;
451 params = cloned_buffer_->d->params;
452 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
453 bibinfo_ = cloned_buffer_->d->bibinfo_;
454 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
455 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
456 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
457 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
458 unnamed = cloned_buffer_->d->unnamed;
459 internal_buffer = cloned_buffer_->d->internal_buffer;
460 layout_position = cloned_buffer_->d->layout_position;
461 preview_file_ = cloned_buffer_->d->preview_file_;
462 preview_format_ = cloned_buffer_->d->preview_format_;
463 preview_error_ = cloned_buffer_->d->preview_error_;
464 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
468 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
469 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
471 LYXERR(Debug::INFO, "Buffer::Buffer()");
473 d->inset = new InsetText(*cloned_buffer->d->inset);
474 d->inset->setBuffer(*this);
475 // FIXME: optimize this loop somewhat, maybe by creating a new
476 // general recursive Inset::setId().
477 DocIterator it = doc_iterator_begin(this);
478 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
479 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
480 it.paragraph().setId(cloned_it.paragraph().id());
482 d->inset = new InsetText(this);
483 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
489 LYXERR(Debug::INFO, "Buffer::~Buffer()");
490 // here the buffer should take care that it is
491 // saved properly, before it goes into the void.
493 // GuiView already destroyed
497 // No need to do additional cleanups for internal buffer.
503 // this is in case of recursive includes: we won't try to delete
504 // ourselves as a child.
505 d->clone_list_->erase(this);
506 // loop over children
507 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
508 Impl::BufferPositionMap::iterator end = d->children_positions.end();
509 for (; it != end; ++it) {
510 Buffer * child = const_cast<Buffer *>(it->first);
511 if (d->clone_list_->erase(child))
514 // if we're the master buffer, then we should get rid of the list
517 // If this is not empty, we have leaked something. Worse, one of the
518 // children still has a reference to this list. But we will try to
519 // continue, rather than shut down.
520 LATTEST(d->clone_list_->empty());
521 list<CloneList *>::iterator it =
522 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
523 if (it == cloned_buffers.end()) {
524 // We will leak in this case, but it is safe to continue.
527 cloned_buffers.erase(it);
528 delete d->clone_list_;
530 // FIXME Do we really need to do this right before we delete d?
531 // clear references to children in macro tables
532 d->children_positions.clear();
533 d->position_to_children.clear();
535 // loop over children
536 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
537 Impl::BufferPositionMap::iterator end = d->children_positions.end();
538 for (; it != end; ++it) {
539 Buffer * child = const_cast<Buffer *>(it->first);
540 if (theBufferList().isLoaded(child)) {
541 if (theBufferList().isOthersChild(this, child))
544 theBufferList().release(child);
549 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
551 msg += emergencyWrite();
553 msg += " " + _("Save failed! Document is lost.");
555 Alert::warning(_("Attempting to close changed document!"), msg);
558 // FIXME Do we really need to do this right before we delete d?
559 // clear references to children in macro tables
560 d->children_positions.clear();
561 d->position_to_children.clear();
563 if (!d->temppath.destroyDirectory()) {
564 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
565 from_utf8(d->temppath.absFileName())));
574 Buffer * Buffer::cloneFromMaster() const
577 cloned_buffers.push_back(new CloneList);
578 CloneList * clones = cloned_buffers.back();
580 masterBuffer()->cloneWithChildren(bufmap, clones);
582 // make sure we got cloned
583 BufferMap::const_iterator bit = bufmap.find(this);
584 LASSERT(bit != bufmap.end(), return 0);
585 Buffer * cloned_buffer = bit->second;
587 return cloned_buffer;
591 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
593 // have we already been cloned?
594 if (bufmap.find(this) != bufmap.end())
597 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
599 // The clone needs its own DocumentClass, since running updateBuffer() will
600 // modify it, and we would otherwise be sharing it with the original Buffer.
601 buffer_clone->params().makeDocumentClass(true);
603 cap::switchBetweenClasses(
604 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
605 static_cast<InsetText &>(buffer_clone->inset()), el);
607 bufmap[this] = buffer_clone;
608 clones->insert(buffer_clone);
609 buffer_clone->d->clone_list_ = clones;
610 buffer_clone->d->macro_lock = true;
611 buffer_clone->d->children_positions.clear();
613 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
614 // math macro caches need to be rethought and simplified.
615 // I am not sure wether we should handle Buffer cloning here or in BufferList.
616 // Right now BufferList knows nothing about buffer clones.
617 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
618 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
619 for (; it != end; ++it) {
620 DocIterator dit = it->first.clone(buffer_clone);
621 dit.setBuffer(buffer_clone);
622 Buffer * child = const_cast<Buffer *>(it->second.buffer);
624 child->cloneWithChildren(bufmap, clones);
625 BufferMap::iterator const bit = bufmap.find(child);
626 LASSERT(bit != bufmap.end(), continue);
627 Buffer * child_clone = bit->second;
629 Inset * inset = dit.nextInset();
630 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
631 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
632 inset_inc->setChildBuffer(child_clone);
633 child_clone->d->setParent(buffer_clone);
634 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
635 buffer_clone->setChild(dit, child_clone);
637 buffer_clone->d->macro_lock = false;
642 Buffer * Buffer::cloneBufferOnly() const {
643 cloned_buffers.push_back(new CloneList);
644 CloneList * clones = cloned_buffers.back();
645 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
647 // The clone needs its own DocumentClass, since running updateBuffer() will
648 // modify it, and we would otherwise be sharing it with the original Buffer.
649 buffer_clone->params().makeDocumentClass(true);
651 cap::switchBetweenClasses(
652 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
653 static_cast<InsetText &>(buffer_clone->inset()), el);
655 clones->insert(buffer_clone);
656 buffer_clone->d->clone_list_ = clones;
658 // we won't be cloning the children
659 buffer_clone->d->children_positions.clear();
664 bool Buffer::isClone() const
666 return d->cloned_buffer_;
670 void Buffer::changed(bool update_metrics) const
673 d->wa_->redrawAll(update_metrics);
677 frontend::WorkAreaManager & Buffer::workAreaManager() const
684 Text & Buffer::text() const
686 return d->inset->text();
690 Inset & Buffer::inset() const
696 BufferParams & Buffer::params()
702 BufferParams const & Buffer::params() const
708 BufferParams const & Buffer::masterParams() const
710 if (masterBuffer() == this)
713 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
714 // Copy child authors to the params. We need those pointers.
715 AuthorList const & child_authors = params().authors();
716 AuthorList::Authors::const_iterator it = child_authors.begin();
717 for (; it != child_authors.end(); ++it)
718 mparams.authors().record(*it);
723 double Buffer::fontScalingFactor() const
725 return isExporting() ? 75.0 * params().html_math_img_scale
726 : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
730 ParagraphList & Buffer::paragraphs()
732 return text().paragraphs();
736 ParagraphList const & Buffer::paragraphs() const
738 return text().paragraphs();
742 LyXVC & Buffer::lyxvc()
748 LyXVC const & Buffer::lyxvc() const
754 string const Buffer::temppath() const
756 return d->temppath.absFileName();
760 TexRow & Buffer::texrow()
766 TexRow const & Buffer::texrow() const
772 TocBackend & Buffer::tocBackend() const
774 return d->toc_backend;
778 Undo & Buffer::undo()
784 void Buffer::setChild(DocIterator const & dit, Buffer * child)
786 d->children_positions[child] = dit;
790 string Buffer::latexName(bool const no_path) const
792 FileName latex_name =
793 makeLatexName(d->exportFileName());
794 return no_path ? latex_name.onlyFileName()
795 : latex_name.absFileName();
799 FileName Buffer::Impl::exportFileName() const
801 docstring const branch_suffix =
802 params.branchlist().getFileNameSuffix();
803 if (branch_suffix.empty())
806 string const name = filename.onlyFileNameWithoutExt()
807 + to_utf8(branch_suffix);
808 FileName res(filename.onlyPath().absFileName() + "/" + name);
809 res.changeExtension(filename.extension());
815 string Buffer::logName(LogType * type) const
817 string const filename = latexName(false);
819 if (filename.empty()) {
825 string const path = temppath();
827 FileName const fname(addName(temppath(),
828 onlyFileName(changeExtension(filename,
831 // FIXME: how do we know this is the name of the build log?
832 FileName const bname(
833 addName(path, onlyFileName(
834 changeExtension(filename,
835 theFormats().extension(params().bufferFormat()) + ".out"))));
837 // Also consider the master buffer log file
838 FileName masterfname = fname;
839 LogType mtype = latexlog;
840 if (masterBuffer() != this) {
841 string const mlogfile = masterBuffer()->logName(&mtype);
842 masterfname = FileName(mlogfile);
845 // If no Latex log or Build log is newer, show Build log
846 if (bname.exists() &&
847 ((!fname.exists() && !masterfname.exists())
848 || (fname.lastModified() < bname.lastModified()
849 && masterfname.lastModified() < bname.lastModified()))) {
850 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
853 return bname.absFileName();
854 // If we have a newer master file log or only a master log, show this
855 } else if (fname != masterfname
856 && (!fname.exists() && (masterfname.exists()
857 || fname.lastModified() < masterfname.lastModified()))) {
858 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
861 return masterfname.absFileName();
863 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
866 return fname.absFileName();
870 void Buffer::setReadonly(bool const flag)
872 if (d->read_only != flag) {
879 void Buffer::setFileName(FileName const & fname)
881 bool const changed = fname != d->filename;
883 d->refreshFileMonitor();
885 lyxvc().file_found_hook(fname);
886 setReadonly(d->filename.isReadOnly());
892 int Buffer::readHeader(Lexer & lex)
894 int unknown_tokens = 0;
896 int begin_header_line = -1;
898 // Initialize parameters that may be/go lacking in header:
899 params().branchlist().clear();
900 params().preamble.erase();
901 params().options.erase();
902 params().master.erase();
903 params().float_placement.erase();
904 params().paperwidth.erase();
905 params().paperheight.erase();
906 params().leftmargin.erase();
907 params().rightmargin.erase();
908 params().topmargin.erase();
909 params().bottommargin.erase();
910 params().headheight.erase();
911 params().headsep.erase();
912 params().footskip.erase();
913 params().columnsep.erase();
914 params().fonts_cjk.erase();
915 params().listings_params.clear();
916 params().clearLayoutModules();
917 params().clearRemovedModules();
918 params().clearIncludedChildren();
919 params().pdfoptions().clear();
920 params().indiceslist().clear();
921 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
922 params().isbackgroundcolor = false;
923 params().fontcolor = RGBColor(0, 0, 0);
924 params().isfontcolor = false;
925 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
926 params().boxbgcolor = RGBColor(0xFF, 0, 0);
927 params().html_latex_start.clear();
928 params().html_latex_end.clear();
929 params().html_math_img_scale = 1.0;
930 params().output_sync_macro.erase();
931 params().setLocalLayout(docstring(), false);
932 params().setLocalLayout(docstring(), true);
933 params().biblio_opts.erase();
934 params().biblatex_bibstyle.erase();
935 params().biblatex_citestyle.erase();
936 params().multibib.erase();
938 for (int i = 0; i < 4; ++i) {
939 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
940 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
943 ErrorList & errorList = d->errorLists["Parse"];
952 if (token == "\\end_header")
956 if (token == "\\begin_header") {
957 begin_header_line = line;
961 LYXERR(Debug::PARSER, "Handling document header token: `"
964 string const result =
965 params().readToken(lex, token, d->filename.onlyPath());
966 if (!result.empty()) {
967 if (token == "\\textclass") {
968 d->layout_position = result;
971 docstring const s = bformat(_("Unknown token: "
975 errorList.push_back(ErrorItem(_("Document header error"), s));
979 if (begin_header_line) {
980 docstring const s = _("\\begin_header is missing");
981 errorList.push_back(ErrorItem(_("Document header error"), s));
984 params().shell_escape = theSession().shellescapeFiles().find(absFileName());
986 params().makeDocumentClass();
988 return unknown_tokens;
993 // changed to be public and have one parameter
994 // Returns true if "\end_document" is not read (Asger)
995 bool Buffer::readDocument(Lexer & lex)
997 ErrorList & errorList = d->errorLists["Parse"];
1000 // remove dummy empty par
1001 paragraphs().clear();
1003 if (!lex.checkFor("\\begin_document")) {
1004 docstring const s = _("\\begin_document is missing");
1005 errorList.push_back(ErrorItem(_("Document header error"), s));
1010 if (params().output_changes) {
1011 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1012 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1013 LaTeXFeatures::isAvailable("xcolor");
1015 if (!dvipost && !xcolorulem) {
1016 Alert::warning(_("Changes not shown in LaTeX output"),
1017 _("Changes will not be highlighted in LaTeX output, "
1018 "because neither dvipost nor xcolor/ulem are installed.\n"
1019 "Please install these packages or redefine "
1020 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1021 } else if (!xcolorulem) {
1022 Alert::warning(_("Changes not shown in LaTeX output"),
1023 _("Changes will not be highlighted in LaTeX output "
1024 "when using pdflatex, because xcolor and ulem are not installed.\n"
1025 "Please install both packages or redefine "
1026 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1030 if (!parent() && !params().master.empty()) {
1031 FileName const master_file = makeAbsPath(params().master,
1032 onlyPath(absFileName()));
1033 if (isLyXFileName(master_file.absFileName())) {
1035 checkAndLoadLyXFile(master_file, true);
1037 // necessary e.g. after a reload
1038 // to re-register the child (bug 5873)
1039 // FIXME: clean up updateMacros (here, only
1040 // child registering is needed).
1041 master->updateMacros();
1042 // set master as master buffer, but only
1043 // if we are a real child
1044 if (master->isChild(this))
1046 // if the master is not fully loaded
1047 // it is probably just loading this
1048 // child. No warning needed then.
1049 else if (master->isFullyLoaded())
1050 LYXERR0("The master '"
1052 << "' assigned to this document ("
1054 << ") does not include "
1055 "this document. Ignoring the master assignment.");
1060 // assure we have a default index
1061 params().indiceslist().addDefault(B_("Index"));
1064 if (FileName::isAbsolute(params().origin))
1065 d->old_position = params().origin;
1067 d->old_position = filePath();
1068 bool const res = text().read(lex, errorList, d->inset);
1069 d->old_position.clear();
1071 // inform parent buffer about local macros
1073 Buffer const * pbuf = parent();
1074 UserMacroSet::const_iterator cit = usermacros.begin();
1075 UserMacroSet::const_iterator end = usermacros.end();
1076 for (; cit != end; ++cit)
1077 pbuf->usermacros.insert(*cit);
1081 updateMacroInstances(InternalUpdate);
1086 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1088 Format const * fmt = theFormats().getFormat(format);
1091 // It is important to use the correct extension here, since some
1092 // converters create a wrong output file otherwise (e.g. html2latex)
1093 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1094 FileName const name(tempfile.name());
1095 ofdocstream os(name.toFilesystemEncoding().c_str());
1096 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1097 bool const success = !(os << contents).fail();
1100 bool converted = false;
1102 params().compressed = false;
1104 // remove dummy empty par
1105 paragraphs().clear();
1107 converted = importFile(format, name, errorList);
1116 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1118 if (!theConverters().isReachable(format, "lyx"))
1121 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1122 FileName const lyx(tempfile.name());
1123 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1124 return readFile(lyx) == ReadSuccess;
1130 bool Buffer::readString(string const & s)
1132 params().compressed = false;
1135 istringstream is(s);
1137 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1138 FileName const fn = tempfile.name();
1141 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1143 if (success && file_format != LYX_FORMAT) {
1144 // We need to call lyx2lyx, so write the input to a file
1145 ofstream os(fn.toFilesystemEncoding().c_str());
1148 // lyxvc in readFile
1149 if (readFile(fn) != ReadSuccess)
1153 if (readDocument(lex))
1159 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1163 if (!lex.setFile(fname)) {
1164 Alert::error(_("File Not Found"),
1165 bformat(_("Unable to open file `%1$s'."),
1166 from_utf8(fn.absFileName())));
1167 return ReadFileNotFound;
1171 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1172 if (ret_plf != ReadSuccess)
1175 if (file_format != LYX_FORMAT) {
1177 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1178 if (ret_clf != ReadSuccess)
1180 ret_clf = readFile(tmpFile);
1181 if (ret_clf == ReadSuccess) {
1182 d->file_format = file_format;
1183 d->need_format_backup = true;
1188 // FIXME: InsetInfo needs to know whether the file is under VCS
1189 // during the parse process, so this has to be done before.
1190 lyxvc().file_found_hook(d->filename);
1192 if (readDocument(lex)) {
1193 Alert::error(_("Document format failure"),
1194 bformat(_("%1$s ended unexpectedly, which means"
1195 " that it is probably corrupted."),
1196 from_utf8(fn.absFileName())));
1197 return ReadDocumentFailure;
1200 d->file_fully_loaded = true;
1201 d->read_only = !d->filename.isWritable();
1202 params().compressed = theFormats().isZippedFile(d->filename);
1208 bool Buffer::isFullyLoaded() const
1210 return d->file_fully_loaded;
1214 void Buffer::setFullyLoaded(bool value)
1216 d->file_fully_loaded = value;
1220 bool Buffer::lastPreviewError() const
1222 return d->preview_error_;
1226 PreviewLoader * Buffer::loader() const
1228 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1230 if (!d->preview_loader_)
1231 d->preview_loader_ = new PreviewLoader(*this);
1232 return d->preview_loader_;
1236 void Buffer::removePreviews() const
1238 delete d->preview_loader_;
1239 d->preview_loader_ = 0;
1243 void Buffer::updatePreviews() const
1245 PreviewLoader * ploader = loader();
1249 InsetIterator it = inset_iterator_begin(*d->inset);
1250 InsetIterator const end = inset_iterator_end(*d->inset);
1251 for (; it != end; ++it)
1252 it->addPreview(it, *ploader);
1254 ploader->startLoading();
1258 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1259 FileName const & fn, int & file_format) const
1261 if(!lex.checkFor("\\lyxformat")) {
1262 Alert::error(_("Document format failure"),
1263 bformat(_("%1$s is not a readable LyX document."),
1264 from_utf8(fn.absFileName())));
1265 return ReadNoLyXFormat;
1271 // LyX formats 217 and earlier were written as 2.17. This corresponds
1272 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1273 // these cases. See also: www.lyx.org/trac/changeset/1313.
1274 size_t dot = tmp_format.find_first_of(".,");
1275 if (dot != string::npos)
1276 tmp_format.erase(dot, 1);
1278 file_format = convert<int>(tmp_format);
1283 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1284 FileName & tmpfile, int from_format)
1286 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1287 tempfile.setAutoRemove(false);
1288 tmpfile = tempfile.name();
1289 if(tmpfile.empty()) {
1290 Alert::error(_("Conversion failed"),
1291 bformat(_("%1$s is from a different"
1292 " version of LyX, but a temporary"
1293 " file for converting it could"
1294 " not be created."),
1295 from_utf8(fn.absFileName())));
1296 return LyX2LyXNoTempFile;
1299 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1300 if (lyx2lyx.empty()) {
1301 Alert::error(_("Conversion script not found"),
1302 bformat(_("%1$s is from a different"
1303 " version of LyX, but the"
1304 " conversion script lyx2lyx"
1305 " could not be found."),
1306 from_utf8(fn.absFileName())));
1307 return LyX2LyXNotFound;
1311 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1312 ostringstream command;
1313 command << os::python()
1314 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1315 << " -t " << convert<string>(LYX_FORMAT)
1316 << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
1317 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1318 string const command_str = command.str();
1320 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1322 cmd_ret const ret = runCommand(command_str);
1323 if (ret.first != 0) {
1324 if (from_format < LYX_FORMAT) {
1325 Alert::error(_("Conversion script failed"),
1326 bformat(_("%1$s is from an older version"
1327 " of LyX and the lyx2lyx script"
1328 " failed to convert it."),
1329 from_utf8(fn.absFileName())));
1330 return LyX2LyXOlderFormat;
1332 Alert::error(_("Conversion script failed"),
1333 bformat(_("%1$s is from a newer version"
1334 " of LyX and the lyx2lyx script"
1335 " failed to convert it."),
1336 from_utf8(fn.absFileName())));
1337 return LyX2LyXNewerFormat;
1344 FileName Buffer::getBackupName() const {
1345 FileName const & fn = fileName();
1346 string const fname = fn.onlyFileNameWithoutExt();
1347 string const fext = fn.extension() + "~";
1348 string const fpath = lyxrc.backupdir_path.empty() ?
1349 fn.onlyPath().absFileName() :
1350 lyxrc.backupdir_path;
1351 string const fform = convert<string>(d->file_format);
1352 string const backname = fname + "-lyxformat-" + fform;
1353 FileName backup(addName(fpath, addExtension(backname, fext)));
1355 // limit recursion, just in case
1357 unsigned long orig_checksum = 0;
1358 while (backup.exists() && v < 100) {
1359 if (orig_checksum == 0)
1360 orig_checksum = fn.checksum();
1361 unsigned long new_checksum = backup.checksum();
1362 if (orig_checksum == new_checksum) {
1363 LYXERR(Debug::FILES, "Not backing up " << fn <<
1364 "since " << backup << "has the same checksum.");
1365 // a bit of a hack, but we have to check this anyway
1366 // below, and setting this is simpler than introducing
1367 // a special boolean for this purpose.
1371 string const newbackname = backname + "-" + convert<string>(v);
1372 backup.set(addName(fpath, addExtension(newbackname, fext)));
1375 return v < 100 ? backup : FileName();
1379 // Should probably be moved to somewhere else: BufferView? GuiView?
1380 bool Buffer::save() const
1382 docstring const file = makeDisplayPath(absFileName(), 20);
1383 d->filename.refresh();
1385 // check the read-only status before moving the file as a backup
1386 if (d->filename.exists()) {
1387 bool const read_only = !d->filename.isWritable();
1389 Alert::warning(_("File is read-only"),
1390 bformat(_("The file %1$s cannot be written because it "
1391 "is marked as read-only."), file));
1396 // ask if the disk file has been externally modified (use checksum method)
1397 if (fileName().exists() && isChecksumModified()) {
1399 bformat(_("Document %1$s has been externally modified. "
1400 "Are you sure you want to overwrite this file?"), file);
1401 int const ret = Alert::prompt(_("Overwrite modified file?"),
1402 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1407 // We don't need autosaves in the immediate future. (Asger)
1408 resetAutosaveTimers();
1410 // if the file does not yet exist, none of the backup activity
1411 // that follows is necessary
1412 if (!fileName().exists()) {
1413 if (!writeFile(fileName()))
1419 // we first write the file to a new name, then move it to its
1420 // proper location once that has been done successfully. that
1421 // way we preserve the original file if something goes wrong.
1422 string const justname = fileName().onlyFileNameWithoutExt();
1423 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1424 justname + "-XXXXXX.lyx");
1425 bool const symlink = fileName().isSymLink();
1427 tempfile->setAutoRemove(false);
1429 FileName savefile(tempfile->name());
1430 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1431 if (!writeFile(savefile))
1434 // we will set this to false if we fail
1435 bool made_backup = true;
1437 FileName backupName;
1438 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1440 if (d->need_format_backup)
1441 backupName = getBackupName();
1443 // If we for some reason failed to find a backup name in case of
1444 // a format change, this will still set one. It's the best we can
1446 if (backupName.empty()) {
1447 backupName.set(fileName().absFileName() + "~");
1448 if (!lyxrc.backupdir_path.empty()) {
1449 string const mangledName =
1450 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1451 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1455 LYXERR(Debug::FILES, "Backing up original file to " <<
1456 backupName.absFileName());
1457 // Except file is symlink do not copy because of #6587.
1458 // Hard links have bad luck.
1459 made_backup = symlink ?
1460 fileName().copyTo(backupName):
1461 fileName().moveTo(backupName);
1464 Alert::error(_("Backup failure"),
1465 bformat(_("Cannot create backup file %1$s.\n"
1466 "Please check whether the directory exists and is writable."),
1467 from_utf8(backupName.absFileName())));
1468 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1469 } else if (d->need_format_backup) {
1470 // the original file has been backed up successfully, so we
1471 // will not need to do that again
1472 d->need_format_backup = false;
1476 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1477 // Only do this if tempfile is not in autoremove mode
1480 // If we have no symlink, we can simply rename the temp file.
1481 // Otherwise, we need to copy it so the symlink stays intact.
1482 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1483 savefile.moveTo(fileName()))
1485 // saveCheckSum() was already called by writeFile(), but the
1486 // time stamp is invalidated by copying/moving
1489 if (d->file_format != LYX_FORMAT)
1490 // the file associated with this buffer is now in the current format
1491 d->file_format = LYX_FORMAT;
1494 // else we saved the file, but failed to move it to the right location.
1496 if (needBackup && made_backup && !symlink) {
1497 // the original file was moved to some new location, so it will look
1498 // to the user as if it was deleted. (see bug #9234.) we could try
1499 // to restore it, but that would basically mean trying to do again
1500 // what we just failed to do. better to leave things as they are.
1501 Alert::error(_("Write failure"),
1502 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1503 "But LyX could not move it to:\n %2$s.\n"
1504 "Your original file has been backed up to:\n %3$s"),
1505 from_utf8(savefile.absFileName()),
1506 from_utf8(fileName().absFileName()),
1507 from_utf8(backupName.absFileName())));
1509 // either we did not try to make a backup, or else we tried and failed,
1510 // or else the original file was a symlink, in which case it was copied,
1511 // not moved. so the original file is intact.
1512 Alert::error(_("Write failure"),
1513 bformat(_("Cannot move saved file to:\n %1$s.\n"
1514 "But the file has successfully been saved as:\n %2$s."),
1515 from_utf8(fileName().absFileName()),
1516 from_utf8(savefile.absFileName())));
1522 bool Buffer::writeFile(FileName const & fname) const
1524 if (d->read_only && fname == d->filename)
1527 bool retval = false;
1529 docstring const str = bformat(_("Saving document %1$s..."),
1530 makeDisplayPath(fname.absFileName()));
1533 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1535 if (params().compressed) {
1536 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1537 retval = ofs && write(ofs);
1539 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1540 retval = ofs && write(ofs);
1544 message(str + _(" could not write file!"));
1549 // removeAutosaveFile();
1552 message(str + _(" done."));
1558 docstring Buffer::emergencyWrite()
1560 // No need to save if the buffer has not changed.
1564 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1566 docstring user_message = bformat(
1567 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1569 // We try to save three places:
1570 // 1) Same place as document. Unless it is an unnamed doc.
1572 string s = absFileName();
1575 if (writeFile(FileName(s))) {
1577 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1578 return user_message;
1580 user_message += " " + _("Save failed! Trying again...\n");
1584 // 2) In HOME directory.
1585 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1587 lyxerr << ' ' << s << endl;
1588 if (writeFile(FileName(s))) {
1590 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1591 return user_message;
1594 user_message += " " + _("Save failed! Trying yet again...\n");
1596 // 3) In "/tmp" directory.
1597 // MakeAbsPath to prepend the current
1598 // drive letter on OS/2
1599 s = addName(package().temp_dir().absFileName(), absFileName());
1601 lyxerr << ' ' << s << endl;
1602 if (writeFile(FileName(s))) {
1604 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1605 return user_message;
1608 user_message += " " + _("Save failed! Document is lost.");
1611 return user_message;
1615 bool Buffer::write(ostream & ofs) const
1618 // Use the standard "C" locale for file output.
1619 ofs.imbue(locale::classic());
1622 // The top of the file should not be written by params().
1624 // write out a comment in the top of the file
1625 // Important: Keep the version formatting in sync with lyx2lyx and
1626 // tex2lyx (bug 7951)
1627 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1628 << " created this file. For more info see http://www.lyx.org/\n"
1629 << "\\lyxformat " << LYX_FORMAT << "\n"
1630 << "\\begin_document\n";
1632 /// For each author, set 'used' to true if there is a change
1633 /// by this author in the document; otherwise set it to 'false'.
1634 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1635 AuthorList::Authors::const_iterator a_end = params().authors().end();
1636 for (; a_it != a_end; ++a_it)
1637 a_it->setUsed(false);
1639 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1640 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1641 for ( ; it != end; ++it)
1642 it->checkAuthors(params().authors());
1644 // now write out the buffer parameters.
1645 ofs << "\\begin_header\n";
1646 params().writeFile(ofs, this);
1647 ofs << "\\end_header\n";
1650 ofs << "\n\\begin_body\n";
1652 ofs << "\n\\end_body\n";
1654 // Write marker that shows file is complete
1655 ofs << "\\end_document" << endl;
1657 // Shouldn't really be needed....
1660 // how to check if close went ok?
1661 // Following is an attempt... (BE 20001011)
1663 // good() returns false if any error occurred, including some
1664 // formatting error.
1665 // bad() returns true if something bad happened in the buffer,
1666 // which should include file system full errors.
1671 lyxerr << "File was not closed properly." << endl;
1678 bool Buffer::makeLaTeXFile(FileName const & fname,
1679 string const & original_path,
1680 OutputParams const & runparams_in,
1681 OutputWhat output) const
1683 OutputParams runparams = runparams_in;
1685 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1686 // Check here, because the "flavor" is not known in BufferParams::encoding()
1687 // (power users can override this safety measure selecting "utf8-plain").
1688 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1689 && (runparams.encoding->name() != "utf8-plain"))
1690 runparams.encoding = encodings.fromLyXName("ascii");
1692 string const encoding = runparams.encoding->iconvName();
1693 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1696 try { ofs.reset(encoding); }
1697 catch (iconv_codecvt_facet_exception const & e) {
1698 lyxerr << "Caught iconv exception: " << e.what() << endl;
1699 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1700 "verify that the support software for your encoding (%1$s) is "
1701 "properly installed"), from_ascii(encoding)));
1704 if (!openFileWrite(ofs, fname))
1707 ErrorList & errorList = d->errorLists["Export"];
1709 bool failed_export = false;
1712 // make sure we are ready to export
1713 // this needs to be done before we validate
1714 // FIXME Do we need to do this all the time? I.e., in children
1715 // of a master we are exporting?
1717 updateMacroInstances(OutputUpdate);
1720 writeLaTeXSource(os, original_path, runparams, output);
1722 catch (EncodingException const & e) {
1723 docstring const failed(1, e.failed_char);
1725 oss << "0x" << hex << e.failed_char << dec;
1726 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1727 " (code point %2$s)"),
1728 failed, from_utf8(oss.str()));
1729 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1730 "representable in the chosen encoding.\n"
1731 "Changing the document encoding to utf8 could help."),
1732 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1733 failed_export = true;
1735 catch (iconv_codecvt_facet_exception const & e) {
1736 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1738 failed_export = true;
1740 catch (exception const & e) {
1741 errorList.push_back(ErrorItem(_("conversion failed"),
1743 lyxerr << e.what() << endl;
1744 failed_export = true;
1747 lyxerr << "Caught some really weird exception..." << endl;
1751 d->texrow = move(os.texrow());
1755 failed_export = true;
1756 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1759 if (runparams_in.silent)
1763 return !failed_export;
1767 void Buffer::writeLaTeXSource(otexstream & os,
1768 string const & original_path,
1769 OutputParams const & runparams_in,
1770 OutputWhat output) const
1772 // The child documents, if any, shall be already loaded at this point.
1774 OutputParams runparams = runparams_in;
1776 // XeTeX with TeX fonts is only safe with ASCII encoding,
1777 // Check here, because the "flavor" is not known in BufferParams::encoding()
1778 // (power users can override this safety measure selecting "utf8-plain").
1779 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1780 && (runparams.encoding->name() != "utf8-plain"))
1781 runparams.encoding = encodings.fromLyXName("ascii");
1782 // FIXME: when only the current paragraph is shown, this is ignored
1783 // (or not reached) and characters encodable in the current
1784 // encoding are not converted to ASCII-representation.
1786 // If we are compiling a file standalone, even if this is the
1787 // child of some other buffer, let's cut the link here, so the
1788 // file is really independent and no concurring settings from
1789 // the master (e.g. branch state) interfere (see #8100).
1790 if (!runparams.is_child)
1791 d->ignore_parent = true;
1793 // Classify the unicode characters appearing in math insets
1794 BufferEncodings::initUnicodeMath(*this);
1796 // validate the buffer.
1797 LYXERR(Debug::LATEX, " Validating buffer...");
1798 LaTeXFeatures features(*this, params(), runparams);
1800 // This is only set once per document (in master)
1801 if (!runparams.is_child)
1802 runparams.use_polyglossia = features.usePolyglossia();
1803 LYXERR(Debug::LATEX, " Buffer validation done.");
1805 bool const output_preamble =
1806 output == FullSource || output == OnlyPreamble;
1807 bool const output_body =
1808 output == FullSource || output == OnlyBody;
1810 // The starting paragraph of the coming rows is the
1811 // first paragraph of the document. (Asger)
1812 if (output_preamble && runparams.nice) {
1813 os << "%% LyX " << lyx_version << " created this file. "
1814 "For more info, see http://www.lyx.org/.\n"
1815 "%% Do not edit unless you really know what "
1818 LYXERR(Debug::INFO, "lyx document header finished");
1820 // There are a few differences between nice LaTeX and usual files:
1821 // usual files have \batchmode and special input@path to allow
1822 // inclusion of figures specified by an explicitly relative path
1823 // (i.e., a path starting with './' or '../') with either \input or
1824 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1825 // input@path is set when the actual parameter original_path is set.
1826 // This is done for usual tex-file, but not for nice-latex-file.
1827 // (Matthias 250696)
1828 // Note that input@path is only needed for something the user does
1829 // in the preamble, included .tex files or ERT, files included by
1830 // LyX work without it.
1831 if (output_preamble) {
1832 if (!runparams.nice) {
1833 // code for usual, NOT nice-latex-file
1834 os << "\\batchmode\n"; // changed from \nonstopmode
1836 if (!original_path.empty()) {
1838 // We don't know the encoding of inputpath
1839 docstring const inputpath = from_utf8(original_path);
1840 docstring uncodable_glyphs;
1841 Encoding const * const enc = runparams.encoding;
1843 for (size_t n = 0; n < inputpath.size(); ++n) {
1844 if (!enc->encodable(inputpath[n])) {
1845 docstring const glyph(1, inputpath[n]);
1846 LYXERR0("Uncodable character '"
1848 << "' in input path!");
1849 uncodable_glyphs += glyph;
1854 // warn user if we found uncodable glyphs.
1855 if (!uncodable_glyphs.empty()) {
1856 frontend::Alert::warning(
1857 _("Uncodable character in file path"),
1859 _("The path of your document\n"
1861 "contains glyphs that are unknown "
1862 "in the current document encoding "
1863 "(namely %2$s). This may result in "
1864 "incomplete output, unless "
1865 "TEXINPUTS contains the document "
1866 "directory and you don't use "
1867 "explicitly relative paths (i.e., "
1868 "paths starting with './' or "
1869 "'../') in the preamble or in ERT."
1870 "\n\nIn case of problems, choose "
1871 "an appropriate document encoding\n"
1872 "(such as utf8) or change the "
1874 inputpath, uncodable_glyphs));
1877 latex_path(original_path);
1878 if (contains(docdir, '#')) {
1879 docdir = subst(docdir, "#", "\\#");
1880 os << "\\catcode`\\#=11"
1881 "\\def\\#{#}\\catcode`\\#=6\n";
1883 if (contains(docdir, '%')) {
1884 docdir = subst(docdir, "%", "\\%");
1885 os << "\\catcode`\\%=11"
1886 "\\def\\%{%}\\catcode`\\%=14\n";
1888 os << "\\makeatletter\n"
1889 << "\\def\\input@path{{"
1891 << "\\makeatother\n";
1895 // get parent macros (if this buffer has a parent) which will be
1896 // written at the document begin further down.
1897 MacroSet parentMacros;
1898 listParentMacros(parentMacros, features);
1900 // Write the preamble
1901 runparams.use_babel = params().writeLaTeX(os, features,
1902 d->filename.onlyPath());
1904 // Biblatex bibliographies are loaded here
1905 if (params().useBiblatex()) {
1906 vector<docstring> const bibfiles =
1907 prepareBibFilePaths(runparams, getBibfilesCache(), true);
1908 for (docstring const & file: bibfiles)
1909 os << "\\addbibresource{" << file << "}\n";
1912 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1913 && !features.hasOnlyPolyglossiaLanguages()) {
1916 vector<string> bll = features.getBabelExclusiveLanguages();
1917 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1920 for (vector<string>::const_iterator it = bll.begin(); it != bll.end(); ++it) {
1925 blangs = bll.size() > 1 ?
1926 bformat(_("The languages %1$s are only supported by Babel."), langs)
1927 : bformat(_("The language %1$s is only supported by Babel."), langs);
1931 for (vector<string>::const_iterator it = pll.begin(); it != pll.end(); ++it) {
1936 plangs = pll.size() > 1 ?
1937 bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
1938 : bformat(_("The language %1$s is only supported by Polyglossia."), langs);
1939 if (!blangs.empty())
1943 frontend::Alert::warning(
1944 _("Incompatible Languages!"),
1946 _("You cannot use the following languages "
1947 "together in one LaTeX document because "
1948 "they require conflicting language packages:\n"
1953 // Japanese might be required only in some children of a document,
1954 // but once required, we must keep use_japanese true.
1955 runparams.use_japanese |= features.isRequired("japanese");
1958 // Restore the parenthood if needed
1959 if (!runparams.is_child)
1960 d->ignore_parent = false;
1965 // mark the beginning of the body to separate it from InPreamble insets
1966 os.texrow().start(TexRow::beginDocument());
1967 os << "\\begin{document}\n";
1969 // mark the start of a new paragraph by simulating a newline,
1970 // so that os.afterParbreak() returns true at document start
1973 // output the parent macros
1974 MacroSet::iterator it = parentMacros.begin();
1975 MacroSet::iterator end = parentMacros.end();
1976 for (; it != end; ++it) {
1977 int num_lines = (*it)->write(os.os(), true);
1978 os.texrow().newlines(num_lines);
1981 } // output_preamble
1983 LYXERR(Debug::INFO, "preamble finished, now the body.");
1986 latexParagraphs(*this, text(), os, runparams);
1988 // Restore the parenthood if needed
1989 if (!runparams.is_child)
1990 d->ignore_parent = false;
1992 // add this just in case after all the paragraphs
1995 if (output_preamble) {
1996 os << "\\end{document}\n";
1997 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1999 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
2001 runparams_in.encoding = runparams.encoding;
2003 LYXERR(Debug::INFO, "Finished making LaTeX file.");
2004 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
2008 void Buffer::makeDocBookFile(FileName const & fname,
2009 OutputParams const & runparams,
2010 OutputWhat output) const
2012 LYXERR(Debug::LATEX, "makeDocBookFile...");
2015 if (!openFileWrite(ofs, fname))
2018 // make sure we are ready to export
2019 // this needs to be done before we validate
2021 updateMacroInstances(OutputUpdate);
2023 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
2027 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2031 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
2032 OutputParams const & runparams,
2033 OutputWhat output) const
2035 LaTeXFeatures features(*this, params(), runparams);
2040 DocumentClass const & tclass = params().documentClass();
2041 string const & top_element = tclass.latexname();
2043 bool const output_preamble =
2044 output == FullSource || output == OnlyPreamble;
2045 bool const output_body =
2046 output == FullSource || output == OnlyBody;
2048 if (output_preamble) {
2049 if (runparams.flavor == OutputParams::XML)
2050 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2053 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2056 if (! tclass.class_header().empty())
2057 os << from_ascii(tclass.class_header());
2058 else if (runparams.flavor == OutputParams::XML)
2059 os << "PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\" "
2060 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2062 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2064 docstring preamble = params().preamble;
2065 if (runparams.flavor != OutputParams::XML ) {
2066 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2067 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2068 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2069 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2072 string const name = runparams.nice
2073 ? changeExtension(absFileName(), ".sgml") : fname;
2074 preamble += features.getIncludedFiles(name);
2075 preamble += features.getLyXSGMLEntities();
2077 if (!preamble.empty()) {
2078 os << "\n [ " << preamble << " ]";
2084 string top = top_element;
2086 if (runparams.flavor == OutputParams::XML)
2087 top += params().language->code();
2089 top += params().language->code().substr(0, 2);
2092 if (!params().options.empty()) {
2094 top += params().options;
2097 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2098 << " file was created by LyX " << lyx_version
2099 << "\n See http://www.lyx.org/ for more information -->\n";
2101 params().documentClass().counters().reset();
2103 sgml::openTag(os, top);
2105 docbookParagraphs(text(), *this, os, runparams);
2106 sgml::closeTag(os, top_element);
2111 void Buffer::makeLyXHTMLFile(FileName const & fname,
2112 OutputParams const & runparams) const
2114 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2117 if (!openFileWrite(ofs, fname))
2120 // make sure we are ready to export
2121 // this has to be done before we validate
2122 updateBuffer(UpdateMaster, OutputUpdate);
2123 updateMacroInstances(OutputUpdate);
2125 writeLyXHTMLSource(ofs, runparams, FullSource);
2129 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2133 void Buffer::writeLyXHTMLSource(odocstream & os,
2134 OutputParams const & runparams,
2135 OutputWhat output) const
2137 LaTeXFeatures features(*this, params(), runparams);
2139 d->bibinfo_.makeCitationLabels(*this);
2141 bool const output_preamble =
2142 output == FullSource || output == OnlyPreamble;
2143 bool const output_body =
2144 output == FullSource || output == OnlyBody || output == IncludedFile;
2146 if (output_preamble) {
2147 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2148 << "<!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"
2149 // FIXME Language should be set properly.
2150 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2152 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2153 // FIXME Presumably need to set this right
2154 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2156 docstring const & doctitle = features.htmlTitle();
2158 << (doctitle.empty() ?
2159 from_ascii("LyX Document") :
2160 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2163 docstring styles = features.getTClassHTMLPreamble();
2164 if (!styles.empty())
2165 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2167 styles = features.getPreambleSnippets().str;
2168 if (!styles.empty())
2169 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2171 // we will collect CSS information in a stream, and then output it
2172 // either here, as part of the header, or else in a separate file.
2173 odocstringstream css;
2174 styles = features.getCSSSnippets();
2175 if (!styles.empty())
2176 css << "/* LyX Provided Styles */\n" << styles << '\n';
2178 styles = features.getTClassHTMLStyles();
2179 if (!styles.empty())
2180 css << "/* Layout-provided Styles */\n" << styles << '\n';
2182 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2183 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2184 if (needfg || needbg) {
2185 css << "\nbody {\n";
2188 << from_ascii(X11hexname(params().fontcolor))
2191 css << " background-color: "
2192 << from_ascii(X11hexname(params().backgroundcolor))
2197 docstring const dstyles = css.str();
2198 if (!dstyles.empty()) {
2199 bool written = false;
2200 if (params().html_css_as_file) {
2201 // open a file for CSS info
2203 string const fcssname = addName(temppath(), "docstyle.css");
2204 FileName const fcssfile = FileName(fcssname);
2205 if (openFileWrite(ocss, fcssfile)) {
2209 // write link to header
2210 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2212 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2215 // we are here if the CSS is supposed to be written to the header
2216 // or if we failed to write it to an external file.
2218 os << "<style type='text/css'>\n"
2227 bool const output_body_tag = (output != IncludedFile);
2228 if (output_body_tag)
2229 os << "<body dir=\"auto\">\n";
2231 if (output != IncludedFile)
2232 // if we're an included file, the counters are in the master.
2233 params().documentClass().counters().reset();
2234 xhtmlParagraphs(text(), *this, xs, runparams);
2235 if (output_body_tag)
2239 if (output_preamble)
2244 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2245 // Other flags: -wall -v0 -x
2246 int Buffer::runChktex()
2250 // get LaTeX-Filename
2251 FileName const path(temppath());
2252 string const name = addName(path.absFileName(), latexName());
2253 string const org_path = filePath();
2255 PathChanger p(path); // path to LaTeX file
2256 message(_("Running chktex..."));
2258 // Generate the LaTeX file if neccessary
2259 OutputParams runparams(¶ms().encoding());
2260 runparams.flavor = OutputParams::LATEX;
2261 runparams.nice = false;
2262 runparams.linelen = lyxrc.plaintext_linelen;
2263 makeLaTeXFile(FileName(name), org_path, runparams);
2266 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2267 int const res = chktex.run(terr); // run chktex
2270 Alert::error(_("chktex failure"),
2271 _("Could not run chktex successfully."));
2273 ErrorList & errlist = d->errorLists["ChkTeX"];
2275 bufferErrors(terr, errlist);
2280 if (runparams.silent)
2281 d->errorLists["ChkTeX"].clear();
2289 void Buffer::validate(LaTeXFeatures & features) const
2291 // Validate the buffer params, but not for included
2292 // files, since they also use the parent buffer's
2294 if (!features.runparams().is_child)
2295 params().validate(features);
2297 for (Paragraph const & p : paragraphs())
2298 p.validate(features);
2300 if (lyxerr.debugging(Debug::LATEX)) {
2301 features.showStruct();
2306 void Buffer::getLabelList(vector<docstring> & list) const
2308 // If this is a child document, use the master's list instead.
2310 masterBuffer()->getLabelList(list);
2315 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2316 Toc::const_iterator toc_it = toc->begin();
2317 Toc::const_iterator end = toc->end();
2318 for (; toc_it != end; ++toc_it) {
2319 if (toc_it->depth() == 0)
2320 list.push_back(toc_it->str());
2325 void Buffer::updateBibfilesCache(UpdateScope scope) const
2327 // FIXME This is probably unnecssary, given where we call this.
2328 // If this is a child document, use the parent's cache instead.
2329 if (parent() && scope != UpdateChildOnly) {
2330 masterBuffer()->updateBibfilesCache();
2334 d->bibfiles_cache_.clear();
2335 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2336 if (it->lyxCode() == BIBTEX_CODE) {
2337 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2338 FileNamePairList const bibfiles = inset.getBibFiles();
2339 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2342 } else if (it->lyxCode() == INCLUDE_CODE) {
2343 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2344 Buffer const * const incbuf = inset.getChildBuffer();
2347 FileNamePairList const & bibfiles =
2348 incbuf->getBibfilesCache(UpdateChildOnly);
2349 if (!bibfiles.empty()) {
2350 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2356 d->bibfile_cache_valid_ = true;
2357 d->bibinfo_cache_valid_ = false;
2358 d->cite_labels_valid_ = false;
2362 void Buffer::invalidateBibinfoCache() const
2364 d->bibinfo_cache_valid_ = false;
2365 d->cite_labels_valid_ = false;
2366 // also invalidate the cache for the parent buffer
2367 Buffer const * const pbuf = d->parent();
2369 pbuf->invalidateBibinfoCache();
2373 void Buffer::invalidateBibfileCache() const
2375 d->bibfile_cache_valid_ = false;
2376 d->bibinfo_cache_valid_ = false;
2377 d->cite_labels_valid_ = false;
2378 // also invalidate the cache for the parent buffer
2379 Buffer const * const pbuf = d->parent();
2381 pbuf->invalidateBibfileCache();
2385 FileNamePairList const & Buffer::getBibfilesCache(UpdateScope scope) const
2387 // FIXME This is probably unnecessary, given where we call this.
2388 // If this is a child document, use the master's cache instead.
2389 Buffer const * const pbuf = masterBuffer();
2390 if (pbuf != this && scope != UpdateChildOnly)
2391 return pbuf->getBibfilesCache();
2393 if (!d->bibfile_cache_valid_)
2394 this->updateBibfilesCache(scope);
2396 return d->bibfiles_cache_;
2400 BiblioInfo const & Buffer::masterBibInfo() const
2402 Buffer const * const tmp = masterBuffer();
2404 return tmp->masterBibInfo();
2409 void Buffer::checkIfBibInfoCacheIsValid() const
2411 // use the master's cache
2412 Buffer const * const tmp = masterBuffer();
2414 tmp->checkIfBibInfoCacheIsValid();
2418 // compare the cached timestamps with the actual ones.
2419 FileNamePairList const & bibfiles_cache = getBibfilesCache();
2420 FileNamePairList::const_iterator ei = bibfiles_cache.begin();
2421 FileNamePairList::const_iterator en = bibfiles_cache.end();
2422 for (; ei != en; ++ ei) {
2423 FileName const fn = ei->second;
2424 time_t lastw = fn.lastModified();
2425 time_t prevw = d->bibfile_status_[fn];
2426 if (lastw != prevw) {
2427 d->bibinfo_cache_valid_ = false;
2428 d->cite_labels_valid_ = false;
2429 d->bibfile_status_[fn] = lastw;
2435 void Buffer::reloadBibInfoCache() const
2437 // use the master's cache
2438 Buffer const * const tmp = masterBuffer();
2440 tmp->reloadBibInfoCache();
2444 checkIfBibInfoCacheIsValid();
2445 if (d->bibinfo_cache_valid_)
2448 d->bibinfo_.clear();
2450 d->bibinfo_cache_valid_ = true;
2454 void Buffer::collectBibKeys() const
2456 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2457 it->collectBibKeys(it);
2461 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2463 Buffer const * tmp = masterBuffer();
2464 BiblioInfo & masterbi = (tmp == this) ?
2465 d->bibinfo_ : tmp->d->bibinfo_;
2466 masterbi.mergeBiblioInfo(bi);
2470 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2472 Buffer const * tmp = masterBuffer();
2473 BiblioInfo & masterbi = (tmp == this) ?
2474 d->bibinfo_ : tmp->d->bibinfo_;
2479 void Buffer::makeCitationLabels() const
2481 Buffer const * const master = masterBuffer();
2482 return d->bibinfo_.makeCitationLabels(*master);
2486 bool Buffer::citeLabelsValid() const
2488 return masterBuffer()->d->cite_labels_valid_;
2492 void Buffer::removeBiblioTempFiles() const
2494 // We remove files that contain LaTeX commands specific to the
2495 // particular bibliographic style being used, in order to avoid
2496 // LaTeX errors when we switch style.
2497 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2498 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2499 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2500 aux_file.removeFile();
2501 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2502 bbl_file.removeFile();
2503 // Also for the parent buffer
2504 Buffer const * const pbuf = parent();
2506 pbuf->removeBiblioTempFiles();
2510 bool Buffer::isDepClean(string const & name) const
2512 DepClean::const_iterator const it = d->dep_clean.find(name);
2513 if (it == d->dep_clean.end())
2519 void Buffer::markDepClean(string const & name)
2521 d->dep_clean[name] = true;
2525 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2528 // FIXME? if there is an Buffer LFUN that can be dispatched even
2529 // if internal, put a switch '(cmd.action)' here.
2535 switch (cmd.action()) {
2537 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2538 flag.setOnOff(hasReadonlyFlag());
2541 // FIXME: There is need for a command-line import.
2542 //case LFUN_BUFFER_IMPORT:
2544 case LFUN_BUFFER_AUTO_SAVE:
2547 case LFUN_BUFFER_EXPORT_CUSTOM:
2548 // FIXME: Nothing to check here?
2551 case LFUN_BUFFER_EXPORT: {
2552 docstring const arg = cmd.argument();
2553 if (arg == "custom") {
2557 string format = (arg.empty() || arg == "default") ?
2558 params().getDefaultOutputFormat() : to_utf8(arg);
2559 size_t pos = format.find(' ');
2560 if (pos != string::npos)
2561 format = format.substr(0, pos);
2562 enable = params().isExportable(format, false);
2564 flag.message(bformat(
2565 _("Don't know how to export to format: %1$s"), arg));
2569 case LFUN_BUFFER_CHKTEX:
2570 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2573 case LFUN_BUILD_PROGRAM:
2574 enable = params().isExportable("program", false);
2577 case LFUN_BRANCH_ACTIVATE:
2578 case LFUN_BRANCH_DEACTIVATE:
2579 case LFUN_BRANCH_MASTER_ACTIVATE:
2580 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2581 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2582 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2583 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2584 : params().branchlist();
2585 docstring const branchName = cmd.argument();
2586 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2590 case LFUN_BRANCH_ADD:
2591 case LFUN_BRANCHES_RENAME:
2592 // if no Buffer is present, then of course we won't be called!
2595 case LFUN_BUFFER_LANGUAGE:
2596 enable = !isReadonly();
2599 case LFUN_BUFFER_VIEW_CACHE:
2600 (d->preview_file_).refresh();
2601 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2604 case LFUN_CHANGES_TRACK:
2605 flag.setEnabled(true);
2606 flag.setOnOff(params().track_changes);
2609 case LFUN_CHANGES_OUTPUT:
2610 flag.setEnabled(true);
2611 flag.setOnOff(params().output_changes);
2614 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
2615 flag.setOnOff(params().compressed);
2619 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
2620 flag.setOnOff(params().output_sync);
2627 flag.setEnabled(enable);
2632 void Buffer::dispatch(string const & command, DispatchResult & result)
2634 return dispatch(lyxaction.lookupFunc(command), result);
2638 // NOTE We can end up here even if we have no GUI, because we are called
2639 // by LyX::exec to handled command-line requests. So we may need to check
2640 // whether we have a GUI or not. The boolean use_gui holds this information.
2641 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2644 // FIXME? if there is an Buffer LFUN that can be dispatched even
2645 // if internal, put a switch '(cmd.action())' here.
2646 dr.dispatched(false);
2649 string const argument = to_utf8(func.argument());
2650 // We'll set this back to false if need be.
2651 bool dispatched = true;
2652 undo().beginUndoGroup();
2654 switch (func.action()) {
2655 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2656 if (lyxvc().inUse()) {
2657 string log = lyxvc().toggleReadOnly();
2662 setReadonly(!hasReadonlyFlag());
2665 case LFUN_BUFFER_EXPORT: {
2666 string const format = (argument.empty() || argument == "default") ?
2667 params().getDefaultOutputFormat() : argument;
2668 ExportStatus const status = doExport(format, false);
2669 dr.setError(status != ExportSuccess);
2670 if (status != ExportSuccess)
2671 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2672 from_utf8(format)));
2676 case LFUN_BUILD_PROGRAM: {
2677 ExportStatus const status = doExport("program", true);
2678 dr.setError(status != ExportSuccess);
2679 if (status != ExportSuccess)
2680 dr.setMessage(_("Error generating literate programming code."));
2684 case LFUN_BUFFER_CHKTEX:
2688 case LFUN_BUFFER_EXPORT_CUSTOM: {
2690 string command = split(argument, format_name, ' ');
2691 Format const * format = theFormats().getFormat(format_name);
2693 lyxerr << "Format \"" << format_name
2694 << "\" not recognized!"
2699 // The name of the file created by the conversion process
2702 // Output to filename
2703 if (format->name() == "lyx") {
2704 string const latexname = latexName(false);
2705 filename = changeExtension(latexname,
2706 format->extension());
2707 filename = addName(temppath(), filename);
2709 if (!writeFile(FileName(filename)))
2713 doExport(format_name, true, filename);
2716 // Substitute $$FName for filename
2717 if (!contains(command, "$$FName"))
2718 command = "( " + command + " ) < $$FName";
2719 command = subst(command, "$$FName", filename);
2721 // Execute the command in the background
2723 call.startscript(Systemcall::DontWait, command,
2724 filePath(), layoutPos());
2728 // FIXME: There is need for a command-line import.
2730 case LFUN_BUFFER_IMPORT:
2735 case LFUN_BUFFER_AUTO_SAVE:
2737 resetAutosaveTimers();
2740 case LFUN_BRANCH_ACTIVATE:
2741 case LFUN_BRANCH_DEACTIVATE:
2742 case LFUN_BRANCH_MASTER_ACTIVATE:
2743 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2744 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2745 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2746 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2749 docstring const branch_name = func.argument();
2750 // the case without a branch name is handled elsewhere
2751 if (branch_name.empty()) {
2755 Branch * branch = buf->params().branchlist().find(branch_name);
2757 LYXERR0("Branch " << branch_name << " does not exist.");
2759 docstring const msg =
2760 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2764 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2765 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2766 if (branch->isSelected() != activate) {
2767 buf->undo().recordUndoBufferParams(CursorData());
2768 branch->setSelected(activate);
2770 dr.screenUpdate(Update::Force);
2771 dr.forceBufferUpdate();
2776 case LFUN_BRANCH_ADD: {
2777 docstring branch_name = func.argument();
2778 if (branch_name.empty()) {
2782 BranchList & branch_list = params().branchlist();
2783 vector<docstring> const branches =
2784 getVectorFromString(branch_name, branch_list.separator());
2786 for (vector<docstring>::const_iterator it = branches.begin();
2787 it != branches.end(); ++it) {
2789 Branch * branch = branch_list.find(branch_name);
2791 LYXERR0("Branch " << branch_name << " already exists.");
2795 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2797 undo().recordUndoBufferParams(CursorData());
2798 branch_list.add(branch_name);
2799 branch = branch_list.find(branch_name);
2800 string const x11hexname = X11hexname(branch->color());
2801 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2802 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2804 dr.screenUpdate(Update::Force);
2812 case LFUN_BRANCHES_RENAME: {
2813 if (func.argument().empty())
2816 docstring const oldname = from_utf8(func.getArg(0));
2817 docstring const newname = from_utf8(func.getArg(1));
2818 InsetIterator it = inset_iterator_begin(inset());
2819 InsetIterator const end = inset_iterator_end(inset());
2820 bool success = false;
2821 for (; it != end; ++it) {
2822 if (it->lyxCode() == BRANCH_CODE) {
2823 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2824 if (ins.branch() == oldname) {
2825 undo().recordUndo(CursorData(it));
2826 ins.rename(newname);
2831 if (it->lyxCode() == INCLUDE_CODE) {
2832 // get buffer of external file
2833 InsetInclude const & ins =
2834 static_cast<InsetInclude const &>(*it);
2835 Buffer * child = ins.getChildBuffer();
2838 child->dispatch(func, dr);
2843 dr.screenUpdate(Update::Force);
2844 dr.forceBufferUpdate();
2849 case LFUN_BUFFER_VIEW_CACHE:
2850 if (!theFormats().view(*this, d->preview_file_,
2851 d->preview_format_))
2852 dr.setMessage(_("Error viewing the output file."));
2855 case LFUN_CHANGES_TRACK:
2856 if (params().save_transient_properties)
2857 undo().recordUndoBufferParams(CursorData());
2858 params().track_changes = !params().track_changes;
2859 if (!params().track_changes)
2860 dr.forceChangesUpdate();
2863 case LFUN_CHANGES_OUTPUT:
2864 if (params().save_transient_properties)
2865 undo().recordUndoBufferParams(CursorData());
2866 params().output_changes = !params().output_changes;
2867 if (params().output_changes) {
2868 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2869 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2870 LaTeXFeatures::isAvailable("xcolor");
2872 if (!dvipost && !xcolorulem) {
2873 Alert::warning(_("Changes not shown in LaTeX output"),
2874 _("Changes will not be highlighted in LaTeX output, "
2875 "because neither dvipost nor xcolor/ulem are installed.\n"
2876 "Please install these packages or redefine "
2877 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2878 } else if (!xcolorulem) {
2879 Alert::warning(_("Changes not shown in LaTeX output"),
2880 _("Changes will not be highlighted in LaTeX output "
2881 "when using pdflatex, because xcolor and ulem are not installed.\n"
2882 "Please install both packages or redefine "
2883 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2888 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2889 // turn compression on/off
2890 undo().recordUndoBufferParams(CursorData());
2891 params().compressed = !params().compressed;
2894 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2895 undo().recordUndoBufferParams(CursorData());
2896 params().output_sync = !params().output_sync;
2903 dr.dispatched(dispatched);
2904 undo().endUndoGroup();
2908 void Buffer::changeLanguage(Language const * from, Language const * to)
2910 LASSERT(from, return);
2911 LASSERT(to, return);
2913 for_each(par_iterator_begin(),
2915 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2919 bool Buffer::isMultiLingual() const
2921 ParConstIterator end = par_iterator_end();
2922 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2923 if (it->isMultiLingual(params()))
2930 std::set<Language const *> Buffer::getLanguages() const
2932 std::set<Language const *> languages;
2933 getLanguages(languages);
2938 void Buffer::getLanguages(std::set<Language const *> & languages) const
2940 ParConstIterator end = par_iterator_end();
2941 // add the buffer language, even if it's not actively used
2942 languages.insert(language());
2943 // iterate over the paragraphs
2944 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2945 it->getLanguages(languages);
2947 ListOfBuffers clist = getDescendents();
2948 ListOfBuffers::const_iterator cit = clist.begin();
2949 ListOfBuffers::const_iterator const cen = clist.end();
2950 for (; cit != cen; ++cit)
2951 (*cit)->getLanguages(languages);
2955 DocIterator Buffer::getParFromID(int const id) const
2957 Buffer * buf = const_cast<Buffer *>(this);
2959 // This means non-existent
2960 return doc_iterator_end(buf);
2962 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2963 if (it.paragraph().id() == id)
2966 return doc_iterator_end(buf);
2970 bool Buffer::hasParWithID(int const id) const
2972 return !getParFromID(id).atEnd();
2976 ParIterator Buffer::par_iterator_begin()
2978 return ParIterator(doc_iterator_begin(this));
2982 ParIterator Buffer::par_iterator_end()
2984 return ParIterator(doc_iterator_end(this));
2988 ParConstIterator Buffer::par_iterator_begin() const
2990 return ParConstIterator(doc_iterator_begin(this));
2994 ParConstIterator Buffer::par_iterator_end() const
2996 return ParConstIterator(doc_iterator_end(this));
3000 Language const * Buffer::language() const
3002 return params().language;
3006 docstring const Buffer::B_(string const & l10n) const
3008 return params().B_(l10n);
3012 bool Buffer::isClean() const
3014 return d->lyx_clean;
3018 bool Buffer::isChecksumModified() const
3020 LASSERT(d->filename.exists(), return false);
3021 return d->checksum_ != d->filename.checksum();
3025 void Buffer::saveCheckSum() const
3027 FileName const & file = d->filename;
3029 d->checksum_ = file.exists() ? file.checksum()
3030 : 0; // in the case of save to a new file.
3034 void Buffer::markClean() const
3036 if (!d->lyx_clean) {
3037 d->lyx_clean = true;
3040 // if the .lyx file has been saved, we don't need an
3042 d->bak_clean = true;
3043 d->undo_.markDirty();
3044 clearExternalModification();
3048 void Buffer::setUnnamed(bool flag)
3054 bool Buffer::isUnnamed() const
3061 /// Don't check unnamed, here: isInternal() is used in
3062 /// newBuffer(), where the unnamed flag has not been set by anyone
3063 /// yet. Also, for an internal buffer, there should be no need for
3064 /// retrieving fileName() nor for checking if it is unnamed or not.
3065 bool Buffer::isInternal() const
3067 return d->internal_buffer;
3071 void Buffer::setInternal(bool flag)
3073 d->internal_buffer = flag;
3077 void Buffer::markDirty()
3080 d->lyx_clean = false;
3083 d->bak_clean = false;
3085 DepClean::iterator it = d->dep_clean.begin();
3086 DepClean::const_iterator const end = d->dep_clean.end();
3088 for (; it != end; ++it)
3093 FileName Buffer::fileName() const
3099 string Buffer::absFileName() const
3101 return d->filename.absFileName();
3105 string Buffer::filePath() const
3107 string const abs = d->filename.onlyPath().absFileName();
3110 int last = abs.length() - 1;
3112 return abs[last] == '/' ? abs : abs + '/';
3116 DocFileName Buffer::getReferencedFileName(string const & fn) const
3119 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3120 result.set(fn, filePath());
3122 // filePath() ends with a path separator
3123 FileName const test(filePath() + fn);
3125 result.set(fn, filePath());
3127 result.set(fn, params().origin);
3134 string const Buffer::prepareFileNameForLaTeX(string const & name,
3135 string const & ext, bool nice) const
3137 string const fname = makeAbsPath(name, filePath()).absFileName();
3138 if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
3144 return to_utf8(makeRelPath(from_utf8(fname),
3145 from_utf8(masterBuffer()->filePath())));
3149 vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
3150 FileNamePairList const bibfilelist,
3151 bool const add_extension) const
3153 // If we are processing the LaTeX file in a temp directory then
3154 // copy the .bib databases to this temp directory, mangling their
3155 // names in the process. Store this mangled name in the list of
3157 // (We need to do all this because BibTeX *really*, *really*
3158 // can't handle "files with spaces" and Windows users tend to
3159 // use such filenames.)
3160 // Otherwise, store the (maybe absolute) path to the original,
3161 // unmangled database name.
3163 vector<docstring> res;
3165 // determine the export format
3166 string const tex_format = flavor2format(runparams.flavor);
3168 // check for spaces in paths
3169 bool found_space = false;
3171 FileNamePairList::const_iterator it = bibfilelist.begin();
3172 FileNamePairList::const_iterator en = bibfilelist.end();
3173 for (; it != en; ++it) {
3174 string utf8input = to_utf8(it->first);
3176 prepareFileNameForLaTeX(utf8input, ".bib", runparams.nice);
3177 FileName const try_in_file =
3178 makeAbsPath(database + ".bib", filePath());
3179 bool const not_from_texmf = try_in_file.isReadableFile();
3181 if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
3183 // mangledFileName() needs the extension
3184 DocFileName const in_file = DocFileName(try_in_file);
3185 database = removeExtension(in_file.mangledFileName());
3186 FileName const out_file = makeAbsPath(database + ".bib",
3187 masterBuffer()->temppath());
3188 bool const success = in_file.copyTo(out_file);
3190 LYXERR0("Failed to copy '" << in_file
3191 << "' to '" << out_file << "'");
3193 } else if (!runparams.inComment && runparams.nice && not_from_texmf) {
3194 runparams.exportdata->addExternalFile(tex_format, try_in_file, database + ".bib");
3195 if (!isValidLaTeXFileName(database)) {
3196 frontend::Alert::warning(_("Invalid filename"),
3197 _("The following filename will cause troubles "
3198 "when running the exported file through LaTeX: ") +
3199 from_utf8(database));
3201 if (!isValidDVIFileName(database)) {
3202 frontend::Alert::warning(_("Problematic filename for DVI"),
3203 _("The following filename can cause troubles "
3204 "when running the exported file through LaTeX "
3205 "and opening the resulting DVI: ") +
3206 from_utf8(database), true);
3214 docstring const path = from_utf8(latex_path(database));
3216 if (contains(path, ' '))
3219 if (find(res.begin(), res.end(), path) == res.end())
3220 res.push_back(path);
3223 // Check if there are spaces in the path and warn BibTeX users, if so.
3224 // (biber can cope with such paths)
3225 if (!prefixIs(runparams.bibtex_command, "biber")) {
3226 // Post this warning only once.
3227 static bool warned_about_spaces = false;
3228 if (!warned_about_spaces &&
3229 runparams.nice && found_space) {
3230 warned_about_spaces = true;
3231 Alert::warning(_("Export Warning!"),
3232 _("There are spaces in the paths to your BibTeX databases.\n"
3233 "BibTeX will be unable to find them."));
3242 string Buffer::layoutPos() const
3244 return d->layout_position;
3248 void Buffer::setLayoutPos(string const & path)
3251 d->layout_position.clear();
3255 LATTEST(FileName::isAbsolute(path));
3257 d->layout_position =
3258 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3260 if (d->layout_position.empty())
3261 d->layout_position = ".";
3265 bool Buffer::hasReadonlyFlag() const
3267 return d->read_only;
3271 bool Buffer::isReadonly() const
3273 return hasReadonlyFlag() || notifiesExternalModification();
3277 void Buffer::setParent(Buffer const * buffer)
3279 // Avoids recursive include.
3280 d->setParent(buffer == this ? 0 : buffer);
3285 Buffer const * Buffer::parent() const
3291 ListOfBuffers Buffer::allRelatives() const
3293 ListOfBuffers lb = masterBuffer()->getDescendents();
3294 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3299 Buffer const * Buffer::masterBuffer() const
3301 // FIXME Should be make sure we are not in some kind
3302 // of recursive include? A -> B -> A will crash this.
3303 Buffer const * const pbuf = d->parent();
3307 return pbuf->masterBuffer();
3311 bool Buffer::isChild(Buffer * child) const
3313 return d->children_positions.find(child) != d->children_positions.end();
3317 DocIterator Buffer::firstChildPosition(Buffer const * child)
3319 Impl::BufferPositionMap::iterator it;
3320 it = d->children_positions.find(child);
3321 if (it == d->children_positions.end())
3322 return DocIterator(this);
3327 bool Buffer::hasChildren() const
3329 return !d->children_positions.empty();
3333 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3335 // loop over children
3336 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3337 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3338 for (; it != end; ++it) {
3339 Buffer * child = const_cast<Buffer *>(it->first);
3341 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3342 if (bit != clist.end())
3344 clist.push_back(child);
3346 // there might be grandchildren
3347 child->collectChildren(clist, true);
3352 ListOfBuffers Buffer::getChildren() const
3355 collectChildren(v, false);
3356 // Make sure we have not included ourselves.
3357 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3358 if (bit != v.end()) {
3359 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3366 ListOfBuffers Buffer::getDescendents() const
3369 collectChildren(v, true);
3370 // Make sure we have not included ourselves.
3371 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3372 if (bit != v.end()) {
3373 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3380 template<typename M>
3381 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3386 typename M::const_iterator it = m.lower_bound(x);
3387 if (it == m.begin())
3395 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3396 DocIterator const & pos) const
3398 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3400 // if paragraphs have no macro context set, pos will be empty
3404 // we haven't found anything yet
3405 DocIterator bestPos = owner_->par_iterator_begin();
3406 MacroData const * bestData = 0;
3408 // find macro definitions for name
3409 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3410 if (nameIt != macros.end()) {
3411 // find last definition in front of pos or at pos itself
3412 PositionScopeMacroMap::const_iterator it
3413 = greatest_below(nameIt->second, pos);
3414 if (it != nameIt->second.end()) {
3416 // scope ends behind pos?
3417 if (pos < it->second.scope) {
3418 // Looks good, remember this. If there
3419 // is no external macro behind this,
3420 // we found the right one already.
3421 bestPos = it->first;
3422 bestData = &it->second.macro;
3426 // try previous macro if there is one
3427 if (it == nameIt->second.begin())
3434 // find macros in included files
3435 PositionScopeBufferMap::const_iterator it
3436 = greatest_below(position_to_children, pos);
3437 if (it == position_to_children.end())
3438 // no children before
3442 // do we know something better (i.e. later) already?
3443 if (it->first < bestPos )
3446 // scope ends behind pos?
3447 if (pos < it->second.scope
3448 && (cloned_buffer_ ||
3449 theBufferList().isLoaded(it->second.buffer))) {
3450 // look for macro in external file
3452 MacroData const * data
3453 = it->second.buffer->getMacro(name, false);
3456 bestPos = it->first;
3462 // try previous file if there is one
3463 if (it == position_to_children.begin())
3468 // return the best macro we have found
3473 MacroData const * Buffer::getMacro(docstring const & name,
3474 DocIterator const & pos, bool global) const
3479 // query buffer macros
3480 MacroData const * data = d->getBufferMacro(name, pos);
3484 // If there is a master buffer, query that
3485 Buffer const * const pbuf = d->parent();
3487 d->macro_lock = true;
3488 MacroData const * macro = pbuf->getMacro(
3489 name, *this, false);
3490 d->macro_lock = false;
3496 data = MacroTable::globalMacros().get(name);
3505 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3507 // set scope end behind the last paragraph
3508 DocIterator scope = par_iterator_begin();
3509 scope.pit() = scope.lastpit() + 1;
3511 return getMacro(name, scope, global);
3515 MacroData const * Buffer::getMacro(docstring const & name,
3516 Buffer const & child, bool global) const
3518 // look where the child buffer is included first
3519 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3520 if (it == d->children_positions.end())
3523 // check for macros at the inclusion position
3524 return getMacro(name, it->second, global);
3528 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3530 pit_type const lastpit = it.lastpit();
3532 // look for macros in each paragraph
3533 while (it.pit() <= lastpit) {
3534 Paragraph & par = it.paragraph();
3536 // iterate over the insets of the current paragraph
3537 InsetList const & insets = par.insetList();
3538 InsetList::const_iterator iit = insets.begin();
3539 InsetList::const_iterator end = insets.end();
3540 for (; iit != end; ++iit) {
3541 it.pos() = iit->pos;
3543 // is it a nested text inset?
3544 if (iit->inset->asInsetText()) {
3545 // Inset needs its own scope?
3546 InsetText const * itext = iit->inset->asInsetText();
3547 bool newScope = itext->isMacroScope();
3549 // scope which ends just behind the inset
3550 DocIterator insetScope = it;
3553 // collect macros in inset
3554 it.push_back(CursorSlice(*iit->inset));
3555 updateMacros(it, newScope ? insetScope : scope);
3560 if (iit->inset->asInsetTabular()) {
3561 CursorSlice slice(*iit->inset);
3562 size_t const numcells = slice.nargs();
3563 for (; slice.idx() < numcells; slice.forwardIdx()) {
3564 it.push_back(slice);
3565 updateMacros(it, scope);
3571 // is it an external file?
3572 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3573 // get buffer of external file
3574 InsetInclude const & inset =
3575 static_cast<InsetInclude const &>(*iit->inset);
3577 Buffer * child = inset.getChildBuffer();
3582 // register its position, but only when it is
3583 // included first in the buffer
3584 if (children_positions.find(child) ==
3585 children_positions.end())
3586 children_positions[child] = it;
3588 // register child with its scope
3589 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3593 InsetMath * im = iit->inset->asInsetMath();
3594 if (doing_export && im) {
3595 InsetMathHull * hull = im->asHullInset();
3597 hull->recordLocation(it);
3600 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3604 InsetMathMacroTemplate & macroTemplate =
3605 *iit->inset->asInsetMath()->asMacroTemplate();
3606 MacroContext mc(owner_, it);
3607 macroTemplate.updateToContext(mc);
3610 bool valid = macroTemplate.validMacro();
3611 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3612 // then the BufferView's cursor will be invalid in
3613 // some cases which leads to crashes.
3618 // FIXME (Abdel), I don't understand why we pass 'it' here
3619 // instead of 'macroTemplate' defined above... is this correct?
3620 macros[macroTemplate.name()][it] =
3621 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3631 void Buffer::updateMacros() const
3636 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3638 // start with empty table
3640 d->children_positions.clear();
3641 d->position_to_children.clear();
3643 // Iterate over buffer, starting with first paragraph
3644 // The scope must be bigger than any lookup DocIterator
3645 // later. For the global lookup, lastpit+1 is used, hence
3646 // we use lastpit+2 here.
3647 DocIterator it = par_iterator_begin();
3648 DocIterator outerScope = it;
3649 outerScope.pit() = outerScope.lastpit() + 2;
3650 d->updateMacros(it, outerScope);
3654 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3656 InsetIterator it = inset_iterator_begin(inset());
3657 InsetIterator const end = inset_iterator_end(inset());
3658 for (; it != end; ++it) {
3659 if (it->lyxCode() == BRANCH_CODE) {
3660 InsetBranch & br = static_cast<InsetBranch &>(*it);
3661 docstring const name = br.branch();
3662 if (!from_master && !params().branchlist().find(name))
3663 result.push_back(name);
3664 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3665 result.push_back(name);
3668 if (it->lyxCode() == INCLUDE_CODE) {
3669 // get buffer of external file
3670 InsetInclude const & ins =
3671 static_cast<InsetInclude const &>(*it);
3672 Buffer * child = ins.getChildBuffer();
3675 child->getUsedBranches(result, true);
3678 // remove duplicates
3683 void Buffer::updateMacroInstances(UpdateType utype) const
3685 LYXERR(Debug::MACROS, "updateMacroInstances for "
3686 << d->filename.onlyFileName());
3687 DocIterator it = doc_iterator_begin(this);
3689 DocIterator const end = doc_iterator_end(this);
3690 for (; it != end; it.forwardInset()) {
3691 // look for MathData cells in InsetMathNest insets
3692 InsetMath * minset = it.nextInset()->asInsetMath();
3696 // update macro in all cells of the InsetMathNest
3697 DocIterator::idx_type n = minset->nargs();
3698 MacroContext mc = MacroContext(this, it);
3699 for (DocIterator::idx_type i = 0; i < n; ++i) {
3700 MathData & data = minset->cell(i);
3701 data.updateMacros(0, mc, utype, 0);
3707 void Buffer::listMacroNames(MacroNameSet & macros) const
3712 d->macro_lock = true;
3714 // loop over macro names
3715 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3716 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3717 for (; nameIt != nameEnd; ++nameIt)
3718 macros.insert(nameIt->first);
3720 // loop over children
3721 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3722 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3723 for (; it != end; ++it) {
3724 Buffer * child = const_cast<Buffer *>(it->first);
3725 // The buffer might have been closed (see #10766).
3726 if (theBufferList().isLoaded(child))
3727 child->listMacroNames(macros);
3731 Buffer const * const pbuf = d->parent();
3733 pbuf->listMacroNames(macros);
3735 d->macro_lock = false;
3739 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3741 Buffer const * const pbuf = d->parent();
3746 pbuf->listMacroNames(names);
3749 MacroNameSet::iterator it = names.begin();
3750 MacroNameSet::iterator end = names.end();
3751 for (; it != end; ++it) {
3753 MacroData const * data =
3754 pbuf->getMacro(*it, *this, false);
3756 macros.insert(data);
3758 // we cannot access the original InsetMathMacroTemplate anymore
3759 // here to calls validate method. So we do its work here manually.
3760 // FIXME: somehow make the template accessible here.
3761 if (data->optionals() > 0)
3762 features.require("xargs");
3768 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3771 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3773 RefCache::iterator it = d->ref_cache_.find(label);
3774 if (it != d->ref_cache_.end())
3775 return it->second.second;
3777 static InsetLabel const * dummy_il = 0;
3778 static References const dummy_refs = References();
3779 it = d->ref_cache_.insert(
3780 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3781 return it->second.second;
3785 Buffer::References const & Buffer::references(docstring const & label) const
3787 return const_cast<Buffer *>(this)->getReferenceCache(label);
3791 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3793 References & refs = getReferenceCache(label);
3794 refs.push_back(make_pair(inset, it));
3798 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3800 masterBuffer()->d->ref_cache_[label].first = il;
3804 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3806 return masterBuffer()->d->ref_cache_[label].first;
3810 void Buffer::clearReferenceCache() const
3813 d->ref_cache_.clear();
3817 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3819 //FIXME: This does not work for child documents yet.
3820 reloadBibInfoCache();
3822 // Check if the label 'from' appears more than once
3823 BiblioInfo const & keys = masterBibInfo();
3824 BiblioInfo::const_iterator bit = keys.begin();
3825 BiblioInfo::const_iterator bend = keys.end();
3826 vector<docstring> labels;
3828 for (; bit != bend; ++bit)
3830 labels.push_back(bit->first);
3832 if (count(labels.begin(), labels.end(), from) > 1)
3835 string const paramName = "key";
3836 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3837 if (it->lyxCode() != CITE_CODE)
3839 InsetCommand * inset = it->asInsetCommand();
3840 docstring const oldValue = inset->getParam(paramName);
3841 if (oldValue == from)
3842 inset->setParam(paramName, to);
3846 // returns NULL if id-to-row conversion is unsupported
3847 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3848 pit_type par_begin, pit_type par_end,
3849 OutputWhat output, bool master) const
3851 unique_ptr<TexRow> texrow;
3852 OutputParams runparams(¶ms().encoding());
3853 runparams.nice = true;
3854 runparams.flavor = params().getOutputFlavor(format);
3855 runparams.linelen = lyxrc.plaintext_linelen;
3856 // No side effect of file copying and image conversion
3857 runparams.dryrun = true;
3859 if (output == CurrentParagraph) {
3860 runparams.par_begin = par_begin;
3861 runparams.par_end = par_end;
3862 if (par_begin + 1 == par_end) {
3864 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3868 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3869 convert<docstring>(par_begin),
3870 convert<docstring>(par_end - 1))
3873 // output paragraphs
3874 if (runparams.flavor == OutputParams::LYX) {
3875 Paragraph const & par = text().paragraphs()[par_begin];
3877 depth_type dt = par.getDepth();
3878 par.write(ods, params(), dt);
3879 os << from_utf8(ods.str());
3880 } else if (runparams.flavor == OutputParams::HTML) {
3882 setMathFlavor(runparams);
3883 xhtmlParagraphs(text(), *this, xs, runparams);
3884 } else if (runparams.flavor == OutputParams::TEXT) {
3886 // FIXME Handles only one paragraph, unlike the others.
3887 // Probably should have some routine with a signature like them.
3888 writePlaintextParagraph(*this,
3889 text().paragraphs()[par_begin], os, runparams, dummy);
3890 } else if (params().isDocBook()) {
3891 docbookParagraphs(text(), *this, os, runparams);
3893 // If we are previewing a paragraph, even if this is the
3894 // child of some other buffer, let's cut the link here,
3895 // so that no concurring settings from the master
3896 // (e.g. branch state) interfere (see #8101).
3898 d->ignore_parent = true;
3899 // We need to validate the Buffer params' features here
3900 // in order to know if we should output polyglossia
3901 // macros (instead of babel macros)
3902 LaTeXFeatures features(*this, params(), runparams);
3904 runparams.use_polyglossia = features.usePolyglossia();
3905 // latex or literate
3908 ots.texrow().newlines(2);
3910 latexParagraphs(*this, text(), ots, runparams);
3911 texrow = ots.releaseTexRow();
3913 // Restore the parenthood
3915 d->ignore_parent = false;
3919 if (output == FullSource)
3920 os << _("Preview source code");
3921 else if (output == OnlyPreamble)
3922 os << _("Preview preamble");
3923 else if (output == OnlyBody)
3924 os << _("Preview body");
3926 if (runparams.flavor == OutputParams::LYX) {
3928 if (output == FullSource)
3930 else if (output == OnlyPreamble)
3931 params().writeFile(ods, this);
3932 else if (output == OnlyBody)
3934 os << from_utf8(ods.str());
3935 } else if (runparams.flavor == OutputParams::HTML) {
3936 writeLyXHTMLSource(os, runparams, output);
3937 } else if (runparams.flavor == OutputParams::TEXT) {
3938 if (output == OnlyPreamble) {
3939 os << "% "<< _("Plain text does not have a preamble.");
3941 writePlaintextFile(*this, os, runparams);
3942 } else if (params().isDocBook()) {
3943 writeDocBookSource(os, absFileName(), runparams, output);
3945 // latex or literate
3948 ots.texrow().newlines(2);
3950 runparams.is_child = true;
3952 writeLaTeXSource(ots, string(), runparams, output);
3953 texrow = ots.releaseTexRow();
3960 ErrorList & Buffer::errorList(string const & type) const
3962 return d->errorLists[type];
3966 void Buffer::updateTocItem(std::string const & type,
3967 DocIterator const & dit) const
3970 d->gui_->updateTocItem(type, dit);
3974 void Buffer::structureChanged() const
3977 d->gui_->structureChanged();
3981 void Buffer::errors(string const & err, bool from_master) const
3984 d->gui_->errors(err, from_master);
3988 void Buffer::message(docstring const & msg) const
3991 d->gui_->message(msg);
3995 void Buffer::setBusy(bool on) const
3998 d->gui_->setBusy(on);
4002 void Buffer::updateTitles() const
4005 d->wa_->updateTitles();
4009 void Buffer::resetAutosaveTimers() const
4012 d->gui_->resetAutosaveTimers();
4016 bool Buffer::hasGuiDelegate() const
4022 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
4031 class AutoSaveBuffer : public ForkedProcess {
4034 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
4035 : buffer_(buffer), fname_(fname) {}
4037 virtual shared_ptr<ForkedProcess> clone() const
4039 return make_shared<AutoSaveBuffer>(*this);
4044 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
4045 from_utf8(fname_.absFileName())));
4046 return run(DontWait);
4050 virtual int generateChild();
4052 Buffer const & buffer_;
4057 int AutoSaveBuffer::generateChild()
4059 #if defined(__APPLE__)
4060 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
4061 * We should use something else like threads.
4063 * Since I do not know how to determine at run time what is the OS X
4064 * version, I just disable forking altogether for now (JMarc)
4066 pid_t const pid = -1;
4068 // tmp_ret will be located (usually) in /tmp
4069 // will that be a problem?
4070 // Note that this calls ForkedCalls::fork(), so it's
4071 // ok cross-platform.
4072 pid_t const pid = fork();
4073 // If you want to debug the autosave
4074 // you should set pid to -1, and comment out the fork.
4075 if (pid != 0 && pid != -1)
4079 // pid = -1 signifies that lyx was unable
4080 // to fork. But we will do the save
4082 bool failed = false;
4083 TempFile tempfile("lyxautoXXXXXX.lyx");
4084 tempfile.setAutoRemove(false);
4085 FileName const tmp_ret = tempfile.name();
4086 if (!tmp_ret.empty()) {
4087 if (!buffer_.writeFile(tmp_ret))
4089 else if (!tmp_ret.moveTo(fname_))
4095 // failed to write/rename tmp_ret so try writing direct
4096 if (!buffer_.writeFile(fname_)) {
4097 // It is dangerous to do this in the child,
4098 // but safe in the parent, so...
4099 if (pid == -1) // emit message signal.
4100 buffer_.message(_("Autosave failed!"));
4104 if (pid == 0) // we are the child so...
4113 FileName Buffer::getEmergencyFileName() const
4115 return FileName(d->filename.absFileName() + ".emergency");
4119 FileName Buffer::getAutosaveFileName() const
4121 // if the document is unnamed try to save in the backup dir, else
4122 // in the default document path, and as a last try in the filePath,
4123 // which will most often be the temporary directory
4126 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
4127 : lyxrc.backupdir_path;
4128 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
4131 string const fname = "#" + d->filename.onlyFileName() + "#";
4133 return makeAbsPath(fname, fpath);
4137 void Buffer::removeAutosaveFile() const
4139 FileName const f = getAutosaveFileName();
4145 void Buffer::moveAutosaveFile(FileName const & oldauto) const
4147 FileName const newauto = getAutosaveFileName();
4149 if (newauto != oldauto && oldauto.exists())
4150 if (!oldauto.moveTo(newauto))
4151 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4155 bool Buffer::autoSave() const
4157 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4158 if (buf->d->bak_clean || hasReadonlyFlag())
4161 message(_("Autosaving current document..."));
4162 buf->d->bak_clean = true;
4164 FileName const fname = getAutosaveFileName();
4165 LASSERT(d->cloned_buffer_, return false);
4167 // If this buffer is cloned, we assume that
4168 // we are running in a separate thread already.
4169 TempFile tempfile("lyxautoXXXXXX.lyx");
4170 tempfile.setAutoRemove(false);
4171 FileName const tmp_ret = tempfile.name();
4172 if (!tmp_ret.empty()) {
4174 // assume successful write of tmp_ret
4175 if (tmp_ret.moveTo(fname))
4178 // failed to write/rename tmp_ret so try writing direct
4179 return writeFile(fname);
4183 void Buffer::setExportStatus(bool e) const
4185 d->doing_export = e;
4186 ListOfBuffers clist = getDescendents();
4187 ListOfBuffers::const_iterator cit = clist.begin();
4188 ListOfBuffers::const_iterator const cen = clist.end();
4189 for (; cit != cen; ++cit)
4190 (*cit)->d->doing_export = e;
4194 bool Buffer::isExporting() const
4196 return d->doing_export;
4200 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4204 return doExport(target, put_in_tempdir, result_file);
4207 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4208 string & result_file) const
4210 bool const update_unincluded =
4211 params().maintain_unincluded_children
4212 && !params().getIncludedChildren().empty();
4214 // (1) export with all included children (omit \includeonly)
4215 if (update_unincluded) {
4216 ExportStatus const status =
4217 doExport(target, put_in_tempdir, true, result_file);
4218 if (status != ExportSuccess)
4221 // (2) export with included children only
4222 return doExport(target, put_in_tempdir, false, result_file);
4226 void Buffer::setMathFlavor(OutputParams & op) const
4228 switch (params().html_math_output) {
4229 case BufferParams::MathML:
4230 op.math_flavor = OutputParams::MathAsMathML;
4232 case BufferParams::HTML:
4233 op.math_flavor = OutputParams::MathAsHTML;
4235 case BufferParams::Images:
4236 op.math_flavor = OutputParams::MathAsImages;
4238 case BufferParams::LaTeX:
4239 op.math_flavor = OutputParams::MathAsLaTeX;
4245 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4246 bool includeall, string & result_file) const
4248 LYXERR(Debug::FILES, "target=" << target);
4249 OutputParams runparams(¶ms().encoding());
4250 string format = target;
4251 string dest_filename;
4252 size_t pos = target.find(' ');
4253 if (pos != string::npos) {
4254 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4255 format = target.substr(0, pos);
4256 if (format == "default")
4257 format = params().getDefaultOutputFormat();
4258 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4259 FileName(dest_filename).onlyPath().createPath();
4260 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4262 MarkAsExporting exporting(this);
4263 string backend_format;
4264 runparams.flavor = OutputParams::LATEX;
4265 runparams.linelen = lyxrc.plaintext_linelen;
4266 runparams.includeall = includeall;
4267 vector<string> backs = params().backends();
4268 Converters converters = theConverters();
4269 bool need_nice_file = false;
4270 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4271 // Get shortest path to format
4272 converters.buildGraph();
4273 Graph::EdgePath path;
4274 for (vector<string>::const_iterator it = backs.begin();
4275 it != backs.end(); ++it) {
4276 Graph::EdgePath p = converters.getPath(*it, format);
4277 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4278 backend_format = *it;
4283 if (!put_in_tempdir) {
4284 // Only show this alert if this is an export to a non-temporary
4285 // file (not for previewing).
4286 Alert::error(_("Couldn't export file"), bformat(
4287 _("No information for exporting the format %1$s."),
4288 theFormats().prettyName(format)));
4290 return ExportNoPathToFormat;
4292 runparams.flavor = converters.getFlavor(path, this);
4293 Graph::EdgePath::const_iterator it = path.begin();
4294 Graph::EdgePath::const_iterator en = path.end();
4295 for (; it != en; ++it)
4296 if (theConverters().get(*it).nice()) {
4297 need_nice_file = true;
4302 backend_format = format;
4303 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4304 // FIXME: Don't hardcode format names here, but use a flag
4305 if (backend_format == "pdflatex")
4306 runparams.flavor = OutputParams::PDFLATEX;
4307 else if (backend_format == "luatex")
4308 runparams.flavor = OutputParams::LUATEX;
4309 else if (backend_format == "dviluatex")
4310 runparams.flavor = OutputParams::DVILUATEX;
4311 else if (backend_format == "xetex")
4312 runparams.flavor = OutputParams::XETEX;
4315 string filename = latexName(false);
4316 filename = addName(temppath(), filename);
4317 filename = changeExtension(filename,
4318 theFormats().extension(backend_format));
4319 LYXERR(Debug::FILES, "filename=" << filename);
4321 // Plain text backend
4322 if (backend_format == "text") {
4323 runparams.flavor = OutputParams::TEXT;
4324 writePlaintextFile(*this, FileName(filename), runparams);
4327 else if (backend_format == "xhtml") {
4328 runparams.flavor = OutputParams::HTML;
4329 setMathFlavor(runparams);
4330 makeLyXHTMLFile(FileName(filename), runparams);
4331 } else if (backend_format == "lyx")
4332 writeFile(FileName(filename));
4334 else if (params().isDocBook()) {
4335 runparams.nice = !put_in_tempdir;
4336 makeDocBookFile(FileName(filename), runparams);
4339 else if (backend_format == format || need_nice_file) {
4340 runparams.nice = true;
4341 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4342 if (d->cloned_buffer_)
4343 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4346 } else if (!lyxrc.tex_allows_spaces
4347 && contains(filePath(), ' ')) {
4348 Alert::error(_("File name error"),
4349 _("The directory path to the document cannot contain spaces."));
4350 return ExportTexPathHasSpaces;
4352 runparams.nice = false;
4353 bool const success = makeLaTeXFile(
4354 FileName(filename), filePath(), runparams);
4355 if (d->cloned_buffer_)
4356 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4361 string const error_type = (format == "program")
4362 ? "Build" : params().bufferFormat();
4363 ErrorList & error_list = d->errorLists[error_type];
4364 string const ext = theFormats().extension(format);
4365 FileName const tmp_result_file(changeExtension(filename, ext));
4366 bool const success = converters.convert(this, FileName(filename),
4367 tmp_result_file, FileName(absFileName()), backend_format, format,
4370 // Emit the signal to show the error list or copy it back to the
4371 // cloned Buffer so that it can be emitted afterwards.
4372 if (format != backend_format) {
4373 if (runparams.silent)
4375 else if (d->cloned_buffer_)
4376 d->cloned_buffer_->d->errorLists[error_type] =
4377 d->errorLists[error_type];
4380 // also to the children, in case of master-buffer-view
4381 ListOfBuffers clist = getDescendents();
4382 ListOfBuffers::const_iterator cit = clist.begin();
4383 ListOfBuffers::const_iterator const cen = clist.end();
4384 for (; cit != cen; ++cit) {
4385 if (runparams.silent)
4386 (*cit)->d->errorLists[error_type].clear();
4387 else if (d->cloned_buffer_) {
4388 // Enable reverse search by copying back the
4389 // texrow object to the cloned buffer.
4390 // FIXME: this is not thread safe.
4391 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4392 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4393 (*cit)->d->errorLists[error_type];
4395 (*cit)->errors(error_type, true);
4399 if (d->cloned_buffer_) {
4400 // Enable reverse dvi or pdf to work by copying back the texrow
4401 // object to the cloned buffer.
4402 // FIXME: There is a possibility of concurrent access to texrow
4403 // here from the main GUI thread that should be securized.
4404 d->cloned_buffer_->d->texrow = d->texrow;
4405 string const error_type = params().bufferFormat();
4406 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4410 if (put_in_tempdir) {
4411 result_file = tmp_result_file.absFileName();
4412 return success ? ExportSuccess : ExportConverterError;
4415 if (dest_filename.empty())
4416 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4418 result_file = dest_filename;
4419 // We need to copy referenced files (e. g. included graphics
4420 // if format == "dvi") to the result dir.
4421 vector<ExportedFile> const files =
4422 runparams.exportdata->externalFiles(format);
4423 string const dest = runparams.export_folder.empty() ?
4424 onlyPath(result_file) : runparams.export_folder;
4425 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4426 : force_overwrite == ALL_FILES;
4427 CopyStatus status = use_force ? FORCE : SUCCESS;
4429 vector<ExportedFile>::const_iterator it = files.begin();
4430 vector<ExportedFile>::const_iterator const en = files.end();
4431 for (; it != en && status != CANCEL; ++it) {
4432 string const fmt = theFormats().getFormatFromFile(it->sourceName);
4433 string fixedName = it->exportName;
4434 if (!runparams.export_folder.empty()) {
4435 // Relative pathnames starting with ../ will be sanitized
4436 // if exporting to a different folder
4437 while (fixedName.substr(0, 3) == "../")
4438 fixedName = fixedName.substr(3, fixedName.length() - 3);
4440 FileName fixedFileName = makeAbsPath(fixedName, dest);
4441 fixedFileName.onlyPath().createPath();
4442 status = copyFile(fmt, it->sourceName,
4444 it->exportName, status == FORCE,
4445 runparams.export_folder.empty());
4448 if (status == CANCEL) {
4449 message(_("Document export cancelled."));
4450 return ExportCancel;
4453 if (tmp_result_file.exists()) {
4454 // Finally copy the main file
4455 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4456 : force_overwrite != NO_FILES;
4457 if (status == SUCCESS && use_force)
4459 status = copyFile(format, tmp_result_file,
4460 FileName(result_file), result_file,
4462 if (status == CANCEL) {
4463 message(_("Document export cancelled."));
4464 return ExportCancel;
4466 message(bformat(_("Document exported as %1$s "
4468 theFormats().prettyName(format),
4469 makeDisplayPath(result_file)));
4472 // This must be a dummy converter like fax (bug 1888)
4473 message(bformat(_("Document exported as %1$s"),
4474 theFormats().prettyName(format)));
4477 return success ? ExportSuccess : ExportConverterError;
4481 Buffer::ExportStatus Buffer::preview(string const & format) const
4483 bool const update_unincluded =
4484 params().maintain_unincluded_children
4485 && !params().getIncludedChildren().empty();
4486 return preview(format, update_unincluded);
4490 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4492 MarkAsExporting exporting(this);
4494 // (1) export with all included children (omit \includeonly)
4496 ExportStatus const status = doExport(format, true, true, result_file);
4497 if (status != ExportSuccess)
4500 // (2) export with included children only
4501 ExportStatus const status = doExport(format, true, false, result_file);
4502 FileName const previewFile(result_file);
4504 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4505 theimpl->preview_file_ = previewFile;
4506 theimpl->preview_format_ = format;
4507 theimpl->preview_error_ = (status != ExportSuccess);
4509 if (status != ExportSuccess)
4512 if (previewFile.exists())
4513 return theFormats().view(*this, previewFile, format) ?
4514 PreviewSuccess : PreviewError;
4516 // Successful export but no output file?
4517 // Probably a bug in error detection.
4518 LATTEST(status != ExportSuccess);
4523 Buffer::ReadStatus Buffer::extractFromVC()
4525 bool const found = LyXVC::file_not_found_hook(d->filename);
4527 return ReadFileNotFound;
4528 if (!d->filename.isReadableFile())
4534 Buffer::ReadStatus Buffer::loadEmergency()
4536 FileName const emergencyFile = getEmergencyFileName();
4537 if (!emergencyFile.exists()
4538 || emergencyFile.lastModified() <= d->filename.lastModified())
4539 return ReadFileNotFound;
4541 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4542 docstring const text = bformat(_("An emergency save of the document "
4543 "%1$s exists.\n\nRecover emergency save?"), file);
4545 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4546 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4552 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4553 bool const success = (ret_llf == ReadSuccess);
4555 if (hasReadonlyFlag()) {
4556 Alert::warning(_("File is read-only"),
4557 bformat(_("An emergency file is successfully loaded, "
4558 "but the original file %1$s is marked read-only. "
4559 "Please make sure to save the document as a different "
4560 "file."), from_utf8(d->filename.absFileName())));
4563 lyxvc().file_found_hook(d->filename);
4564 str = _("Document was successfully recovered.");
4566 str = _("Document was NOT successfully recovered.");
4567 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4568 makeDisplayPath(emergencyFile.absFileName()));
4570 int const del_emerg =
4571 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4572 _("&Remove"), _("&Keep"));
4573 if (del_emerg == 0) {
4574 emergencyFile.removeFile();
4576 Alert::warning(_("Emergency file deleted"),
4577 _("Do not forget to save your file now!"), true);
4579 return success ? ReadSuccess : ReadEmergencyFailure;
4582 int const del_emerg =
4583 Alert::prompt(_("Delete emergency file?"),
4584 _("Remove emergency file now?"), 1, 1,
4585 _("&Remove"), _("&Keep"));
4587 emergencyFile.removeFile();
4588 return ReadOriginal;
4598 Buffer::ReadStatus Buffer::loadAutosave()
4600 // Now check if autosave file is newer.
4601 FileName const autosaveFile = getAutosaveFileName();
4602 if (!autosaveFile.exists()
4603 || autosaveFile.lastModified() <= d->filename.lastModified())
4604 return ReadFileNotFound;
4606 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4607 docstring const text = bformat(_("The backup of the document %1$s "
4608 "is newer.\n\nLoad the backup instead?"), file);
4609 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4610 _("&Load backup"), _("Load &original"), _("&Cancel"));
4615 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4616 // the file is not saved if we load the autosave file.
4617 if (ret_llf == ReadSuccess) {
4618 if (hasReadonlyFlag()) {
4619 Alert::warning(_("File is read-only"),
4620 bformat(_("A backup file is successfully loaded, "
4621 "but the original file %1$s is marked read-only. "
4622 "Please make sure to save the document as a "
4624 from_utf8(d->filename.absFileName())));
4627 lyxvc().file_found_hook(d->filename);
4630 return ReadAutosaveFailure;
4633 // Here we delete the autosave
4634 autosaveFile.removeFile();
4635 return ReadOriginal;
4643 Buffer::ReadStatus Buffer::loadLyXFile()
4645 if (!d->filename.isReadableFile()) {
4646 ReadStatus const ret_rvc = extractFromVC();
4647 if (ret_rvc != ReadSuccess)
4651 ReadStatus const ret_re = loadEmergency();
4652 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4655 ReadStatus const ret_ra = loadAutosave();
4656 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4659 return loadThisLyXFile(d->filename);
4663 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4665 return readFile(fn);
4669 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4671 for (auto const & err : terr) {
4672 TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
4673 int errorRow = err.error_in_line;
4674 Buffer const * buf = 0;
4676 if (err.child_name.empty())
4677 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4679 // The error occurred in a child
4680 for (Buffer const * child : getDescendents()) {
4681 string const child_name =
4682 DocFileName(changeExtension(child->absFileName(), "tex")).
4684 if (err.child_name != child_name)
4686 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4687 if (!TexRow::isNone(start)) {
4688 buf = d->cloned_buffer_
4689 ? child->d->cloned_buffer_->d->owner_
4696 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4702 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4704 LBUFERR(!text().paragraphs().empty());
4706 // Use the master text class also for child documents
4707 Buffer const * const master = masterBuffer();
4708 DocumentClass const & textclass = master->params().documentClass();
4710 // do this only if we are the top-level Buffer
4711 if (master == this) {
4712 textclass.counters().reset(from_ascii("bibitem"));
4713 reloadBibInfoCache();
4716 // keep the buffers to be children in this set. If the call from the
4717 // master comes back we can see which of them were actually seen (i.e.
4718 // via an InsetInclude). The remaining ones in the set need still be updated.
4719 static std::set<Buffer const *> bufToUpdate;
4720 if (scope == UpdateMaster) {
4721 // If this is a child document start with the master
4722 if (master != this) {
4723 bufToUpdate.insert(this);
4724 master->updateBuffer(UpdateMaster, utype);
4725 // If the master buffer has no gui associated with it, then the TocModel is
4726 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4727 // (bug 5699). The same happens if the master buffer is open in a different
4728 // window. This test catches both possibilities.
4729 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4730 // There remains a problem here: If there is another child open in yet a third
4731 // window, that TOC is not updated. So some more general solution is needed at
4733 if (master->d->gui_ != d->gui_)
4736 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4737 if (bufToUpdate.find(this) == bufToUpdate.end())
4741 // start over the counters in the master
4742 textclass.counters().reset();
4745 // update will be done below for this buffer
4746 bufToUpdate.erase(this);
4748 // update all caches
4749 clearReferenceCache();
4751 setChangesPresent(false);
4753 Buffer & cbuf = const_cast<Buffer &>(*this);
4756 ParIterator parit = cbuf.par_iterator_begin();
4757 updateBuffer(parit, utype);
4760 // If this document has siblings, then update the TocBackend later. The
4761 // reason is to ensure that later siblings are up to date when e.g. the
4762 // broken or not status of references is computed. The update is called
4763 // in InsetInclude::addToToc.
4766 d->bibinfo_cache_valid_ = true;
4767 d->cite_labels_valid_ = true;
4769 cbuf.tocBackend().update(true, utype);
4770 if (scope == UpdateMaster)
4771 cbuf.structureChanged();
4775 static depth_type getDepth(DocIterator const & it)
4777 depth_type depth = 0;
4778 for (size_t i = 0 ; i < it.depth() ; ++i)
4779 if (!it[i].inset().inMathed())
4780 depth += it[i].paragraph().getDepth() + 1;
4781 // remove 1 since the outer inset does not count
4782 // we should have at least one non-math inset, so
4783 // depth should nevery be 0. but maybe it is worth
4784 // marking this, just in case.
4786 // coverity[INTEGER_OVERFLOW]
4790 static depth_type getItemDepth(ParIterator const & it)
4792 Paragraph const & par = *it;
4793 LabelType const labeltype = par.layout().labeltype;
4795 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4798 // this will hold the lowest depth encountered up to now.
4799 depth_type min_depth = getDepth(it);
4800 ParIterator prev_it = it;
4803 --prev_it.top().pit();
4805 // start of nested inset: go to outer par
4807 if (prev_it.empty()) {
4808 // start of document: nothing to do
4813 // We search for the first paragraph with same label
4814 // that is not more deeply nested.
4815 Paragraph & prev_par = *prev_it;
4816 depth_type const prev_depth = getDepth(prev_it);
4817 if (labeltype == prev_par.layout().labeltype) {
4818 if (prev_depth < min_depth)
4819 return prev_par.itemdepth + 1;
4820 if (prev_depth == min_depth)
4821 return prev_par.itemdepth;
4823 min_depth = min(min_depth, prev_depth);
4824 // small optimization: if we are at depth 0, we won't
4825 // find anything else
4826 if (prev_depth == 0)
4832 static bool needEnumCounterReset(ParIterator const & it)
4834 Paragraph const & par = *it;
4835 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4836 depth_type const cur_depth = par.getDepth();
4837 ParIterator prev_it = it;
4838 while (prev_it.pit()) {
4839 --prev_it.top().pit();
4840 Paragraph const & prev_par = *prev_it;
4841 if (prev_par.getDepth() <= cur_depth)
4842 return prev_par.layout().name() != par.layout().name();
4844 // start of nested inset: reset
4849 // set the label of a paragraph. This includes the counters.
4850 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4852 BufferParams const & bp = owner_->masterBuffer()->params();
4853 DocumentClass const & textclass = bp.documentClass();
4854 Paragraph & par = it.paragraph();
4855 Layout const & layout = par.layout();
4856 Counters & counters = textclass.counters();
4858 if (par.params().startOfAppendix()) {
4859 // We want to reset the counter corresponding to toplevel sectioning
4860 Layout const & lay = textclass.getTOCLayout();
4861 docstring const cnt = lay.counter;
4863 counters.reset(cnt);
4864 counters.appendix(true);
4866 par.params().appendix(counters.appendix());
4868 // Compute the item depth of the paragraph
4869 par.itemdepth = getItemDepth(it);
4871 if (layout.margintype == MARGIN_MANUAL) {
4872 if (par.params().labelWidthString().empty())
4873 par.params().labelWidthString(par.expandLabel(layout, bp));
4874 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4875 // we do not need to do anything here, since the empty case is
4876 // handled during export.
4878 par.params().labelWidthString(docstring());
4881 switch(layout.labeltype) {
4882 case LABEL_ITEMIZE: {
4883 // At some point of time we should do something more
4884 // clever here, like:
4885 // par.params().labelString(
4886 // bp.user_defined_bullet(par.itemdepth).getText());
4887 // for now, use a simple hardcoded label
4888 docstring itemlabel;
4889 switch (par.itemdepth) {
4891 itemlabel = char_type(0x2022);
4894 itemlabel = char_type(0x2013);
4897 itemlabel = char_type(0x2217);
4900 itemlabel = char_type(0x2219); // or 0x00b7
4903 par.params().labelString(itemlabel);
4907 case LABEL_ENUMERATE: {
4908 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4910 switch (par.itemdepth) {
4921 enumcounter += "iv";
4924 // not a valid enumdepth...
4928 // Increase the master counter?
4929 if (layout.stepmastercounter && needEnumCounterReset(it))
4930 counters.stepMaster(enumcounter, utype);
4932 // Maybe we have to reset the enumeration counter.
4933 if (!layout.resumecounter && needEnumCounterReset(it))
4934 counters.reset(enumcounter);
4935 counters.step(enumcounter, utype);
4937 string const & lang = par.getParLanguage(bp)->code();
4938 par.params().labelString(counters.theCounter(enumcounter, lang));
4943 case LABEL_SENSITIVE: {
4944 string const & type = counters.current_float();
4945 docstring full_label;
4947 full_label = owner_->B_("Senseless!!! ");
4949 docstring name = owner_->B_(textclass.floats().getType(type).name());
4950 if (counters.hasCounter(from_utf8(type))) {
4951 string const & lang = par.getParLanguage(bp)->code();
4952 counters.step(from_utf8(type), utype);
4953 full_label = bformat(from_ascii("%1$s %2$s:"),
4955 counters.theCounter(from_utf8(type), lang));
4957 full_label = bformat(from_ascii("%1$s #:"), name);
4959 par.params().labelString(full_label);
4963 case LABEL_NO_LABEL:
4964 par.params().labelString(docstring());
4968 case LABEL_CENTERED:
4969 case LABEL_STATIC: {
4970 docstring const & lcounter = layout.counter;
4971 if (!lcounter.empty()) {
4972 if (layout.toclevel <= bp.secnumdepth
4973 && (layout.latextype != LATEX_ENVIRONMENT
4974 || it.text()->isFirstInSequence(it.pit()))) {
4975 if (counters.hasCounter(lcounter))
4976 counters.step(lcounter, utype);
4977 par.params().labelString(par.expandLabel(layout, bp));
4979 par.params().labelString(docstring());
4981 par.params().labelString(par.expandLabel(layout, bp));
4987 par.params().labelString(par.expandLabel(layout, bp));
4992 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4994 // LASSERT: Is it safe to continue here, or should we just return?
4995 LASSERT(parit.pit() == 0, /**/);
4997 // Set the position of the text in the buffer to be able
4998 // to resolve macros in it.
4999 parit.text()->setMacrocontextPosition(parit);
5001 depth_type maxdepth = 0;
5002 pit_type const lastpit = parit.lastpit();
5003 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
5004 // reduce depth if necessary
5005 if (parit->params().depth() > maxdepth) {
5006 /** FIXME: this function is const, but
5007 * nevertheless it modifies the buffer. To be
5008 * cleaner, one should modify the buffer in
5009 * another function, which is actually
5010 * non-const. This would however be costly in
5011 * terms of code duplication.
5013 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
5014 parit->params().depth(maxdepth);
5016 maxdepth = parit->getMaxDepthAfter();
5018 if (utype == OutputUpdate) {
5019 // track the active counters
5020 // we have to do this for the master buffer, since the local
5021 // buffer isn't tracking anything.
5022 masterBuffer()->params().documentClass().counters().
5023 setActiveLayout(parit->layout());
5026 // set the counter for this paragraph
5027 d->setLabel(parit, utype);
5029 // update change-tracking flag
5030 parit->addChangesToBuffer(*this);
5033 InsetList::const_iterator iit = parit->insetList().begin();
5034 InsetList::const_iterator end = parit->insetList().end();
5035 for (; iit != end; ++iit) {
5036 parit.pos() = iit->pos;
5037 iit->inset->updateBuffer(parit, utype);
5043 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
5044 WordLangTuple & word_lang, docstring_list & suggestions) const
5048 suggestions.clear();
5049 word_lang = WordLangTuple();
5050 bool const to_end = to.empty();
5051 DocIterator const end = to_end ? doc_iterator_end(this) : to;
5052 // OK, we start from here.
5053 for (; from != end; from.forwardPos()) {
5054 // This skips all insets with spell check disabled.
5055 while (!from.allowSpellCheck()) {
5059 // If from is at the end of the document (which is possible
5060 // when "from" was changed above) LyX will crash later otherwise.
5061 if (from.atEnd() || (!to_end && from >= end))
5064 from.paragraph().spellCheck();
5065 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
5066 if (SpellChecker::misspelled(res)) {
5070 // Do not increase progress when from == to, otherwise the word
5071 // count will be wrong.
5081 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
5083 bool inword = false;
5088 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
5089 if (!dit.inTexted()) {
5094 Paragraph const & par = dit.paragraph();
5095 pos_type const pos = dit.pos();
5097 // Copied and adapted from isWordSeparator() in Paragraph
5098 if (pos == dit.lastpos()) {
5101 Inset const * ins = par.getInset(pos);
5102 if (ins && skipNoOutput && !ins->producesOutput()) {
5105 // stop if end of range was skipped
5106 if (!to.atEnd() && dit >= to)
5109 } else if (!par.isDeleted(pos)) {
5110 if (par.isWordSeparator(pos))
5116 if (ins && ins->isLetter())
5118 else if (ins && ins->isSpace())
5121 char_type const c = par.getChar(pos);
5122 if (isPrintableNonspace(c))
5124 else if (isSpace(c))
5134 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
5136 d->updateStatistics(from, to, skipNoOutput);
5140 int Buffer::wordCount() const
5142 return d->wordCount();
5146 int Buffer::charCount(bool with_blanks) const
5148 return d->charCount(with_blanks);
5152 Buffer::ReadStatus Buffer::reload()
5155 // c.f. bug http://www.lyx.org/trac/ticket/6587
5156 removeAutosaveFile();
5157 // e.g., read-only status could have changed due to version control
5158 d->filename.refresh();
5159 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5161 // clear parent. this will get reset if need be.
5163 ReadStatus const status = loadLyXFile();
5164 if (status == ReadSuccess) {
5169 message(bformat(_("Document %1$s reloaded."), disp_fn));
5172 message(bformat(_("Could not reload document %1$s."), disp_fn));
5182 bool Buffer::saveAs(FileName const & fn)
5184 FileName const old_name = fileName();
5185 FileName const old_auto = getAutosaveFileName();
5186 bool const old_unnamed = isUnnamed();
5187 bool success = true;
5188 d->old_position = filePath();
5195 // bring the autosave file with us, just in case.
5196 moveAutosaveFile(old_auto);
5197 // validate version control data and
5198 // correct buffer title
5199 lyxvc().file_found_hook(fileName());
5201 // the file has now been saved to the new location.
5202 // we need to check that the locations of child buffers
5204 checkChildBuffers();
5205 checkMasterBuffer();
5208 // reset the old filename and unnamed state
5209 setFileName(old_name);
5210 setUnnamed(old_unnamed);
5214 d->old_position.clear();
5219 void Buffer::checkChildBuffers()
5221 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5222 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5223 for (; it != en; ++it) {
5224 DocIterator dit = it->second;
5225 Buffer * cbuf = const_cast<Buffer *>(it->first);
5226 if (!cbuf || !theBufferList().isLoaded(cbuf))
5228 Inset * inset = dit.nextInset();
5229 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5230 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5231 docstring const & incfile = inset_inc->getParam("filename");
5232 string oldloc = cbuf->absFileName();
5233 string newloc = makeAbsPath(to_utf8(incfile),
5234 onlyPath(absFileName())).absFileName();
5235 if (oldloc == newloc)
5237 // the location of the child file is incorrect.
5239 inset_inc->setChildBuffer(0);
5241 // invalidate cache of children
5242 d->children_positions.clear();
5243 d->position_to_children.clear();
5247 // If a child has been saved under a different name/path, it might have been
5248 // orphaned. Therefore the master needs to be reset (bug 8161).
5249 void Buffer::checkMasterBuffer()
5251 Buffer const * const master = masterBuffer();
5255 // necessary to re-register the child (bug 5873)
5256 // FIXME: clean up updateMacros (here, only
5257 // child registering is needed).
5258 master->updateMacros();
5259 // (re)set master as master buffer, but only
5260 // if we are a real child
5261 if (master->isChild(this))
5268 string Buffer::includedFilePath(string const & name, string const & ext) const
5270 if (d->old_position.empty() ||
5271 equivalent(FileName(d->old_position), FileName(filePath())))
5274 bool isabsolute = FileName::isAbsolute(name);
5275 // both old_position and filePath() end with a path separator
5276 string absname = isabsolute ? name : d->old_position + name;
5278 // if old_position is set to origin, we need to do the equivalent of
5279 // getReferencedFileName() (see readDocument())
5280 if (!isabsolute && d->old_position == params().origin) {
5281 FileName const test(addExtension(filePath() + name, ext));
5283 absname = filePath() + name;
5286 if (!FileName(addExtension(absname, ext)).exists())
5290 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5292 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5293 from_utf8(filePath())));
5297 void Buffer::setChangesPresent(bool b) const
5299 d->tracked_changes_present_ = b;
5303 bool Buffer::areChangesPresent() const
5305 return d->tracked_changes_present_;
5309 void Buffer::updateChangesPresent() const
5311 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5312 setChangesPresent(false);
5313 ParConstIterator it = par_iterator_begin();
5314 ParConstIterator const end = par_iterator_end();
5315 for (; !areChangesPresent() && it != end; ++it)
5316 it->addChangesToBuffer(*this);
5320 void Buffer::Impl::refreshFileMonitor()
5322 if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
5323 file_monitor_->refresh();
5327 // The previous file monitor is invalid
5328 // This also destroys the previous file monitor and all its connections
5329 file_monitor_ = FileSystemWatcher::monitor(filename);
5330 // file_monitor_ will be destroyed with *this, so it is not going to call a
5331 // destroyed object method.
5332 file_monitor_->connect([this](bool exists) {
5333 fileExternallyModified(exists);
5338 void Buffer::Impl::fileExternallyModified(bool const exists)
5340 // ignore notifications after our own saving operations
5341 if (checksum_ == filename.checksum()) {
5342 LYXERR(Debug::FILES, "External modification but "
5343 "checksum unchanged: " << filename);
5346 lyx_clean = bak_clean = false;
5347 // If the file has been deleted, only mark the file as dirty since it is
5348 // pointless to prompt for reloading. If later a file is moved into this
5349 // location, then the externally modified warning will appear then.
5351 externally_modified_ = true;
5352 // Update external modification notification.
5353 // Dirty buffers must be visible at all times.
5354 if (wa_ && wa_->unhide(owner_))
5355 wa_->updateTitles();
5357 // Unable to unhide the buffer (e.g. no GUI or not current View)
5362 bool Buffer::notifiesExternalModification() const
5364 return d->externally_modified_;
5368 void Buffer::clearExternalModification() const
5370 d->externally_modified_ = false;
5372 d->wa_->updateTitles();