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"
58 #include "SpellChecker.h"
60 #include "texstream.h"
63 #include "TextClass.h"
64 #include "TocBackend.h"
66 #include "VCBackend.h"
68 #include "WordLangTuple.h"
71 #include "insets/InsetBibtex.h"
72 #include "insets/InsetBranch.h"
73 #include "insets/InsetInclude.h"
74 #include "insets/InsetTabular.h"
75 #include "insets/InsetText.h"
77 #include "mathed/InsetMathHull.h"
78 #include "mathed/MacroTable.h"
79 #include "mathed/MathMacroTemplate.h"
80 #include "mathed/MathSupport.h"
82 #include "graphics/GraphicsCache.h"
83 #include "graphics/PreviewLoader.h"
85 #include "frontends/alert.h"
86 #include "frontends/Delegates.h"
87 #include "frontends/WorkAreaManager.h"
89 #include "support/lassert.h"
90 #include "support/convert.h"
91 #include "support/debug.h"
92 #include "support/docstring_list.h"
93 #include "support/ExceptionMessage.h"
94 #include "support/FileName.h"
95 #include "support/FileNameList.h"
96 #include "support/filetools.h"
97 #include "support/ForkedCalls.h"
98 #include "support/gettext.h"
99 #include "support/gzstream.h"
100 #include "support/lstrings.h"
101 #include "support/lyxalgo.h"
102 #include "support/mutex.h"
103 #include "support/os.h"
104 #include "support/Package.h"
105 #include "support/PathChanger.h"
106 #include "support/Systemcall.h"
107 #include "support/TempFile.h"
108 #include "support/textutils.h"
109 #include "support/types.h"
111 #include "support/bind.h"
123 using namespace lyx::support;
124 using namespace lyx::graphics;
128 namespace Alert = frontend::Alert;
129 namespace os = support::os;
133 int const LYX_FORMAT = LYX_FORMAT_LYX;
135 typedef map<string, bool> DepClean;
136 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
141 // A storehouse for the cloned buffers.
142 list<CloneList *> cloned_buffers;
148 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
152 delete preview_loader_;
160 /// search for macro in local (buffer) table or in children
161 MacroData const * getBufferMacro(docstring const & name,
162 DocIterator const & pos) const;
164 /// Update macro table starting with position of it \param it in some
166 void updateMacros(DocIterator & it, DocIterator & scope);
168 void setLabel(ParIterator & it, UpdateType utype) const;
170 /** If we have branches that use the file suffix
171 feature, return the file name with suffix appended.
173 support::FileName exportFileName() const;
180 mutable TexRow texrow;
182 /// need to regenerate .tex?
186 mutable bool lyx_clean;
188 /// is autosave needed?
189 mutable bool bak_clean;
191 /// is this an unnamed file (New...)?
194 /// is this an internal bufffer?
195 bool internal_buffer;
200 /// name of the file the buffer is associated with.
203 /** Set to true only when the file is fully loaded.
204 * Used to prevent the premature generation of previews
205 * and by the citation inset.
207 bool file_fully_loaded;
209 /// original format of loaded file
212 /// if the file was originally loaded from an older format, do
213 /// we need to back it up still?
214 bool need_format_backup;
216 /// Ignore the parent (e.g. when exporting a child standalone)?
220 mutable TocBackend toc_backend;
225 ScopeMacro(DocIterator const & s, MacroData const & m)
226 : scope(s), macro(m) {}
230 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
231 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
232 /// map from the macro name to the position map,
233 /// which maps the macro definition position to the scope and the MacroData.
234 NamePositionScopeMacroMap macros;
235 /// This seem to change the way Buffer::getMacro() works
236 mutable bool macro_lock;
238 /// positions of child buffers in the buffer
239 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
241 ScopeBuffer() : buffer(0) {}
242 ScopeBuffer(DocIterator const & s, Buffer const * b)
243 : scope(s), buffer(b) {}
245 Buffer const * buffer;
247 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
248 /// position of children buffers in this buffer
249 BufferPositionMap children_positions;
250 /// map from children inclusion positions to their scope and their buffer
251 PositionScopeBufferMap position_to_children;
253 /// Contains the old buffer filePath() while saving-as, or the
254 /// directory where the document was last saved while loading.
257 /** Keeps track of the path of local layout files.
258 * If possible, it is always relative to the buffer path.
259 * Empty for layouts in system or user directory.
261 string layout_position;
263 /// Container for all sort of Buffer dependant errors.
264 map<string, ErrorList> errorLists;
266 /// timestamp and checksum used to test if the file has been externally
267 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
269 unsigned long checksum_;
272 frontend::WorkAreaManager * wa_;
274 frontend::GuiBufferDelegate * gui_;
279 /// A cache for the bibfiles (including bibfiles of loaded child
280 /// documents), needed for appropriate update of natbib labels.
281 mutable support::FileNamePairList bibfiles_cache_;
283 // FIXME The caching mechanism could be improved. At present, we have a
284 // cache for each Buffer, that caches all the bibliography info for that
285 // Buffer. A more efficient solution would be to have a global cache per
286 // file, and then to construct the Buffer's bibinfo from that.
287 /// A cache for bibliography info
288 mutable BiblioInfo bibinfo_;
289 /// whether the bibinfo cache is valid
290 mutable bool bibinfo_cache_valid_;
291 /// whether the bibfile cache is valid
292 mutable bool bibfile_cache_valid_;
293 /// Cache of timestamps of .bib files
294 map<FileName, time_t> bibfile_status_;
295 /// Indicates whether the bibinfo has changed since the last time
296 /// we ran updateBuffer(), i.e., whether citation labels may need
298 mutable bool cite_labels_valid_;
300 /// These two hold the file name and format, written to by
301 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
302 FileName preview_file_;
303 string preview_format_;
304 /// If there was an error when previewing, on the next preview we do
305 /// a fresh compile (e.g. in case the user installed a package that
309 mutable RefCache ref_cache_;
311 /// our Text that should be wrapped in an InsetText
315 PreviewLoader * preview_loader_;
317 /// This is here to force the test to be done whenever parent_buffer
319 Buffer const * parent() const
321 // ignore_parent temporarily "orphans" a buffer
322 // (e.g. if a child is compiled standalone)
325 // if parent_buffer is not loaded, then it has been unloaded,
326 // which means that parent_buffer is an invalid pointer. So we
327 // set it to null in that case.
328 // however, the BufferList doesn't know about cloned buffers, so
329 // they will always be regarded as unloaded. in that case, we hope
331 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
333 return parent_buffer;
337 void setParent(Buffer const * pb)
339 if (parent_buffer == pb)
342 if (!cloned_buffer_ && parent_buffer && pb)
343 LYXERR0("Warning: a buffer should not have two parents!");
345 if (!cloned_buffer_ && parent_buffer) {
346 parent_buffer->invalidateBibfileCache();
347 parent_buffer->invalidateBibinfoCache();
351 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
352 /// This one is useful for preview detached in a thread.
353 Buffer const * cloned_buffer_;
355 CloneList * clone_list_;
356 /// are we in the process of exporting this buffer?
357 mutable bool doing_export;
359 /// compute statistics
360 /// \p from initial position
361 /// \p to points to the end position
362 void updateStatistics(DocIterator & from, DocIterator & to,
363 bool skipNoOutput = true);
364 /// statistics accessor functions
365 int wordCount() const
369 int charCount(bool with_blanks) const
372 + (with_blanks ? blank_count_ : 0);
375 // does the buffer contain tracked changes? (if so, we automatically
376 // display the review toolbar, for instance)
377 mutable bool tracked_changes_present_;
380 /// So we can force access via the accessors.
381 mutable Buffer const * parent_buffer;
390 /// Creates the per buffer temporary directory
391 static FileName createBufferTmpDir()
393 // FIXME This would be the ideal application for a TempDir class (like
394 // TempFile but for directories)
399 Mutex::Locker locker(&mutex);
400 counter = convert<string>(count++);
402 // We are in our own directory. Why bother to mangle name?
403 // In fact I wrote this code to circumvent a problematic behaviour
404 // (bug?) of EMX mkstemp().
405 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
408 if (!tmpfl.createDirectory(0777)) {
409 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
410 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
411 from_utf8(tmpfl.absFileName())));
417 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
418 Buffer const * cloned_buffer)
419 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
420 internal_buffer(false), read_only(readonly_), filename(file),
421 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
422 ignore_parent(false), toc_backend(owner), macro_lock(false), timestamp_(0),
423 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
424 bibfile_cache_valid_(false), cite_labels_valid_(false), preview_error_(false),
425 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
426 clone_list_(0), doing_export(false), parent_buffer(0),
427 word_count_(0), char_count_(0), blank_count_(0)
429 if (!cloned_buffer_) {
430 temppath = createBufferTmpDir();
431 lyxvc.setBuffer(owner_);
433 wa_ = new frontend::WorkAreaManager;
436 temppath = cloned_buffer_->d->temppath;
437 file_fully_loaded = true;
438 params = cloned_buffer_->d->params;
439 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
440 bibinfo_ = cloned_buffer_->d->bibinfo_;
441 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
442 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
443 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
444 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
445 unnamed = cloned_buffer_->d->unnamed;
446 internal_buffer = cloned_buffer_->d->internal_buffer;
447 layout_position = cloned_buffer_->d->layout_position;
448 preview_file_ = cloned_buffer_->d->preview_file_;
449 preview_format_ = cloned_buffer_->d->preview_format_;
450 preview_error_ = cloned_buffer_->d->preview_error_;
451 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
455 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
456 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
458 LYXERR(Debug::INFO, "Buffer::Buffer()");
460 d->inset = new InsetText(*cloned_buffer->d->inset);
461 d->inset->setBuffer(*this);
462 // FIXME: optimize this loop somewhat, maybe by creating a new
463 // general recursive Inset::setId().
464 DocIterator it = doc_iterator_begin(this);
465 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
466 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
467 it.paragraph().setId(cloned_it.paragraph().id());
469 d->inset = new InsetText(this);
470 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
476 LYXERR(Debug::INFO, "Buffer::~Buffer()");
477 // here the buffer should take care that it is
478 // saved properly, before it goes into the void.
480 // GuiView already destroyed
484 // No need to do additional cleanups for internal buffer.
490 // this is in case of recursive includes: we won't try to delete
491 // ourselves as a child.
492 d->clone_list_->erase(this);
493 // loop over children
494 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
495 Impl::BufferPositionMap::iterator end = d->children_positions.end();
496 for (; it != end; ++it) {
497 Buffer * child = const_cast<Buffer *>(it->first);
498 if (d->clone_list_->erase(child))
501 // if we're the master buffer, then we should get rid of the list
504 // If this is not empty, we have leaked something. Worse, one of the
505 // children still has a reference to this list. But we will try to
506 // continue, rather than shut down.
507 LATTEST(d->clone_list_->empty());
508 list<CloneList *>::iterator it =
509 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
510 if (it == cloned_buffers.end()) {
511 // We will leak in this case, but it is safe to continue.
514 cloned_buffers.erase(it);
515 delete d->clone_list_;
517 // FIXME Do we really need to do this right before we delete d?
518 // clear references to children in macro tables
519 d->children_positions.clear();
520 d->position_to_children.clear();
522 // loop over children
523 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
524 Impl::BufferPositionMap::iterator end = d->children_positions.end();
525 for (; it != end; ++it) {
526 Buffer * child = const_cast<Buffer *>(it->first);
527 if (theBufferList().isLoaded(child)) {
528 if (theBufferList().isOthersChild(this, child))
531 theBufferList().release(child);
536 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
537 msg += emergencyWrite();
538 Alert::warning(_("Attempting to close changed document!"), msg);
541 // FIXME Do we really need to do this right before we delete d?
542 // clear references to children in macro tables
543 d->children_positions.clear();
544 d->position_to_children.clear();
546 if (!d->temppath.destroyDirectory()) {
547 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
548 from_utf8(d->temppath.absFileName())));
557 Buffer * Buffer::cloneFromMaster() const
560 cloned_buffers.push_back(new CloneList);
561 CloneList * clones = cloned_buffers.back();
563 masterBuffer()->cloneWithChildren(bufmap, clones);
565 // make sure we got cloned
566 BufferMap::const_iterator bit = bufmap.find(this);
567 LASSERT(bit != bufmap.end(), return 0);
568 Buffer * cloned_buffer = bit->second;
570 return cloned_buffer;
574 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
576 // have we already been cloned?
577 if (bufmap.find(this) != bufmap.end())
580 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
582 // The clone needs its own DocumentClass, since running updateBuffer() will
583 // modify it, and we would otherwise be sharing it with the original Buffer.
584 buffer_clone->params().makeDocumentClass(true);
586 cap::switchBetweenClasses(
587 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
588 static_cast<InsetText &>(buffer_clone->inset()), el);
590 bufmap[this] = buffer_clone;
591 clones->insert(buffer_clone);
592 buffer_clone->d->clone_list_ = clones;
593 buffer_clone->d->macro_lock = true;
594 buffer_clone->d->children_positions.clear();
596 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
597 // math macro caches need to be rethought and simplified.
598 // I am not sure wether we should handle Buffer cloning here or in BufferList.
599 // Right now BufferList knows nothing about buffer clones.
600 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
601 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
602 for (; it != end; ++it) {
603 DocIterator dit = it->first.clone(buffer_clone);
604 dit.setBuffer(buffer_clone);
605 Buffer * child = const_cast<Buffer *>(it->second.buffer);
607 child->cloneWithChildren(bufmap, clones);
608 BufferMap::iterator const bit = bufmap.find(child);
609 LASSERT(bit != bufmap.end(), continue);
610 Buffer * child_clone = bit->second;
612 Inset * inset = dit.nextInset();
613 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
614 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
615 inset_inc->setChildBuffer(child_clone);
616 child_clone->d->setParent(buffer_clone);
617 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
618 buffer_clone->setChild(dit, child_clone);
620 buffer_clone->d->macro_lock = false;
625 Buffer * Buffer::cloneBufferOnly() const {
626 cloned_buffers.push_back(new CloneList);
627 CloneList * clones = cloned_buffers.back();
628 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
630 // The clone needs its own DocumentClass, since running updateBuffer() will
631 // modify it, and we would otherwise be sharing it with the original Buffer.
632 buffer_clone->params().makeDocumentClass(true);
634 cap::switchBetweenClasses(
635 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
636 static_cast<InsetText &>(buffer_clone->inset()), el);
638 clones->insert(buffer_clone);
639 buffer_clone->d->clone_list_ = clones;
641 // we won't be cloning the children
642 buffer_clone->d->children_positions.clear();
647 bool Buffer::isClone() const
649 return d->cloned_buffer_;
653 void Buffer::changed(bool update_metrics) const
656 d->wa_->redrawAll(update_metrics);
660 frontend::WorkAreaManager & Buffer::workAreaManager() const
667 Text & Buffer::text() const
669 return d->inset->text();
673 Inset & Buffer::inset() const
679 BufferParams & Buffer::params()
685 BufferParams const & Buffer::params() const
691 BufferParams const & Buffer::masterParams() const
693 if (masterBuffer() == this)
696 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
697 // Copy child authors to the params. We need those pointers.
698 AuthorList const & child_authors = params().authors();
699 AuthorList::Authors::const_iterator it = child_authors.begin();
700 for (; it != child_authors.end(); ++it)
701 mparams.authors().record(*it);
706 double Buffer::fontScalingFactor() const
708 return isExporting() ? 75.0 * params().html_math_img_scale
709 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
713 ParagraphList & Buffer::paragraphs()
715 return text().paragraphs();
719 ParagraphList const & Buffer::paragraphs() const
721 return text().paragraphs();
725 LyXVC & Buffer::lyxvc()
731 LyXVC const & Buffer::lyxvc() const
737 string const Buffer::temppath() const
739 return d->temppath.absFileName();
743 TexRow & Buffer::texrow()
749 TexRow const & Buffer::texrow() const
755 TocBackend & Buffer::tocBackend() const
757 return d->toc_backend;
761 Undo & Buffer::undo()
767 void Buffer::setChild(DocIterator const & dit, Buffer * child)
769 d->children_positions[child] = dit;
773 string Buffer::latexName(bool const no_path) const
775 FileName latex_name =
776 makeLatexName(d->exportFileName());
777 return no_path ? latex_name.onlyFileName()
778 : latex_name.absFileName();
782 FileName Buffer::Impl::exportFileName() const
784 docstring const branch_suffix =
785 params.branchlist().getFileNameSuffix();
786 if (branch_suffix.empty())
789 string const name = filename.onlyFileNameWithoutExt()
790 + to_utf8(branch_suffix);
791 FileName res(filename.onlyPath().absFileName() + "/" + name);
792 res.changeExtension(filename.extension());
798 string Buffer::logName(LogType * type) const
800 string const filename = latexName(false);
802 if (filename.empty()) {
808 string const path = temppath();
810 FileName const fname(addName(temppath(),
811 onlyFileName(changeExtension(filename,
814 // FIXME: how do we know this is the name of the build log?
815 FileName const bname(
816 addName(path, onlyFileName(
817 changeExtension(filename,
818 formats.extension(params().bufferFormat()) + ".out"))));
820 // Also consider the master buffer log file
821 FileName masterfname = fname;
822 LogType mtype = latexlog;
823 if (masterBuffer() != this) {
824 string const mlogfile = masterBuffer()->logName(&mtype);
825 masterfname = FileName(mlogfile);
828 // If no Latex log or Build log is newer, show Build log
829 if (bname.exists() &&
830 ((!fname.exists() && !masterfname.exists())
831 || (fname.lastModified() < bname.lastModified()
832 && masterfname.lastModified() < bname.lastModified()))) {
833 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
836 return bname.absFileName();
837 // If we have a newer master file log or only a master log, show this
838 } else if (fname != masterfname
839 && (!fname.exists() && (masterfname.exists()
840 || fname.lastModified() < masterfname.lastModified()))) {
841 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
844 return masterfname.absFileName();
846 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
849 return fname.absFileName();
853 void Buffer::setReadonly(bool const flag)
855 if (d->read_only != flag) {
862 void Buffer::setFileName(FileName const & fname)
864 bool const changed = fname != d->filename;
867 lyxvc().file_found_hook(fname);
868 setReadonly(d->filename.isReadOnly());
874 int Buffer::readHeader(Lexer & lex)
876 int unknown_tokens = 0;
878 int begin_header_line = -1;
880 // Initialize parameters that may be/go lacking in header:
881 params().branchlist().clear();
882 params().preamble.erase();
883 params().options.erase();
884 params().master.erase();
885 params().float_placement.erase();
886 params().paperwidth.erase();
887 params().paperheight.erase();
888 params().leftmargin.erase();
889 params().rightmargin.erase();
890 params().topmargin.erase();
891 params().bottommargin.erase();
892 params().headheight.erase();
893 params().headsep.erase();
894 params().footskip.erase();
895 params().columnsep.erase();
896 params().fonts_cjk.erase();
897 params().listings_params.clear();
898 params().clearLayoutModules();
899 params().clearRemovedModules();
900 params().clearIncludedChildren();
901 params().pdfoptions().clear();
902 params().indiceslist().clear();
903 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
904 params().isbackgroundcolor = false;
905 params().fontcolor = RGBColor(0, 0, 0);
906 params().isfontcolor = false;
907 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
908 params().boxbgcolor = RGBColor(0xFF, 0, 0);
909 params().html_latex_start.clear();
910 params().html_latex_end.clear();
911 params().html_math_img_scale = 1.0;
912 params().output_sync_macro.erase();
913 params().setLocalLayout(docstring(), false);
914 params().setLocalLayout(docstring(), true);
916 for (int i = 0; i < 4; ++i) {
917 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
918 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
921 ErrorList & errorList = d->errorLists["Parse"];
930 if (token == "\\end_header")
934 if (token == "\\begin_header") {
935 begin_header_line = line;
939 LYXERR(Debug::PARSER, "Handling document header token: `"
942 string const result =
943 params().readToken(lex, token, d->filename.onlyPath());
944 if (!result.empty()) {
945 if (token == "\\textclass") {
946 d->layout_position = result;
949 docstring const s = bformat(_("Unknown token: "
953 errorList.push_back(ErrorItem(_("Document header error"), s));
957 if (begin_header_line) {
958 docstring const s = _("\\begin_header is missing");
959 errorList.push_back(ErrorItem(_("Document header error"), s));
962 params().makeDocumentClass();
964 return unknown_tokens;
969 // changed to be public and have one parameter
970 // Returns true if "\end_document" is not read (Asger)
971 bool Buffer::readDocument(Lexer & lex)
973 ErrorList & errorList = d->errorLists["Parse"];
976 // remove dummy empty par
977 paragraphs().clear();
979 if (!lex.checkFor("\\begin_document")) {
980 docstring const s = _("\\begin_document is missing");
981 errorList.push_back(ErrorItem(_("Document header error"), s));
986 if (params().output_changes) {
987 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
988 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
989 LaTeXFeatures::isAvailable("xcolor");
991 if (!dvipost && !xcolorulem) {
992 Alert::warning(_("Changes not shown in LaTeX output"),
993 _("Changes will not be highlighted in LaTeX output, "
994 "because neither dvipost nor xcolor/ulem are installed.\n"
995 "Please install these packages or redefine "
996 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
997 } else if (!xcolorulem) {
998 Alert::warning(_("Changes not shown in LaTeX output"),
999 _("Changes will not be highlighted in LaTeX output "
1000 "when using pdflatex, because xcolor and ulem are not installed.\n"
1001 "Please install both packages or redefine "
1002 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1006 if (!parent() && !params().master.empty()) {
1007 FileName const master_file = makeAbsPath(params().master,
1008 onlyPath(absFileName()));
1009 if (isLyXFileName(master_file.absFileName())) {
1011 checkAndLoadLyXFile(master_file, true);
1013 // necessary e.g. after a reload
1014 // to re-register the child (bug 5873)
1015 // FIXME: clean up updateMacros (here, only
1016 // child registering is needed).
1017 master->updateMacros();
1018 // set master as master buffer, but only
1019 // if we are a real child
1020 if (master->isChild(this))
1022 // if the master is not fully loaded
1023 // it is probably just loading this
1024 // child. No warning needed then.
1025 else if (master->isFullyLoaded())
1026 LYXERR0("The master '"
1028 << "' assigned to this document ("
1030 << ") does not include "
1031 "this document. Ignoring the master assignment.");
1036 // assure we have a default index
1037 params().indiceslist().addDefault(B_("Index"));
1040 if (FileName::isAbsolute(params().origin))
1041 d->old_position = params().origin;
1043 d->old_position = filePath();
1044 bool const res = text().read(lex, errorList, d->inset);
1045 d->old_position.clear();
1047 // inform parent buffer about local macros
1049 Buffer const * pbuf = parent();
1050 UserMacroSet::const_iterator cit = usermacros.begin();
1051 UserMacroSet::const_iterator end = usermacros.end();
1052 for (; cit != end; ++cit)
1053 pbuf->usermacros.insert(*cit);
1057 updateMacroInstances(InternalUpdate);
1062 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1064 Format const * fmt = formats.getFormat(format);
1067 // It is important to use the correct extension here, since some
1068 // converters create a wrong output file otherwise (e.g. html2latex)
1069 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1070 FileName const name(tempfile.name());
1071 ofdocstream os(name.toFilesystemEncoding().c_str());
1072 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1073 bool const success = !(os << contents).fail();
1076 bool converted = false;
1078 params().compressed = false;
1080 // remove dummy empty par
1081 paragraphs().clear();
1083 converted = importFile(format, name, errorList);
1092 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1094 if (!theConverters().isReachable(format, "lyx"))
1097 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1098 FileName const lyx(tempfile.name());
1099 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1100 return readFile(lyx) == ReadSuccess;
1106 bool Buffer::readString(string const & s)
1108 params().compressed = false;
1111 istringstream is(s);
1113 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1114 FileName const fn = tempfile.name();
1117 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1119 if (success && file_format != LYX_FORMAT) {
1120 // We need to call lyx2lyx, so write the input to a file
1121 ofstream os(fn.toFilesystemEncoding().c_str());
1124 // lyxvc in readFile
1125 if (readFile(fn) != ReadSuccess)
1129 if (readDocument(lex))
1135 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1139 if (!lex.setFile(fname)) {
1140 Alert::error(_("File Not Found"),
1141 bformat(_("Unable to open file `%1$s'."),
1142 from_utf8(fn.absFileName())));
1143 return ReadFileNotFound;
1147 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1148 if (ret_plf != ReadSuccess)
1151 if (file_format != LYX_FORMAT) {
1153 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1154 if (ret_clf != ReadSuccess)
1156 ret_clf = readFile(tmpFile);
1157 if (ret_clf == ReadSuccess) {
1158 d->file_format = file_format;
1159 d->need_format_backup = true;
1164 // FIXME: InsetInfo needs to know whether the file is under VCS
1165 // during the parse process, so this has to be done before.
1166 lyxvc().file_found_hook(d->filename);
1168 if (readDocument(lex)) {
1169 Alert::error(_("Document format failure"),
1170 bformat(_("%1$s ended unexpectedly, which means"
1171 " that it is probably corrupted."),
1172 from_utf8(fn.absFileName())));
1173 return ReadDocumentFailure;
1176 d->file_fully_loaded = true;
1177 d->read_only = !d->filename.isWritable();
1178 params().compressed = formats.isZippedFile(d->filename);
1184 bool Buffer::isFullyLoaded() const
1186 return d->file_fully_loaded;
1190 void Buffer::setFullyLoaded(bool value)
1192 d->file_fully_loaded = value;
1196 bool Buffer::lastPreviewError() const
1198 return d->preview_error_;
1202 PreviewLoader * Buffer::loader() const
1204 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1206 if (!d->preview_loader_)
1207 d->preview_loader_ = new PreviewLoader(*this);
1208 return d->preview_loader_;
1212 void Buffer::removePreviews() const
1214 delete d->preview_loader_;
1215 d->preview_loader_ = 0;
1219 void Buffer::updatePreviews() const
1221 PreviewLoader * ploader = loader();
1225 InsetIterator it = inset_iterator_begin(*d->inset);
1226 InsetIterator const end = inset_iterator_end(*d->inset);
1227 for (; it != end; ++it)
1228 it->addPreview(it, *ploader);
1230 ploader->startLoading();
1234 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1235 FileName const & fn, int & file_format) const
1237 if(!lex.checkFor("\\lyxformat")) {
1238 Alert::error(_("Document format failure"),
1239 bformat(_("%1$s is not a readable LyX document."),
1240 from_utf8(fn.absFileName())));
1241 return ReadNoLyXFormat;
1247 // LyX formats 217 and earlier were written as 2.17. This corresponds
1248 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1249 // these cases. See also: www.lyx.org/trac/changeset/1313.
1250 size_t dot = tmp_format.find_first_of(".,");
1251 if (dot != string::npos)
1252 tmp_format.erase(dot, 1);
1254 file_format = convert<int>(tmp_format);
1259 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1260 FileName & tmpfile, int from_format)
1262 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1263 tempfile.setAutoRemove(false);
1264 tmpfile = tempfile.name();
1265 if(tmpfile.empty()) {
1266 Alert::error(_("Conversion failed"),
1267 bformat(_("%1$s is from a different"
1268 " version of LyX, but a temporary"
1269 " file for converting it could"
1270 " not be created."),
1271 from_utf8(fn.absFileName())));
1272 return LyX2LyXNoTempFile;
1275 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1276 if (lyx2lyx.empty()) {
1277 Alert::error(_("Conversion script not found"),
1278 bformat(_("%1$s is from a different"
1279 " version of LyX, but the"
1280 " conversion script lyx2lyx"
1281 " could not be found."),
1282 from_utf8(fn.absFileName())));
1283 return LyX2LyXNotFound;
1287 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1288 ostringstream command;
1289 command << os::python()
1290 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1291 << " -t " << convert<string>(LYX_FORMAT)
1292 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1293 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1294 string const command_str = command.str();
1296 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1298 cmd_ret const ret = runCommand(command_str);
1299 if (ret.first != 0) {
1300 if (from_format < LYX_FORMAT) {
1301 Alert::error(_("Conversion script failed"),
1302 bformat(_("%1$s is from an older version"
1303 " of LyX and the lyx2lyx script"
1304 " failed to convert it."),
1305 from_utf8(fn.absFileName())));
1306 return LyX2LyXOlderFormat;
1308 Alert::error(_("Conversion script failed"),
1309 bformat(_("%1$s is from a newer version"
1310 " of LyX and the lyx2lyx script"
1311 " failed to convert it."),
1312 from_utf8(fn.absFileName())));
1313 return LyX2LyXNewerFormat;
1320 FileName Buffer::getBackupName() const {
1321 FileName const & fn = fileName();
1322 string const fname = fn.onlyFileNameWithoutExt();
1323 string const fext = fn.extension() + "~";
1324 string const fpath = lyxrc.backupdir_path.empty() ?
1325 fn.onlyPath().absFileName() :
1326 lyxrc.backupdir_path;
1327 string const fform = convert<string>(d->file_format);
1328 string const backname = fname + "-lyxformat-" + fform;
1329 FileName backup(addName(fpath, addExtension(backname, fext)));
1331 // limit recursion, just in case
1333 unsigned long orig_checksum = 0;
1334 while (backup.exists() && v < 100) {
1335 if (orig_checksum == 0)
1336 orig_checksum = fn.checksum();
1337 unsigned long new_checksum = backup.checksum();
1338 if (orig_checksum == new_checksum) {
1339 LYXERR(Debug::FILES, "Not backing up " << fn <<
1340 "since " << backup << "has the same checksum.");
1341 // a bit of a hack, but we have to check this anyway
1342 // below, and setting this is simpler than introducing
1343 // a special boolean for this purpose.
1347 string const newbackname = backname + "-" + convert<string>(v);
1348 backup.set(addName(fpath, addExtension(newbackname, fext)));
1351 return v < 100 ? backup : FileName();
1355 // Should probably be moved to somewhere else: BufferView? GuiView?
1356 bool Buffer::save() const
1358 docstring const file = makeDisplayPath(absFileName(), 20);
1359 d->filename.refresh();
1361 // check the read-only status before moving the file as a backup
1362 if (d->filename.exists()) {
1363 bool const read_only = !d->filename.isWritable();
1365 Alert::warning(_("File is read-only"),
1366 bformat(_("The file %1$s cannot be written because it "
1367 "is marked as read-only."), file));
1372 // ask if the disk file has been externally modified (use checksum method)
1373 if (fileName().exists() && isExternallyModified(checksum_method)) {
1375 bformat(_("Document %1$s has been externally modified. "
1376 "Are you sure you want to overwrite this file?"), file);
1377 int const ret = Alert::prompt(_("Overwrite modified file?"),
1378 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1383 // We don't need autosaves in the immediate future. (Asger)
1384 resetAutosaveTimers();
1386 // if the file does not yet exist, none of the backup activity
1387 // that follows is necessary
1388 if (!fileName().exists()) {
1389 if (!writeFile(fileName()))
1395 // we first write the file to a new name, then move it to its
1396 // proper location once that has been done successfully. that
1397 // way we preserve the original file if something goes wrong.
1398 string const justname = fileName().onlyFileNameWithoutExt();
1399 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1400 justname + "-XXXXXX.lyx");
1401 bool const symlink = fileName().isSymLink();
1403 tempfile->setAutoRemove(false);
1405 FileName savefile(tempfile->name());
1406 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1407 if (!writeFile(savefile))
1410 // we will set this to false if we fail
1411 bool made_backup = true;
1413 FileName backupName;
1414 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1416 if (d->need_format_backup)
1417 backupName = getBackupName();
1419 // If we for some reason failed to find a backup name in case of
1420 // a format change, this will still set one. It's the best we can
1422 if (backupName.empty()) {
1423 backupName.set(fileName().absFileName() + "~");
1424 if (!lyxrc.backupdir_path.empty()) {
1425 string const mangledName =
1426 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1427 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1431 LYXERR(Debug::FILES, "Backing up original file to " <<
1432 backupName.absFileName());
1433 // Except file is symlink do not copy because of #6587.
1434 // Hard links have bad luck.
1435 made_backup = symlink ?
1436 fileName().copyTo(backupName):
1437 fileName().moveTo(backupName);
1440 Alert::error(_("Backup failure"),
1441 bformat(_("Cannot create backup file %1$s.\n"
1442 "Please check whether the directory exists and is writable."),
1443 from_utf8(backupName.absFileName())));
1444 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1445 } else if (d->need_format_backup) {
1446 // the original file has been backed up successfully, so we
1447 // will not need to do that again
1448 d->need_format_backup = false;
1452 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1453 // Only do this if tempfile is not in autoremove mode
1456 // If we have no symlink, we can simply rename the temp file.
1457 // Otherwise, we need to copy it so the symlink stays intact.
1458 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1459 savefile.moveTo(fileName()))
1461 // saveCheckSum() was already called by writeFile(), but the
1462 // time stamp is invalidated by copying/moving
1465 if (d->file_format != LYX_FORMAT)
1466 // the file associated with this buffer is now in the current format
1467 d->file_format = LYX_FORMAT;
1470 // else we saved the file, but failed to move it to the right location.
1472 if (needBackup && made_backup && !symlink) {
1473 // the original file was moved to some new location, so it will look
1474 // to the user as if it was deleted. (see bug #9234.) we could try
1475 // to restore it, but that would basically mean trying to do again
1476 // what we just failed to do. better to leave things as they are.
1477 Alert::error(_("Write failure"),
1478 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1479 "But LyX could not move it to:\n %2$s.\n"
1480 "Your original file has been backed up to:\n %3$s"),
1481 from_utf8(savefile.absFileName()),
1482 from_utf8(fileName().absFileName()),
1483 from_utf8(backupName.absFileName())));
1485 // either we did not try to make a backup, or else we tried and failed,
1486 // or else the original file was a symlink, in which case it was copied,
1487 // not moved. so the original file is intact.
1488 Alert::error(_("Write failure"),
1489 bformat(_("Cannot move saved file to:\n %1$s.\n"
1490 "But the file has successfully been saved as:\n %2$s."),
1491 from_utf8(fileName().absFileName()),
1492 from_utf8(savefile.absFileName())));
1498 bool Buffer::writeFile(FileName const & fname) const
1500 if (d->read_only && fname == d->filename)
1503 bool retval = false;
1505 docstring const str = bformat(_("Saving document %1$s..."),
1506 makeDisplayPath(fname.absFileName()));
1509 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1511 if (params().compressed) {
1512 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1513 retval = ofs && write(ofs);
1515 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1516 retval = ofs && write(ofs);
1520 message(str + _(" could not write file!"));
1525 // removeAutosaveFile();
1528 message(str + _(" done."));
1534 docstring Buffer::emergencyWrite()
1536 // No need to save if the buffer has not changed.
1540 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1542 docstring user_message = bformat(
1543 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1545 // We try to save three places:
1546 // 1) Same place as document. Unless it is an unnamed doc.
1548 string s = absFileName();
1551 if (writeFile(FileName(s))) {
1553 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1554 return user_message;
1556 user_message += " " + _("Save failed! Trying again...\n");
1560 // 2) In HOME directory.
1561 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1563 lyxerr << ' ' << s << endl;
1564 if (writeFile(FileName(s))) {
1566 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1567 return user_message;
1570 user_message += " " + _("Save failed! Trying yet again...\n");
1572 // 3) In "/tmp" directory.
1573 // MakeAbsPath to prepend the current
1574 // drive letter on OS/2
1575 s = addName(package().temp_dir().absFileName(), absFileName());
1577 lyxerr << ' ' << s << endl;
1578 if (writeFile(FileName(s))) {
1580 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1581 return user_message;
1584 user_message += " " + _("Save failed! Bummer. Document is lost.");
1587 return user_message;
1591 bool Buffer::write(ostream & ofs) const
1594 // Use the standard "C" locale for file output.
1595 ofs.imbue(locale::classic());
1598 // The top of the file should not be written by params().
1600 // write out a comment in the top of the file
1601 // Important: Keep the version formatting in sync with lyx2lyx and
1602 // tex2lyx (bug 7951)
1603 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1604 << " created this file. For more info see http://www.lyx.org/\n"
1605 << "\\lyxformat " << LYX_FORMAT << "\n"
1606 << "\\begin_document\n";
1608 /// For each author, set 'used' to true if there is a change
1609 /// by this author in the document; otherwise set it to 'false'.
1610 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1611 AuthorList::Authors::const_iterator a_end = params().authors().end();
1612 for (; a_it != a_end; ++a_it)
1613 a_it->setUsed(false);
1615 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1616 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1617 for ( ; it != end; ++it)
1618 it->checkAuthors(params().authors());
1620 // now write out the buffer parameters.
1621 ofs << "\\begin_header\n";
1622 params().writeFile(ofs, this);
1623 ofs << "\\end_header\n";
1626 ofs << "\n\\begin_body\n";
1628 ofs << "\n\\end_body\n";
1630 // Write marker that shows file is complete
1631 ofs << "\\end_document" << endl;
1633 // Shouldn't really be needed....
1636 // how to check if close went ok?
1637 // Following is an attempt... (BE 20001011)
1639 // good() returns false if any error occurred, including some
1640 // formatting error.
1641 // bad() returns true if something bad happened in the buffer,
1642 // which should include file system full errors.
1647 lyxerr << "File was not closed properly." << endl;
1654 bool Buffer::makeLaTeXFile(FileName const & fname,
1655 string const & original_path,
1656 OutputParams const & runparams_in,
1657 OutputWhat output) const
1659 OutputParams runparams = runparams_in;
1661 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1662 // Check here, because the "flavor" is not known in BufferParams::encoding()
1663 // (power users can override this safety measure selecting "utf8-plain").
1664 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1665 && (runparams.encoding->name() != "utf8-plain"))
1666 runparams.encoding = encodings.fromLyXName("ascii");
1668 string const encoding = runparams.encoding->iconvName();
1669 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1672 try { ofs.reset(encoding); }
1673 catch (iconv_codecvt_facet_exception const & e) {
1674 lyxerr << "Caught iconv exception: " << e.what() << endl;
1675 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1676 "verify that the support software for your encoding (%1$s) is "
1677 "properly installed"), from_ascii(encoding)));
1680 if (!openFileWrite(ofs, fname))
1683 ErrorList & errorList = d->errorLists["Export"];
1685 bool failed_export = false;
1688 // make sure we are ready to export
1689 // this needs to be done before we validate
1690 // FIXME Do we need to do this all the time? I.e., in children
1691 // of a master we are exporting?
1693 updateMacroInstances(OutputUpdate);
1696 writeLaTeXSource(os, original_path, runparams, output);
1698 catch (EncodingException const & e) {
1699 docstring const failed(1, e.failed_char);
1701 oss << "0x" << hex << e.failed_char << dec;
1702 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1703 " (code point %2$s)"),
1704 failed, from_utf8(oss.str()));
1705 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1706 "representable in the chosen encoding.\n"
1707 "Changing the document encoding to utf8 could help."),
1708 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1709 failed_export = true;
1711 catch (iconv_codecvt_facet_exception const & e) {
1712 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1714 failed_export = true;
1716 catch (exception const & e) {
1717 errorList.push_back(ErrorItem(_("conversion failed"),
1719 failed_export = true;
1722 lyxerr << "Caught some really weird exception..." << endl;
1726 d->texrow = move(os.texrow());
1730 failed_export = true;
1731 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1734 if (runparams_in.silent)
1738 return !failed_export;
1742 void Buffer::writeLaTeXSource(otexstream & os,
1743 string const & original_path,
1744 OutputParams const & runparams_in,
1745 OutputWhat output) const
1747 // The child documents, if any, shall be already loaded at this point.
1749 OutputParams runparams = runparams_in;
1751 // XeTeX with TeX fonts is only safe with ASCII encoding,
1752 // Check here, because the "flavor" is not known in BufferParams::encoding()
1753 // (power users can override this safety measure selecting "utf8-plain").
1754 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1755 && (runparams.encoding->name() != "utf8-plain"))
1756 runparams.encoding = encodings.fromLyXName("ascii");
1757 // FIXME: when only the current paragraph is shown, this is ignored
1758 // (or not reached) and characters encodable in the current
1759 // encoding are not converted to ASCII-representation.
1761 // If we are compiling a file standalone, even if this is the
1762 // child of some other buffer, let's cut the link here, so the
1763 // file is really independent and no concurring settings from
1764 // the master (e.g. branch state) interfere (see #8100).
1765 if (!runparams.is_child)
1766 d->ignore_parent = true;
1768 // Classify the unicode characters appearing in math insets
1769 BufferEncodings::initUnicodeMath(*this);
1771 // validate the buffer.
1772 LYXERR(Debug::LATEX, " Validating buffer...");
1773 LaTeXFeatures features(*this, params(), runparams);
1775 // This is only set once per document (in master)
1776 if (!runparams.is_child)
1777 runparams.use_polyglossia = features.usePolyglossia();
1778 LYXERR(Debug::LATEX, " Buffer validation done.");
1780 bool const output_preamble =
1781 output == FullSource || output == OnlyPreamble;
1782 bool const output_body =
1783 output == FullSource || output == OnlyBody;
1785 // The starting paragraph of the coming rows is the
1786 // first paragraph of the document. (Asger)
1787 if (output_preamble && runparams.nice) {
1788 os << "%% LyX " << lyx_version << " created this file. "
1789 "For more info, see http://www.lyx.org/.\n"
1790 "%% Do not edit unless you really know what "
1793 LYXERR(Debug::INFO, "lyx document header finished");
1795 // There are a few differences between nice LaTeX and usual files:
1796 // usual files have \batchmode and special input@path to allow
1797 // inclusion of figures specified by an explicitly relative path
1798 // (i.e., a path starting with './' or '../') with either \input or
1799 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1800 // input@path is set when the actual parameter original_path is set.
1801 // This is done for usual tex-file, but not for nice-latex-file.
1802 // (Matthias 250696)
1803 // Note that input@path is only needed for something the user does
1804 // in the preamble, included .tex files or ERT, files included by
1805 // LyX work without it.
1806 if (output_preamble) {
1807 if (!runparams.nice) {
1808 // code for usual, NOT nice-latex-file
1809 os << "\\batchmode\n"; // changed from \nonstopmode
1811 if (!original_path.empty()) {
1813 // We don't know the encoding of inputpath
1814 docstring const inputpath = from_utf8(original_path);
1815 docstring uncodable_glyphs;
1816 Encoding const * const enc = runparams.encoding;
1818 for (size_t n = 0; n < inputpath.size(); ++n) {
1819 if (!enc->encodable(inputpath[n])) {
1820 docstring const glyph(1, inputpath[n]);
1821 LYXERR0("Uncodable character '"
1823 << "' in input path!");
1824 uncodable_glyphs += glyph;
1829 // warn user if we found uncodable glyphs.
1830 if (!uncodable_glyphs.empty()) {
1831 frontend::Alert::warning(
1832 _("Uncodable character in file path"),
1834 _("The path of your document\n"
1836 "contains glyphs that are unknown "
1837 "in the current document encoding "
1838 "(namely %2$s). This may result in "
1839 "incomplete output, unless "
1840 "TEXINPUTS contains the document "
1841 "directory and you don't use "
1842 "explicitly relative paths (i.e., "
1843 "paths starting with './' or "
1844 "'../') in the preamble or in ERT."
1845 "\n\nIn case of problems, choose "
1846 "an appropriate document encoding\n"
1847 "(such as utf8) or change the "
1849 inputpath, uncodable_glyphs));
1852 support::latex_path(original_path);
1853 if (contains(docdir, '#')) {
1854 docdir = subst(docdir, "#", "\\#");
1855 os << "\\catcode`\\#=11"
1856 "\\def\\#{#}\\catcode`\\#=6\n";
1858 if (contains(docdir, '%')) {
1859 docdir = subst(docdir, "%", "\\%");
1860 os << "\\catcode`\\%=11"
1861 "\\def\\%{%}\\catcode`\\%=14\n";
1863 os << "\\makeatletter\n"
1864 << "\\def\\input@path{{"
1866 << "\\makeatother\n";
1870 // get parent macros (if this buffer has a parent) which will be
1871 // written at the document begin further down.
1872 MacroSet parentMacros;
1873 listParentMacros(parentMacros, features);
1875 // Write the preamble
1876 runparams.use_babel = params().writeLaTeX(os, features,
1877 d->filename.onlyPath());
1879 if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
1880 && !features.hasOnlyPolyglossiaLanguages()) {
1883 vector<string> bll = features.getBabelExclusiveLanguages();
1884 vector<string> pll = features.getPolyglossiaExclusiveLanguages();
1887 for (vector<string>::const_iterator it = bll.begin(); it != bll.end(); ++it) {
1892 blangs = bll.size() > 1 ?
1893 support::bformat(_("The languages %1$s are only supported by Babel."), langs)
1894 : support::bformat(_("The language %1$s is only supported by Babel."), langs);
1898 for (vector<string>::const_iterator it = pll.begin(); it != pll.end(); ++it) {
1903 plangs = pll.size() > 1 ?
1904 support::bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
1905 : support::bformat(_("The language %1$s is only supported by Polyglossia."), langs);
1906 if (!blangs.empty())
1910 frontend::Alert::warning(
1911 _("Incompatible Languages!"),
1913 _("You cannot use the following languages "
1914 "together in one LaTeX document because "
1915 "they require conflicting language packages:\n"
1920 // Japanese might be required only in some children of a document,
1921 // but once required, we must keep use_japanese true.
1922 runparams.use_japanese |= features.isRequired("japanese");
1925 // Restore the parenthood if needed
1926 if (!runparams.is_child)
1927 d->ignore_parent = false;
1932 // mark the beginning of the body to separate it from InPreamble insets
1933 os.texrow().start(TexRow::beginDocument());
1934 os << "\\begin{document}\n";
1936 // mark the start of a new paragraph by simulating a newline,
1937 // so that os.afterParbreak() returns true at document start
1940 // output the parent macros
1941 MacroSet::iterator it = parentMacros.begin();
1942 MacroSet::iterator end = parentMacros.end();
1943 for (; it != end; ++it) {
1944 int num_lines = (*it)->write(os.os(), true);
1945 os.texrow().newlines(num_lines);
1948 } // output_preamble
1950 LYXERR(Debug::INFO, "preamble finished, now the body.");
1953 latexParagraphs(*this, text(), os, runparams);
1955 // Restore the parenthood if needed
1956 if (!runparams.is_child)
1957 d->ignore_parent = false;
1959 // add this just in case after all the paragraphs
1962 if (output_preamble) {
1963 os << "\\end{document}\n";
1964 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1966 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1968 runparams_in.encoding = runparams.encoding;
1970 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1971 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1975 void Buffer::makeDocBookFile(FileName const & fname,
1976 OutputParams const & runparams,
1977 OutputWhat output) const
1979 LYXERR(Debug::LATEX, "makeDocBookFile...");
1982 if (!openFileWrite(ofs, fname))
1985 // make sure we are ready to export
1986 // this needs to be done before we validate
1988 updateMacroInstances(OutputUpdate);
1990 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1994 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1998 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1999 OutputParams const & runparams,
2000 OutputWhat output) const
2002 LaTeXFeatures features(*this, params(), runparams);
2007 DocumentClass const & tclass = params().documentClass();
2008 string const & top_element = tclass.latexname();
2010 bool const output_preamble =
2011 output == FullSource || output == OnlyPreamble;
2012 bool const output_body =
2013 output == FullSource || output == OnlyBody;
2015 if (output_preamble) {
2016 if (runparams.flavor == OutputParams::XML)
2017 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
2020 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
2023 if (! tclass.class_header().empty())
2024 os << from_ascii(tclass.class_header());
2025 else if (runparams.flavor == OutputParams::XML)
2026 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
2027 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
2029 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
2031 docstring preamble = params().preamble;
2032 if (runparams.flavor != OutputParams::XML ) {
2033 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
2034 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
2035 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
2036 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
2039 string const name = runparams.nice
2040 ? changeExtension(absFileName(), ".sgml") : fname;
2041 preamble += features.getIncludedFiles(name);
2042 preamble += features.getLyXSGMLEntities();
2044 if (!preamble.empty()) {
2045 os << "\n [ " << preamble << " ]";
2051 string top = top_element;
2053 if (runparams.flavor == OutputParams::XML)
2054 top += params().language->code();
2056 top += params().language->code().substr(0, 2);
2059 if (!params().options.empty()) {
2061 top += params().options;
2064 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2065 << " file was created by LyX " << lyx_version
2066 << "\n See http://www.lyx.org/ for more information -->\n";
2068 params().documentClass().counters().reset();
2070 sgml::openTag(os, top);
2072 docbookParagraphs(text(), *this, os, runparams);
2073 sgml::closeTag(os, top_element);
2078 void Buffer::makeLyXHTMLFile(FileName const & fname,
2079 OutputParams const & runparams) const
2081 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2084 if (!openFileWrite(ofs, fname))
2087 // make sure we are ready to export
2088 // this has to be done before we validate
2089 updateBuffer(UpdateMaster, OutputUpdate);
2090 updateMacroInstances(OutputUpdate);
2092 writeLyXHTMLSource(ofs, runparams, FullSource);
2096 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2100 void Buffer::writeLyXHTMLSource(odocstream & os,
2101 OutputParams const & runparams,
2102 OutputWhat output) const
2104 LaTeXFeatures features(*this, params(), runparams);
2106 d->bibinfo_.makeCitationLabels(*this);
2108 bool const output_preamble =
2109 output == FullSource || output == OnlyPreamble;
2110 bool const output_body =
2111 output == FullSource || output == OnlyBody || output == IncludedFile;
2113 if (output_preamble) {
2114 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2115 << "<!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"
2116 // FIXME Language should be set properly.
2117 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2119 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2120 // FIXME Presumably need to set this right
2121 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2123 docstring const & doctitle = features.htmlTitle();
2125 << (doctitle.empty() ?
2126 from_ascii("LyX Document") :
2127 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2130 docstring styles = features.getTClassHTMLPreamble();
2131 if (!styles.empty())
2132 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2134 styles = features.getPreambleSnippets().str;
2135 if (!styles.empty())
2136 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2138 // we will collect CSS information in a stream, and then output it
2139 // either here, as part of the header, or else in a separate file.
2140 odocstringstream css;
2141 styles = features.getCSSSnippets();
2142 if (!styles.empty())
2143 css << "/* LyX Provided Styles */\n" << styles << '\n';
2145 styles = features.getTClassHTMLStyles();
2146 if (!styles.empty())
2147 css << "/* Layout-provided Styles */\n" << styles << '\n';
2149 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2150 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2151 if (needfg || needbg) {
2152 css << "\nbody {\n";
2155 << from_ascii(X11hexname(params().fontcolor))
2158 css << " background-color: "
2159 << from_ascii(X11hexname(params().backgroundcolor))
2164 docstring const dstyles = css.str();
2165 if (!dstyles.empty()) {
2166 bool written = false;
2167 if (params().html_css_as_file) {
2168 // open a file for CSS info
2170 string const fcssname = addName(temppath(), "docstyle.css");
2171 FileName const fcssfile = FileName(fcssname);
2172 if (openFileWrite(ocss, fcssfile)) {
2176 // write link to header
2177 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2179 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2182 // we are here if the CSS is supposed to be written to the header
2183 // or if we failed to write it to an external file.
2185 os << "<style type='text/css'>\n"
2194 bool const output_body_tag = (output != IncludedFile);
2195 if (output_body_tag)
2196 os << "<body dir=\"auto\">\n";
2198 if (output != IncludedFile)
2199 // if we're an included file, the counters are in the master.
2200 params().documentClass().counters().reset();
2201 xhtmlParagraphs(text(), *this, xs, runparams);
2202 if (output_body_tag)
2206 if (output_preamble)
2211 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2212 // Other flags: -wall -v0 -x
2213 int Buffer::runChktex()
2217 // get LaTeX-Filename
2218 FileName const path(temppath());
2219 string const name = addName(path.absFileName(), latexName());
2220 string const org_path = filePath();
2222 PathChanger p(path); // path to LaTeX file
2223 message(_("Running chktex..."));
2225 // Generate the LaTeX file if neccessary
2226 OutputParams runparams(¶ms().encoding());
2227 runparams.flavor = OutputParams::LATEX;
2228 runparams.nice = false;
2229 runparams.linelen = lyxrc.plaintext_linelen;
2230 makeLaTeXFile(FileName(name), org_path, runparams);
2233 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2234 int const res = chktex.run(terr); // run chktex
2237 Alert::error(_("chktex failure"),
2238 _("Could not run chktex successfully."));
2240 ErrorList & errlist = d->errorLists["ChkTeX"];
2242 bufferErrors(terr, errlist);
2247 if (runparams.silent)
2248 d->errorLists["ChkTeX"].clear();
2256 void Buffer::validate(LaTeXFeatures & features) const
2258 // Validate the buffer params, but not for included
2259 // files, since they also use the parent buffer's
2261 if (!features.runparams().is_child)
2262 params().validate(features);
2264 for (Paragraph const & p : paragraphs())
2265 p.validate(features);
2267 if (lyxerr.debugging(Debug::LATEX)) {
2268 features.showStruct();
2273 void Buffer::getLabelList(vector<docstring> & list) const
2275 // If this is a child document, use the master's list instead.
2277 masterBuffer()->getLabelList(list);
2282 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2283 Toc::const_iterator toc_it = toc->begin();
2284 Toc::const_iterator end = toc->end();
2285 for (; toc_it != end; ++toc_it) {
2286 if (toc_it->depth() == 0)
2287 list.push_back(toc_it->str());
2292 void Buffer::updateBibfilesCache(UpdateScope scope) const
2294 // FIXME This is probably unnecssary, given where we call this.
2295 // If this is a child document, use the parent's cache instead.
2296 if (parent() && scope != UpdateChildOnly) {
2297 masterBuffer()->updateBibfilesCache();
2301 d->bibfiles_cache_.clear();
2302 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2303 if (it->lyxCode() == BIBTEX_CODE) {
2304 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2305 support::FileNamePairList const bibfiles = inset.getBibFiles();
2306 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2309 } else if (it->lyxCode() == INCLUDE_CODE) {
2310 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2311 Buffer const * const incbuf = inset.getChildBuffer();
2314 support::FileNamePairList const & bibfiles =
2315 incbuf->getBibfilesCache(UpdateChildOnly);
2316 if (!bibfiles.empty()) {
2317 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2323 d->bibfile_cache_valid_ = true;
2324 d->bibinfo_cache_valid_ = false;
2325 d->cite_labels_valid_ = false;
2329 void Buffer::invalidateBibinfoCache() const
2331 d->bibinfo_cache_valid_ = false;
2332 d->cite_labels_valid_ = false;
2333 // also invalidate the cache for the parent buffer
2334 Buffer const * const pbuf = d->parent();
2336 pbuf->invalidateBibinfoCache();
2340 void Buffer::invalidateBibfileCache() const
2342 d->bibfile_cache_valid_ = false;
2343 d->bibinfo_cache_valid_ = false;
2344 d->cite_labels_valid_ = false;
2345 // also invalidate the cache for the parent buffer
2346 Buffer const * const pbuf = d->parent();
2348 pbuf->invalidateBibfileCache();
2352 support::FileNamePairList const & Buffer::getBibfilesCache(UpdateScope scope) const
2354 // FIXME This is probably unnecessary, given where we call this.
2355 // If this is a child document, use the master's cache instead.
2356 Buffer const * const pbuf = masterBuffer();
2357 if (pbuf != this && scope != UpdateChildOnly)
2358 return pbuf->getBibfilesCache();
2360 if (!d->bibfile_cache_valid_)
2361 this->updateBibfilesCache(scope);
2363 return d->bibfiles_cache_;
2367 BiblioInfo const & Buffer::masterBibInfo() const
2369 Buffer const * const tmp = masterBuffer();
2371 return tmp->masterBibInfo();
2376 void Buffer::checkIfBibInfoCacheIsValid() const
2378 // use the master's cache
2379 Buffer const * const tmp = masterBuffer();
2381 tmp->checkIfBibInfoCacheIsValid();
2385 // compare the cached timestamps with the actual ones.
2386 FileNamePairList const & bibfiles_cache = getBibfilesCache();
2387 FileNamePairList::const_iterator ei = bibfiles_cache.begin();
2388 FileNamePairList::const_iterator en = bibfiles_cache.end();
2389 for (; ei != en; ++ ei) {
2390 FileName const fn = ei->second;
2391 time_t lastw = fn.lastModified();
2392 time_t prevw = d->bibfile_status_[fn];
2393 if (lastw != prevw) {
2394 d->bibinfo_cache_valid_ = false;
2395 d->cite_labels_valid_ = false;
2396 d->bibfile_status_[fn] = lastw;
2402 void Buffer::reloadBibInfoCache() const
2404 // use the master's cache
2405 Buffer const * const tmp = masterBuffer();
2407 tmp->reloadBibInfoCache();
2411 checkIfBibInfoCacheIsValid();
2412 if (d->bibinfo_cache_valid_)
2415 d->bibinfo_.clear();
2417 d->bibinfo_cache_valid_ = true;
2421 void Buffer::collectBibKeys() const
2423 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2424 it->collectBibKeys(it);
2428 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2430 Buffer const * tmp = masterBuffer();
2431 BiblioInfo & masterbi = (tmp == this) ?
2432 d->bibinfo_ : tmp->d->bibinfo_;
2433 masterbi.mergeBiblioInfo(bi);
2437 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2439 Buffer const * tmp = masterBuffer();
2440 BiblioInfo & masterbi = (tmp == this) ?
2441 d->bibinfo_ : tmp->d->bibinfo_;
2446 void Buffer::makeCitationLabels() const
2448 Buffer const * const master = masterBuffer();
2449 return d->bibinfo_.makeCitationLabels(*master);
2453 bool Buffer::citeLabelsValid() const
2455 return masterBuffer()->d->cite_labels_valid_;
2459 void Buffer::removeBiblioTempFiles() const
2461 // We remove files that contain LaTeX commands specific to the
2462 // particular bibliographic style being used, in order to avoid
2463 // LaTeX errors when we switch style.
2464 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2465 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2466 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2467 aux_file.removeFile();
2468 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2469 bbl_file.removeFile();
2470 // Also for the parent buffer
2471 Buffer const * const pbuf = parent();
2473 pbuf->removeBiblioTempFiles();
2477 bool Buffer::isDepClean(string const & name) const
2479 DepClean::const_iterator const it = d->dep_clean.find(name);
2480 if (it == d->dep_clean.end())
2486 void Buffer::markDepClean(string const & name)
2488 d->dep_clean[name] = true;
2492 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2495 // FIXME? if there is an Buffer LFUN that can be dispatched even
2496 // if internal, put a switch '(cmd.action)' here.
2502 switch (cmd.action()) {
2504 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2505 flag.setOnOff(isReadonly());
2508 // FIXME: There is need for a command-line import.
2509 //case LFUN_BUFFER_IMPORT:
2511 case LFUN_BUFFER_AUTO_SAVE:
2514 case LFUN_BUFFER_EXPORT_CUSTOM:
2515 // FIXME: Nothing to check here?
2518 case LFUN_BUFFER_EXPORT: {
2519 docstring const arg = cmd.argument();
2520 if (arg == "custom") {
2524 string format = to_utf8(arg);
2525 size_t pos = format.find(' ');
2526 if (pos != string::npos)
2527 format = format.substr(0, pos);
2528 enable = params().isExportable(format, false);
2530 flag.message(bformat(
2531 _("Don't know how to export to format: %1$s"), arg));
2535 case LFUN_BUFFER_CHKTEX:
2536 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2539 case LFUN_BUILD_PROGRAM:
2540 enable = params().isExportable("program", false);
2543 case LFUN_BRANCH_ACTIVATE:
2544 case LFUN_BRANCH_DEACTIVATE:
2545 case LFUN_BRANCH_MASTER_ACTIVATE:
2546 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2547 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2548 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2549 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2550 : params().branchlist();
2551 docstring const branchName = cmd.argument();
2552 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2556 case LFUN_BRANCH_ADD:
2557 case LFUN_BRANCHES_RENAME:
2558 // if no Buffer is present, then of course we won't be called!
2561 case LFUN_BUFFER_LANGUAGE:
2562 enable = !isReadonly();
2565 case LFUN_BUFFER_VIEW_CACHE:
2566 (d->preview_file_).refresh();
2567 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2570 case LFUN_CHANGES_TRACK:
2571 flag.setEnabled(true);
2572 flag.setOnOff(params().track_changes);
2575 case LFUN_CHANGES_OUTPUT:
2576 flag.setEnabled(true);
2577 flag.setOnOff(params().output_changes);
2580 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
2581 flag.setOnOff(params().compressed);
2585 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
2586 flag.setOnOff(params().output_sync);
2593 flag.setEnabled(enable);
2598 void Buffer::dispatch(string const & command, DispatchResult & result)
2600 return dispatch(lyxaction.lookupFunc(command), result);
2604 // NOTE We can end up here even if we have no GUI, because we are called
2605 // by LyX::exec to handled command-line requests. So we may need to check
2606 // whether we have a GUI or not. The boolean use_gui holds this information.
2607 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2610 // FIXME? if there is an Buffer LFUN that can be dispatched even
2611 // if internal, put a switch '(cmd.action())' here.
2612 dr.dispatched(false);
2615 string const argument = to_utf8(func.argument());
2616 // We'll set this back to false if need be.
2617 bool dispatched = true;
2618 undo().beginUndoGroup();
2620 switch (func.action()) {
2621 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2622 if (lyxvc().inUse()) {
2623 string log = lyxvc().toggleReadOnly();
2628 setReadonly(!isReadonly());
2631 case LFUN_BUFFER_EXPORT: {
2632 ExportStatus const status = doExport(argument, false);
2633 dr.setError(status != ExportSuccess);
2634 if (status != ExportSuccess)
2635 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2640 case LFUN_BUILD_PROGRAM: {
2641 ExportStatus const status = doExport("program", true);
2642 dr.setError(status != ExportSuccess);
2643 if (status != ExportSuccess)
2644 dr.setMessage(_("Error generating literate programming code."));
2648 case LFUN_BUFFER_CHKTEX:
2652 case LFUN_BUFFER_EXPORT_CUSTOM: {
2654 string command = split(argument, format_name, ' ');
2655 Format const * format = formats.getFormat(format_name);
2657 lyxerr << "Format \"" << format_name
2658 << "\" not recognized!"
2663 // The name of the file created by the conversion process
2666 // Output to filename
2667 if (format->name() == "lyx") {
2668 string const latexname = latexName(false);
2669 filename = changeExtension(latexname,
2670 format->extension());
2671 filename = addName(temppath(), filename);
2673 if (!writeFile(FileName(filename)))
2677 doExport(format_name, true, filename);
2680 // Substitute $$FName for filename
2681 if (!contains(command, "$$FName"))
2682 command = "( " + command + " ) < $$FName";
2683 command = subst(command, "$$FName", filename);
2685 // Execute the command in the background
2687 call.startscript(Systemcall::DontWait, command,
2688 filePath(), layoutPos());
2692 // FIXME: There is need for a command-line import.
2694 case LFUN_BUFFER_IMPORT:
2699 case LFUN_BUFFER_AUTO_SAVE:
2701 resetAutosaveTimers();
2704 case LFUN_BRANCH_ACTIVATE:
2705 case LFUN_BRANCH_DEACTIVATE:
2706 case LFUN_BRANCH_MASTER_ACTIVATE:
2707 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2708 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2709 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2710 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2713 docstring const branch_name = func.argument();
2714 // the case without a branch name is handled elsewhere
2715 if (branch_name.empty()) {
2719 Branch * branch = buf->params().branchlist().find(branch_name);
2721 LYXERR0("Branch " << branch_name << " does not exist.");
2723 docstring const msg =
2724 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2728 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2729 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2730 if (branch->isSelected() != activate) {
2731 buf->undo().recordUndoBufferParams(CursorData());
2732 branch->setSelected(activate);
2734 dr.screenUpdate(Update::Force);
2735 dr.forceBufferUpdate();
2740 case LFUN_BRANCH_ADD: {
2741 docstring branch_name = func.argument();
2742 if (branch_name.empty()) {
2746 BranchList & branch_list = params().branchlist();
2747 vector<docstring> const branches =
2748 getVectorFromString(branch_name, branch_list.separator());
2750 for (vector<docstring>::const_iterator it = branches.begin();
2751 it != branches.end(); ++it) {
2753 Branch * branch = branch_list.find(branch_name);
2755 LYXERR0("Branch " << branch_name << " already exists.");
2759 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2761 undo().recordUndoBufferParams(CursorData());
2762 branch_list.add(branch_name);
2763 branch = branch_list.find(branch_name);
2764 string const x11hexname = X11hexname(branch->color());
2765 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2766 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2768 dr.screenUpdate(Update::Force);
2776 case LFUN_BRANCHES_RENAME: {
2777 if (func.argument().empty())
2780 docstring const oldname = from_utf8(func.getArg(0));
2781 docstring const newname = from_utf8(func.getArg(1));
2782 InsetIterator it = inset_iterator_begin(inset());
2783 InsetIterator const end = inset_iterator_end(inset());
2784 bool success = false;
2785 for (; it != end; ++it) {
2786 if (it->lyxCode() == BRANCH_CODE) {
2787 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2788 if (ins.branch() == oldname) {
2789 undo().recordUndo(CursorData(it));
2790 ins.rename(newname);
2795 if (it->lyxCode() == INCLUDE_CODE) {
2796 // get buffer of external file
2797 InsetInclude const & ins =
2798 static_cast<InsetInclude const &>(*it);
2799 Buffer * child = ins.getChildBuffer();
2802 child->dispatch(func, dr);
2807 dr.screenUpdate(Update::Force);
2808 dr.forceBufferUpdate();
2813 case LFUN_BUFFER_VIEW_CACHE:
2814 if (!formats.view(*this, d->preview_file_,
2815 d->preview_format_))
2816 dr.setMessage(_("Error viewing the output file."));
2819 case LFUN_CHANGES_TRACK:
2820 if (params().save_transient_properties)
2821 undo().recordUndoBufferParams(CursorData());
2822 params().track_changes = !params().track_changes;
2823 if (!params().track_changes)
2824 dr.forceChangesUpdate();
2827 case LFUN_CHANGES_OUTPUT:
2828 if (params().save_transient_properties)
2829 undo().recordUndoBufferParams(CursorData());
2830 params().output_changes = !params().output_changes;
2831 if (params().output_changes) {
2832 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2833 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2834 LaTeXFeatures::isAvailable("xcolor");
2836 if (!dvipost && !xcolorulem) {
2837 Alert::warning(_("Changes not shown in LaTeX output"),
2838 _("Changes will not be highlighted in LaTeX output, "
2839 "because neither dvipost nor xcolor/ulem are installed.\n"
2840 "Please install these packages or redefine "
2841 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2842 } else if (!xcolorulem) {
2843 Alert::warning(_("Changes not shown in LaTeX output"),
2844 _("Changes will not be highlighted in LaTeX output "
2845 "when using pdflatex, because xcolor and ulem are not installed.\n"
2846 "Please install both packages or redefine "
2847 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2852 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2853 // turn compression on/off
2854 undo().recordUndoBufferParams(CursorData());
2855 params().compressed = !params().compressed;
2858 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2859 undo().recordUndoBufferParams(CursorData());
2860 params().output_sync = !params().output_sync;
2867 dr.dispatched(dispatched);
2868 undo().endUndoGroup();
2872 void Buffer::changeLanguage(Language const * from, Language const * to)
2874 LASSERT(from, return);
2875 LASSERT(to, return);
2877 for_each(par_iterator_begin(),
2879 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2883 bool Buffer::isMultiLingual() const
2885 ParConstIterator end = par_iterator_end();
2886 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2887 if (it->isMultiLingual(params()))
2894 std::set<Language const *> Buffer::getLanguages() const
2896 std::set<Language const *> languages;
2897 getLanguages(languages);
2902 void Buffer::getLanguages(std::set<Language const *> & languages) const
2904 ParConstIterator end = par_iterator_end();
2905 // add the buffer language, even if it's not actively used
2906 languages.insert(language());
2907 // iterate over the paragraphs
2908 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2909 it->getLanguages(languages);
2911 ListOfBuffers clist = getDescendents();
2912 ListOfBuffers::const_iterator cit = clist.begin();
2913 ListOfBuffers::const_iterator const cen = clist.end();
2914 for (; cit != cen; ++cit)
2915 (*cit)->getLanguages(languages);
2919 DocIterator Buffer::getParFromID(int const id) const
2921 Buffer * buf = const_cast<Buffer *>(this);
2923 // This means non-existent
2924 return doc_iterator_end(buf);
2926 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2927 if (it.paragraph().id() == id)
2930 return doc_iterator_end(buf);
2934 bool Buffer::hasParWithID(int const id) const
2936 return !getParFromID(id).atEnd();
2940 ParIterator Buffer::par_iterator_begin()
2942 return ParIterator(doc_iterator_begin(this));
2946 ParIterator Buffer::par_iterator_end()
2948 return ParIterator(doc_iterator_end(this));
2952 ParConstIterator Buffer::par_iterator_begin() const
2954 return ParConstIterator(doc_iterator_begin(this));
2958 ParConstIterator Buffer::par_iterator_end() const
2960 return ParConstIterator(doc_iterator_end(this));
2964 Language const * Buffer::language() const
2966 return params().language;
2970 docstring const Buffer::B_(string const & l10n) const
2972 return params().B_(l10n);
2976 bool Buffer::isClean() const
2978 return d->lyx_clean;
2982 bool Buffer::isExternallyModified(CheckMethod method) const
2984 LASSERT(d->filename.exists(), return false);
2985 // if method == timestamp, check timestamp before checksum
2986 return (method == checksum_method
2987 || d->timestamp_ != d->filename.lastModified())
2988 && d->checksum_ != d->filename.checksum();
2992 void Buffer::saveCheckSum() const
2994 FileName const & file = d->filename;
2997 if (file.exists()) {
2998 d->timestamp_ = file.lastModified();
2999 d->checksum_ = file.checksum();
3001 // in the case of save to a new file.
3008 void Buffer::markClean() const
3010 if (!d->lyx_clean) {
3011 d->lyx_clean = true;
3014 // if the .lyx file has been saved, we don't need an
3016 d->bak_clean = true;
3017 d->undo_.markDirty();
3021 void Buffer::setUnnamed(bool flag)
3027 bool Buffer::isUnnamed() const
3034 /// Don't check unnamed, here: isInternal() is used in
3035 /// newBuffer(), where the unnamed flag has not been set by anyone
3036 /// yet. Also, for an internal buffer, there should be no need for
3037 /// retrieving fileName() nor for checking if it is unnamed or not.
3038 bool Buffer::isInternal() const
3040 return d->internal_buffer;
3044 void Buffer::setInternal(bool flag)
3046 d->internal_buffer = flag;
3050 void Buffer::markDirty()
3053 d->lyx_clean = false;
3056 d->bak_clean = false;
3058 DepClean::iterator it = d->dep_clean.begin();
3059 DepClean::const_iterator const end = d->dep_clean.end();
3061 for (; it != end; ++it)
3066 FileName Buffer::fileName() const
3072 string Buffer::absFileName() const
3074 return d->filename.absFileName();
3078 string Buffer::filePath() const
3080 string const abs = d->filename.onlyPath().absFileName();
3083 int last = abs.length() - 1;
3085 return abs[last] == '/' ? abs : abs + '/';
3089 DocFileName Buffer::getReferencedFileName(string const & fn) const
3092 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3093 result.set(fn, filePath());
3095 // filePath() ends with a path separator
3096 FileName const test(filePath() + fn);
3098 result.set(fn, filePath());
3100 result.set(fn, params().origin);
3107 string Buffer::layoutPos() const
3109 return d->layout_position;
3113 void Buffer::setLayoutPos(string const & path)
3116 d->layout_position.clear();
3120 LATTEST(FileName::isAbsolute(path));
3122 d->layout_position =
3123 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3125 if (d->layout_position.empty())
3126 d->layout_position = ".";
3130 bool Buffer::isReadonly() const
3132 return d->read_only;
3136 void Buffer::setParent(Buffer const * buffer)
3138 // Avoids recursive include.
3139 d->setParent(buffer == this ? 0 : buffer);
3144 Buffer const * Buffer::parent() const
3150 ListOfBuffers Buffer::allRelatives() const
3152 ListOfBuffers lb = masterBuffer()->getDescendents();
3153 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3158 Buffer const * Buffer::masterBuffer() const
3160 // FIXME Should be make sure we are not in some kind
3161 // of recursive include? A -> B -> A will crash this.
3162 Buffer const * const pbuf = d->parent();
3166 return pbuf->masterBuffer();
3170 bool Buffer::isChild(Buffer * child) const
3172 return d->children_positions.find(child) != d->children_positions.end();
3176 DocIterator Buffer::firstChildPosition(Buffer const * child)
3178 Impl::BufferPositionMap::iterator it;
3179 it = d->children_positions.find(child);
3180 if (it == d->children_positions.end())
3181 return DocIterator(this);
3186 bool Buffer::hasChildren() const
3188 return !d->children_positions.empty();
3192 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3194 // loop over children
3195 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3196 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3197 for (; it != end; ++it) {
3198 Buffer * child = const_cast<Buffer *>(it->first);
3200 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3201 if (bit != clist.end())
3203 clist.push_back(child);
3205 // there might be grandchildren
3206 child->collectChildren(clist, true);
3211 ListOfBuffers Buffer::getChildren() const
3214 collectChildren(v, false);
3215 // Make sure we have not included ourselves.
3216 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3217 if (bit != v.end()) {
3218 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3225 ListOfBuffers Buffer::getDescendents() const
3228 collectChildren(v, true);
3229 // Make sure we have not included ourselves.
3230 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3231 if (bit != v.end()) {
3232 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3239 template<typename M>
3240 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3245 typename M::const_iterator it = m.lower_bound(x);
3246 if (it == m.begin())
3254 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3255 DocIterator const & pos) const
3257 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3259 // if paragraphs have no macro context set, pos will be empty
3263 // we haven't found anything yet
3264 DocIterator bestPos = owner_->par_iterator_begin();
3265 MacroData const * bestData = 0;
3267 // find macro definitions for name
3268 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3269 if (nameIt != macros.end()) {
3270 // find last definition in front of pos or at pos itself
3271 PositionScopeMacroMap::const_iterator it
3272 = greatest_below(nameIt->second, pos);
3273 if (it != nameIt->second.end()) {
3275 // scope ends behind pos?
3276 if (pos < it->second.scope) {
3277 // Looks good, remember this. If there
3278 // is no external macro behind this,
3279 // we found the right one already.
3280 bestPos = it->first;
3281 bestData = &it->second.macro;
3285 // try previous macro if there is one
3286 if (it == nameIt->second.begin())
3293 // find macros in included files
3294 PositionScopeBufferMap::const_iterator it
3295 = greatest_below(position_to_children, pos);
3296 if (it == position_to_children.end())
3297 // no children before
3301 // do we know something better (i.e. later) already?
3302 if (it->first < bestPos )
3305 // scope ends behind pos?
3306 if (pos < it->second.scope
3307 && (cloned_buffer_ ||
3308 theBufferList().isLoaded(it->second.buffer))) {
3309 // look for macro in external file
3311 MacroData const * data
3312 = it->second.buffer->getMacro(name, false);
3315 bestPos = it->first;
3321 // try previous file if there is one
3322 if (it == position_to_children.begin())
3327 // return the best macro we have found
3332 MacroData const * Buffer::getMacro(docstring const & name,
3333 DocIterator const & pos, bool global) const
3338 // query buffer macros
3339 MacroData const * data = d->getBufferMacro(name, pos);
3343 // If there is a master buffer, query that
3344 Buffer const * const pbuf = d->parent();
3346 d->macro_lock = true;
3347 MacroData const * macro = pbuf->getMacro(
3348 name, *this, false);
3349 d->macro_lock = false;
3355 data = MacroTable::globalMacros().get(name);
3364 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3366 // set scope end behind the last paragraph
3367 DocIterator scope = par_iterator_begin();
3368 scope.pit() = scope.lastpit() + 1;
3370 return getMacro(name, scope, global);
3374 MacroData const * Buffer::getMacro(docstring const & name,
3375 Buffer const & child, bool global) const
3377 // look where the child buffer is included first
3378 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3379 if (it == d->children_positions.end())
3382 // check for macros at the inclusion position
3383 return getMacro(name, it->second, global);
3387 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3389 pit_type const lastpit = it.lastpit();
3391 // look for macros in each paragraph
3392 while (it.pit() <= lastpit) {
3393 Paragraph & par = it.paragraph();
3395 // iterate over the insets of the current paragraph
3396 InsetList const & insets = par.insetList();
3397 InsetList::const_iterator iit = insets.begin();
3398 InsetList::const_iterator end = insets.end();
3399 for (; iit != end; ++iit) {
3400 it.pos() = iit->pos;
3402 // is it a nested text inset?
3403 if (iit->inset->asInsetText()) {
3404 // Inset needs its own scope?
3405 InsetText const * itext = iit->inset->asInsetText();
3406 bool newScope = itext->isMacroScope();
3408 // scope which ends just behind the inset
3409 DocIterator insetScope = it;
3412 // collect macros in inset
3413 it.push_back(CursorSlice(*iit->inset));
3414 updateMacros(it, newScope ? insetScope : scope);
3419 if (iit->inset->asInsetTabular()) {
3420 CursorSlice slice(*iit->inset);
3421 size_t const numcells = slice.nargs();
3422 for (; slice.idx() < numcells; slice.forwardIdx()) {
3423 it.push_back(slice);
3424 updateMacros(it, scope);
3430 // is it an external file?
3431 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3432 // get buffer of external file
3433 InsetInclude const & inset =
3434 static_cast<InsetInclude const &>(*iit->inset);
3436 Buffer * child = inset.getChildBuffer();
3441 // register its position, but only when it is
3442 // included first in the buffer
3443 if (children_positions.find(child) ==
3444 children_positions.end())
3445 children_positions[child] = it;
3447 // register child with its scope
3448 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3452 InsetMath * im = iit->inset->asInsetMath();
3453 if (doing_export && im) {
3454 InsetMathHull * hull = im->asHullInset();
3456 hull->recordLocation(it);
3459 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3463 MathMacroTemplate & macroTemplate =
3464 *iit->inset->asInsetMath()->asMacroTemplate();
3465 MacroContext mc(owner_, it);
3466 macroTemplate.updateToContext(mc);
3469 bool valid = macroTemplate.validMacro();
3470 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3471 // then the BufferView's cursor will be invalid in
3472 // some cases which leads to crashes.
3477 // FIXME (Abdel), I don't understand why we pass 'it' here
3478 // instead of 'macroTemplate' defined above... is this correct?
3479 macros[macroTemplate.name()][it] =
3480 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3490 void Buffer::updateMacros() const
3495 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3497 // start with empty table
3499 d->children_positions.clear();
3500 d->position_to_children.clear();
3502 // Iterate over buffer, starting with first paragraph
3503 // The scope must be bigger than any lookup DocIterator
3504 // later. For the global lookup, lastpit+1 is used, hence
3505 // we use lastpit+2 here.
3506 DocIterator it = par_iterator_begin();
3507 DocIterator outerScope = it;
3508 outerScope.pit() = outerScope.lastpit() + 2;
3509 d->updateMacros(it, outerScope);
3513 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3515 InsetIterator it = inset_iterator_begin(inset());
3516 InsetIterator const end = inset_iterator_end(inset());
3517 for (; it != end; ++it) {
3518 if (it->lyxCode() == BRANCH_CODE) {
3519 InsetBranch & br = static_cast<InsetBranch &>(*it);
3520 docstring const name = br.branch();
3521 if (!from_master && !params().branchlist().find(name))
3522 result.push_back(name);
3523 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3524 result.push_back(name);
3527 if (it->lyxCode() == INCLUDE_CODE) {
3528 // get buffer of external file
3529 InsetInclude const & ins =
3530 static_cast<InsetInclude const &>(*it);
3531 Buffer * child = ins.getChildBuffer();
3534 child->getUsedBranches(result, true);
3537 // remove duplicates
3542 void Buffer::updateMacroInstances(UpdateType utype) const
3544 LYXERR(Debug::MACROS, "updateMacroInstances for "
3545 << d->filename.onlyFileName());
3546 DocIterator it = doc_iterator_begin(this);
3548 DocIterator const end = doc_iterator_end(this);
3549 for (; it != end; it.forwardInset()) {
3550 // look for MathData cells in InsetMathNest insets
3551 InsetMath * minset = it.nextInset()->asInsetMath();
3555 // update macro in all cells of the InsetMathNest
3556 DocIterator::idx_type n = minset->nargs();
3557 MacroContext mc = MacroContext(this, it);
3558 for (DocIterator::idx_type i = 0; i < n; ++i) {
3559 MathData & data = minset->cell(i);
3560 data.updateMacros(0, mc, utype, 0);
3566 void Buffer::listMacroNames(MacroNameSet & macros) const
3571 d->macro_lock = true;
3573 // loop over macro names
3574 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3575 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3576 for (; nameIt != nameEnd; ++nameIt)
3577 macros.insert(nameIt->first);
3579 // loop over children
3580 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3581 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3582 for (; it != end; ++it)
3583 it->first->listMacroNames(macros);
3586 Buffer const * const pbuf = d->parent();
3588 pbuf->listMacroNames(macros);
3590 d->macro_lock = false;
3594 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3596 Buffer const * const pbuf = d->parent();
3601 pbuf->listMacroNames(names);
3604 MacroNameSet::iterator it = names.begin();
3605 MacroNameSet::iterator end = names.end();
3606 for (; it != end; ++it) {
3608 MacroData const * data =
3609 pbuf->getMacro(*it, *this, false);
3611 macros.insert(data);
3613 // we cannot access the original MathMacroTemplate anymore
3614 // here to calls validate method. So we do its work here manually.
3615 // FIXME: somehow make the template accessible here.
3616 if (data->optionals() > 0)
3617 features.require("xargs");
3623 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3626 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3628 RefCache::iterator it = d->ref_cache_.find(label);
3629 if (it != d->ref_cache_.end())
3630 return it->second.second;
3632 static InsetLabel const * dummy_il = 0;
3633 static References const dummy_refs = References();
3634 it = d->ref_cache_.insert(
3635 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3636 return it->second.second;
3640 Buffer::References const & Buffer::references(docstring const & label) const
3642 return const_cast<Buffer *>(this)->getReferenceCache(label);
3646 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3648 References & refs = getReferenceCache(label);
3649 refs.push_back(make_pair(inset, it));
3653 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3655 masterBuffer()->d->ref_cache_[label].first = il;
3659 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3661 return masterBuffer()->d->ref_cache_[label].first;
3665 void Buffer::clearReferenceCache() const
3668 d->ref_cache_.clear();
3672 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3674 //FIXME: This does not work for child documents yet.
3675 reloadBibInfoCache();
3677 // Check if the label 'from' appears more than once
3678 BiblioInfo const & keys = masterBibInfo();
3679 BiblioInfo::const_iterator bit = keys.begin();
3680 BiblioInfo::const_iterator bend = keys.end();
3681 vector<docstring> labels;
3683 for (; bit != bend; ++bit)
3685 labels.push_back(bit->first);
3687 if (count(labels.begin(), labels.end(), from) > 1)
3690 string const paramName = "key";
3691 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3692 if (it->lyxCode() != CITE_CODE)
3694 InsetCommand * inset = it->asInsetCommand();
3695 docstring const oldValue = inset->getParam(paramName);
3696 if (oldValue == from)
3697 inset->setParam(paramName, to);
3701 // returns NULL if id-to-row conversion is unsupported
3702 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3703 pit_type par_begin, pit_type par_end,
3704 OutputWhat output, bool master) const
3706 unique_ptr<TexRow> texrow;
3707 OutputParams runparams(¶ms().encoding());
3708 runparams.nice = true;
3709 runparams.flavor = params().getOutputFlavor(format);
3710 runparams.linelen = lyxrc.plaintext_linelen;
3711 // No side effect of file copying and image conversion
3712 runparams.dryrun = true;
3714 if (output == CurrentParagraph) {
3715 runparams.par_begin = par_begin;
3716 runparams.par_end = par_end;
3717 if (par_begin + 1 == par_end) {
3719 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3723 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3724 convert<docstring>(par_begin),
3725 convert<docstring>(par_end - 1))
3728 // output paragraphs
3729 if (runparams.flavor == OutputParams::LYX) {
3730 Paragraph const & par = text().paragraphs()[par_begin];
3732 depth_type dt = par.getDepth();
3733 par.write(ods, params(), dt);
3734 os << from_utf8(ods.str());
3735 } else if (runparams.flavor == OutputParams::HTML) {
3737 setMathFlavor(runparams);
3738 xhtmlParagraphs(text(), *this, xs, runparams);
3739 } else if (runparams.flavor == OutputParams::TEXT) {
3741 // FIXME Handles only one paragraph, unlike the others.
3742 // Probably should have some routine with a signature like them.
3743 writePlaintextParagraph(*this,
3744 text().paragraphs()[par_begin], os, runparams, dummy);
3745 } else if (params().isDocBook()) {
3746 docbookParagraphs(text(), *this, os, runparams);
3748 // If we are previewing a paragraph, even if this is the
3749 // child of some other buffer, let's cut the link here,
3750 // so that no concurring settings from the master
3751 // (e.g. branch state) interfere (see #8101).
3753 d->ignore_parent = true;
3754 // We need to validate the Buffer params' features here
3755 // in order to know if we should output polyglossia
3756 // macros (instead of babel macros)
3757 LaTeXFeatures features(*this, params(), runparams);
3759 runparams.use_polyglossia = features.usePolyglossia();
3760 // latex or literate
3763 ots.texrow().newlines(2);
3765 latexParagraphs(*this, text(), ots, runparams);
3766 texrow = ots.releaseTexRow();
3768 // Restore the parenthood
3770 d->ignore_parent = false;
3774 if (output == FullSource)
3775 os << _("Preview source code");
3776 else if (output == OnlyPreamble)
3777 os << _("Preview preamble");
3778 else if (output == OnlyBody)
3779 os << _("Preview body");
3781 if (runparams.flavor == OutputParams::LYX) {
3783 if (output == FullSource)
3785 else if (output == OnlyPreamble)
3786 params().writeFile(ods, this);
3787 else if (output == OnlyBody)
3789 os << from_utf8(ods.str());
3790 } else if (runparams.flavor == OutputParams::HTML) {
3791 writeLyXHTMLSource(os, runparams, output);
3792 } else if (runparams.flavor == OutputParams::TEXT) {
3793 if (output == OnlyPreamble) {
3794 os << "% "<< _("Plain text does not have a preamble.");
3796 writePlaintextFile(*this, os, runparams);
3797 } else if (params().isDocBook()) {
3798 writeDocBookSource(os, absFileName(), runparams, output);
3800 // latex or literate
3803 ots.texrow().newlines(2);
3805 runparams.is_child = true;
3806 writeLaTeXSource(ots, string(), runparams, output);
3807 texrow = ots.releaseTexRow();
3814 ErrorList & Buffer::errorList(string const & type) const
3816 return d->errorLists[type];
3820 void Buffer::updateTocItem(std::string const & type,
3821 DocIterator const & dit) const
3824 d->gui_->updateTocItem(type, dit);
3828 void Buffer::structureChanged() const
3831 d->gui_->structureChanged();
3835 void Buffer::errors(string const & err, bool from_master) const
3838 d->gui_->errors(err, from_master);
3842 void Buffer::message(docstring const & msg) const
3845 d->gui_->message(msg);
3849 void Buffer::setBusy(bool on) const
3852 d->gui_->setBusy(on);
3856 void Buffer::updateTitles() const
3859 d->wa_->updateTitles();
3863 void Buffer::resetAutosaveTimers() const
3866 d->gui_->resetAutosaveTimers();
3870 bool Buffer::hasGuiDelegate() const
3876 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3885 class AutoSaveBuffer : public ForkedProcess {
3888 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3889 : buffer_(buffer), fname_(fname) {}
3891 virtual shared_ptr<ForkedProcess> clone() const
3893 return make_shared<AutoSaveBuffer>(*this);
3898 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3899 from_utf8(fname_.absFileName())));
3900 return run(DontWait);
3904 virtual int generateChild();
3906 Buffer const & buffer_;
3911 int AutoSaveBuffer::generateChild()
3913 #if defined(__APPLE__)
3914 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3915 * We should use something else like threads.
3917 * Since I do not know how to determine at run time what is the OS X
3918 * version, I just disable forking altogether for now (JMarc)
3920 pid_t const pid = -1;
3922 // tmp_ret will be located (usually) in /tmp
3923 // will that be a problem?
3924 // Note that this calls ForkedCalls::fork(), so it's
3925 // ok cross-platform.
3926 pid_t const pid = fork();
3927 // If you want to debug the autosave
3928 // you should set pid to -1, and comment out the fork.
3929 if (pid != 0 && pid != -1)
3933 // pid = -1 signifies that lyx was unable
3934 // to fork. But we will do the save
3936 bool failed = false;
3937 TempFile tempfile("lyxautoXXXXXX.lyx");
3938 tempfile.setAutoRemove(false);
3939 FileName const tmp_ret = tempfile.name();
3940 if (!tmp_ret.empty()) {
3941 if (!buffer_.writeFile(tmp_ret))
3943 else if (!tmp_ret.moveTo(fname_))
3949 // failed to write/rename tmp_ret so try writing direct
3950 if (!buffer_.writeFile(fname_)) {
3951 // It is dangerous to do this in the child,
3952 // but safe in the parent, so...
3953 if (pid == -1) // emit message signal.
3954 buffer_.message(_("Autosave failed!"));
3958 if (pid == 0) // we are the child so...
3967 FileName Buffer::getEmergencyFileName() const
3969 return FileName(d->filename.absFileName() + ".emergency");
3973 FileName Buffer::getAutosaveFileName() const
3975 // if the document is unnamed try to save in the backup dir, else
3976 // in the default document path, and as a last try in the filePath,
3977 // which will most often be the temporary directory
3980 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3981 : lyxrc.backupdir_path;
3982 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3985 string const fname = "#" + d->filename.onlyFileName() + "#";
3987 return makeAbsPath(fname, fpath);
3991 void Buffer::removeAutosaveFile() const
3993 FileName const f = getAutosaveFileName();
3999 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
4001 FileName const newauto = getAutosaveFileName();
4003 if (newauto != oldauto && oldauto.exists())
4004 if (!oldauto.moveTo(newauto))
4005 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
4009 bool Buffer::autoSave() const
4011 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
4012 if (buf->d->bak_clean || isReadonly())
4015 message(_("Autosaving current document..."));
4016 buf->d->bak_clean = true;
4018 FileName const fname = getAutosaveFileName();
4019 LASSERT(d->cloned_buffer_, return false);
4021 // If this buffer is cloned, we assume that
4022 // we are running in a separate thread already.
4023 TempFile tempfile("lyxautoXXXXXX.lyx");
4024 tempfile.setAutoRemove(false);
4025 FileName const tmp_ret = tempfile.name();
4026 if (!tmp_ret.empty()) {
4028 // assume successful write of tmp_ret
4029 if (tmp_ret.moveTo(fname))
4032 // failed to write/rename tmp_ret so try writing direct
4033 return writeFile(fname);
4037 void Buffer::setExportStatus(bool e) const
4039 d->doing_export = e;
4040 ListOfBuffers clist = getDescendents();
4041 ListOfBuffers::const_iterator cit = clist.begin();
4042 ListOfBuffers::const_iterator const cen = clist.end();
4043 for (; cit != cen; ++cit)
4044 (*cit)->d->doing_export = e;
4048 bool Buffer::isExporting() const
4050 return d->doing_export;
4054 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4058 return doExport(target, put_in_tempdir, result_file);
4061 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4062 string & result_file) const
4064 bool const update_unincluded =
4065 params().maintain_unincluded_children
4066 && !params().getIncludedChildren().empty();
4068 // (1) export with all included children (omit \includeonly)
4069 if (update_unincluded) {
4070 ExportStatus const status =
4071 doExport(target, put_in_tempdir, true, result_file);
4072 if (status != ExportSuccess)
4075 // (2) export with included children only
4076 return doExport(target, put_in_tempdir, false, result_file);
4080 void Buffer::setMathFlavor(OutputParams & op) const
4082 switch (params().html_math_output) {
4083 case BufferParams::MathML:
4084 op.math_flavor = OutputParams::MathAsMathML;
4086 case BufferParams::HTML:
4087 op.math_flavor = OutputParams::MathAsHTML;
4089 case BufferParams::Images:
4090 op.math_flavor = OutputParams::MathAsImages;
4092 case BufferParams::LaTeX:
4093 op.math_flavor = OutputParams::MathAsLaTeX;
4099 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4100 bool includeall, string & result_file) const
4102 LYXERR(Debug::FILES, "target=" << target);
4103 OutputParams runparams(¶ms().encoding());
4104 string format = target;
4105 string dest_filename;
4106 size_t pos = target.find(' ');
4107 if (pos != string::npos) {
4108 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4109 format = target.substr(0, pos);
4110 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4111 FileName(dest_filename).onlyPath().createPath();
4112 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4114 MarkAsExporting exporting(this);
4115 string backend_format;
4116 runparams.flavor = OutputParams::LATEX;
4117 runparams.linelen = lyxrc.plaintext_linelen;
4118 runparams.includeall = includeall;
4119 vector<string> backs = params().backends();
4120 Converters converters = theConverters();
4121 bool need_nice_file = false;
4122 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4123 // Get shortest path to format
4124 converters.buildGraph();
4125 Graph::EdgePath path;
4126 for (vector<string>::const_iterator it = backs.begin();
4127 it != backs.end(); ++it) {
4128 Graph::EdgePath p = converters.getPath(*it, format);
4129 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4130 backend_format = *it;
4135 if (!put_in_tempdir) {
4136 // Only show this alert if this is an export to a non-temporary
4137 // file (not for previewing).
4138 Alert::error(_("Couldn't export file"), bformat(
4139 _("No information for exporting the format %1$s."),
4140 formats.prettyName(format)));
4142 return ExportNoPathToFormat;
4144 runparams.flavor = converters.getFlavor(path, this);
4145 Graph::EdgePath::const_iterator it = path.begin();
4146 Graph::EdgePath::const_iterator en = path.end();
4147 for (; it != en; ++it)
4148 if (theConverters().get(*it).nice()) {
4149 need_nice_file = true;
4154 backend_format = format;
4155 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4156 // FIXME: Don't hardcode format names here, but use a flag
4157 if (backend_format == "pdflatex")
4158 runparams.flavor = OutputParams::PDFLATEX;
4159 else if (backend_format == "luatex")
4160 runparams.flavor = OutputParams::LUATEX;
4161 else if (backend_format == "dviluatex")
4162 runparams.flavor = OutputParams::DVILUATEX;
4163 else if (backend_format == "xetex")
4164 runparams.flavor = OutputParams::XETEX;
4167 string filename = latexName(false);
4168 filename = addName(temppath(), filename);
4169 filename = changeExtension(filename,
4170 formats.extension(backend_format));
4171 LYXERR(Debug::FILES, "filename=" << filename);
4173 // Plain text backend
4174 if (backend_format == "text") {
4175 runparams.flavor = OutputParams::TEXT;
4176 writePlaintextFile(*this, FileName(filename), runparams);
4179 else if (backend_format == "xhtml") {
4180 runparams.flavor = OutputParams::HTML;
4181 setMathFlavor(runparams);
4182 makeLyXHTMLFile(FileName(filename), runparams);
4183 } else if (backend_format == "lyx")
4184 writeFile(FileName(filename));
4186 else if (params().isDocBook()) {
4187 runparams.nice = !put_in_tempdir;
4188 makeDocBookFile(FileName(filename), runparams);
4191 else if (backend_format == format || need_nice_file) {
4192 runparams.nice = true;
4193 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4194 if (d->cloned_buffer_)
4195 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4198 } else if (!lyxrc.tex_allows_spaces
4199 && contains(filePath(), ' ')) {
4200 Alert::error(_("File name error"),
4201 _("The directory path to the document cannot contain spaces."));
4202 return ExportTexPathHasSpaces;
4204 runparams.nice = false;
4205 bool const success = makeLaTeXFile(
4206 FileName(filename), filePath(), runparams);
4207 if (d->cloned_buffer_)
4208 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4213 string const error_type = (format == "program")
4214 ? "Build" : params().bufferFormat();
4215 ErrorList & error_list = d->errorLists[error_type];
4216 string const ext = formats.extension(format);
4217 FileName const tmp_result_file(changeExtension(filename, ext));
4218 bool const success = converters.convert(this, FileName(filename),
4219 tmp_result_file, FileName(absFileName()), backend_format, format,
4222 // Emit the signal to show the error list or copy it back to the
4223 // cloned Buffer so that it can be emitted afterwards.
4224 if (format != backend_format) {
4225 if (runparams.silent)
4227 else if (d->cloned_buffer_)
4228 d->cloned_buffer_->d->errorLists[error_type] =
4229 d->errorLists[error_type];
4232 // also to the children, in case of master-buffer-view
4233 ListOfBuffers clist = getDescendents();
4234 ListOfBuffers::const_iterator cit = clist.begin();
4235 ListOfBuffers::const_iterator const cen = clist.end();
4236 for (; cit != cen; ++cit) {
4237 if (runparams.silent)
4238 (*cit)->d->errorLists[error_type].clear();
4239 else if (d->cloned_buffer_) {
4240 // Enable reverse search by copying back the
4241 // texrow object to the cloned buffer.
4242 // FIXME: this is not thread safe.
4243 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4244 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4245 (*cit)->d->errorLists[error_type];
4247 (*cit)->errors(error_type, true);
4251 if (d->cloned_buffer_) {
4252 // Enable reverse dvi or pdf to work by copying back the texrow
4253 // object to the cloned buffer.
4254 // FIXME: There is a possibility of concurrent access to texrow
4255 // here from the main GUI thread that should be securized.
4256 d->cloned_buffer_->d->texrow = d->texrow;
4257 string const error_type = params().bufferFormat();
4258 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4262 if (put_in_tempdir) {
4263 result_file = tmp_result_file.absFileName();
4264 return success ? ExportSuccess : ExportConverterError;
4267 if (dest_filename.empty())
4268 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4270 result_file = dest_filename;
4271 // We need to copy referenced files (e. g. included graphics
4272 // if format == "dvi") to the result dir.
4273 vector<ExportedFile> const files =
4274 runparams.exportdata->externalFiles(format);
4275 string const dest = runparams.export_folder.empty() ?
4276 onlyPath(result_file) : runparams.export_folder;
4277 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4278 : force_overwrite == ALL_FILES;
4279 CopyStatus status = use_force ? FORCE : SUCCESS;
4281 vector<ExportedFile>::const_iterator it = files.begin();
4282 vector<ExportedFile>::const_iterator const en = files.end();
4283 for (; it != en && status != CANCEL; ++it) {
4284 string const fmt = formats.getFormatFromFile(it->sourceName);
4285 string fixedName = it->exportName;
4286 if (!runparams.export_folder.empty()) {
4287 // Relative pathnames starting with ../ will be sanitized
4288 // if exporting to a different folder
4289 while (fixedName.substr(0, 3) == "../")
4290 fixedName = fixedName.substr(3, fixedName.length() - 3);
4292 FileName fixedFileName = makeAbsPath(fixedName, dest);
4293 fixedFileName.onlyPath().createPath();
4294 status = copyFile(fmt, it->sourceName,
4296 it->exportName, status == FORCE,
4297 runparams.export_folder.empty());
4300 if (status == CANCEL) {
4301 message(_("Document export cancelled."));
4302 return ExportCancel;
4305 if (tmp_result_file.exists()) {
4306 // Finally copy the main file
4307 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4308 : force_overwrite != NO_FILES;
4309 if (status == SUCCESS && use_force)
4311 status = copyFile(format, tmp_result_file,
4312 FileName(result_file), result_file,
4314 if (status == CANCEL) {
4315 message(_("Document export cancelled."));
4316 return ExportCancel;
4318 message(bformat(_("Document exported as %1$s "
4320 formats.prettyName(format),
4321 makeDisplayPath(result_file)));
4324 // This must be a dummy converter like fax (bug 1888)
4325 message(bformat(_("Document exported as %1$s"),
4326 formats.prettyName(format)));
4329 return success ? ExportSuccess : ExportConverterError;
4333 Buffer::ExportStatus Buffer::preview(string const & format) const
4335 bool const update_unincluded =
4336 params().maintain_unincluded_children
4337 && !params().getIncludedChildren().empty();
4338 return preview(format, update_unincluded);
4342 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4344 MarkAsExporting exporting(this);
4346 // (1) export with all included children (omit \includeonly)
4348 ExportStatus const status = doExport(format, true, true, result_file);
4349 if (status != ExportSuccess)
4352 // (2) export with included children only
4353 ExportStatus const status = doExport(format, true, false, result_file);
4354 FileName const previewFile(result_file);
4356 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4357 theimpl->preview_file_ = previewFile;
4358 theimpl->preview_format_ = format;
4359 theimpl->preview_error_ = (status != ExportSuccess);
4361 if (status != ExportSuccess)
4364 if (previewFile.exists())
4365 return formats.view(*this, previewFile, format) ?
4366 PreviewSuccess : PreviewError;
4368 // Successful export but no output file?
4369 // Probably a bug in error detection.
4370 LATTEST(status != ExportSuccess);
4375 Buffer::ReadStatus Buffer::extractFromVC()
4377 bool const found = LyXVC::file_not_found_hook(d->filename);
4379 return ReadFileNotFound;
4380 if (!d->filename.isReadableFile())
4386 Buffer::ReadStatus Buffer::loadEmergency()
4388 FileName const emergencyFile = getEmergencyFileName();
4389 if (!emergencyFile.exists()
4390 || emergencyFile.lastModified() <= d->filename.lastModified())
4391 return ReadFileNotFound;
4393 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4394 docstring const text = bformat(_("An emergency save of the document "
4395 "%1$s exists.\n\nRecover emergency save?"), file);
4397 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4398 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4404 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4405 bool const success = (ret_llf == ReadSuccess);
4408 Alert::warning(_("File is read-only"),
4409 bformat(_("An emergency file is successfully loaded, "
4410 "but the original file %1$s is marked read-only. "
4411 "Please make sure to save the document as a different "
4412 "file."), from_utf8(d->filename.absFileName())));
4415 lyxvc().file_found_hook(d->filename);
4416 str = _("Document was successfully recovered.");
4418 str = _("Document was NOT successfully recovered.");
4419 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4420 makeDisplayPath(emergencyFile.absFileName()));
4422 int const del_emerg =
4423 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4424 _("&Remove"), _("&Keep"));
4425 if (del_emerg == 0) {
4426 emergencyFile.removeFile();
4428 Alert::warning(_("Emergency file deleted"),
4429 _("Do not forget to save your file now!"), true);
4431 return success ? ReadSuccess : ReadEmergencyFailure;
4434 int const del_emerg =
4435 Alert::prompt(_("Delete emergency file?"),
4436 _("Remove emergency file now?"), 1, 1,
4437 _("&Remove"), _("&Keep"));
4439 emergencyFile.removeFile();
4440 return ReadOriginal;
4450 Buffer::ReadStatus Buffer::loadAutosave()
4452 // Now check if autosave file is newer.
4453 FileName const autosaveFile = getAutosaveFileName();
4454 if (!autosaveFile.exists()
4455 || autosaveFile.lastModified() <= d->filename.lastModified())
4456 return ReadFileNotFound;
4458 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4459 docstring const text = bformat(_("The backup of the document %1$s "
4460 "is newer.\n\nLoad the backup instead?"), file);
4461 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4462 _("&Load backup"), _("Load &original"), _("&Cancel"));
4467 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4468 // the file is not saved if we load the autosave file.
4469 if (ret_llf == ReadSuccess) {
4471 Alert::warning(_("File is read-only"),
4472 bformat(_("A backup file is successfully loaded, "
4473 "but the original file %1$s is marked read-only. "
4474 "Please make sure to save the document as a "
4476 from_utf8(d->filename.absFileName())));
4479 lyxvc().file_found_hook(d->filename);
4482 return ReadAutosaveFailure;
4485 // Here we delete the autosave
4486 autosaveFile.removeFile();
4487 return ReadOriginal;
4495 Buffer::ReadStatus Buffer::loadLyXFile()
4497 if (!d->filename.isReadableFile()) {
4498 ReadStatus const ret_rvc = extractFromVC();
4499 if (ret_rvc != ReadSuccess)
4503 ReadStatus const ret_re = loadEmergency();
4504 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4507 ReadStatus const ret_ra = loadAutosave();
4508 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4511 return loadThisLyXFile(d->filename);
4515 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4517 return readFile(fn);
4521 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4523 for (auto const & err : terr) {
4524 TexRow::TextEntry start, end = TexRow::text_none;
4525 int errorRow = err.error_in_line;
4526 Buffer const * buf = 0;
4528 if (err.child_name.empty())
4529 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4531 // The error occurred in a child
4532 for (Buffer const * child : getDescendents()) {
4533 string const child_name =
4534 DocFileName(changeExtension(child->absFileName(), "tex")).
4536 if (err.child_name != child_name)
4538 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4539 if (!TexRow::isNone(start)) {
4540 buf = d->cloned_buffer_
4541 ? child->d->cloned_buffer_->d->owner_
4548 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4554 void Buffer::setBuffersForInsets() const
4556 inset().setBuffer(const_cast<Buffer &>(*this));
4560 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4562 LBUFERR(!text().paragraphs().empty());
4564 // Use the master text class also for child documents
4565 Buffer const * const master = masterBuffer();
4566 DocumentClass const & textclass = master->params().documentClass();
4568 // do this only if we are the top-level Buffer
4569 if (master == this) {
4570 textclass.counters().reset(from_ascii("bibitem"));
4571 reloadBibInfoCache();
4574 // keep the buffers to be children in this set. If the call from the
4575 // master comes back we can see which of them were actually seen (i.e.
4576 // via an InsetInclude). The remaining ones in the set need still be updated.
4577 static std::set<Buffer const *> bufToUpdate;
4578 if (scope == UpdateMaster) {
4579 // If this is a child document start with the master
4580 if (master != this) {
4581 bufToUpdate.insert(this);
4582 master->updateBuffer(UpdateMaster, utype);
4583 // If the master buffer has no gui associated with it, then the TocModel is
4584 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4585 // (bug 5699). The same happens if the master buffer is open in a different
4586 // window. This test catches both possibilities.
4587 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4588 // There remains a problem here: If there is another child open in yet a third
4589 // window, that TOC is not updated. So some more general solution is needed at
4591 if (master->d->gui_ != d->gui_)
4594 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4595 if (bufToUpdate.find(this) == bufToUpdate.end())
4599 // start over the counters in the master
4600 textclass.counters().reset();
4603 // update will be done below for this buffer
4604 bufToUpdate.erase(this);
4606 // update all caches
4607 clearReferenceCache();
4609 setChangesPresent(false);
4611 Buffer & cbuf = const_cast<Buffer &>(*this);
4614 ParIterator parit = cbuf.par_iterator_begin();
4615 updateBuffer(parit, utype);
4618 // TocBackend update will be done later.
4621 d->bibinfo_cache_valid_ = true;
4622 d->cite_labels_valid_ = true;
4624 cbuf.tocBackend().update(true, utype);
4625 if (scope == UpdateMaster)
4626 cbuf.structureChanged();
4630 static depth_type getDepth(DocIterator const & it)
4632 depth_type depth = 0;
4633 for (size_t i = 0 ; i < it.depth() ; ++i)
4634 if (!it[i].inset().inMathed())
4635 depth += it[i].paragraph().getDepth() + 1;
4636 // remove 1 since the outer inset does not count
4637 // we should have at least one non-math inset, so
4638 // depth should nevery be 0. but maybe it is worth
4639 // marking this, just in case.
4641 // coverity[INTEGER_OVERFLOW]
4645 static depth_type getItemDepth(ParIterator const & it)
4647 Paragraph const & par = *it;
4648 LabelType const labeltype = par.layout().labeltype;
4650 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4653 // this will hold the lowest depth encountered up to now.
4654 depth_type min_depth = getDepth(it);
4655 ParIterator prev_it = it;
4658 --prev_it.top().pit();
4660 // start of nested inset: go to outer par
4662 if (prev_it.empty()) {
4663 // start of document: nothing to do
4668 // We search for the first paragraph with same label
4669 // that is not more deeply nested.
4670 Paragraph & prev_par = *prev_it;
4671 depth_type const prev_depth = getDepth(prev_it);
4672 if (labeltype == prev_par.layout().labeltype) {
4673 if (prev_depth < min_depth)
4674 return prev_par.itemdepth + 1;
4675 if (prev_depth == min_depth)
4676 return prev_par.itemdepth;
4678 min_depth = min(min_depth, prev_depth);
4679 // small optimization: if we are at depth 0, we won't
4680 // find anything else
4681 if (prev_depth == 0)
4687 static bool needEnumCounterReset(ParIterator const & it)
4689 Paragraph const & par = *it;
4690 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4691 depth_type const cur_depth = par.getDepth();
4692 ParIterator prev_it = it;
4693 while (prev_it.pit()) {
4694 --prev_it.top().pit();
4695 Paragraph const & prev_par = *prev_it;
4696 if (prev_par.getDepth() <= cur_depth)
4697 return prev_par.layout().name() != par.layout().name();
4699 // start of nested inset: reset
4704 // set the label of a paragraph. This includes the counters.
4705 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4707 BufferParams const & bp = owner_->masterBuffer()->params();
4708 DocumentClass const & textclass = bp.documentClass();
4709 Paragraph & par = it.paragraph();
4710 Layout const & layout = par.layout();
4711 Counters & counters = textclass.counters();
4713 if (par.params().startOfAppendix()) {
4714 // We want to reset the counter corresponding to toplevel sectioning
4715 Layout const & lay = textclass.getTOCLayout();
4716 docstring const cnt = lay.counter;
4718 counters.reset(cnt);
4719 counters.appendix(true);
4721 par.params().appendix(counters.appendix());
4723 // Compute the item depth of the paragraph
4724 par.itemdepth = getItemDepth(it);
4726 if (layout.margintype == MARGIN_MANUAL) {
4727 if (par.params().labelWidthString().empty())
4728 par.params().labelWidthString(par.expandLabel(layout, bp));
4729 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4730 // we do not need to do anything here, since the empty case is
4731 // handled during export.
4733 par.params().labelWidthString(docstring());
4736 switch(layout.labeltype) {
4737 case LABEL_ITEMIZE: {
4738 // At some point of time we should do something more
4739 // clever here, like:
4740 // par.params().labelString(
4741 // bp.user_defined_bullet(par.itemdepth).getText());
4742 // for now, use a simple hardcoded label
4743 docstring itemlabel;
4744 switch (par.itemdepth) {
4746 itemlabel = char_type(0x2022);
4749 itemlabel = char_type(0x2013);
4752 itemlabel = char_type(0x2217);
4755 itemlabel = char_type(0x2219); // or 0x00b7
4758 par.params().labelString(itemlabel);
4762 case LABEL_ENUMERATE: {
4763 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4765 switch (par.itemdepth) {
4774 enumcounter += "iv";
4777 // not a valid enumdepth...
4781 // Increase the master counter?
4782 if (layout.stepmastercounter && needEnumCounterReset(it))
4783 counters.stepMaster(enumcounter, utype);
4785 // Maybe we have to reset the enumeration counter.
4786 if (!layout.resumecounter && needEnumCounterReset(it))
4787 counters.reset(enumcounter);
4788 counters.step(enumcounter, utype);
4790 string const & lang = par.getParLanguage(bp)->code();
4791 par.params().labelString(counters.theCounter(enumcounter, lang));
4796 case LABEL_SENSITIVE: {
4797 string const & type = counters.current_float();
4798 docstring full_label;
4800 full_label = owner_->B_("Senseless!!! ");
4802 docstring name = owner_->B_(textclass.floats().getType(type).name());
4803 if (counters.hasCounter(from_utf8(type))) {
4804 string const & lang = par.getParLanguage(bp)->code();
4805 counters.step(from_utf8(type), utype);
4806 full_label = bformat(from_ascii("%1$s %2$s:"),
4808 counters.theCounter(from_utf8(type), lang));
4810 full_label = bformat(from_ascii("%1$s #:"), name);
4812 par.params().labelString(full_label);
4816 case LABEL_NO_LABEL:
4817 par.params().labelString(docstring());
4821 case LABEL_CENTERED:
4822 case LABEL_STATIC: {
4823 docstring const & lcounter = layout.counter;
4824 if (!lcounter.empty()) {
4825 if (layout.toclevel <= bp.secnumdepth
4826 && (layout.latextype != LATEX_ENVIRONMENT
4827 || it.text()->isFirstInSequence(it.pit()))) {
4828 if (counters.hasCounter(lcounter))
4829 counters.step(lcounter, utype);
4830 par.params().labelString(par.expandLabel(layout, bp));
4832 par.params().labelString(docstring());
4834 par.params().labelString(par.expandLabel(layout, bp));
4840 par.params().labelString(par.expandLabel(layout, bp));
4845 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4847 // LASSERT: Is it safe to continue here, or should we just return?
4848 LASSERT(parit.pit() == 0, /**/);
4850 // Set the position of the text in the buffer to be able
4851 // to resolve macros in it.
4852 parit.text()->setMacrocontextPosition(parit);
4854 depth_type maxdepth = 0;
4855 pit_type const lastpit = parit.lastpit();
4856 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4857 // reduce depth if necessary
4858 if (parit->params().depth() > maxdepth) {
4859 /** FIXME: this function is const, but
4860 * nevertheless it modifies the buffer. To be
4861 * cleaner, one should modify the buffer in
4862 * another function, which is actually
4863 * non-const. This would however be costly in
4864 * terms of code duplication.
4866 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4867 parit->params().depth(maxdepth);
4869 maxdepth = parit->getMaxDepthAfter();
4871 if (utype == OutputUpdate) {
4872 // track the active counters
4873 // we have to do this for the master buffer, since the local
4874 // buffer isn't tracking anything.
4875 masterBuffer()->params().documentClass().counters().
4876 setActiveLayout(parit->layout());
4879 // set the counter for this paragraph
4880 d->setLabel(parit, utype);
4882 // update change-tracking flag
4883 parit->addChangesToBuffer(*this);
4886 InsetList::const_iterator iit = parit->insetList().begin();
4887 InsetList::const_iterator end = parit->insetList().end();
4888 for (; iit != end; ++iit) {
4889 parit.pos() = iit->pos;
4890 iit->inset->updateBuffer(parit, utype);
4896 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4897 WordLangTuple & word_lang, docstring_list & suggestions) const
4901 suggestions.clear();
4902 word_lang = WordLangTuple();
4903 bool const to_end = to.empty();
4904 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4905 // OK, we start from here.
4906 for (; from != end; from.forwardPos()) {
4907 // This skips all insets with spell check disabled.
4908 while (!from.allowSpellCheck()) {
4912 // If from is at the end of the document (which is possible
4913 // when "from" was changed above) LyX will crash later otherwise.
4914 if (from.atEnd() || (!to_end && from >= end))
4917 from.paragraph().spellCheck();
4918 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4919 if (SpellChecker::misspelled(res)) {
4923 // Do not increase progress when from == to, otherwise the word
4924 // count will be wrong.
4934 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4936 bool inword = false;
4941 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4942 if (!dit.inTexted()) {
4947 Paragraph const & par = dit.paragraph();
4948 pos_type const pos = dit.pos();
4950 // Copied and adapted from isWordSeparator() in Paragraph
4951 if (pos == dit.lastpos()) {
4954 Inset const * ins = par.getInset(pos);
4955 if (ins && skipNoOutput && !ins->producesOutput()) {
4958 // stop if end of range was skipped
4959 if (!to.atEnd() && dit >= to)
4962 } else if (!par.isDeleted(pos)) {
4963 if (par.isWordSeparator(pos))
4969 if (ins && ins->isLetter())
4971 else if (ins && ins->isSpace())
4974 char_type const c = par.getChar(pos);
4975 if (isPrintableNonspace(c))
4977 else if (isSpace(c))
4987 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4989 d->updateStatistics(from, to, skipNoOutput);
4993 int Buffer::wordCount() const
4995 return d->wordCount();
4999 int Buffer::charCount(bool with_blanks) const
5001 return d->charCount(with_blanks);
5005 Buffer::ReadStatus Buffer::reload()
5008 // c.f. bug http://www.lyx.org/trac/ticket/6587
5009 removeAutosaveFile();
5010 // e.g., read-only status could have changed due to version control
5011 d->filename.refresh();
5012 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
5014 // clear parent. this will get reset if need be.
5016 ReadStatus const status = loadLyXFile();
5017 if (status == ReadSuccess) {
5022 message(bformat(_("Document %1$s reloaded."), disp_fn));
5025 message(bformat(_("Could not reload document %1$s."), disp_fn));
5035 bool Buffer::saveAs(FileName const & fn)
5037 FileName const old_name = fileName();
5038 FileName const old_auto = getAutosaveFileName();
5039 bool const old_unnamed = isUnnamed();
5040 bool success = true;
5041 d->old_position = filePath();
5048 // bring the autosave file with us, just in case.
5049 moveAutosaveFile(old_auto);
5050 // validate version control data and
5051 // correct buffer title
5052 lyxvc().file_found_hook(fileName());
5054 // the file has now been saved to the new location.
5055 // we need to check that the locations of child buffers
5057 checkChildBuffers();
5058 checkMasterBuffer();
5061 // reset the old filename and unnamed state
5062 setFileName(old_name);
5063 setUnnamed(old_unnamed);
5067 d->old_position.clear();
5072 void Buffer::checkChildBuffers()
5074 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5075 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5076 for (; it != en; ++it) {
5077 DocIterator dit = it->second;
5078 Buffer * cbuf = const_cast<Buffer *>(it->first);
5079 if (!cbuf || !theBufferList().isLoaded(cbuf))
5081 Inset * inset = dit.nextInset();
5082 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5083 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5084 docstring const & incfile = inset_inc->getParam("filename");
5085 string oldloc = cbuf->absFileName();
5086 string newloc = makeAbsPath(to_utf8(incfile),
5087 onlyPath(absFileName())).absFileName();
5088 if (oldloc == newloc)
5090 // the location of the child file is incorrect.
5092 inset_inc->setChildBuffer(0);
5094 // invalidate cache of children
5095 d->children_positions.clear();
5096 d->position_to_children.clear();
5100 // If a child has been saved under a different name/path, it might have been
5101 // orphaned. Therefore the master needs to be reset (bug 8161).
5102 void Buffer::checkMasterBuffer()
5104 Buffer const * const master = masterBuffer();
5108 // necessary to re-register the child (bug 5873)
5109 // FIXME: clean up updateMacros (here, only
5110 // child registering is needed).
5111 master->updateMacros();
5112 // (re)set master as master buffer, but only
5113 // if we are a real child
5114 if (master->isChild(this))
5121 string Buffer::includedFilePath(string const & name, string const & ext) const
5123 if (d->old_position.empty() ||
5124 equivalent(FileName(d->old_position), FileName(filePath())))
5127 bool isabsolute = FileName::isAbsolute(name);
5128 // both old_position and filePath() end with a path separator
5129 string absname = isabsolute ? name : d->old_position + name;
5131 // if old_position is set to origin, we need to do the equivalent of
5132 // getReferencedFileName() (see readDocument())
5133 if (!isabsolute && d->old_position == params().origin) {
5134 FileName const test(addExtension(filePath() + name, ext));
5136 absname = filePath() + name;
5139 if (!FileName(addExtension(absname, ext)).exists())
5143 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5145 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5146 from_utf8(filePath())));
5150 void Buffer::setChangesPresent(bool b) const
5152 d->tracked_changes_present_ = b;
5156 bool Buffer::areChangesPresent() const
5158 return d->tracked_changes_present_;
5162 void Buffer::updateChangesPresent() const
5164 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5165 setChangesPresent(false);
5166 ParConstIterator it = par_iterator_begin();
5167 ParConstIterator const end = par_iterator_end();
5168 for (; !areChangesPresent() && it != end; ++it)
5169 it->addChangesToBuffer(*this);