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/PreviewLoader.h"
84 #include "frontends/alert.h"
85 #include "frontends/Delegates.h"
86 #include "frontends/WorkAreaManager.h"
88 #include "support/lassert.h"
89 #include "support/convert.h"
90 #include "support/debug.h"
91 #include "support/docstring_list.h"
92 #include "support/ExceptionMessage.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/ForkedCalls.h"
97 #include "support/gettext.h"
98 #include "support/gzstream.h"
99 #include "support/lstrings.h"
100 #include "support/lyxalgo.h"
101 #include "support/mutex.h"
102 #include "support/os.h"
103 #include "support/Package.h"
104 #include "support/PathChanger.h"
105 #include "support/Systemcall.h"
106 #include "support/TempFile.h"
107 #include "support/textutils.h"
108 #include "support/types.h"
110 #include "support/bind.h"
122 using namespace lyx::support;
123 using namespace lyx::graphics;
127 namespace Alert = frontend::Alert;
128 namespace os = support::os;
132 int const LYX_FORMAT = LYX_FORMAT_LYX;
134 typedef map<string, bool> DepClean;
135 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
140 // A storehouse for the cloned buffers.
141 list<CloneList *> cloned_buffers;
147 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
151 delete preview_loader_;
159 /// search for macro in local (buffer) table or in children
160 MacroData const * getBufferMacro(docstring const & name,
161 DocIterator const & pos) const;
163 /// Update macro table starting with position of it \param it in some
165 void updateMacros(DocIterator & it, DocIterator & scope);
167 void setLabel(ParIterator & it, UpdateType utype) const;
169 /** If we have branches that use the file suffix
170 feature, return the file name with suffix appended.
172 support::FileName exportFileName() const;
179 mutable TexRow texrow;
181 /// need to regenerate .tex?
185 mutable bool lyx_clean;
187 /// is autosave needed?
188 mutable bool bak_clean;
190 /// is this an unnamed file (New...)?
193 /// is this an internal bufffer?
194 bool internal_buffer;
199 /// name of the file the buffer is associated with.
202 /** Set to true only when the file is fully loaded.
203 * Used to prevent the premature generation of previews
204 * and by the citation inset.
206 bool file_fully_loaded;
208 /// original format of loaded file
211 /// if the file was originally loaded from an older format, do
212 /// we need to back it up still?
213 bool need_format_backup;
215 /// Ignore the parent (e.g. when exporting a child standalone)?
219 mutable TocBackend toc_backend;
224 ScopeMacro(DocIterator const & s, MacroData const & m)
225 : scope(s), macro(m) {}
229 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
230 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
231 /// map from the macro name to the position map,
232 /// which maps the macro definition position to the scope and the MacroData.
233 NamePositionScopeMacroMap macros;
234 /// This seem to change the way Buffer::getMacro() works
235 mutable bool macro_lock;
237 /// positions of child buffers in the buffer
238 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
240 ScopeBuffer() : buffer(0) {}
241 ScopeBuffer(DocIterator const & s, Buffer const * b)
242 : scope(s), buffer(b) {}
244 Buffer const * buffer;
246 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
247 /// position of children buffers in this buffer
248 BufferPositionMap children_positions;
249 /// map from children inclusion positions to their scope and their buffer
250 PositionScopeBufferMap position_to_children;
252 /// Contains the old buffer filePath() while saving-as, or the
253 /// directory where the document was last saved while loading.
256 /** Keeps track of the path of local layout files.
257 * If possible, it is always relative to the buffer path.
258 * Empty for layouts in system or user directory.
260 string layout_position;
262 /// Container for all sort of Buffer dependant errors.
263 map<string, ErrorList> errorLists;
265 /// timestamp and checksum used to test if the file has been externally
266 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
268 unsigned long checksum_;
271 frontend::WorkAreaManager * wa_;
273 frontend::GuiBufferDelegate * gui_;
278 /// A cache for the bibfiles (including bibfiles of loaded child
279 /// documents), needed for appropriate update of natbib labels.
280 mutable support::FileNameList bibfiles_cache_;
282 // FIXME The caching mechanism could be improved. At present, we have a
283 // cache for each Buffer, that caches all the bibliography info for that
284 // Buffer. A more efficient solution would be to have a global cache per
285 // file, and then to construct the Buffer's bibinfo from that.
286 /// A cache for bibliography info
287 mutable BiblioInfo bibinfo_;
288 /// whether the bibinfo cache is valid
289 mutable bool bibinfo_cache_valid_;
290 /// whether the bibfile cache is valid
291 mutable bool bibfile_cache_valid_;
292 /// Cache of timestamps of .bib files
293 map<FileName, time_t> bibfile_status_;
294 /// Indicates whether the bibinfo has changed since the last time
295 /// we ran updateBuffer(), i.e., whether citation labels may need
297 mutable bool cite_labels_valid_;
299 /// These two hold the file name and format, written to by
300 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
301 FileName preview_file_;
302 string preview_format_;
303 /// If there was an error when previewing, on the next preview we do
304 /// a fresh compile (e.g. in case the user installed a package that
308 mutable RefCache ref_cache_;
310 /// our Text that should be wrapped in an InsetText
314 PreviewLoader * preview_loader_;
316 /// This is here to force the test to be done whenever parent_buffer
318 Buffer const * parent() const
320 // ignore_parent temporarily "orphans" a buffer
321 // (e.g. if a child is compiled standalone)
324 // if parent_buffer is not loaded, then it has been unloaded,
325 // which means that parent_buffer is an invalid pointer. So we
326 // set it to null in that case.
327 // however, the BufferList doesn't know about cloned buffers, so
328 // they will always be regarded as unloaded. in that case, we hope
330 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
332 return parent_buffer;
336 void setParent(Buffer const * pb)
338 if (parent_buffer == pb)
341 if (!cloned_buffer_ && parent_buffer && pb)
342 LYXERR0("Warning: a buffer should not have two parents!");
344 if (!cloned_buffer_ && parent_buffer) {
345 parent_buffer->invalidateBibfileCache();
346 parent_buffer->invalidateBibinfoCache();
350 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
351 /// This one is useful for preview detached in a thread.
352 Buffer const * cloned_buffer_;
354 CloneList * clone_list_;
355 /// are we in the process of exporting this buffer?
356 mutable bool doing_export;
358 /// compute statistics
359 /// \p from initial position
360 /// \p to points to the end position
361 void updateStatistics(DocIterator & from, DocIterator & to,
362 bool skipNoOutput = true);
363 /// statistics accessor functions
364 int wordCount() const
368 int charCount(bool with_blanks) const
371 + (with_blanks ? blank_count_ : 0);
374 // does the buffer contain tracked changes? (if so, we automatically
375 // display the review toolbar, for instance)
376 mutable bool tracked_changes_present_;
379 /// So we can force access via the accessors.
380 mutable Buffer const * parent_buffer;
389 /// Creates the per buffer temporary directory
390 static FileName createBufferTmpDir()
392 // FIXME This would be the ideal application for a TempDir class (like
393 // TempFile but for directories)
398 Mutex::Locker locker(&mutex);
399 counter = convert<string>(count++);
401 // We are in our own directory. Why bother to mangle name?
402 // In fact I wrote this code to circumvent a problematic behaviour
403 // (bug?) of EMX mkstemp().
404 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
407 if (!tmpfl.createDirectory(0777)) {
408 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
409 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
410 from_utf8(tmpfl.absFileName())));
416 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
417 Buffer const * cloned_buffer)
418 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
419 internal_buffer(false), read_only(readonly_), filename(file),
420 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
421 ignore_parent(false), toc_backend(owner), macro_lock(false), timestamp_(0),
422 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
423 bibfile_cache_valid_(false), cite_labels_valid_(false), preview_error_(false),
424 inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer), clone_list_(0),
425 doing_export(false), parent_buffer(0),
426 word_count_(0), char_count_(0), blank_count_(0)
428 if (!cloned_buffer_) {
429 temppath = createBufferTmpDir();
430 lyxvc.setBuffer(owner_);
432 wa_ = new frontend::WorkAreaManager;
435 temppath = cloned_buffer_->d->temppath;
436 file_fully_loaded = true;
437 params = cloned_buffer_->d->params;
438 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
439 bibinfo_ = cloned_buffer_->d->bibinfo_;
440 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
441 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
442 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
443 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
444 unnamed = cloned_buffer_->d->unnamed;
445 internal_buffer = cloned_buffer_->d->internal_buffer;
446 layout_position = cloned_buffer_->d->layout_position;
447 preview_file_ = cloned_buffer_->d->preview_file_;
448 preview_format_ = cloned_buffer_->d->preview_format_;
449 preview_error_ = cloned_buffer_->d->preview_error_;
450 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
454 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
455 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
457 LYXERR(Debug::INFO, "Buffer::Buffer()");
459 d->inset = new InsetText(*cloned_buffer->d->inset);
460 d->inset->setBuffer(*this);
461 // FIXME: optimize this loop somewhat, maybe by creating a new
462 // general recursive Inset::setId().
463 DocIterator it = doc_iterator_begin(this);
464 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
465 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
466 it.paragraph().setId(cloned_it.paragraph().id());
468 d->inset = new InsetText(this);
469 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
475 LYXERR(Debug::INFO, "Buffer::~Buffer()");
476 // here the buffer should take care that it is
477 // saved properly, before it goes into the void.
479 // GuiView already destroyed
483 // No need to do additional cleanups for internal buffer.
489 // this is in case of recursive includes: we won't try to delete
490 // ourselves as a child.
491 d->clone_list_->erase(this);
492 // loop over children
493 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
494 Impl::BufferPositionMap::iterator end = d->children_positions.end();
495 for (; it != end; ++it) {
496 Buffer * child = const_cast<Buffer *>(it->first);
497 if (d->clone_list_->erase(child))
500 // if we're the master buffer, then we should get rid of the list
503 // If this is not empty, we have leaked something. Worse, one of the
504 // children still has a reference to this list. But we will try to
505 // continue, rather than shut down.
506 LATTEST(d->clone_list_->empty());
507 list<CloneList *>::iterator it =
508 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
509 if (it == cloned_buffers.end()) {
510 // We will leak in this case, but it is safe to continue.
513 cloned_buffers.erase(it);
514 delete d->clone_list_;
516 // FIXME Do we really need to do this right before we delete d?
517 // clear references to children in macro tables
518 d->children_positions.clear();
519 d->position_to_children.clear();
521 // loop over children
522 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
523 Impl::BufferPositionMap::iterator end = d->children_positions.end();
524 for (; it != end; ++it) {
525 Buffer * child = const_cast<Buffer *>(it->first);
526 if (theBufferList().isLoaded(child)) {
527 if (theBufferList().isOthersChild(this, child))
530 theBufferList().release(child);
535 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
536 msg += emergencyWrite();
537 Alert::warning(_("Attempting to close changed document!"), msg);
540 // FIXME Do we really need to do this right before we delete d?
541 // clear references to children in macro tables
542 d->children_positions.clear();
543 d->position_to_children.clear();
545 if (!d->temppath.destroyDirectory()) {
546 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
547 from_utf8(d->temppath.absFileName())));
556 Buffer * Buffer::cloneFromMaster() const
559 cloned_buffers.push_back(new CloneList);
560 CloneList * clones = cloned_buffers.back();
562 masterBuffer()->cloneWithChildren(bufmap, clones);
564 // make sure we got cloned
565 BufferMap::const_iterator bit = bufmap.find(this);
566 LASSERT(bit != bufmap.end(), return 0);
567 Buffer * cloned_buffer = bit->second;
569 return cloned_buffer;
573 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
575 // have we already been cloned?
576 if (bufmap.find(this) != bufmap.end())
579 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
581 // The clone needs its own DocumentClass, since running updateBuffer() will
582 // modify it, and we would otherwise be sharing it with the original Buffer.
583 buffer_clone->params().makeDocumentClass(true);
585 cap::switchBetweenClasses(
586 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
587 static_cast<InsetText &>(buffer_clone->inset()), el);
589 bufmap[this] = buffer_clone;
590 clones->insert(buffer_clone);
591 buffer_clone->d->clone_list_ = clones;
592 buffer_clone->d->macro_lock = true;
593 buffer_clone->d->children_positions.clear();
595 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
596 // math macro caches need to be rethought and simplified.
597 // I am not sure wether we should handle Buffer cloning here or in BufferList.
598 // Right now BufferList knows nothing about buffer clones.
599 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
600 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
601 for (; it != end; ++it) {
602 DocIterator dit = it->first.clone(buffer_clone);
603 dit.setBuffer(buffer_clone);
604 Buffer * child = const_cast<Buffer *>(it->second.buffer);
606 child->cloneWithChildren(bufmap, clones);
607 BufferMap::iterator const bit = bufmap.find(child);
608 LASSERT(bit != bufmap.end(), continue);
609 Buffer * child_clone = bit->second;
611 Inset * inset = dit.nextInset();
612 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
613 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
614 inset_inc->setChildBuffer(child_clone);
615 child_clone->d->setParent(buffer_clone);
616 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
617 buffer_clone->setChild(dit, child_clone);
619 buffer_clone->d->macro_lock = false;
624 Buffer * Buffer::cloneBufferOnly() const {
625 cloned_buffers.push_back(new CloneList);
626 CloneList * clones = cloned_buffers.back();
627 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
629 // The clone needs its own DocumentClass, since running updateBuffer() will
630 // modify it, and we would otherwise be sharing it with the original Buffer.
631 buffer_clone->params().makeDocumentClass(true);
633 cap::switchBetweenClasses(
634 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
635 static_cast<InsetText &>(buffer_clone->inset()), el);
637 clones->insert(buffer_clone);
638 buffer_clone->d->clone_list_ = clones;
640 // we won't be cloning the children
641 buffer_clone->d->children_positions.clear();
646 bool Buffer::isClone() const
648 return d->cloned_buffer_;
652 void Buffer::changed(bool update_metrics) const
655 d->wa_->redrawAll(update_metrics);
659 frontend::WorkAreaManager & Buffer::workAreaManager() const
666 Text & Buffer::text() const
668 return d->inset->text();
672 Inset & Buffer::inset() const
678 BufferParams & Buffer::params()
684 BufferParams const & Buffer::params() const
690 BufferParams const & Buffer::masterParams() const
692 if (masterBuffer() == this)
695 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
696 // Copy child authors to the params. We need those pointers.
697 AuthorList const & child_authors = params().authors();
698 AuthorList::Authors::const_iterator it = child_authors.begin();
699 for (; it != child_authors.end(); ++it)
700 mparams.authors().record(*it);
705 double Buffer::fontScalingFactor() const
707 return isExporting() ? 75.0 * params().html_math_img_scale
708 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
712 ParagraphList & Buffer::paragraphs()
714 return text().paragraphs();
718 ParagraphList const & Buffer::paragraphs() const
720 return text().paragraphs();
724 LyXVC & Buffer::lyxvc()
730 LyXVC const & Buffer::lyxvc() const
736 string const Buffer::temppath() const
738 return d->temppath.absFileName();
742 TexRow & Buffer::texrow()
748 TexRow const & Buffer::texrow() const
754 TocBackend & Buffer::tocBackend() const
756 return d->toc_backend;
760 Undo & Buffer::undo()
766 void Buffer::setChild(DocIterator const & dit, Buffer * child)
768 d->children_positions[child] = dit;
772 string Buffer::latexName(bool const no_path) const
774 FileName latex_name =
775 makeLatexName(d->exportFileName());
776 return no_path ? latex_name.onlyFileName()
777 : latex_name.absFileName();
781 FileName Buffer::Impl::exportFileName() const
783 docstring const branch_suffix =
784 params.branchlist().getFileNameSuffix();
785 if (branch_suffix.empty())
788 string const name = filename.onlyFileNameWithoutExt()
789 + to_utf8(branch_suffix);
790 FileName res(filename.onlyPath().absFileName() + "/" + name);
791 res.changeExtension(filename.extension());
797 string Buffer::logName(LogType * type) const
799 string const filename = latexName(false);
801 if (filename.empty()) {
807 string const path = temppath();
809 FileName const fname(addName(temppath(),
810 onlyFileName(changeExtension(filename,
813 // FIXME: how do we know this is the name of the build log?
814 FileName const bname(
815 addName(path, onlyFileName(
816 changeExtension(filename,
817 formats.extension(params().bufferFormat()) + ".out"))));
819 // Also consider the master buffer log file
820 FileName masterfname = fname;
821 LogType mtype = latexlog;
822 if (masterBuffer() != this) {
823 string const mlogfile = masterBuffer()->logName(&mtype);
824 masterfname = FileName(mlogfile);
827 // If no Latex log or Build log is newer, show Build log
828 if (bname.exists() &&
829 ((!fname.exists() && !masterfname.exists())
830 || (fname.lastModified() < bname.lastModified()
831 && masterfname.lastModified() < bname.lastModified()))) {
832 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
835 return bname.absFileName();
836 // If we have a newer master file log or only a master log, show this
837 } else if (fname != masterfname
838 && (!fname.exists() && (masterfname.exists()
839 || fname.lastModified() < masterfname.lastModified()))) {
840 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
843 return masterfname.absFileName();
845 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
848 return fname.absFileName();
852 void Buffer::setReadonly(bool const flag)
854 if (d->read_only != flag) {
861 void Buffer::setFileName(FileName const & fname)
863 bool const changed = fname != d->filename;
866 lyxvc().file_found_hook(fname);
867 setReadonly(d->filename.isReadOnly());
873 int Buffer::readHeader(Lexer & lex)
875 int unknown_tokens = 0;
877 int begin_header_line = -1;
879 // Initialize parameters that may be/go lacking in header:
880 params().branchlist().clear();
881 params().preamble.erase();
882 params().options.erase();
883 params().master.erase();
884 params().float_placement.erase();
885 params().paperwidth.erase();
886 params().paperheight.erase();
887 params().leftmargin.erase();
888 params().rightmargin.erase();
889 params().topmargin.erase();
890 params().bottommargin.erase();
891 params().headheight.erase();
892 params().headsep.erase();
893 params().footskip.erase();
894 params().columnsep.erase();
895 params().fonts_cjk.erase();
896 params().listings_params.clear();
897 params().clearLayoutModules();
898 params().clearRemovedModules();
899 params().clearIncludedChildren();
900 params().pdfoptions().clear();
901 params().indiceslist().clear();
902 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
903 params().isbackgroundcolor = false;
904 params().fontcolor = RGBColor(0, 0, 0);
905 params().isfontcolor = false;
906 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
907 params().boxbgcolor = RGBColor(0xFF, 0, 0);
908 params().html_latex_start.clear();
909 params().html_latex_end.clear();
910 params().html_math_img_scale = 1.0;
911 params().output_sync_macro.erase();
912 params().setLocalLayout(string(), false);
913 params().setLocalLayout(string(), true);
915 for (int i = 0; i < 4; ++i) {
916 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
917 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
920 ErrorList & errorList = d->errorLists["Parse"];
929 if (token == "\\end_header")
933 if (token == "\\begin_header") {
934 begin_header_line = line;
938 LYXERR(Debug::PARSER, "Handling document header token: `"
941 string const result =
942 params().readToken(lex, token, d->filename.onlyPath());
943 if (!result.empty()) {
944 if (token == "\\textclass") {
945 d->layout_position = result;
948 docstring const s = bformat(_("Unknown token: "
952 errorList.push_back(ErrorItem(_("Document header error"),
957 if (begin_header_line) {
958 docstring const s = _("\\begin_header is missing");
959 errorList.push_back(ErrorItem(_("Document header error"),
963 params().makeDocumentClass();
965 return unknown_tokens;
970 // changed to be public and have one parameter
971 // Returns true if "\end_document" is not read (Asger)
972 bool Buffer::readDocument(Lexer & lex)
974 ErrorList & errorList = d->errorLists["Parse"];
977 // remove dummy empty par
978 paragraphs().clear();
980 if (!lex.checkFor("\\begin_document")) {
981 docstring const s = _("\\begin_document is missing");
982 errorList.push_back(ErrorItem(_("Document header error"),
988 if (params().output_changes) {
989 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
990 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
991 LaTeXFeatures::isAvailable("xcolor");
993 if (!dvipost && !xcolorulem) {
994 Alert::warning(_("Changes not shown in LaTeX output"),
995 _("Changes will not be highlighted in LaTeX output, "
996 "because neither dvipost nor xcolor/ulem are installed.\n"
997 "Please install these packages or redefine "
998 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
999 } else if (!xcolorulem) {
1000 Alert::warning(_("Changes not shown in LaTeX output"),
1001 _("Changes will not be highlighted in LaTeX output "
1002 "when using pdflatex, because xcolor and ulem are not installed.\n"
1003 "Please install both packages or redefine "
1004 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1008 if (!parent() && !params().master.empty()) {
1009 FileName const master_file = makeAbsPath(params().master,
1010 onlyPath(absFileName()));
1011 if (isLyXFileName(master_file.absFileName())) {
1013 checkAndLoadLyXFile(master_file, true);
1015 // necessary e.g. after a reload
1016 // to re-register the child (bug 5873)
1017 // FIXME: clean up updateMacros (here, only
1018 // child registering is needed).
1019 master->updateMacros();
1020 // set master as master buffer, but only
1021 // if we are a real child
1022 if (master->isChild(this))
1024 // if the master is not fully loaded
1025 // it is probably just loading this
1026 // child. No warning needed then.
1027 else if (master->isFullyLoaded())
1028 LYXERR0("The master '"
1030 << "' assigned to this document ("
1032 << ") does not include "
1033 "this document. Ignoring the master assignment.");
1038 // assure we have a default index
1039 params().indiceslist().addDefault(B_("Index"));
1042 if (FileName::isAbsolute(params().origin))
1043 d->old_position = params().origin;
1045 d->old_position = filePath();
1046 bool const res = text().read(lex, errorList, d->inset);
1047 d->old_position.clear();
1049 // inform parent buffer about local macros
1051 Buffer const * pbuf = parent();
1052 UserMacroSet::const_iterator cit = usermacros.begin();
1053 UserMacroSet::const_iterator end = usermacros.end();
1054 for (; cit != end; ++cit)
1055 pbuf->usermacros.insert(*cit);
1059 updateMacroInstances(InternalUpdate);
1064 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1066 Format const * fmt = formats.getFormat(format);
1069 // It is important to use the correct extension here, since some
1070 // converters create a wrong output file otherwise (e.g. html2latex)
1071 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1072 FileName const name(tempfile.name());
1073 ofdocstream os(name.toFilesystemEncoding().c_str());
1074 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1075 bool const success = !(os << contents).fail();
1078 bool converted = false;
1080 params().compressed = false;
1082 // remove dummy empty par
1083 paragraphs().clear();
1085 converted = importFile(format, name, errorList);
1094 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1096 if (!theConverters().isReachable(format, "lyx"))
1099 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1100 FileName const lyx(tempfile.name());
1101 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1102 return readFile(lyx) == ReadSuccess;
1108 bool Buffer::readString(string const & s)
1110 params().compressed = false;
1113 istringstream is(s);
1115 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1116 FileName const fn = tempfile.name();
1119 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1121 if (success && file_format != LYX_FORMAT) {
1122 // We need to call lyx2lyx, so write the input to a file
1123 ofstream os(fn.toFilesystemEncoding().c_str());
1126 // lyxvc in readFile
1127 if (readFile(fn) != ReadSuccess)
1131 if (readDocument(lex))
1137 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1141 if (!lex.setFile(fname)) {
1142 Alert::error(_("File Not Found"),
1143 bformat(_("Unable to open file `%1$s'."),
1144 from_utf8(fn.absFileName())));
1145 return ReadFileNotFound;
1149 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1150 if (ret_plf != ReadSuccess)
1153 if (file_format != LYX_FORMAT) {
1155 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1156 if (ret_clf != ReadSuccess)
1158 ret_clf = readFile(tmpFile);
1159 if (ret_clf == ReadSuccess) {
1160 d->file_format = file_format;
1161 d->need_format_backup = true;
1166 // FIXME: InsetInfo needs to know whether the file is under VCS
1167 // during the parse process, so this has to be done before.
1168 lyxvc().file_found_hook(d->filename);
1170 if (readDocument(lex)) {
1171 Alert::error(_("Document format failure"),
1172 bformat(_("%1$s ended unexpectedly, which means"
1173 " that it is probably corrupted."),
1174 from_utf8(fn.absFileName())));
1175 return ReadDocumentFailure;
1178 d->file_fully_loaded = true;
1179 d->read_only = !d->filename.isWritable();
1180 params().compressed = formats.isZippedFile(d->filename);
1186 bool Buffer::isFullyLoaded() const
1188 return d->file_fully_loaded;
1192 void Buffer::setFullyLoaded(bool value)
1194 d->file_fully_loaded = value;
1198 bool Buffer::lastPreviewError() const
1200 return d->preview_error_;
1204 PreviewLoader * Buffer::loader() const
1206 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1208 if (!d->preview_loader_)
1209 d->preview_loader_ = new PreviewLoader(*this);
1210 return d->preview_loader_;
1214 void Buffer::removePreviews() const
1216 delete d->preview_loader_;
1217 d->preview_loader_ = 0;
1221 void Buffer::updatePreviews() const
1223 PreviewLoader * ploader = loader();
1227 InsetIterator it = inset_iterator_begin(*d->inset);
1228 InsetIterator const end = inset_iterator_end(*d->inset);
1229 for (; it != end; ++it)
1230 it->addPreview(it, *ploader);
1232 ploader->startLoading();
1236 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1237 FileName const & fn, int & file_format) const
1239 if(!lex.checkFor("\\lyxformat")) {
1240 Alert::error(_("Document format failure"),
1241 bformat(_("%1$s is not a readable LyX document."),
1242 from_utf8(fn.absFileName())));
1243 return ReadNoLyXFormat;
1249 // LyX formats 217 and earlier were written as 2.17. This corresponds
1250 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1251 // these cases. See also: www.lyx.org/trac/changeset/1313.
1252 size_t dot = tmp_format.find_first_of(".,");
1253 if (dot != string::npos)
1254 tmp_format.erase(dot, 1);
1256 file_format = convert<int>(tmp_format);
1261 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1262 FileName & tmpfile, int from_format)
1264 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1265 tempfile.setAutoRemove(false);
1266 tmpfile = tempfile.name();
1267 if(tmpfile.empty()) {
1268 Alert::error(_("Conversion failed"),
1269 bformat(_("%1$s is from a different"
1270 " version of LyX, but a temporary"
1271 " file for converting it could"
1272 " not be created."),
1273 from_utf8(fn.absFileName())));
1274 return LyX2LyXNoTempFile;
1277 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1278 if (lyx2lyx.empty()) {
1279 Alert::error(_("Conversion script not found"),
1280 bformat(_("%1$s is from a different"
1281 " version of LyX, but the"
1282 " conversion script lyx2lyx"
1283 " could not be found."),
1284 from_utf8(fn.absFileName())));
1285 return LyX2LyXNotFound;
1289 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1290 ostringstream command;
1291 command << os::python()
1292 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1293 << " -t " << convert<string>(LYX_FORMAT)
1294 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1295 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1296 string const command_str = command.str();
1298 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1300 cmd_ret const ret = runCommand(command_str);
1301 if (ret.first != 0) {
1302 if (from_format < LYX_FORMAT) {
1303 Alert::error(_("Conversion script failed"),
1304 bformat(_("%1$s is from an older version"
1305 " of LyX and the lyx2lyx script"
1306 " failed to convert it."),
1307 from_utf8(fn.absFileName())));
1308 return LyX2LyXOlderFormat;
1310 Alert::error(_("Conversion script failed"),
1311 bformat(_("%1$s is from a newer version"
1312 " of LyX and the lyx2lyx script"
1313 " failed to convert it."),
1314 from_utf8(fn.absFileName())));
1315 return LyX2LyXNewerFormat;
1322 FileName Buffer::getBackupName() const {
1323 FileName const & fn = fileName();
1324 string const fname = fn.onlyFileNameWithoutExt();
1325 string const fext = fn.extension() + "~";
1326 string const fpath = lyxrc.backupdir_path.empty() ?
1327 fn.onlyPath().absFileName() :
1328 lyxrc.backupdir_path;
1329 string const fform = convert<string>(d->file_format);
1330 string const backname = fname + "-lyxformat-" + fform;
1331 FileName backup(addName(fpath, addExtension(backname, fext)));
1333 // limit recursion, just in case
1335 unsigned long orig_checksum = 0;
1336 while (backup.exists() && v < 100) {
1337 if (orig_checksum == 0)
1338 orig_checksum = fn.checksum();
1339 unsigned long new_checksum = backup.checksum();
1340 if (orig_checksum == new_checksum) {
1341 LYXERR(Debug::FILES, "Not backing up " << fn <<
1342 "since " << backup << "has the same checksum.");
1343 // a bit of a hack, but we have to check this anyway
1344 // below, and setting this is simpler than introducing
1345 // a special boolean for this purpose.
1349 string const newbackname = backname + "-" + convert<string>(v);
1350 backup.set(addName(fpath, addExtension(newbackname, fext)));
1353 return v < 100 ? backup : FileName();
1357 // Should probably be moved to somewhere else: BufferView? GuiView?
1358 bool Buffer::save() const
1360 docstring const file = makeDisplayPath(absFileName(), 20);
1361 d->filename.refresh();
1363 // check the read-only status before moving the file as a backup
1364 if (d->filename.exists()) {
1365 bool const read_only = !d->filename.isWritable();
1367 Alert::warning(_("File is read-only"),
1368 bformat(_("The file %1$s cannot be written because it "
1369 "is marked as read-only."), file));
1374 // ask if the disk file has been externally modified (use checksum method)
1375 if (fileName().exists() && isExternallyModified(checksum_method)) {
1377 bformat(_("Document %1$s has been externally modified. "
1378 "Are you sure you want to overwrite this file?"), file);
1379 int const ret = Alert::prompt(_("Overwrite modified file?"),
1380 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1385 // We don't need autosaves in the immediate future. (Asger)
1386 resetAutosaveTimers();
1388 // if the file does not yet exist, none of the backup activity
1389 // that follows is necessary
1390 if (!fileName().exists()) {
1391 if (!writeFile(fileName()))
1397 // we first write the file to a new name, then move it to its
1398 // proper location once that has been done successfully. that
1399 // way we preserve the original file if something goes wrong.
1400 string const justname = fileName().onlyFileNameWithoutExt();
1401 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1402 justname + "-XXXXXX.lyx");
1403 bool const symlink = fileName().isSymLink();
1405 tempfile->setAutoRemove(false);
1407 FileName savefile(tempfile->name());
1408 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1409 if (!writeFile(savefile))
1412 // we will set this to false if we fail
1413 bool made_backup = true;
1415 FileName backupName;
1416 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1418 if (d->need_format_backup)
1419 backupName = getBackupName();
1421 // If we for some reason failed to find a backup name in case of
1422 // a format change, this will still set one. It's the best we can
1424 if (backupName.empty()) {
1425 backupName.set(fileName().absFileName() + "~");
1426 if (!lyxrc.backupdir_path.empty()) {
1427 string const mangledName =
1428 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1429 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1433 LYXERR(Debug::FILES, "Backing up original file to " <<
1434 backupName.absFileName());
1435 // Except file is symlink do not copy because of #6587.
1436 // Hard links have bad luck.
1437 made_backup = symlink ?
1438 fileName().copyTo(backupName):
1439 fileName().moveTo(backupName);
1442 Alert::error(_("Backup failure"),
1443 bformat(_("Cannot create backup file %1$s.\n"
1444 "Please check whether the directory exists and is writable."),
1445 from_utf8(backupName.absFileName())));
1446 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1447 } else if (d->need_format_backup) {
1448 // the original file has been backed up successfully, so we
1449 // will not need to do that again
1450 d->need_format_backup = false;
1454 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1455 // Only do this if tempfile is not in autoremove mode
1458 // If we have no symlink, we can simply rename the temp file.
1459 // Otherwise, we need to copy it so the symlink stays intact.
1460 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1461 savefile.moveTo(fileName()))
1463 // saveCheckSum() was already called by writeFile(), but the
1464 // time stamp is invalidated by copying/moving
1467 if (d->file_format != LYX_FORMAT)
1468 // the file associated with this buffer is now in the current format
1469 d->file_format = LYX_FORMAT;
1472 // else we saved the file, but failed to move it to the right location.
1474 if (needBackup && made_backup && !symlink) {
1475 // the original file was moved to some new location, so it will look
1476 // to the user as if it was deleted. (see bug #9234.) we could try
1477 // to restore it, but that would basically mean trying to do again
1478 // what we just failed to do. better to leave things as they are.
1479 Alert::error(_("Write failure"),
1480 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1481 "But LyX could not move it to:\n %2$s.\n"
1482 "Your original file has been backed up to:\n %3$s"),
1483 from_utf8(savefile.absFileName()),
1484 from_utf8(fileName().absFileName()),
1485 from_utf8(backupName.absFileName())));
1487 // either we did not try to make a backup, or else we tried and failed,
1488 // or else the original file was a symlink, in which case it was copied,
1489 // not moved. so the original file is intact.
1490 Alert::error(_("Write failure"),
1491 bformat(_("Cannot move saved file to:\n %1$s.\n"
1492 "But the file has successfully been saved as:\n %2$s."),
1493 from_utf8(fileName().absFileName()),
1494 from_utf8(savefile.absFileName())));
1500 bool Buffer::writeFile(FileName const & fname) const
1502 if (d->read_only && fname == d->filename)
1505 bool retval = false;
1507 docstring const str = bformat(_("Saving document %1$s..."),
1508 makeDisplayPath(fname.absFileName()));
1511 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1513 if (params().compressed) {
1514 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1515 retval = ofs && write(ofs);
1517 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1518 retval = ofs && write(ofs);
1522 message(str + _(" could not write file!"));
1527 // removeAutosaveFile();
1530 message(str + _(" done."));
1536 docstring Buffer::emergencyWrite()
1538 // No need to save if the buffer has not changed.
1542 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1544 docstring user_message = bformat(
1545 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1547 // We try to save three places:
1548 // 1) Same place as document. Unless it is an unnamed doc.
1550 string s = absFileName();
1553 if (writeFile(FileName(s))) {
1555 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1556 return user_message;
1558 user_message += " " + _("Save failed! Trying again...\n");
1562 // 2) In HOME directory.
1563 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1565 lyxerr << ' ' << s << endl;
1566 if (writeFile(FileName(s))) {
1568 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1569 return user_message;
1572 user_message += " " + _("Save failed! Trying yet again...\n");
1574 // 3) In "/tmp" directory.
1575 // MakeAbsPath to prepend the current
1576 // drive letter on OS/2
1577 s = addName(package().temp_dir().absFileName(), absFileName());
1579 lyxerr << ' ' << s << endl;
1580 if (writeFile(FileName(s))) {
1582 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1583 return user_message;
1586 user_message += " " + _("Save failed! Bummer. Document is lost.");
1589 return user_message;
1593 bool Buffer::write(ostream & ofs) const
1596 // Use the standard "C" locale for file output.
1597 ofs.imbue(locale::classic());
1600 // The top of the file should not be written by params().
1602 // write out a comment in the top of the file
1603 // Important: Keep the version formatting in sync with lyx2lyx and
1604 // tex2lyx (bug 7951)
1605 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1606 << " created this file. For more info see http://www.lyx.org/\n"
1607 << "\\lyxformat " << LYX_FORMAT << "\n"
1608 << "\\begin_document\n";
1610 /// For each author, set 'used' to true if there is a change
1611 /// by this author in the document; otherwise set it to 'false'.
1612 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1613 AuthorList::Authors::const_iterator a_end = params().authors().end();
1614 for (; a_it != a_end; ++a_it)
1615 a_it->setUsed(false);
1617 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1618 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1619 for ( ; it != end; ++it)
1620 it->checkAuthors(params().authors());
1622 // now write out the buffer parameters.
1623 ofs << "\\begin_header\n";
1624 params().writeFile(ofs, this);
1625 ofs << "\\end_header\n";
1628 ofs << "\n\\begin_body\n";
1630 ofs << "\n\\end_body\n";
1632 // Write marker that shows file is complete
1633 ofs << "\\end_document" << endl;
1635 // Shouldn't really be needed....
1638 // how to check if close went ok?
1639 // Following is an attempt... (BE 20001011)
1641 // good() returns false if any error occurred, including some
1642 // formatting error.
1643 // bad() returns true if something bad happened in the buffer,
1644 // which should include file system full errors.
1649 lyxerr << "File was not closed properly." << endl;
1656 bool Buffer::makeLaTeXFile(FileName const & fname,
1657 string const & original_path,
1658 OutputParams const & runparams_in,
1659 OutputWhat output) const
1661 OutputParams runparams = runparams_in;
1663 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1664 // Check here, because the "flavor" is not known in BufferParams::encoding()
1665 // (power users can override this safety measure selecting "utf8-plain").
1666 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1667 && (runparams.encoding->name() != "utf8-plain"))
1668 runparams.encoding = encodings.fromLyXName("ascii");
1670 string const encoding = runparams.encoding->iconvName();
1671 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1674 try { ofs.reset(encoding); }
1675 catch (iconv_codecvt_facet_exception const & e) {
1676 lyxerr << "Caught iconv exception: " << e.what() << endl;
1677 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1678 "verify that the support software for your encoding (%1$s) is "
1679 "properly installed"), from_ascii(encoding)));
1682 if (!openFileWrite(ofs, fname))
1685 ErrorList & errorList = d->errorLists["Export"];
1687 bool failed_export = false;
1690 // make sure we are ready to export
1691 // this needs to be done before we validate
1692 // FIXME Do we need to do this all the time? I.e., in children
1693 // of a master we are exporting?
1695 updateMacroInstances(OutputUpdate);
1698 writeLaTeXSource(os, original_path, runparams, output);
1700 catch (EncodingException const & e) {
1701 docstring const failed(1, e.failed_char);
1703 oss << "0x" << hex << e.failed_char << dec;
1704 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1705 " (code point %2$s)"),
1706 failed, from_utf8(oss.str()));
1707 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1708 "representable in the chosen encoding.\n"
1709 "Changing the document encoding to utf8 could help."),
1710 e.par_id, e.pos, e.pos + 1));
1711 failed_export = true;
1713 catch (iconv_codecvt_facet_exception const & e) {
1714 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1715 _(e.what()), -1, 0, 0));
1716 failed_export = true;
1718 catch (exception const & e) {
1719 errorList.push_back(ErrorItem(_("conversion failed"),
1720 _(e.what()), -1, 0, 0));
1721 failed_export = true;
1724 lyxerr << "Caught some really weird exception..." << endl;
1728 d->texrow = move(os.texrow());
1732 failed_export = true;
1733 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1736 if (runparams_in.silent)
1740 return !failed_export;
1744 void Buffer::writeLaTeXSource(otexstream & os,
1745 string const & original_path,
1746 OutputParams const & runparams_in,
1747 OutputWhat output) const
1749 // The child documents, if any, shall be already loaded at this point.
1751 OutputParams runparams = runparams_in;
1753 // XeTeX with TeX fonts is only safe with ASCII encoding,
1754 // Check here, because the "flavor" is not known in BufferParams::encoding()
1755 // (power users can override this safety measure selecting "utf8-plain").
1756 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1757 && (runparams.encoding->name() != "utf8-plain"))
1758 runparams.encoding = encodings.fromLyXName("ascii");
1759 // FIXME: when only the current paragraph is shown, this is ignored
1760 // (or not reached) and characters encodable in the current
1761 // encoding are not converted to ASCII-representation.
1763 // If we are compiling a file standalone, even if this is the
1764 // child of some other buffer, let's cut the link here, so the
1765 // file is really independent and no concurring settings from
1766 // the master (e.g. branch state) interfere (see #8100).
1767 if (!runparams.is_child)
1768 d->ignore_parent = true;
1770 // Classify the unicode characters appearing in math insets
1771 BufferEncodings::initUnicodeMath(*this);
1773 // validate the buffer.
1774 LYXERR(Debug::LATEX, " Validating buffer...");
1775 LaTeXFeatures features(*this, params(), runparams);
1777 // This is only set once per document (in master)
1778 if (!runparams.is_child)
1779 runparams.use_polyglossia = features.usePolyglossia();
1780 LYXERR(Debug::LATEX, " Buffer validation done.");
1782 bool const output_preamble =
1783 output == FullSource || output == OnlyPreamble;
1784 bool const output_body =
1785 output == FullSource || output == OnlyBody;
1787 // The starting paragraph of the coming rows is the
1788 // first paragraph of the document. (Asger)
1789 if (output_preamble && runparams.nice) {
1790 os << "%% LyX " << lyx_version << " created this file. "
1791 "For more info, see http://www.lyx.org/.\n"
1792 "%% Do not edit unless you really know what "
1795 LYXERR(Debug::INFO, "lyx document header finished");
1797 // There are a few differences between nice LaTeX and usual files:
1798 // usual files have \batchmode and special input@path to allow
1799 // inclusion of figures specified by an explicitly relative path
1800 // (i.e., a path starting with './' or '../') with either \input or
1801 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1802 // input@path is set when the actual parameter original_path is set.
1803 // This is done for usual tex-file, but not for nice-latex-file.
1804 // (Matthias 250696)
1805 // Note that input@path is only needed for something the user does
1806 // in the preamble, included .tex files or ERT, files included by
1807 // LyX work without it.
1808 if (output_preamble) {
1809 if (!runparams.nice) {
1810 // code for usual, NOT nice-latex-file
1811 os << "\\batchmode\n"; // changed from \nonstopmode
1813 if (!original_path.empty()) {
1815 // We don't know the encoding of inputpath
1816 docstring const inputpath = from_utf8(original_path);
1817 docstring uncodable_glyphs;
1818 Encoding const * const enc = runparams.encoding;
1820 for (size_t n = 0; n < inputpath.size(); ++n) {
1821 if (!enc->encodable(inputpath[n])) {
1822 docstring const glyph(1, inputpath[n]);
1823 LYXERR0("Uncodable character '"
1825 << "' in input path!");
1826 uncodable_glyphs += glyph;
1831 // warn user if we found uncodable glyphs.
1832 if (!uncodable_glyphs.empty()) {
1833 frontend::Alert::warning(
1834 _("Uncodable character in file path"),
1836 _("The path of your document\n"
1838 "contains glyphs that are unknown "
1839 "in the current document encoding "
1840 "(namely %2$s). This may result in "
1841 "incomplete output, unless "
1842 "TEXINPUTS contains the document "
1843 "directory and you don't use "
1844 "explicitly relative paths (i.e., "
1845 "paths starting with './' or "
1846 "'../') in the preamble or in ERT."
1847 "\n\nIn case of problems, choose "
1848 "an appropriate document encoding\n"
1849 "(such as utf8) or change the "
1851 inputpath, uncodable_glyphs));
1854 support::latex_path(original_path);
1855 if (contains(docdir, '#')) {
1856 docdir = subst(docdir, "#", "\\#");
1857 os << "\\catcode`\\#=11"
1858 "\\def\\#{#}\\catcode`\\#=6\n";
1860 if (contains(docdir, '%')) {
1861 docdir = subst(docdir, "%", "\\%");
1862 os << "\\catcode`\\%=11"
1863 "\\def\\%{%}\\catcode`\\%=14\n";
1865 os << "\\makeatletter\n"
1866 << "\\def\\input@path{{"
1868 << "\\makeatother\n";
1872 // get parent macros (if this buffer has a parent) which will be
1873 // written at the document begin further down.
1874 MacroSet parentMacros;
1875 listParentMacros(parentMacros, features);
1877 // Write the preamble
1878 runparams.use_babel = params().writeLaTeX(os, features,
1879 d->filename.onlyPath());
1881 // Japanese might be required only in some children of a document,
1882 // but once required, we must keep use_japanese true.
1883 runparams.use_japanese |= features.isRequired("japanese");
1886 // Restore the parenthood if needed
1887 if (!runparams.is_child)
1888 d->ignore_parent = false;
1893 os << "\\begin{document}\n";
1895 // output the parent macros
1896 MacroSet::iterator it = parentMacros.begin();
1897 MacroSet::iterator end = parentMacros.end();
1898 for (; it != end; ++it) {
1899 int num_lines = (*it)->write(os.os(), true);
1900 os.texrow().newlines(num_lines);
1903 } // output_preamble
1905 os.texrow().start(paragraphs().begin()->id(), 0);
1907 LYXERR(Debug::INFO, "preamble finished, now the body.");
1910 latexParagraphs(*this, text(), os, runparams);
1912 // Restore the parenthood if needed
1913 if (!runparams.is_child)
1914 d->ignore_parent = false;
1916 // add this just in case after all the paragraphs
1919 if (output_preamble) {
1920 os << "\\end{document}\n";
1921 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1923 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1925 runparams_in.encoding = runparams.encoding;
1927 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1928 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1932 void Buffer::makeDocBookFile(FileName const & fname,
1933 OutputParams const & runparams,
1934 OutputWhat output) const
1936 LYXERR(Debug::LATEX, "makeDocBookFile...");
1939 if (!openFileWrite(ofs, fname))
1942 // make sure we are ready to export
1943 // this needs to be done before we validate
1945 updateMacroInstances(OutputUpdate);
1947 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1951 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1955 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1956 OutputParams const & runparams,
1957 OutputWhat output) const
1959 LaTeXFeatures features(*this, params(), runparams);
1964 DocumentClass const & tclass = params().documentClass();
1965 string const & top_element = tclass.latexname();
1967 bool const output_preamble =
1968 output == FullSource || output == OnlyPreamble;
1969 bool const output_body =
1970 output == FullSource || output == OnlyBody;
1972 if (output_preamble) {
1973 if (runparams.flavor == OutputParams::XML)
1974 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1977 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1980 if (! tclass.class_header().empty())
1981 os << from_ascii(tclass.class_header());
1982 else if (runparams.flavor == OutputParams::XML)
1983 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1984 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1986 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1988 docstring preamble = from_utf8(params().preamble);
1989 if (runparams.flavor != OutputParams::XML ) {
1990 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1991 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1992 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1993 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1996 string const name = runparams.nice
1997 ? changeExtension(absFileName(), ".sgml") : fname;
1998 preamble += features.getIncludedFiles(name);
1999 preamble += features.getLyXSGMLEntities();
2001 if (!preamble.empty()) {
2002 os << "\n [ " << preamble << " ]";
2008 string top = top_element;
2010 if (runparams.flavor == OutputParams::XML)
2011 top += params().language->code();
2013 top += params().language->code().substr(0, 2);
2016 if (!params().options.empty()) {
2018 top += params().options;
2021 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2022 << " file was created by LyX " << lyx_version
2023 << "\n See http://www.lyx.org/ for more information -->\n";
2025 params().documentClass().counters().reset();
2027 sgml::openTag(os, top);
2029 docbookParagraphs(text(), *this, os, runparams);
2030 sgml::closeTag(os, top_element);
2035 void Buffer::makeLyXHTMLFile(FileName const & fname,
2036 OutputParams const & runparams) const
2038 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2041 if (!openFileWrite(ofs, fname))
2044 // make sure we are ready to export
2045 // this has to be done before we validate
2046 updateBuffer(UpdateMaster, OutputUpdate);
2047 updateMacroInstances(OutputUpdate);
2049 writeLyXHTMLSource(ofs, runparams, FullSource);
2053 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2057 void Buffer::writeLyXHTMLSource(odocstream & os,
2058 OutputParams const & runparams,
2059 OutputWhat output) const
2061 LaTeXFeatures features(*this, params(), runparams);
2063 d->bibinfo_.makeCitationLabels(*this);
2065 bool const output_preamble =
2066 output == FullSource || output == OnlyPreamble;
2067 bool const output_body =
2068 output == FullSource || output == OnlyBody || output == IncludedFile;
2070 if (output_preamble) {
2071 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2072 << "<!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"
2073 // FIXME Language should be set properly.
2074 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2076 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2077 // FIXME Presumably need to set this right
2078 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2080 docstring const & doctitle = features.htmlTitle();
2082 << (doctitle.empty() ?
2083 from_ascii("LyX Document") :
2084 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2087 docstring styles = features.getTClassHTMLPreamble();
2088 if (!styles.empty())
2089 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2091 styles = from_utf8(features.getPreambleSnippets());
2092 if (!styles.empty())
2093 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2095 // we will collect CSS information in a stream, and then output it
2096 // either here, as part of the header, or else in a separate file.
2097 odocstringstream css;
2098 styles = from_utf8(features.getCSSSnippets());
2099 if (!styles.empty())
2100 css << "/* LyX Provided Styles */\n" << styles << '\n';
2102 styles = features.getTClassHTMLStyles();
2103 if (!styles.empty())
2104 css << "/* Layout-provided Styles */\n" << styles << '\n';
2106 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2107 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2108 if (needfg || needbg) {
2109 css << "\nbody {\n";
2112 << from_ascii(X11hexname(params().fontcolor))
2115 css << " background-color: "
2116 << from_ascii(X11hexname(params().backgroundcolor))
2121 docstring const dstyles = css.str();
2122 if (!dstyles.empty()) {
2123 bool written = false;
2124 if (params().html_css_as_file) {
2125 // open a file for CSS info
2127 string const fcssname = addName(temppath(), "docstyle.css");
2128 FileName const fcssfile = FileName(fcssname);
2129 if (openFileWrite(ocss, fcssfile)) {
2133 // write link to header
2134 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2136 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2139 // we are here if the CSS is supposed to be written to the header
2140 // or if we failed to write it to an external file.
2142 os << "<style type='text/css'>\n"
2151 bool const output_body_tag = (output != IncludedFile);
2152 if (output_body_tag)
2153 os << "<body dir=\"auto\">\n";
2155 if (output != IncludedFile)
2156 // if we're an included file, the counters are in the master.
2157 params().documentClass().counters().reset();
2158 xhtmlParagraphs(text(), *this, xs, runparams);
2159 if (output_body_tag)
2163 if (output_preamble)
2168 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2169 // Other flags: -wall -v0 -x
2170 int Buffer::runChktex()
2174 // get LaTeX-Filename
2175 FileName const path(temppath());
2176 string const name = addName(path.absFileName(), latexName());
2177 string const org_path = filePath();
2179 PathChanger p(path); // path to LaTeX file
2180 message(_("Running chktex..."));
2182 // Generate the LaTeX file if neccessary
2183 OutputParams runparams(¶ms().encoding());
2184 runparams.flavor = OutputParams::LATEX;
2185 runparams.nice = false;
2186 runparams.linelen = lyxrc.plaintext_linelen;
2187 makeLaTeXFile(FileName(name), org_path, runparams);
2190 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2191 int const res = chktex.run(terr); // run chktex
2194 Alert::error(_("chktex failure"),
2195 _("Could not run chktex successfully."));
2197 ErrorList & errlist = d->errorLists["ChkTeX"];
2199 bufferErrors(terr, errlist);
2204 if (runparams.silent)
2205 d->errorLists["ChkTeX"].clear();
2213 void Buffer::validate(LaTeXFeatures & features) const
2215 // Validate the buffer params, but not for included
2216 // files, since they also use the parent buffer's
2218 if (!features.runparams().is_child)
2219 params().validate(features);
2221 for (Paragraph const & p : paragraphs())
2222 p.validate(features);
2224 if (lyxerr.debugging(Debug::LATEX)) {
2225 features.showStruct();
2230 void Buffer::getLabelList(vector<docstring> & list) const
2232 // If this is a child document, use the master's list instead.
2234 masterBuffer()->getLabelList(list);
2239 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2240 Toc::const_iterator toc_it = toc->begin();
2241 Toc::const_iterator end = toc->end();
2242 for (; toc_it != end; ++toc_it) {
2243 if (toc_it->depth() == 0)
2244 list.push_back(toc_it->str());
2249 void Buffer::updateBibfilesCache(UpdateScope scope) const
2251 // FIXME This is probably unnecssary, given where we call this.
2252 // If this is a child document, use the parent's cache instead.
2253 if (parent() && scope != UpdateChildOnly) {
2254 masterBuffer()->updateBibfilesCache();
2258 d->bibfiles_cache_.clear();
2259 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2260 if (it->lyxCode() == BIBTEX_CODE) {
2261 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2262 support::FileNameList const bibfiles = inset.getBibFiles();
2263 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2266 } else if (it->lyxCode() == INCLUDE_CODE) {
2267 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2268 Buffer const * const incbuf = inset.getChildBuffer();
2271 support::FileNameList const & bibfiles =
2272 incbuf->getBibfilesCache(UpdateChildOnly);
2273 if (!bibfiles.empty()) {
2274 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2280 d->bibfile_cache_valid_ = true;
2281 d->bibinfo_cache_valid_ = false;
2282 d->cite_labels_valid_ = false;
2286 void Buffer::invalidateBibinfoCache() const
2288 d->bibinfo_cache_valid_ = false;
2289 d->cite_labels_valid_ = false;
2290 // also invalidate the cache for the parent buffer
2291 Buffer const * const pbuf = d->parent();
2293 pbuf->invalidateBibinfoCache();
2297 void Buffer::invalidateBibfileCache() const
2299 d->bibfile_cache_valid_ = false;
2300 d->bibinfo_cache_valid_ = false;
2301 d->cite_labels_valid_ = false;
2302 // also invalidate the cache for the parent buffer
2303 Buffer const * const pbuf = d->parent();
2305 pbuf->invalidateBibfileCache();
2309 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2311 // FIXME This is probably unnecessary, given where we call this.
2312 // If this is a child document, use the master's cache instead.
2313 Buffer const * const pbuf = masterBuffer();
2314 if (pbuf != this && scope != UpdateChildOnly)
2315 return pbuf->getBibfilesCache();
2317 if (!d->bibfile_cache_valid_)
2318 this->updateBibfilesCache(scope);
2320 return d->bibfiles_cache_;
2324 BiblioInfo const & Buffer::masterBibInfo() const
2326 Buffer const * const tmp = masterBuffer();
2328 return tmp->masterBibInfo();
2333 void Buffer::checkIfBibInfoCacheIsValid() const
2335 // use the master's cache
2336 Buffer const * const tmp = masterBuffer();
2338 tmp->checkIfBibInfoCacheIsValid();
2342 // compare the cached timestamps with the actual ones.
2343 FileNameList const & bibfiles_cache = getBibfilesCache();
2344 FileNameList::const_iterator ei = bibfiles_cache.begin();
2345 FileNameList::const_iterator en = bibfiles_cache.end();
2346 for (; ei != en; ++ ei) {
2347 time_t lastw = ei->lastModified();
2348 time_t prevw = d->bibfile_status_[*ei];
2349 if (lastw != prevw) {
2350 d->bibinfo_cache_valid_ = false;
2351 d->cite_labels_valid_ = false;
2352 d->bibfile_status_[*ei] = lastw;
2358 void Buffer::reloadBibInfoCache() const
2360 // use the master's cache
2361 Buffer const * const tmp = masterBuffer();
2363 tmp->reloadBibInfoCache();
2367 checkIfBibInfoCacheIsValid();
2368 if (d->bibinfo_cache_valid_)
2371 d->bibinfo_.clear();
2373 d->bibinfo_cache_valid_ = true;
2377 void Buffer::collectBibKeys() const
2379 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2380 it->collectBibKeys(it);
2384 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2386 Buffer const * tmp = masterBuffer();
2387 BiblioInfo & masterbi = (tmp == this) ?
2388 d->bibinfo_ : tmp->d->bibinfo_;
2389 masterbi.mergeBiblioInfo(bi);
2393 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2395 Buffer const * tmp = masterBuffer();
2396 BiblioInfo & masterbi = (tmp == this) ?
2397 d->bibinfo_ : tmp->d->bibinfo_;
2402 void Buffer::makeCitationLabels() const
2404 Buffer const * const master = masterBuffer();
2405 return d->bibinfo_.makeCitationLabels(*master);
2409 bool Buffer::citeLabelsValid() const
2411 return masterBuffer()->d->cite_labels_valid_;
2415 void Buffer::removeBiblioTempFiles() const
2417 // We remove files that contain LaTeX commands specific to the
2418 // particular bibliographic style being used, in order to avoid
2419 // LaTeX errors when we switch style.
2420 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2421 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2422 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2423 aux_file.removeFile();
2424 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2425 bbl_file.removeFile();
2426 // Also for the parent buffer
2427 Buffer const * const pbuf = parent();
2429 pbuf->removeBiblioTempFiles();
2433 bool Buffer::isDepClean(string const & name) const
2435 DepClean::const_iterator const it = d->dep_clean.find(name);
2436 if (it == d->dep_clean.end())
2442 void Buffer::markDepClean(string const & name)
2444 d->dep_clean[name] = true;
2448 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2451 // FIXME? if there is an Buffer LFUN that can be dispatched even
2452 // if internal, put a switch '(cmd.action)' here.
2458 switch (cmd.action()) {
2460 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2461 flag.setOnOff(isReadonly());
2464 // FIXME: There is need for a command-line import.
2465 //case LFUN_BUFFER_IMPORT:
2467 case LFUN_BUFFER_AUTO_SAVE:
2470 case LFUN_BUFFER_EXPORT_CUSTOM:
2471 // FIXME: Nothing to check here?
2474 case LFUN_BUFFER_EXPORT: {
2475 docstring const arg = cmd.argument();
2476 if (arg == "custom") {
2480 string format = to_utf8(arg);
2481 size_t pos = format.find(' ');
2482 if (pos != string::npos)
2483 format = format.substr(0, pos);
2484 enable = params().isExportable(format);
2486 flag.message(bformat(
2487 _("Don't know how to export to format: %1$s"), arg));
2491 case LFUN_BUFFER_CHKTEX:
2492 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2495 case LFUN_BUILD_PROGRAM:
2496 enable = params().isExportable("program");
2499 case LFUN_BRANCH_ACTIVATE:
2500 case LFUN_BRANCH_DEACTIVATE:
2501 case LFUN_BRANCH_MASTER_ACTIVATE:
2502 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2503 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2504 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2505 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2506 : params().branchlist();
2507 docstring const branchName = cmd.argument();
2508 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2512 case LFUN_BRANCH_ADD:
2513 case LFUN_BRANCHES_RENAME:
2514 // if no Buffer is present, then of course we won't be called!
2517 case LFUN_BUFFER_LANGUAGE:
2518 enable = !isReadonly();
2521 case LFUN_BUFFER_VIEW_CACHE:
2522 (d->preview_file_).refresh();
2523 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2526 case LFUN_CHANGES_TRACK:
2527 flag.setEnabled(true);
2528 flag.setOnOff(params().track_changes);
2531 case LFUN_CHANGES_OUTPUT:
2532 flag.setEnabled(true);
2533 flag.setOnOff(params().output_changes);
2536 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
2537 flag.setOnOff(params().compressed);
2541 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
2542 flag.setOnOff(params().output_sync);
2549 flag.setEnabled(enable);
2554 void Buffer::dispatch(string const & command, DispatchResult & result)
2556 return dispatch(lyxaction.lookupFunc(command), result);
2560 // NOTE We can end up here even if we have no GUI, because we are called
2561 // by LyX::exec to handled command-line requests. So we may need to check
2562 // whether we have a GUI or not. The boolean use_gui holds this information.
2563 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2566 // FIXME? if there is an Buffer LFUN that can be dispatched even
2567 // if internal, put a switch '(cmd.action())' here.
2568 dr.dispatched(false);
2571 string const argument = to_utf8(func.argument());
2572 // We'll set this back to false if need be.
2573 bool dispatched = true;
2574 undo().beginUndoGroup();
2576 switch (func.action()) {
2577 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2578 if (lyxvc().inUse()) {
2579 string log = lyxvc().toggleReadOnly();
2584 setReadonly(!isReadonly());
2587 case LFUN_BUFFER_EXPORT: {
2588 ExportStatus const status = doExport(argument, false);
2589 dr.setError(status != ExportSuccess);
2590 if (status != ExportSuccess)
2591 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2596 case LFUN_BUILD_PROGRAM: {
2597 ExportStatus const status = doExport("program", true);
2598 dr.setError(status != ExportSuccess);
2599 if (status != ExportSuccess)
2600 dr.setMessage(_("Error generating literate programming code."));
2604 case LFUN_BUFFER_CHKTEX:
2608 case LFUN_BUFFER_EXPORT_CUSTOM: {
2610 string command = split(argument, format_name, ' ');
2611 Format const * format = formats.getFormat(format_name);
2613 lyxerr << "Format \"" << format_name
2614 << "\" not recognized!"
2619 // The name of the file created by the conversion process
2622 // Output to filename
2623 if (format->name() == "lyx") {
2624 string const latexname = latexName(false);
2625 filename = changeExtension(latexname,
2626 format->extension());
2627 filename = addName(temppath(), filename);
2629 if (!writeFile(FileName(filename)))
2633 doExport(format_name, true, filename);
2636 // Substitute $$FName for filename
2637 if (!contains(command, "$$FName"))
2638 command = "( " + command + " ) < $$FName";
2639 command = subst(command, "$$FName", filename);
2641 // Execute the command in the background
2643 call.startscript(Systemcall::DontWait, command,
2644 filePath(), layoutPos());
2648 // FIXME: There is need for a command-line import.
2650 case LFUN_BUFFER_IMPORT:
2655 case LFUN_BUFFER_AUTO_SAVE:
2657 resetAutosaveTimers();
2660 case LFUN_BRANCH_ACTIVATE:
2661 case LFUN_BRANCH_DEACTIVATE:
2662 case LFUN_BRANCH_MASTER_ACTIVATE:
2663 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2664 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2665 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2666 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2669 docstring const branch_name = func.argument();
2670 // the case without a branch name is handled elsewhere
2671 if (branch_name.empty()) {
2675 Branch * branch = buf->params().branchlist().find(branch_name);
2677 LYXERR0("Branch " << branch_name << " does not exist.");
2679 docstring const msg =
2680 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2684 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2685 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2686 if (branch->isSelected() != activate) {
2687 buf->undo().recordUndoBufferParams(CursorData());
2688 branch->setSelected(activate);
2690 dr.screenUpdate(Update::Force);
2691 dr.forceBufferUpdate();
2696 case LFUN_BRANCH_ADD: {
2697 docstring branch_name = func.argument();
2698 if (branch_name.empty()) {
2702 BranchList & branch_list = params().branchlist();
2703 vector<docstring> const branches =
2704 getVectorFromString(branch_name, branch_list.separator());
2706 for (vector<docstring>::const_iterator it = branches.begin();
2707 it != branches.end(); ++it) {
2709 Branch * branch = branch_list.find(branch_name);
2711 LYXERR0("Branch " << branch_name << " already exists.");
2715 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2717 undo().recordUndoBufferParams(CursorData());
2718 branch_list.add(branch_name);
2719 branch = branch_list.find(branch_name);
2720 string const x11hexname = X11hexname(branch->color());
2721 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2722 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2724 dr.screenUpdate(Update::Force);
2732 case LFUN_BRANCHES_RENAME: {
2733 if (func.argument().empty())
2736 docstring const oldname = from_utf8(func.getArg(0));
2737 docstring const newname = from_utf8(func.getArg(1));
2738 InsetIterator it = inset_iterator_begin(inset());
2739 InsetIterator const end = inset_iterator_end(inset());
2740 bool success = false;
2741 for (; it != end; ++it) {
2742 if (it->lyxCode() == BRANCH_CODE) {
2743 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2744 if (ins.branch() == oldname) {
2745 undo().recordUndo(CursorData(it));
2746 ins.rename(newname);
2751 if (it->lyxCode() == INCLUDE_CODE) {
2752 // get buffer of external file
2753 InsetInclude const & ins =
2754 static_cast<InsetInclude const &>(*it);
2755 Buffer * child = ins.getChildBuffer();
2758 child->dispatch(func, dr);
2763 dr.screenUpdate(Update::Force);
2764 dr.forceBufferUpdate();
2769 case LFUN_BUFFER_VIEW_CACHE:
2770 if (!formats.view(*this, d->preview_file_,
2771 d->preview_format_))
2772 dr.setMessage(_("Error viewing the output file."));
2775 case LFUN_CHANGES_TRACK:
2776 if (params().save_transient_properties)
2777 undo().recordUndoBufferParams(CursorData());
2778 params().track_changes = !params().track_changes;
2779 if (!params().track_changes)
2780 dr.forceChangesUpdate();
2783 case LFUN_CHANGES_OUTPUT:
2784 if (params().save_transient_properties)
2785 undo().recordUndoBufferParams(CursorData());
2786 params().output_changes = !params().output_changes;
2787 if (params().output_changes) {
2788 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2789 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2790 LaTeXFeatures::isAvailable("xcolor");
2792 if (!dvipost && !xcolorulem) {
2793 Alert::warning(_("Changes not shown in LaTeX output"),
2794 _("Changes will not be highlighted in LaTeX output, "
2795 "because neither dvipost nor xcolor/ulem are installed.\n"
2796 "Please install these packages or redefine "
2797 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2798 } else if (!xcolorulem) {
2799 Alert::warning(_("Changes not shown in LaTeX output"),
2800 _("Changes will not be highlighted in LaTeX output "
2801 "when using pdflatex, because xcolor and ulem are not installed.\n"
2802 "Please install both packages or redefine "
2803 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2808 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2809 // turn compression on/off
2810 undo().recordUndoBufferParams(CursorData());
2811 params().compressed = !params().compressed;
2814 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2815 undo().recordUndoBufferParams(CursorData());
2816 params().output_sync = !params().output_sync;
2823 dr.dispatched(dispatched);
2824 undo().endUndoGroup();
2828 void Buffer::changeLanguage(Language const * from, Language const * to)
2830 LASSERT(from, return);
2831 LASSERT(to, return);
2833 for_each(par_iterator_begin(),
2835 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2839 bool Buffer::isMultiLingual() const
2841 ParConstIterator end = par_iterator_end();
2842 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2843 if (it->isMultiLingual(params()))
2850 std::set<Language const *> Buffer::getLanguages() const
2852 std::set<Language const *> languages;
2853 getLanguages(languages);
2858 void Buffer::getLanguages(std::set<Language const *> & languages) const
2860 ParConstIterator end = par_iterator_end();
2861 // add the buffer language, even if it's not actively used
2862 languages.insert(language());
2863 // iterate over the paragraphs
2864 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2865 it->getLanguages(languages);
2867 ListOfBuffers clist = getDescendents();
2868 ListOfBuffers::const_iterator cit = clist.begin();
2869 ListOfBuffers::const_iterator const cen = clist.end();
2870 for (; cit != cen; ++cit)
2871 (*cit)->getLanguages(languages);
2875 DocIterator Buffer::getParFromID(int const id) const
2877 Buffer * buf = const_cast<Buffer *>(this);
2879 // This means non-existent
2880 return doc_iterator_end(buf);
2882 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2883 if (it.paragraph().id() == id)
2886 return doc_iterator_end(buf);
2890 bool Buffer::hasParWithID(int const id) const
2892 return !getParFromID(id).atEnd();
2896 ParIterator Buffer::par_iterator_begin()
2898 return ParIterator(doc_iterator_begin(this));
2902 ParIterator Buffer::par_iterator_end()
2904 return ParIterator(doc_iterator_end(this));
2908 ParConstIterator Buffer::par_iterator_begin() const
2910 return ParConstIterator(doc_iterator_begin(this));
2914 ParConstIterator Buffer::par_iterator_end() const
2916 return ParConstIterator(doc_iterator_end(this));
2920 Language const * Buffer::language() const
2922 return params().language;
2926 docstring const Buffer::B_(string const & l10n) const
2928 return params().B_(l10n);
2932 bool Buffer::isClean() const
2934 return d->lyx_clean;
2938 bool Buffer::isExternallyModified(CheckMethod method) const
2940 LASSERT(d->filename.exists(), return false);
2941 // if method == timestamp, check timestamp before checksum
2942 return (method == checksum_method
2943 || d->timestamp_ != d->filename.lastModified())
2944 && d->checksum_ != d->filename.checksum();
2948 void Buffer::saveCheckSum() const
2950 FileName const & file = d->filename;
2953 if (file.exists()) {
2954 d->timestamp_ = file.lastModified();
2955 d->checksum_ = file.checksum();
2957 // in the case of save to a new file.
2964 void Buffer::markClean() const
2966 if (!d->lyx_clean) {
2967 d->lyx_clean = true;
2970 // if the .lyx file has been saved, we don't need an
2972 d->bak_clean = true;
2973 d->undo_.markDirty();
2977 void Buffer::setUnnamed(bool flag)
2983 bool Buffer::isUnnamed() const
2990 /// Don't check unnamed, here: isInternal() is used in
2991 /// newBuffer(), where the unnamed flag has not been set by anyone
2992 /// yet. Also, for an internal buffer, there should be no need for
2993 /// retrieving fileName() nor for checking if it is unnamed or not.
2994 bool Buffer::isInternal() const
2996 return d->internal_buffer;
3000 void Buffer::setInternal(bool flag)
3002 d->internal_buffer = flag;
3006 void Buffer::markDirty()
3009 d->lyx_clean = false;
3012 d->bak_clean = false;
3014 DepClean::iterator it = d->dep_clean.begin();
3015 DepClean::const_iterator const end = d->dep_clean.end();
3017 for (; it != end; ++it)
3022 FileName Buffer::fileName() const
3028 string Buffer::absFileName() const
3030 return d->filename.absFileName();
3034 string Buffer::filePath() const
3036 string const abs = d->filename.onlyPath().absFileName();
3039 int last = abs.length() - 1;
3041 return abs[last] == '/' ? abs : abs + '/';
3045 DocFileName Buffer::getReferencedFileName(string const & fn) const
3048 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3049 result.set(fn, filePath());
3051 // filePath() ends with a path separator
3052 FileName const test(filePath() + fn);
3054 result.set(fn, filePath());
3056 result.set(fn, params().origin);
3063 string Buffer::layoutPos() const
3065 return d->layout_position;
3069 void Buffer::setLayoutPos(string const & path)
3072 d->layout_position.clear();
3076 LATTEST(FileName::isAbsolute(path));
3078 d->layout_position =
3079 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3081 if (d->layout_position.empty())
3082 d->layout_position = ".";
3086 bool Buffer::isReadonly() const
3088 return d->read_only;
3092 void Buffer::setParent(Buffer const * buffer)
3094 // Avoids recursive include.
3095 d->setParent(buffer == this ? 0 : buffer);
3100 Buffer const * Buffer::parent() const
3106 ListOfBuffers Buffer::allRelatives() const
3108 ListOfBuffers lb = masterBuffer()->getDescendents();
3109 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3114 Buffer const * Buffer::masterBuffer() const
3116 // FIXME Should be make sure we are not in some kind
3117 // of recursive include? A -> B -> A will crash this.
3118 Buffer const * const pbuf = d->parent();
3122 return pbuf->masterBuffer();
3126 bool Buffer::isChild(Buffer * child) const
3128 return d->children_positions.find(child) != d->children_positions.end();
3132 DocIterator Buffer::firstChildPosition(Buffer const * child)
3134 Impl::BufferPositionMap::iterator it;
3135 it = d->children_positions.find(child);
3136 if (it == d->children_positions.end())
3137 return DocIterator(this);
3142 bool Buffer::hasChildren() const
3144 return !d->children_positions.empty();
3148 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3150 // loop over children
3151 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3152 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3153 for (; it != end; ++it) {
3154 Buffer * child = const_cast<Buffer *>(it->first);
3156 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3157 if (bit != clist.end())
3159 clist.push_back(child);
3161 // there might be grandchildren
3162 child->collectChildren(clist, true);
3167 ListOfBuffers Buffer::getChildren() const
3170 collectChildren(v, false);
3171 // Make sure we have not included ourselves.
3172 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3173 if (bit != v.end()) {
3174 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3181 ListOfBuffers Buffer::getDescendents() const
3184 collectChildren(v, true);
3185 // Make sure we have not included ourselves.
3186 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3187 if (bit != v.end()) {
3188 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3195 template<typename M>
3196 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3201 typename M::const_iterator it = m.lower_bound(x);
3202 if (it == m.begin())
3210 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3211 DocIterator const & pos) const
3213 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3215 // if paragraphs have no macro context set, pos will be empty
3219 // we haven't found anything yet
3220 DocIterator bestPos = owner_->par_iterator_begin();
3221 MacroData const * bestData = 0;
3223 // find macro definitions for name
3224 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3225 if (nameIt != macros.end()) {
3226 // find last definition in front of pos or at pos itself
3227 PositionScopeMacroMap::const_iterator it
3228 = greatest_below(nameIt->second, pos);
3229 if (it != nameIt->second.end()) {
3231 // scope ends behind pos?
3232 if (pos < it->second.scope) {
3233 // Looks good, remember this. If there
3234 // is no external macro behind this,
3235 // we found the right one already.
3236 bestPos = it->first;
3237 bestData = &it->second.macro;
3241 // try previous macro if there is one
3242 if (it == nameIt->second.begin())
3249 // find macros in included files
3250 PositionScopeBufferMap::const_iterator it
3251 = greatest_below(position_to_children, pos);
3252 if (it == position_to_children.end())
3253 // no children before
3257 // do we know something better (i.e. later) already?
3258 if (it->first < bestPos )
3261 // scope ends behind pos?
3262 if (pos < it->second.scope
3263 && (cloned_buffer_ ||
3264 theBufferList().isLoaded(it->second.buffer))) {
3265 // look for macro in external file
3267 MacroData const * data
3268 = it->second.buffer->getMacro(name, false);
3271 bestPos = it->first;
3277 // try previous file if there is one
3278 if (it == position_to_children.begin())
3283 // return the best macro we have found
3288 MacroData const * Buffer::getMacro(docstring const & name,
3289 DocIterator const & pos, bool global) const
3294 // query buffer macros
3295 MacroData const * data = d->getBufferMacro(name, pos);
3299 // If there is a master buffer, query that
3300 Buffer const * const pbuf = d->parent();
3302 d->macro_lock = true;
3303 MacroData const * macro = pbuf->getMacro(
3304 name, *this, false);
3305 d->macro_lock = false;
3311 data = MacroTable::globalMacros().get(name);
3320 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3322 // set scope end behind the last paragraph
3323 DocIterator scope = par_iterator_begin();
3324 scope.pit() = scope.lastpit() + 1;
3326 return getMacro(name, scope, global);
3330 MacroData const * Buffer::getMacro(docstring const & name,
3331 Buffer const & child, bool global) const
3333 // look where the child buffer is included first
3334 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3335 if (it == d->children_positions.end())
3338 // check for macros at the inclusion position
3339 return getMacro(name, it->second, global);
3343 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3345 pit_type const lastpit = it.lastpit();
3347 // look for macros in each paragraph
3348 while (it.pit() <= lastpit) {
3349 Paragraph & par = it.paragraph();
3351 // iterate over the insets of the current paragraph
3352 InsetList const & insets = par.insetList();
3353 InsetList::const_iterator iit = insets.begin();
3354 InsetList::const_iterator end = insets.end();
3355 for (; iit != end; ++iit) {
3356 it.pos() = iit->pos;
3358 // is it a nested text inset?
3359 if (iit->inset->asInsetText()) {
3360 // Inset needs its own scope?
3361 InsetText const * itext = iit->inset->asInsetText();
3362 bool newScope = itext->isMacroScope();
3364 // scope which ends just behind the inset
3365 DocIterator insetScope = it;
3368 // collect macros in inset
3369 it.push_back(CursorSlice(*iit->inset));
3370 updateMacros(it, newScope ? insetScope : scope);
3375 if (iit->inset->asInsetTabular()) {
3376 CursorSlice slice(*iit->inset);
3377 size_t const numcells = slice.nargs();
3378 for (; slice.idx() < numcells; slice.forwardIdx()) {
3379 it.push_back(slice);
3380 updateMacros(it, scope);
3386 // is it an external file?
3387 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3388 // get buffer of external file
3389 InsetInclude const & inset =
3390 static_cast<InsetInclude const &>(*iit->inset);
3392 Buffer * child = inset.getChildBuffer();
3397 // register its position, but only when it is
3398 // included first in the buffer
3399 if (children_positions.find(child) ==
3400 children_positions.end())
3401 children_positions[child] = it;
3403 // register child with its scope
3404 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3408 InsetMath * im = iit->inset->asInsetMath();
3409 if (doing_export && im) {
3410 InsetMathHull * hull = im->asHullInset();
3412 hull->recordLocation(it);
3415 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3419 MathMacroTemplate & macroTemplate =
3420 *iit->inset->asInsetMath()->asMacroTemplate();
3421 MacroContext mc(owner_, it);
3422 macroTemplate.updateToContext(mc);
3425 bool valid = macroTemplate.validMacro();
3426 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3427 // then the BufferView's cursor will be invalid in
3428 // some cases which leads to crashes.
3433 // FIXME (Abdel), I don't understand why we pass 'it' here
3434 // instead of 'macroTemplate' defined above... is this correct?
3435 macros[macroTemplate.name()][it] =
3436 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3446 void Buffer::updateMacros() const
3451 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3453 // start with empty table
3455 d->children_positions.clear();
3456 d->position_to_children.clear();
3458 // Iterate over buffer, starting with first paragraph
3459 // The scope must be bigger than any lookup DocIterator
3460 // later. For the global lookup, lastpit+1 is used, hence
3461 // we use lastpit+2 here.
3462 DocIterator it = par_iterator_begin();
3463 DocIterator outerScope = it;
3464 outerScope.pit() = outerScope.lastpit() + 2;
3465 d->updateMacros(it, outerScope);
3469 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3471 InsetIterator it = inset_iterator_begin(inset());
3472 InsetIterator const end = inset_iterator_end(inset());
3473 for (; it != end; ++it) {
3474 if (it->lyxCode() == BRANCH_CODE) {
3475 InsetBranch & br = static_cast<InsetBranch &>(*it);
3476 docstring const name = br.branch();
3477 if (!from_master && !params().branchlist().find(name))
3478 result.push_back(name);
3479 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3480 result.push_back(name);
3483 if (it->lyxCode() == INCLUDE_CODE) {
3484 // get buffer of external file
3485 InsetInclude const & ins =
3486 static_cast<InsetInclude const &>(*it);
3487 Buffer * child = ins.getChildBuffer();
3490 child->getUsedBranches(result, true);
3493 // remove duplicates
3498 void Buffer::updateMacroInstances(UpdateType utype) const
3500 LYXERR(Debug::MACROS, "updateMacroInstances for "
3501 << d->filename.onlyFileName());
3502 DocIterator it = doc_iterator_begin(this);
3504 DocIterator const end = doc_iterator_end(this);
3505 for (; it != end; it.forwardInset()) {
3506 // look for MathData cells in InsetMathNest insets
3507 InsetMath * minset = it.nextInset()->asInsetMath();
3511 // update macro in all cells of the InsetMathNest
3512 DocIterator::idx_type n = minset->nargs();
3513 MacroContext mc = MacroContext(this, it);
3514 for (DocIterator::idx_type i = 0; i < n; ++i) {
3515 MathData & data = minset->cell(i);
3516 data.updateMacros(0, mc, utype);
3522 void Buffer::listMacroNames(MacroNameSet & macros) const
3527 d->macro_lock = true;
3529 // loop over macro names
3530 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3531 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3532 for (; nameIt != nameEnd; ++nameIt)
3533 macros.insert(nameIt->first);
3535 // loop over children
3536 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3537 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3538 for (; it != end; ++it)
3539 it->first->listMacroNames(macros);
3542 Buffer const * const pbuf = d->parent();
3544 pbuf->listMacroNames(macros);
3546 d->macro_lock = false;
3550 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3552 Buffer const * const pbuf = d->parent();
3557 pbuf->listMacroNames(names);
3560 MacroNameSet::iterator it = names.begin();
3561 MacroNameSet::iterator end = names.end();
3562 for (; it != end; ++it) {
3564 MacroData const * data =
3565 pbuf->getMacro(*it, *this, false);
3567 macros.insert(data);
3569 // we cannot access the original MathMacroTemplate anymore
3570 // here to calls validate method. So we do its work here manually.
3571 // FIXME: somehow make the template accessible here.
3572 if (data->optionals() > 0)
3573 features.require("xargs");
3579 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3582 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3584 RefCache::iterator it = d->ref_cache_.find(label);
3585 if (it != d->ref_cache_.end())
3586 return it->second.second;
3588 static InsetLabel const * dummy_il = 0;
3589 static References const dummy_refs = References();
3590 it = d->ref_cache_.insert(
3591 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3592 return it->second.second;
3596 Buffer::References const & Buffer::references(docstring const & label) const
3598 return const_cast<Buffer *>(this)->getReferenceCache(label);
3602 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3604 References & refs = getReferenceCache(label);
3605 refs.push_back(make_pair(inset, it));
3609 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3611 masterBuffer()->d->ref_cache_[label].first = il;
3615 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3617 return masterBuffer()->d->ref_cache_[label].first;
3621 void Buffer::clearReferenceCache() const
3624 d->ref_cache_.clear();
3628 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3630 //FIXME: This does not work for child documents yet.
3631 reloadBibInfoCache();
3633 // Check if the label 'from' appears more than once
3634 BiblioInfo const & keys = masterBibInfo();
3635 BiblioInfo::const_iterator bit = keys.begin();
3636 BiblioInfo::const_iterator bend = keys.end();
3637 vector<docstring> labels;
3639 for (; bit != bend; ++bit)
3641 labels.push_back(bit->first);
3643 if (count(labels.begin(), labels.end(), from) > 1)
3646 string const paramName = "key";
3647 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3648 if (it->lyxCode() != CITE_CODE)
3650 InsetCommand * inset = it->asInsetCommand();
3651 docstring const oldValue = inset->getParam(paramName);
3652 if (oldValue == from)
3653 inset->setParam(paramName, to);
3657 // returns NULL if id-to-row conversion is unsupported
3658 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3659 pit_type par_begin, pit_type par_end,
3660 OutputWhat output, bool master) const
3662 unique_ptr<TexRow> texrow;
3663 OutputParams runparams(¶ms().encoding());
3664 runparams.nice = true;
3665 runparams.flavor = params().getOutputFlavor(format);
3666 runparams.linelen = lyxrc.plaintext_linelen;
3667 // No side effect of file copying and image conversion
3668 runparams.dryrun = true;
3670 if (output == CurrentParagraph) {
3671 runparams.par_begin = par_begin;
3672 runparams.par_end = par_end;
3673 if (par_begin + 1 == par_end) {
3675 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3679 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3680 convert<docstring>(par_begin),
3681 convert<docstring>(par_end - 1))
3684 // output paragraphs
3685 if (runparams.flavor == OutputParams::LYX) {
3686 Paragraph const & par = text().paragraphs()[par_begin];
3688 depth_type dt = par.getDepth();
3689 par.write(ods, params(), dt);
3690 os << from_utf8(ods.str());
3691 } else if (runparams.flavor == OutputParams::HTML) {
3693 setMathFlavor(runparams);
3694 xhtmlParagraphs(text(), *this, xs, runparams);
3695 } else if (runparams.flavor == OutputParams::TEXT) {
3697 // FIXME Handles only one paragraph, unlike the others.
3698 // Probably should have some routine with a signature like them.
3699 writePlaintextParagraph(*this,
3700 text().paragraphs()[par_begin], os, runparams, dummy);
3701 } else if (params().isDocBook()) {
3702 docbookParagraphs(text(), *this, os, runparams);
3704 // If we are previewing a paragraph, even if this is the
3705 // child of some other buffer, let's cut the link here,
3706 // so that no concurring settings from the master
3707 // (e.g. branch state) interfere (see #8101).
3709 d->ignore_parent = true;
3710 // We need to validate the Buffer params' features here
3711 // in order to know if we should output polyglossia
3712 // macros (instead of babel macros)
3713 LaTeXFeatures features(*this, params(), runparams);
3714 params().validate(features);
3715 runparams.use_polyglossia = features.usePolyglossia();
3716 // latex or literate
3719 ots.texrow().newlines(2);
3721 latexParagraphs(*this, text(), ots, runparams);
3722 texrow = ots.releaseTexRow();
3724 // Restore the parenthood
3726 d->ignore_parent = false;
3730 if (output == FullSource)
3731 os << _("Preview source code");
3732 else if (output == OnlyPreamble)
3733 os << _("Preview preamble");
3734 else if (output == OnlyBody)
3735 os << _("Preview body");
3737 if (runparams.flavor == OutputParams::LYX) {
3739 if (output == FullSource)
3741 else if (output == OnlyPreamble)
3742 params().writeFile(ods, this);
3743 else if (output == OnlyBody)
3745 os << from_utf8(ods.str());
3746 } else if (runparams.flavor == OutputParams::HTML) {
3747 writeLyXHTMLSource(os, runparams, output);
3748 } else if (runparams.flavor == OutputParams::TEXT) {
3749 if (output == OnlyPreamble) {
3750 os << "% "<< _("Plain text does not have a preamble.");
3752 writePlaintextFile(*this, os, runparams);
3753 } else if (params().isDocBook()) {
3754 writeDocBookSource(os, absFileName(), runparams, output);
3756 // latex or literate
3759 ots.texrow().newlines(2);
3761 runparams.is_child = true;
3762 writeLaTeXSource(ots, string(), runparams, output);
3763 texrow = ots.releaseTexRow();
3770 ErrorList & Buffer::errorList(string const & type) const
3772 return d->errorLists[type];
3776 void Buffer::updateTocItem(std::string const & type,
3777 DocIterator const & dit) const
3780 d->gui_->updateTocItem(type, dit);
3784 void Buffer::structureChanged() const
3787 d->gui_->structureChanged();
3791 void Buffer::errors(string const & err, bool from_master) const
3794 d->gui_->errors(err, from_master);
3798 void Buffer::message(docstring const & msg) const
3801 d->gui_->message(msg);
3805 void Buffer::setBusy(bool on) const
3808 d->gui_->setBusy(on);
3812 void Buffer::updateTitles() const
3815 d->wa_->updateTitles();
3819 void Buffer::resetAutosaveTimers() const
3822 d->gui_->resetAutosaveTimers();
3826 bool Buffer::hasGuiDelegate() const
3832 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3841 class AutoSaveBuffer : public ForkedProcess {
3844 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3845 : buffer_(buffer), fname_(fname) {}
3847 virtual shared_ptr<ForkedProcess> clone() const
3849 return make_shared<AutoSaveBuffer>(*this);
3854 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3855 from_utf8(fname_.absFileName())));
3856 return run(DontWait);
3860 virtual int generateChild();
3862 Buffer const & buffer_;
3867 int AutoSaveBuffer::generateChild()
3869 #if defined(__APPLE__)
3870 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3871 * We should use something else like threads.
3873 * Since I do not know how to determine at run time what is the OS X
3874 * version, I just disable forking altogether for now (JMarc)
3876 pid_t const pid = -1;
3878 // tmp_ret will be located (usually) in /tmp
3879 // will that be a problem?
3880 // Note that this calls ForkedCalls::fork(), so it's
3881 // ok cross-platform.
3882 pid_t const pid = fork();
3883 // If you want to debug the autosave
3884 // you should set pid to -1, and comment out the fork.
3885 if (pid != 0 && pid != -1)
3889 // pid = -1 signifies that lyx was unable
3890 // to fork. But we will do the save
3892 bool failed = false;
3893 TempFile tempfile("lyxautoXXXXXX.lyx");
3894 tempfile.setAutoRemove(false);
3895 FileName const tmp_ret = tempfile.name();
3896 if (!tmp_ret.empty()) {
3897 if (!buffer_.writeFile(tmp_ret))
3899 else if (!tmp_ret.moveTo(fname_))
3905 // failed to write/rename tmp_ret so try writing direct
3906 if (!buffer_.writeFile(fname_)) {
3907 // It is dangerous to do this in the child,
3908 // but safe in the parent, so...
3909 if (pid == -1) // emit message signal.
3910 buffer_.message(_("Autosave failed!"));
3914 if (pid == 0) // we are the child so...
3923 FileName Buffer::getEmergencyFileName() const
3925 return FileName(d->filename.absFileName() + ".emergency");
3929 FileName Buffer::getAutosaveFileName() const
3931 // if the document is unnamed try to save in the backup dir, else
3932 // in the default document path, and as a last try in the filePath,
3933 // which will most often be the temporary directory
3936 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3937 : lyxrc.backupdir_path;
3938 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3941 string const fname = "#" + d->filename.onlyFileName() + "#";
3943 return makeAbsPath(fname, fpath);
3947 void Buffer::removeAutosaveFile() const
3949 FileName const f = getAutosaveFileName();
3955 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3957 FileName const newauto = getAutosaveFileName();
3959 if (newauto != oldauto && oldauto.exists())
3960 if (!oldauto.moveTo(newauto))
3961 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3965 bool Buffer::autoSave() const
3967 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3968 if (buf->d->bak_clean || isReadonly())
3971 message(_("Autosaving current document..."));
3972 buf->d->bak_clean = true;
3974 FileName const fname = getAutosaveFileName();
3975 LASSERT(d->cloned_buffer_, return false);
3977 // If this buffer is cloned, we assume that
3978 // we are running in a separate thread already.
3979 TempFile tempfile("lyxautoXXXXXX.lyx");
3980 tempfile.setAutoRemove(false);
3981 FileName const tmp_ret = tempfile.name();
3982 if (!tmp_ret.empty()) {
3984 // assume successful write of tmp_ret
3985 if (tmp_ret.moveTo(fname))
3988 // failed to write/rename tmp_ret so try writing direct
3989 return writeFile(fname);
3993 void Buffer::setExportStatus(bool e) const
3995 d->doing_export = e;
3996 ListOfBuffers clist = getDescendents();
3997 ListOfBuffers::const_iterator cit = clist.begin();
3998 ListOfBuffers::const_iterator const cen = clist.end();
3999 for (; cit != cen; ++cit)
4000 (*cit)->d->doing_export = e;
4004 bool Buffer::isExporting() const
4006 return d->doing_export;
4010 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4014 return doExport(target, put_in_tempdir, result_file);
4017 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4018 string & result_file) const
4020 bool const update_unincluded =
4021 params().maintain_unincluded_children
4022 && !params().getIncludedChildren().empty();
4024 // (1) export with all included children (omit \includeonly)
4025 if (update_unincluded) {
4026 ExportStatus const status =
4027 doExport(target, put_in_tempdir, true, result_file);
4028 if (status != ExportSuccess)
4031 // (2) export with included children only
4032 return doExport(target, put_in_tempdir, false, result_file);
4036 void Buffer::setMathFlavor(OutputParams & op) const
4038 switch (params().html_math_output) {
4039 case BufferParams::MathML:
4040 op.math_flavor = OutputParams::MathAsMathML;
4042 case BufferParams::HTML:
4043 op.math_flavor = OutputParams::MathAsHTML;
4045 case BufferParams::Images:
4046 op.math_flavor = OutputParams::MathAsImages;
4048 case BufferParams::LaTeX:
4049 op.math_flavor = OutputParams::MathAsLaTeX;
4055 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4056 bool includeall, string & result_file) const
4058 LYXERR(Debug::FILES, "target=" << target);
4059 OutputParams runparams(¶ms().encoding());
4060 string format = target;
4061 string dest_filename;
4062 size_t pos = target.find(' ');
4063 if (pos != string::npos) {
4064 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4065 format = target.substr(0, pos);
4066 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4067 FileName(dest_filename).onlyPath().createPath();
4068 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4070 MarkAsExporting exporting(this);
4071 string backend_format;
4072 runparams.flavor = OutputParams::LATEX;
4073 runparams.linelen = lyxrc.plaintext_linelen;
4074 runparams.includeall = includeall;
4075 vector<string> backs = params().backends();
4076 Converters converters = theConverters();
4077 bool need_nice_file = false;
4078 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4079 // Get shortest path to format
4080 converters.buildGraph();
4081 Graph::EdgePath path;
4082 for (vector<string>::const_iterator it = backs.begin();
4083 it != backs.end(); ++it) {
4084 Graph::EdgePath p = converters.getPath(*it, format);
4085 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4086 backend_format = *it;
4091 if (!put_in_tempdir) {
4092 // Only show this alert if this is an export to a non-temporary
4093 // file (not for previewing).
4094 Alert::error(_("Couldn't export file"), bformat(
4095 _("No information for exporting the format %1$s."),
4096 formats.prettyName(format)));
4098 return ExportNoPathToFormat;
4100 runparams.flavor = converters.getFlavor(path, this);
4101 Graph::EdgePath::const_iterator it = path.begin();
4102 Graph::EdgePath::const_iterator en = path.end();
4103 for (; it != en; ++it)
4104 if (theConverters().get(*it).nice()) {
4105 need_nice_file = true;
4110 backend_format = format;
4111 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4112 // FIXME: Don't hardcode format names here, but use a flag
4113 if (backend_format == "pdflatex")
4114 runparams.flavor = OutputParams::PDFLATEX;
4115 else if (backend_format == "luatex")
4116 runparams.flavor = OutputParams::LUATEX;
4117 else if (backend_format == "dviluatex")
4118 runparams.flavor = OutputParams::DVILUATEX;
4119 else if (backend_format == "xetex")
4120 runparams.flavor = OutputParams::XETEX;
4123 string filename = latexName(false);
4124 filename = addName(temppath(), filename);
4125 filename = changeExtension(filename,
4126 formats.extension(backend_format));
4127 LYXERR(Debug::FILES, "filename=" << filename);
4129 // Plain text backend
4130 if (backend_format == "text") {
4131 runparams.flavor = OutputParams::TEXT;
4132 writePlaintextFile(*this, FileName(filename), runparams);
4135 else if (backend_format == "xhtml") {
4136 runparams.flavor = OutputParams::HTML;
4137 setMathFlavor(runparams);
4138 makeLyXHTMLFile(FileName(filename), runparams);
4139 } else if (backend_format == "lyx")
4140 writeFile(FileName(filename));
4142 else if (params().isDocBook()) {
4143 runparams.nice = !put_in_tempdir;
4144 makeDocBookFile(FileName(filename), runparams);
4147 else if (backend_format == format || need_nice_file) {
4148 runparams.nice = true;
4149 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4150 if (d->cloned_buffer_)
4151 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4154 } else if (!lyxrc.tex_allows_spaces
4155 && contains(filePath(), ' ')) {
4156 Alert::error(_("File name error"),
4157 _("The directory path to the document cannot contain spaces."));
4158 return ExportTexPathHasSpaces;
4160 runparams.nice = false;
4161 bool const success = makeLaTeXFile(
4162 FileName(filename), filePath(), runparams);
4163 if (d->cloned_buffer_)
4164 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4169 string const error_type = (format == "program")
4170 ? "Build" : params().bufferFormat();
4171 ErrorList & error_list = d->errorLists[error_type];
4172 string const ext = formats.extension(format);
4173 FileName const tmp_result_file(changeExtension(filename, ext));
4174 bool const success = converters.convert(this, FileName(filename),
4175 tmp_result_file, FileName(absFileName()), backend_format, format,
4178 // Emit the signal to show the error list or copy it back to the
4179 // cloned Buffer so that it can be emitted afterwards.
4180 if (format != backend_format) {
4181 if (runparams.silent)
4183 else if (d->cloned_buffer_)
4184 d->cloned_buffer_->d->errorLists[error_type] =
4185 d->errorLists[error_type];
4188 // also to the children, in case of master-buffer-view
4189 ListOfBuffers clist = getDescendents();
4190 ListOfBuffers::const_iterator cit = clist.begin();
4191 ListOfBuffers::const_iterator const cen = clist.end();
4192 for (; cit != cen; ++cit) {
4193 if (runparams.silent)
4194 (*cit)->d->errorLists[error_type].clear();
4195 else if (d->cloned_buffer_) {
4196 // Enable reverse search by copying back the
4197 // texrow object to the cloned buffer.
4198 // FIXME: this is not thread safe.
4199 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4200 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4201 (*cit)->d->errorLists[error_type];
4203 (*cit)->errors(error_type, true);
4207 if (d->cloned_buffer_) {
4208 // Enable reverse dvi or pdf to work by copying back the texrow
4209 // object to the cloned buffer.
4210 // FIXME: There is a possibility of concurrent access to texrow
4211 // here from the main GUI thread that should be securized.
4212 d->cloned_buffer_->d->texrow = d->texrow;
4213 string const error_type = params().bufferFormat();
4214 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4218 if (put_in_tempdir) {
4219 result_file = tmp_result_file.absFileName();
4220 return success ? ExportSuccess : ExportConverterError;
4223 if (dest_filename.empty())
4224 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4226 result_file = dest_filename;
4227 // We need to copy referenced files (e. g. included graphics
4228 // if format == "dvi") to the result dir.
4229 vector<ExportedFile> const files =
4230 runparams.exportdata->externalFiles(format);
4231 string const dest = runparams.export_folder.empty() ?
4232 onlyPath(result_file) : runparams.export_folder;
4233 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4234 : force_overwrite == ALL_FILES;
4235 CopyStatus status = use_force ? FORCE : SUCCESS;
4237 vector<ExportedFile>::const_iterator it = files.begin();
4238 vector<ExportedFile>::const_iterator const en = files.end();
4239 for (; it != en && status != CANCEL; ++it) {
4240 string const fmt = formats.getFormatFromFile(it->sourceName);
4241 string fixedName = it->exportName;
4242 if (!runparams.export_folder.empty()) {
4243 // Relative pathnames starting with ../ will be sanitized
4244 // if exporting to a different folder
4245 while (fixedName.substr(0, 3) == "../")
4246 fixedName = fixedName.substr(3, fixedName.length() - 3);
4248 FileName fixedFileName = makeAbsPath(fixedName, dest);
4249 fixedFileName.onlyPath().createPath();
4250 status = copyFile(fmt, it->sourceName,
4252 it->exportName, status == FORCE,
4253 runparams.export_folder.empty());
4256 if (status == CANCEL) {
4257 message(_("Document export cancelled."));
4258 return ExportCancel;
4261 if (tmp_result_file.exists()) {
4262 // Finally copy the main file
4263 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4264 : force_overwrite != NO_FILES;
4265 if (status == SUCCESS && use_force)
4267 status = copyFile(format, tmp_result_file,
4268 FileName(result_file), result_file,
4270 if (status == CANCEL) {
4271 message(_("Document export cancelled."));
4272 return ExportCancel;
4274 message(bformat(_("Document exported as %1$s "
4276 formats.prettyName(format),
4277 makeDisplayPath(result_file)));
4280 // This must be a dummy converter like fax (bug 1888)
4281 message(bformat(_("Document exported as %1$s"),
4282 formats.prettyName(format)));
4285 return success ? ExportSuccess : ExportConverterError;
4289 Buffer::ExportStatus Buffer::preview(string const & format) const
4291 bool const update_unincluded =
4292 params().maintain_unincluded_children
4293 && !params().getIncludedChildren().empty();
4294 return preview(format, update_unincluded);
4298 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4300 MarkAsExporting exporting(this);
4302 // (1) export with all included children (omit \includeonly)
4304 ExportStatus const status = doExport(format, true, true, result_file);
4305 if (status != ExportSuccess)
4308 // (2) export with included children only
4309 ExportStatus const status = doExport(format, true, false, result_file);
4310 FileName const previewFile(result_file);
4312 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4313 theimpl->preview_file_ = previewFile;
4314 theimpl->preview_format_ = format;
4315 theimpl->preview_error_ = (status != ExportSuccess);
4317 if (status != ExportSuccess)
4320 if (previewFile.exists())
4321 return formats.view(*this, previewFile, format) ?
4322 PreviewSuccess : PreviewError;
4324 // Successful export but no output file?
4325 // Probably a bug in error detection.
4326 LATTEST(status != ExportSuccess);
4331 Buffer::ReadStatus Buffer::extractFromVC()
4333 bool const found = LyXVC::file_not_found_hook(d->filename);
4335 return ReadFileNotFound;
4336 if (!d->filename.isReadableFile())
4342 Buffer::ReadStatus Buffer::loadEmergency()
4344 FileName const emergencyFile = getEmergencyFileName();
4345 if (!emergencyFile.exists()
4346 || emergencyFile.lastModified() <= d->filename.lastModified())
4347 return ReadFileNotFound;
4349 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4350 docstring const text = bformat(_("An emergency save of the document "
4351 "%1$s exists.\n\nRecover emergency save?"), file);
4353 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4354 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4360 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4361 bool const success = (ret_llf == ReadSuccess);
4364 Alert::warning(_("File is read-only"),
4365 bformat(_("An emergency file is successfully loaded, "
4366 "but the original file %1$s is marked read-only. "
4367 "Please make sure to save the document as a different "
4368 "file."), from_utf8(d->filename.absFileName())));
4371 lyxvc().file_found_hook(d->filename);
4372 str = _("Document was successfully recovered.");
4374 str = _("Document was NOT successfully recovered.");
4375 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4376 makeDisplayPath(emergencyFile.absFileName()));
4378 int const del_emerg =
4379 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4380 _("&Remove"), _("&Keep"));
4381 if (del_emerg == 0) {
4382 emergencyFile.removeFile();
4384 Alert::warning(_("Emergency file deleted"),
4385 _("Do not forget to save your file now!"), true);
4387 return success ? ReadSuccess : ReadEmergencyFailure;
4390 int const del_emerg =
4391 Alert::prompt(_("Delete emergency file?"),
4392 _("Remove emergency file now?"), 1, 1,
4393 _("&Remove"), _("&Keep"));
4395 emergencyFile.removeFile();
4396 return ReadOriginal;
4406 Buffer::ReadStatus Buffer::loadAutosave()
4408 // Now check if autosave file is newer.
4409 FileName const autosaveFile = getAutosaveFileName();
4410 if (!autosaveFile.exists()
4411 || autosaveFile.lastModified() <= d->filename.lastModified())
4412 return ReadFileNotFound;
4414 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4415 docstring const text = bformat(_("The backup of the document %1$s "
4416 "is newer.\n\nLoad the backup instead?"), file);
4417 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4418 _("&Load backup"), _("Load &original"), _("&Cancel"));
4423 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4424 // the file is not saved if we load the autosave file.
4425 if (ret_llf == ReadSuccess) {
4427 Alert::warning(_("File is read-only"),
4428 bformat(_("A backup file is successfully loaded, "
4429 "but the original file %1$s is marked read-only. "
4430 "Please make sure to save the document as a "
4432 from_utf8(d->filename.absFileName())));
4435 lyxvc().file_found_hook(d->filename);
4438 return ReadAutosaveFailure;
4441 // Here we delete the autosave
4442 autosaveFile.removeFile();
4443 return ReadOriginal;
4451 Buffer::ReadStatus Buffer::loadLyXFile()
4453 if (!d->filename.isReadableFile()) {
4454 ReadStatus const ret_rvc = extractFromVC();
4455 if (ret_rvc != ReadSuccess)
4459 ReadStatus const ret_re = loadEmergency();
4460 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4463 ReadStatus const ret_ra = loadAutosave();
4464 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4467 return loadThisLyXFile(d->filename);
4471 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4473 return readFile(fn);
4477 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4479 TeXErrors::Errors::const_iterator it = terr.begin();
4480 TeXErrors::Errors::const_iterator end = terr.end();
4481 ListOfBuffers clist = getDescendents();
4482 ListOfBuffers::const_iterator cen = clist.end();
4484 for (; it != end; ++it) {
4487 int errorRow = it->error_in_line;
4488 Buffer const * buf = 0;
4490 if (it->child_name.empty())
4491 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4493 // The error occurred in a child
4494 ListOfBuffers::const_iterator cit = clist.begin();
4495 for (; cit != cen; ++cit) {
4496 string const child_name =
4497 DocFileName(changeExtension(
4498 (*cit)->absFileName(), "tex")).
4500 if (it->child_name != child_name)
4502 (*cit)->d->texrow.getIdFromRow(errorRow,
4503 id_start, pos_start);
4504 if (id_start != -1) {
4505 buf = d->cloned_buffer_
4506 ? (*cit)->d->cloned_buffer_->d->owner_
4507 : (*cit)->d->owner_;
4518 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4519 } while (found && id_start == id_end && pos_start == pos_end);
4521 if (id_start != id_end) {
4522 // Next registered position is outside the inset where
4523 // the error occurred, so signal end-of-paragraph
4527 errorList.push_back(ErrorItem(it->error_desc,
4528 it->error_text, id_start, pos_start, pos_end, buf));
4533 void Buffer::setBuffersForInsets() const
4535 inset().setBuffer(const_cast<Buffer &>(*this));
4539 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4541 LBUFERR(!text().paragraphs().empty());
4543 // Use the master text class also for child documents
4544 Buffer const * const master = masterBuffer();
4545 DocumentClass const & textclass = master->params().documentClass();
4547 // do this only if we are the top-level Buffer
4548 if (master == this) {
4549 textclass.counters().reset(from_ascii("bibitem"));
4550 reloadBibInfoCache();
4553 // keep the buffers to be children in this set. If the call from the
4554 // master comes back we can see which of them were actually seen (i.e.
4555 // via an InsetInclude). The remaining ones in the set need still be updated.
4556 static std::set<Buffer const *> bufToUpdate;
4557 if (scope == UpdateMaster) {
4558 // If this is a child document start with the master
4559 if (master != this) {
4560 bufToUpdate.insert(this);
4561 master->updateBuffer(UpdateMaster, utype);
4562 // If the master buffer has no gui associated with it, then the TocModel is
4563 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4564 // (bug 5699). The same happens if the master buffer is open in a different
4565 // window. This test catches both possibilities.
4566 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4567 // There remains a problem here: If there is another child open in yet a third
4568 // window, that TOC is not updated. So some more general solution is needed at
4570 if (master->d->gui_ != d->gui_)
4573 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4574 if (bufToUpdate.find(this) == bufToUpdate.end())
4578 // start over the counters in the master
4579 textclass.counters().reset();
4582 // update will be done below for this buffer
4583 bufToUpdate.erase(this);
4585 // update all caches
4586 clearReferenceCache();
4588 setChangesPresent(false);
4590 Buffer & cbuf = const_cast<Buffer &>(*this);
4593 ParIterator parit = cbuf.par_iterator_begin();
4594 updateBuffer(parit, utype);
4597 // TocBackend update will be done later.
4600 d->bibinfo_cache_valid_ = true;
4601 d->cite_labels_valid_ = true;
4603 cbuf.tocBackend().update(true, utype);
4604 if (scope == UpdateMaster)
4605 cbuf.structureChanged();
4609 static depth_type getDepth(DocIterator const & it)
4611 depth_type depth = 0;
4612 for (size_t i = 0 ; i < it.depth() ; ++i)
4613 if (!it[i].inset().inMathed())
4614 depth += it[i].paragraph().getDepth() + 1;
4615 // remove 1 since the outer inset does not count
4616 // we should have at least one non-math inset, so
4617 // depth should nevery be 0. but maybe it is worth
4618 // marking this, just in case.
4620 // coverity[INTEGER_OVERFLOW]
4624 static depth_type getItemDepth(ParIterator const & it)
4626 Paragraph const & par = *it;
4627 LabelType const labeltype = par.layout().labeltype;
4629 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4632 // this will hold the lowest depth encountered up to now.
4633 depth_type min_depth = getDepth(it);
4634 ParIterator prev_it = it;
4637 --prev_it.top().pit();
4639 // start of nested inset: go to outer par
4641 if (prev_it.empty()) {
4642 // start of document: nothing to do
4647 // We search for the first paragraph with same label
4648 // that is not more deeply nested.
4649 Paragraph & prev_par = *prev_it;
4650 depth_type const prev_depth = getDepth(prev_it);
4651 if (labeltype == prev_par.layout().labeltype) {
4652 if (prev_depth < min_depth)
4653 return prev_par.itemdepth + 1;
4654 if (prev_depth == min_depth)
4655 return prev_par.itemdepth;
4657 min_depth = min(min_depth, prev_depth);
4658 // small optimization: if we are at depth 0, we won't
4659 // find anything else
4660 if (prev_depth == 0)
4666 static bool needEnumCounterReset(ParIterator const & it)
4668 Paragraph const & par = *it;
4669 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4670 depth_type const cur_depth = par.getDepth();
4671 ParIterator prev_it = it;
4672 while (prev_it.pit()) {
4673 --prev_it.top().pit();
4674 Paragraph const & prev_par = *prev_it;
4675 if (prev_par.getDepth() <= cur_depth)
4676 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4678 // start of nested inset: reset
4683 // set the label of a paragraph. This includes the counters.
4684 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4686 BufferParams const & bp = owner_->masterBuffer()->params();
4687 DocumentClass const & textclass = bp.documentClass();
4688 Paragraph & par = it.paragraph();
4689 Layout const & layout = par.layout();
4690 Counters & counters = textclass.counters();
4692 if (par.params().startOfAppendix()) {
4693 // We want to reset the counter corresponding to toplevel sectioning
4694 Layout const & lay = textclass.getTOCLayout();
4695 docstring const cnt = lay.counter;
4697 counters.reset(cnt);
4698 counters.appendix(true);
4700 par.params().appendix(counters.appendix());
4702 // Compute the item depth of the paragraph
4703 par.itemdepth = getItemDepth(it);
4705 if (layout.margintype == MARGIN_MANUAL) {
4706 if (par.params().labelWidthString().empty())
4707 par.params().labelWidthString(par.expandLabel(layout, bp));
4708 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4709 // we do not need to do anything here, since the empty case is
4710 // handled during export.
4712 par.params().labelWidthString(docstring());
4715 switch(layout.labeltype) {
4716 case LABEL_ITEMIZE: {
4717 // At some point of time we should do something more
4718 // clever here, like:
4719 // par.params().labelString(
4720 // bp.user_defined_bullet(par.itemdepth).getText());
4721 // for now, use a simple hardcoded label
4722 docstring itemlabel;
4723 switch (par.itemdepth) {
4725 itemlabel = char_type(0x2022);
4728 itemlabel = char_type(0x2013);
4731 itemlabel = char_type(0x2217);
4734 itemlabel = char_type(0x2219); // or 0x00b7
4737 par.params().labelString(itemlabel);
4741 case LABEL_ENUMERATE: {
4742 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4744 switch (par.itemdepth) {
4753 enumcounter += "iv";
4756 // not a valid enumdepth...
4760 // Maybe we have to reset the enumeration counter.
4761 if (needEnumCounterReset(it))
4762 counters.reset(enumcounter);
4763 counters.step(enumcounter, utype);
4765 string const & lang = par.getParLanguage(bp)->code();
4766 par.params().labelString(counters.theCounter(enumcounter, lang));
4771 case LABEL_SENSITIVE: {
4772 string const & type = counters.current_float();
4773 docstring full_label;
4775 full_label = owner_->B_("Senseless!!! ");
4777 docstring name = owner_->B_(textclass.floats().getType(type).name());
4778 if (counters.hasCounter(from_utf8(type))) {
4779 string const & lang = par.getParLanguage(bp)->code();
4780 counters.step(from_utf8(type), utype);
4781 full_label = bformat(from_ascii("%1$s %2$s:"),
4783 counters.theCounter(from_utf8(type), lang));
4785 full_label = bformat(from_ascii("%1$s #:"), name);
4787 par.params().labelString(full_label);
4791 case LABEL_NO_LABEL:
4792 par.params().labelString(docstring());
4796 case LABEL_CENTERED:
4797 case LABEL_STATIC: {
4798 docstring const & lcounter = layout.counter;
4799 if (!lcounter.empty()) {
4800 if (layout.toclevel <= bp.secnumdepth
4801 && (layout.latextype != LATEX_ENVIRONMENT
4802 || it.text()->isFirstInSequence(it.pit()))) {
4803 if (counters.hasCounter(lcounter))
4804 counters.step(lcounter, utype);
4805 par.params().labelString(par.expandLabel(layout, bp));
4807 par.params().labelString(docstring());
4809 par.params().labelString(par.expandLabel(layout, bp));
4815 par.params().labelString(par.expandLabel(layout, bp));
4820 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4822 // LASSERT: Is it safe to continue here, or should we just return?
4823 LASSERT(parit.pit() == 0, /**/);
4825 // Set the position of the text in the buffer to be able
4826 // to resolve macros in it.
4827 parit.text()->setMacrocontextPosition(parit);
4829 depth_type maxdepth = 0;
4830 pit_type const lastpit = parit.lastpit();
4831 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4832 // reduce depth if necessary
4833 if (parit->params().depth() > maxdepth) {
4834 /** FIXME: this function is const, but
4835 * nevertheless it modifies the buffer. To be
4836 * cleaner, one should modify the buffer in
4837 * another function, which is actually
4838 * non-const. This would however be costly in
4839 * terms of code duplication.
4841 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4842 parit->params().depth(maxdepth);
4844 maxdepth = parit->getMaxDepthAfter();
4846 if (utype == OutputUpdate) {
4847 // track the active counters
4848 // we have to do this for the master buffer, since the local
4849 // buffer isn't tracking anything.
4850 masterBuffer()->params().documentClass().counters().
4851 setActiveLayout(parit->layout());
4854 // set the counter for this paragraph
4855 d->setLabel(parit, utype);
4857 // update change-tracking flag
4858 parit->addChangesToBuffer(*this);
4861 InsetList::const_iterator iit = parit->insetList().begin();
4862 InsetList::const_iterator end = parit->insetList().end();
4863 for (; iit != end; ++iit) {
4864 parit.pos() = iit->pos;
4865 iit->inset->updateBuffer(parit, utype);
4871 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4872 WordLangTuple & word_lang, docstring_list & suggestions) const
4876 suggestions.clear();
4877 word_lang = WordLangTuple();
4878 bool const to_end = to.empty();
4879 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4880 // OK, we start from here.
4881 for (; from != end; from.forwardPos()) {
4882 // This skips all insets with spell check disabled.
4883 while (!from.allowSpellCheck()) {
4887 // If from is at the end of the document (which is possible
4888 // when "from" was changed above) LyX will crash later otherwise.
4889 if (from.atEnd() || (!to_end && from >= end))
4892 from.paragraph().spellCheck();
4893 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4894 if (SpellChecker::misspelled(res)) {
4898 // Do not increase progress when from == to, otherwise the word
4899 // count will be wrong.
4909 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4911 bool inword = false;
4916 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4917 if (!dit.inTexted()) {
4922 Paragraph const & par = dit.paragraph();
4923 pos_type const pos = dit.pos();
4925 // Copied and adapted from isWordSeparator() in Paragraph
4926 if (pos == dit.lastpos()) {
4929 Inset const * ins = par.getInset(pos);
4930 if (ins && skipNoOutput && !ins->producesOutput()) {
4933 // stop if end of range was skipped
4934 if (!to.atEnd() && dit >= to)
4937 } else if (!par.isDeleted(pos)) {
4938 if (par.isWordSeparator(pos))
4944 if (ins && ins->isLetter())
4946 else if (ins && ins->isSpace())
4949 char_type const c = par.getChar(pos);
4950 if (isPrintableNonspace(c))
4952 else if (isSpace(c))
4962 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4964 d->updateStatistics(from, to, skipNoOutput);
4968 int Buffer::wordCount() const
4970 return d->wordCount();
4974 int Buffer::charCount(bool with_blanks) const
4976 return d->charCount(with_blanks);
4980 Buffer::ReadStatus Buffer::reload()
4983 // c.f. bug http://www.lyx.org/trac/ticket/6587
4984 removeAutosaveFile();
4985 // e.g., read-only status could have changed due to version control
4986 d->filename.refresh();
4987 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4989 // clear parent. this will get reset if need be.
4991 ReadStatus const status = loadLyXFile();
4992 if (status == ReadSuccess) {
4997 message(bformat(_("Document %1$s reloaded."), disp_fn));
5000 message(bformat(_("Could not reload document %1$s."), disp_fn));
5010 bool Buffer::saveAs(FileName const & fn)
5012 FileName const old_name = fileName();
5013 FileName const old_auto = getAutosaveFileName();
5014 bool const old_unnamed = isUnnamed();
5015 bool success = true;
5016 d->old_position = filePath();
5023 // bring the autosave file with us, just in case.
5024 moveAutosaveFile(old_auto);
5025 // validate version control data and
5026 // correct buffer title
5027 lyxvc().file_found_hook(fileName());
5029 // the file has now been saved to the new location.
5030 // we need to check that the locations of child buffers
5032 checkChildBuffers();
5033 checkMasterBuffer();
5036 // reset the old filename and unnamed state
5037 setFileName(old_name);
5038 setUnnamed(old_unnamed);
5042 d->old_position.clear();
5047 void Buffer::checkChildBuffers()
5049 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5050 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5051 for (; it != en; ++it) {
5052 DocIterator dit = it->second;
5053 Buffer * cbuf = const_cast<Buffer *>(it->first);
5054 if (!cbuf || !theBufferList().isLoaded(cbuf))
5056 Inset * inset = dit.nextInset();
5057 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5058 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5059 docstring const & incfile = inset_inc->getParam("filename");
5060 string oldloc = cbuf->absFileName();
5061 string newloc = makeAbsPath(to_utf8(incfile),
5062 onlyPath(absFileName())).absFileName();
5063 if (oldloc == newloc)
5065 // the location of the child file is incorrect.
5067 inset_inc->setChildBuffer(0);
5069 // invalidate cache of children
5070 d->children_positions.clear();
5071 d->position_to_children.clear();
5075 // If a child has been saved under a different name/path, it might have been
5076 // orphaned. Therefore the master needs to be reset (bug 8161).
5077 void Buffer::checkMasterBuffer()
5079 Buffer const * const master = masterBuffer();
5083 // necessary to re-register the child (bug 5873)
5084 // FIXME: clean up updateMacros (here, only
5085 // child registering is needed).
5086 master->updateMacros();
5087 // (re)set master as master buffer, but only
5088 // if we are a real child
5089 if (master->isChild(this))
5096 string Buffer::includedFilePath(string const & name, string const & ext) const
5098 if (d->old_position.empty() ||
5099 equivalent(FileName(d->old_position), FileName(filePath())))
5102 bool isabsolute = FileName::isAbsolute(name);
5103 // both old_position and filePath() end with a path separator
5104 string absname = isabsolute ? name : d->old_position + name;
5106 // if old_position is set to origin, we need to do the equivalent of
5107 // getReferencedFileName() (see readDocument())
5108 if (!isabsolute && d->old_position == params().origin) {
5109 FileName const test(addExtension(filePath() + name, ext));
5111 absname = filePath() + name;
5114 if (!FileName(addExtension(absname, ext)).exists())
5118 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5120 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5121 from_utf8(filePath())));
5125 void Buffer::setChangesPresent(bool b) const
5127 d->tracked_changes_present_ = b;
5131 bool Buffer::areChangesPresent() const
5133 return d->tracked_changes_present_;
5137 void Buffer::updateChangesPresent() const
5139 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5140 setChangesPresent(false);
5141 ParConstIterator it = par_iterator_begin();
5142 ParConstIterator const end = par_iterator_end();
5143 for (; !areChangesPresent() && it != end; ++it)
5144 it->addChangesToBuffer(*this);