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(docstring(), false);
913 params().setLocalLayout(docstring(), 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"), s));
956 if (begin_header_line) {
957 docstring const s = _("\\begin_header is missing");
958 errorList.push_back(ErrorItem(_("Document header error"), s));
961 params().makeDocumentClass();
963 return unknown_tokens;
968 // changed to be public and have one parameter
969 // Returns true if "\end_document" is not read (Asger)
970 bool Buffer::readDocument(Lexer & lex)
972 ErrorList & errorList = d->errorLists["Parse"];
975 // remove dummy empty par
976 paragraphs().clear();
978 if (!lex.checkFor("\\begin_document")) {
979 docstring const s = _("\\begin_document is missing");
980 errorList.push_back(ErrorItem(_("Document header error"), s));
985 if (params().output_changes) {
986 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
987 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
988 LaTeXFeatures::isAvailable("xcolor");
990 if (!dvipost && !xcolorulem) {
991 Alert::warning(_("Changes not shown in LaTeX output"),
992 _("Changes will not be highlighted in LaTeX output, "
993 "because neither dvipost nor xcolor/ulem are installed.\n"
994 "Please install these packages or redefine "
995 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
996 } else if (!xcolorulem) {
997 Alert::warning(_("Changes not shown in LaTeX output"),
998 _("Changes will not be highlighted in LaTeX output "
999 "when using pdflatex, because xcolor and ulem are not installed.\n"
1000 "Please install both packages or redefine "
1001 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1005 if (!parent() && !params().master.empty()) {
1006 FileName const master_file = makeAbsPath(params().master,
1007 onlyPath(absFileName()));
1008 if (isLyXFileName(master_file.absFileName())) {
1010 checkAndLoadLyXFile(master_file, true);
1012 // necessary e.g. after a reload
1013 // to re-register the child (bug 5873)
1014 // FIXME: clean up updateMacros (here, only
1015 // child registering is needed).
1016 master->updateMacros();
1017 // set master as master buffer, but only
1018 // if we are a real child
1019 if (master->isChild(this))
1021 // if the master is not fully loaded
1022 // it is probably just loading this
1023 // child. No warning needed then.
1024 else if (master->isFullyLoaded())
1025 LYXERR0("The master '"
1027 << "' assigned to this document ("
1029 << ") does not include "
1030 "this document. Ignoring the master assignment.");
1035 // assure we have a default index
1036 params().indiceslist().addDefault(B_("Index"));
1039 if (FileName::isAbsolute(params().origin))
1040 d->old_position = params().origin;
1042 d->old_position = filePath();
1043 bool const res = text().read(lex, errorList, d->inset);
1044 d->old_position.clear();
1046 // inform parent buffer about local macros
1048 Buffer const * pbuf = parent();
1049 UserMacroSet::const_iterator cit = usermacros.begin();
1050 UserMacroSet::const_iterator end = usermacros.end();
1051 for (; cit != end; ++cit)
1052 pbuf->usermacros.insert(*cit);
1056 updateMacroInstances(InternalUpdate);
1061 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1063 Format const * fmt = formats.getFormat(format);
1066 // It is important to use the correct extension here, since some
1067 // converters create a wrong output file otherwise (e.g. html2latex)
1068 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1069 FileName const name(tempfile.name());
1070 ofdocstream os(name.toFilesystemEncoding().c_str());
1071 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1072 bool const success = !(os << contents).fail();
1075 bool converted = false;
1077 params().compressed = false;
1079 // remove dummy empty par
1080 paragraphs().clear();
1082 converted = importFile(format, name, errorList);
1091 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1093 if (!theConverters().isReachable(format, "lyx"))
1096 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1097 FileName const lyx(tempfile.name());
1098 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1099 return readFile(lyx) == ReadSuccess;
1105 bool Buffer::readString(string const & s)
1107 params().compressed = false;
1110 istringstream is(s);
1112 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1113 FileName const fn = tempfile.name();
1116 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1118 if (success && file_format != LYX_FORMAT) {
1119 // We need to call lyx2lyx, so write the input to a file
1120 ofstream os(fn.toFilesystemEncoding().c_str());
1123 // lyxvc in readFile
1124 if (readFile(fn) != ReadSuccess)
1128 if (readDocument(lex))
1134 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1138 if (!lex.setFile(fname)) {
1139 Alert::error(_("File Not Found"),
1140 bformat(_("Unable to open file `%1$s'."),
1141 from_utf8(fn.absFileName())));
1142 return ReadFileNotFound;
1146 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1147 if (ret_plf != ReadSuccess)
1150 if (file_format != LYX_FORMAT) {
1152 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1153 if (ret_clf != ReadSuccess)
1155 ret_clf = readFile(tmpFile);
1156 if (ret_clf == ReadSuccess) {
1157 d->file_format = file_format;
1158 d->need_format_backup = true;
1163 // FIXME: InsetInfo needs to know whether the file is under VCS
1164 // during the parse process, so this has to be done before.
1165 lyxvc().file_found_hook(d->filename);
1167 if (readDocument(lex)) {
1168 Alert::error(_("Document format failure"),
1169 bformat(_("%1$s ended unexpectedly, which means"
1170 " that it is probably corrupted."),
1171 from_utf8(fn.absFileName())));
1172 return ReadDocumentFailure;
1175 d->file_fully_loaded = true;
1176 d->read_only = !d->filename.isWritable();
1177 params().compressed = formats.isZippedFile(d->filename);
1183 bool Buffer::isFullyLoaded() const
1185 return d->file_fully_loaded;
1189 void Buffer::setFullyLoaded(bool value)
1191 d->file_fully_loaded = value;
1195 bool Buffer::lastPreviewError() const
1197 return d->preview_error_;
1201 PreviewLoader * Buffer::loader() const
1203 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1205 if (!d->preview_loader_)
1206 d->preview_loader_ = new PreviewLoader(*this);
1207 return d->preview_loader_;
1211 void Buffer::removePreviews() const
1213 delete d->preview_loader_;
1214 d->preview_loader_ = 0;
1218 void Buffer::updatePreviews() const
1220 PreviewLoader * ploader = loader();
1224 InsetIterator it = inset_iterator_begin(*d->inset);
1225 InsetIterator const end = inset_iterator_end(*d->inset);
1226 for (; it != end; ++it)
1227 it->addPreview(it, *ploader);
1229 ploader->startLoading();
1233 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1234 FileName const & fn, int & file_format) const
1236 if(!lex.checkFor("\\lyxformat")) {
1237 Alert::error(_("Document format failure"),
1238 bformat(_("%1$s is not a readable LyX document."),
1239 from_utf8(fn.absFileName())));
1240 return ReadNoLyXFormat;
1246 // LyX formats 217 and earlier were written as 2.17. This corresponds
1247 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1248 // these cases. See also: www.lyx.org/trac/changeset/1313.
1249 size_t dot = tmp_format.find_first_of(".,");
1250 if (dot != string::npos)
1251 tmp_format.erase(dot, 1);
1253 file_format = convert<int>(tmp_format);
1258 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1259 FileName & tmpfile, int from_format)
1261 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1262 tempfile.setAutoRemove(false);
1263 tmpfile = tempfile.name();
1264 if(tmpfile.empty()) {
1265 Alert::error(_("Conversion failed"),
1266 bformat(_("%1$s is from a different"
1267 " version of LyX, but a temporary"
1268 " file for converting it could"
1269 " not be created."),
1270 from_utf8(fn.absFileName())));
1271 return LyX2LyXNoTempFile;
1274 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1275 if (lyx2lyx.empty()) {
1276 Alert::error(_("Conversion script not found"),
1277 bformat(_("%1$s is from a different"
1278 " version of LyX, but the"
1279 " conversion script lyx2lyx"
1280 " could not be found."),
1281 from_utf8(fn.absFileName())));
1282 return LyX2LyXNotFound;
1286 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1287 ostringstream command;
1288 command << os::python()
1289 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1290 << " -t " << convert<string>(LYX_FORMAT)
1291 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1292 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1293 string const command_str = command.str();
1295 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1297 cmd_ret const ret = runCommand(command_str);
1298 if (ret.first != 0) {
1299 if (from_format < LYX_FORMAT) {
1300 Alert::error(_("Conversion script failed"),
1301 bformat(_("%1$s is from an older version"
1302 " of LyX and the lyx2lyx script"
1303 " failed to convert it."),
1304 from_utf8(fn.absFileName())));
1305 return LyX2LyXOlderFormat;
1307 Alert::error(_("Conversion script failed"),
1308 bformat(_("%1$s is from a newer version"
1309 " of LyX and the lyx2lyx script"
1310 " failed to convert it."),
1311 from_utf8(fn.absFileName())));
1312 return LyX2LyXNewerFormat;
1319 FileName Buffer::getBackupName() const {
1320 FileName const & fn = fileName();
1321 string const fname = fn.onlyFileNameWithoutExt();
1322 string const fext = fn.extension() + "~";
1323 string const fpath = lyxrc.backupdir_path.empty() ?
1324 fn.onlyPath().absFileName() :
1325 lyxrc.backupdir_path;
1326 string const fform = convert<string>(d->file_format);
1327 string const backname = fname + "-lyxformat-" + fform;
1328 FileName backup(addName(fpath, addExtension(backname, fext)));
1330 // limit recursion, just in case
1332 unsigned long orig_checksum = 0;
1333 while (backup.exists() && v < 100) {
1334 if (orig_checksum == 0)
1335 orig_checksum = fn.checksum();
1336 unsigned long new_checksum = backup.checksum();
1337 if (orig_checksum == new_checksum) {
1338 LYXERR(Debug::FILES, "Not backing up " << fn <<
1339 "since " << backup << "has the same checksum.");
1340 // a bit of a hack, but we have to check this anyway
1341 // below, and setting this is simpler than introducing
1342 // a special boolean for this purpose.
1346 string const newbackname = backname + "-" + convert<string>(v);
1347 backup.set(addName(fpath, addExtension(newbackname, fext)));
1350 return v < 100 ? backup : FileName();
1354 // Should probably be moved to somewhere else: BufferView? GuiView?
1355 bool Buffer::save() const
1357 docstring const file = makeDisplayPath(absFileName(), 20);
1358 d->filename.refresh();
1360 // check the read-only status before moving the file as a backup
1361 if (d->filename.exists()) {
1362 bool const read_only = !d->filename.isWritable();
1364 Alert::warning(_("File is read-only"),
1365 bformat(_("The file %1$s cannot be written because it "
1366 "is marked as read-only."), file));
1371 // ask if the disk file has been externally modified (use checksum method)
1372 if (fileName().exists() && isExternallyModified(checksum_method)) {
1374 bformat(_("Document %1$s has been externally modified. "
1375 "Are you sure you want to overwrite this file?"), file);
1376 int const ret = Alert::prompt(_("Overwrite modified file?"),
1377 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1382 // We don't need autosaves in the immediate future. (Asger)
1383 resetAutosaveTimers();
1385 // if the file does not yet exist, none of the backup activity
1386 // that follows is necessary
1387 if (!fileName().exists()) {
1388 if (!writeFile(fileName()))
1394 // we first write the file to a new name, then move it to its
1395 // proper location once that has been done successfully. that
1396 // way we preserve the original file if something goes wrong.
1397 string const justname = fileName().onlyFileNameWithoutExt();
1398 auto tempfile = make_unique<TempFile>(fileName().onlyPath(),
1399 justname + "-XXXXXX.lyx");
1400 bool const symlink = fileName().isSymLink();
1402 tempfile->setAutoRemove(false);
1404 FileName savefile(tempfile->name());
1405 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1406 if (!writeFile(savefile))
1409 // we will set this to false if we fail
1410 bool made_backup = true;
1412 FileName backupName;
1413 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1415 if (d->need_format_backup)
1416 backupName = getBackupName();
1418 // If we for some reason failed to find a backup name in case of
1419 // a format change, this will still set one. It's the best we can
1421 if (backupName.empty()) {
1422 backupName.set(fileName().absFileName() + "~");
1423 if (!lyxrc.backupdir_path.empty()) {
1424 string const mangledName =
1425 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1426 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1430 LYXERR(Debug::FILES, "Backing up original file to " <<
1431 backupName.absFileName());
1432 // Except file is symlink do not copy because of #6587.
1433 // Hard links have bad luck.
1434 made_backup = symlink ?
1435 fileName().copyTo(backupName):
1436 fileName().moveTo(backupName);
1439 Alert::error(_("Backup failure"),
1440 bformat(_("Cannot create backup file %1$s.\n"
1441 "Please check whether the directory exists and is writable."),
1442 from_utf8(backupName.absFileName())));
1443 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1444 } else if (d->need_format_backup) {
1445 // the original file has been backed up successfully, so we
1446 // will not need to do that again
1447 d->need_format_backup = false;
1451 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1452 // Only do this if tempfile is not in autoremove mode
1455 // If we have no symlink, we can simply rename the temp file.
1456 // Otherwise, we need to copy it so the symlink stays intact.
1457 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1458 savefile.moveTo(fileName()))
1460 // saveCheckSum() was already called by writeFile(), but the
1461 // time stamp is invalidated by copying/moving
1464 if (d->file_format != LYX_FORMAT)
1465 // the file associated with this buffer is now in the current format
1466 d->file_format = LYX_FORMAT;
1469 // else we saved the file, but failed to move it to the right location.
1471 if (needBackup && made_backup && !symlink) {
1472 // the original file was moved to some new location, so it will look
1473 // to the user as if it was deleted. (see bug #9234.) we could try
1474 // to restore it, but that would basically mean trying to do again
1475 // what we just failed to do. better to leave things as they are.
1476 Alert::error(_("Write failure"),
1477 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1478 "But LyX could not move it to:\n %2$s.\n"
1479 "Your original file has been backed up to:\n %3$s"),
1480 from_utf8(savefile.absFileName()),
1481 from_utf8(fileName().absFileName()),
1482 from_utf8(backupName.absFileName())));
1484 // either we did not try to make a backup, or else we tried and failed,
1485 // or else the original file was a symlink, in which case it was copied,
1486 // not moved. so the original file is intact.
1487 Alert::error(_("Write failure"),
1488 bformat(_("Cannot move saved file to:\n %1$s.\n"
1489 "But the file has successfully been saved as:\n %2$s."),
1490 from_utf8(fileName().absFileName()),
1491 from_utf8(savefile.absFileName())));
1497 bool Buffer::writeFile(FileName const & fname) const
1499 if (d->read_only && fname == d->filename)
1502 bool retval = false;
1504 docstring const str = bformat(_("Saving document %1$s..."),
1505 makeDisplayPath(fname.absFileName()));
1508 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1510 if (params().compressed) {
1511 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1512 retval = ofs && write(ofs);
1514 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1515 retval = ofs && write(ofs);
1519 message(str + _(" could not write file!"));
1524 // removeAutosaveFile();
1527 message(str + _(" done."));
1533 docstring Buffer::emergencyWrite()
1535 // No need to save if the buffer has not changed.
1539 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1541 docstring user_message = bformat(
1542 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1544 // We try to save three places:
1545 // 1) Same place as document. Unless it is an unnamed doc.
1547 string s = absFileName();
1550 if (writeFile(FileName(s))) {
1552 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1553 return user_message;
1555 user_message += " " + _("Save failed! Trying again...\n");
1559 // 2) In HOME directory.
1560 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1562 lyxerr << ' ' << s << endl;
1563 if (writeFile(FileName(s))) {
1565 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1566 return user_message;
1569 user_message += " " + _("Save failed! Trying yet again...\n");
1571 // 3) In "/tmp" directory.
1572 // MakeAbsPath to prepend the current
1573 // drive letter on OS/2
1574 s = addName(package().temp_dir().absFileName(), absFileName());
1576 lyxerr << ' ' << s << endl;
1577 if (writeFile(FileName(s))) {
1579 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1580 return user_message;
1583 user_message += " " + _("Save failed! Bummer. Document is lost.");
1586 return user_message;
1590 bool Buffer::write(ostream & ofs) const
1593 // Use the standard "C" locale for file output.
1594 ofs.imbue(locale::classic());
1597 // The top of the file should not be written by params().
1599 // write out a comment in the top of the file
1600 // Important: Keep the version formatting in sync with lyx2lyx and
1601 // tex2lyx (bug 7951)
1602 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1603 << " created this file. For more info see http://www.lyx.org/\n"
1604 << "\\lyxformat " << LYX_FORMAT << "\n"
1605 << "\\begin_document\n";
1607 /// For each author, set 'used' to true if there is a change
1608 /// by this author in the document; otherwise set it to 'false'.
1609 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1610 AuthorList::Authors::const_iterator a_end = params().authors().end();
1611 for (; a_it != a_end; ++a_it)
1612 a_it->setUsed(false);
1614 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1615 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1616 for ( ; it != end; ++it)
1617 it->checkAuthors(params().authors());
1619 // now write out the buffer parameters.
1620 ofs << "\\begin_header\n";
1621 params().writeFile(ofs, this);
1622 ofs << "\\end_header\n";
1625 ofs << "\n\\begin_body\n";
1627 ofs << "\n\\end_body\n";
1629 // Write marker that shows file is complete
1630 ofs << "\\end_document" << endl;
1632 // Shouldn't really be needed....
1635 // how to check if close went ok?
1636 // Following is an attempt... (BE 20001011)
1638 // good() returns false if any error occurred, including some
1639 // formatting error.
1640 // bad() returns true if something bad happened in the buffer,
1641 // which should include file system full errors.
1646 lyxerr << "File was not closed properly." << endl;
1653 bool Buffer::makeLaTeXFile(FileName const & fname,
1654 string const & original_path,
1655 OutputParams const & runparams_in,
1656 OutputWhat output) const
1658 OutputParams runparams = runparams_in;
1660 // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
1661 // Check here, because the "flavor" is not known in BufferParams::encoding()
1662 // (power users can override this safety measure selecting "utf8-plain").
1663 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1664 && (runparams.encoding->name() != "utf8-plain"))
1665 runparams.encoding = encodings.fromLyXName("ascii");
1667 string const encoding = runparams.encoding->iconvName();
1668 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1671 try { ofs.reset(encoding); }
1672 catch (iconv_codecvt_facet_exception const & e) {
1673 lyxerr << "Caught iconv exception: " << e.what() << endl;
1674 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1675 "verify that the support software for your encoding (%1$s) is "
1676 "properly installed"), from_ascii(encoding)));
1679 if (!openFileWrite(ofs, fname))
1682 ErrorList & errorList = d->errorLists["Export"];
1684 bool failed_export = false;
1687 // make sure we are ready to export
1688 // this needs to be done before we validate
1689 // FIXME Do we need to do this all the time? I.e., in children
1690 // of a master we are exporting?
1692 updateMacroInstances(OutputUpdate);
1695 writeLaTeXSource(os, original_path, runparams, output);
1697 catch (EncodingException const & e) {
1698 docstring const failed(1, e.failed_char);
1700 oss << "0x" << hex << e.failed_char << dec;
1701 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1702 " (code point %2$s)"),
1703 failed, from_utf8(oss.str()));
1704 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1705 "representable in the chosen encoding.\n"
1706 "Changing the document encoding to utf8 could help."),
1707 {e.par_id, e.pos}, {e.par_id, e.pos + 1}));
1708 failed_export = true;
1710 catch (iconv_codecvt_facet_exception const & e) {
1711 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1713 failed_export = true;
1715 catch (exception const & e) {
1716 errorList.push_back(ErrorItem(_("conversion failed"),
1718 failed_export = true;
1721 lyxerr << "Caught some really weird exception..." << endl;
1725 d->texrow = move(os.texrow());
1729 failed_export = true;
1730 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1733 if (runparams_in.silent)
1737 return !failed_export;
1741 void Buffer::writeLaTeXSource(otexstream & os,
1742 string const & original_path,
1743 OutputParams const & runparams_in,
1744 OutputWhat output) const
1746 // The child documents, if any, shall be already loaded at this point.
1748 OutputParams runparams = runparams_in;
1750 // XeTeX with TeX fonts is only safe with ASCII encoding,
1751 // Check here, because the "flavor" is not known in BufferParams::encoding()
1752 // (power users can override this safety measure selecting "utf8-plain").
1753 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
1754 && (runparams.encoding->name() != "utf8-plain"))
1755 runparams.encoding = encodings.fromLyXName("ascii");
1756 // FIXME: when only the current paragraph is shown, this is ignored
1757 // (or not reached) and characters encodable in the current
1758 // encoding are not converted to ASCII-representation.
1760 // If we are compiling a file standalone, even if this is the
1761 // child of some other buffer, let's cut the link here, so the
1762 // file is really independent and no concurring settings from
1763 // the master (e.g. branch state) interfere (see #8100).
1764 if (!runparams.is_child)
1765 d->ignore_parent = true;
1767 // Classify the unicode characters appearing in math insets
1768 BufferEncodings::initUnicodeMath(*this);
1770 // validate the buffer.
1771 LYXERR(Debug::LATEX, " Validating buffer...");
1772 LaTeXFeatures features(*this, params(), runparams);
1774 // This is only set once per document (in master)
1775 if (!runparams.is_child)
1776 runparams.use_polyglossia = features.usePolyglossia();
1777 LYXERR(Debug::LATEX, " Buffer validation done.");
1779 bool const output_preamble =
1780 output == FullSource || output == OnlyPreamble;
1781 bool const output_body =
1782 output == FullSource || output == OnlyBody;
1784 // The starting paragraph of the coming rows is the
1785 // first paragraph of the document. (Asger)
1786 if (output_preamble && runparams.nice) {
1787 os << "%% LyX " << lyx_version << " created this file. "
1788 "For more info, see http://www.lyx.org/.\n"
1789 "%% Do not edit unless you really know what "
1792 LYXERR(Debug::INFO, "lyx document header finished");
1794 // There are a few differences between nice LaTeX and usual files:
1795 // usual files have \batchmode and special input@path to allow
1796 // inclusion of figures specified by an explicitly relative path
1797 // (i.e., a path starting with './' or '../') with either \input or
1798 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1799 // input@path is set when the actual parameter original_path is set.
1800 // This is done for usual tex-file, but not for nice-latex-file.
1801 // (Matthias 250696)
1802 // Note that input@path is only needed for something the user does
1803 // in the preamble, included .tex files or ERT, files included by
1804 // LyX work without it.
1805 if (output_preamble) {
1806 if (!runparams.nice) {
1807 // code for usual, NOT nice-latex-file
1808 os << "\\batchmode\n"; // changed from \nonstopmode
1810 if (!original_path.empty()) {
1812 // We don't know the encoding of inputpath
1813 docstring const inputpath = from_utf8(original_path);
1814 docstring uncodable_glyphs;
1815 Encoding const * const enc = runparams.encoding;
1817 for (size_t n = 0; n < inputpath.size(); ++n) {
1818 if (!enc->encodable(inputpath[n])) {
1819 docstring const glyph(1, inputpath[n]);
1820 LYXERR0("Uncodable character '"
1822 << "' in input path!");
1823 uncodable_glyphs += glyph;
1828 // warn user if we found uncodable glyphs.
1829 if (!uncodable_glyphs.empty()) {
1830 frontend::Alert::warning(
1831 _("Uncodable character in file path"),
1833 _("The path of your document\n"
1835 "contains glyphs that are unknown "
1836 "in the current document encoding "
1837 "(namely %2$s). This may result in "
1838 "incomplete output, unless "
1839 "TEXINPUTS contains the document "
1840 "directory and you don't use "
1841 "explicitly relative paths (i.e., "
1842 "paths starting with './' or "
1843 "'../') in the preamble or in ERT."
1844 "\n\nIn case of problems, choose "
1845 "an appropriate document encoding\n"
1846 "(such as utf8) or change the "
1848 inputpath, uncodable_glyphs));
1851 support::latex_path(original_path);
1852 if (contains(docdir, '#')) {
1853 docdir = subst(docdir, "#", "\\#");
1854 os << "\\catcode`\\#=11"
1855 "\\def\\#{#}\\catcode`\\#=6\n";
1857 if (contains(docdir, '%')) {
1858 docdir = subst(docdir, "%", "\\%");
1859 os << "\\catcode`\\%=11"
1860 "\\def\\%{%}\\catcode`\\%=14\n";
1862 os << "\\makeatletter\n"
1863 << "\\def\\input@path{{"
1865 << "\\makeatother\n";
1869 // get parent macros (if this buffer has a parent) which will be
1870 // written at the document begin further down.
1871 MacroSet parentMacros;
1872 listParentMacros(parentMacros, features);
1874 // Write the preamble
1875 runparams.use_babel = params().writeLaTeX(os, features,
1876 d->filename.onlyPath());
1878 // Japanese might be required only in some children of a document,
1879 // but once required, we must keep use_japanese true.
1880 runparams.use_japanese |= features.isRequired("japanese");
1883 // Restore the parenthood if needed
1884 if (!runparams.is_child)
1885 d->ignore_parent = false;
1890 // mark the beginning of the body to separate it from InPreamble insets
1891 os.texrow().start(TexRow::beginDocument());
1892 os << "\\begin{document}\n";
1894 // output the parent macros
1895 MacroSet::iterator it = parentMacros.begin();
1896 MacroSet::iterator end = parentMacros.end();
1897 for (; it != end; ++it) {
1898 int num_lines = (*it)->write(os.os(), true);
1899 os.texrow().newlines(num_lines);
1902 } // output_preamble
1904 LYXERR(Debug::INFO, "preamble finished, now the body.");
1907 latexParagraphs(*this, text(), os, runparams);
1909 // Restore the parenthood if needed
1910 if (!runparams.is_child)
1911 d->ignore_parent = false;
1913 // add this just in case after all the paragraphs
1916 if (output_preamble) {
1917 os << "\\end{document}\n";
1918 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1920 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1922 runparams_in.encoding = runparams.encoding;
1924 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1925 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1929 void Buffer::makeDocBookFile(FileName const & fname,
1930 OutputParams const & runparams,
1931 OutputWhat output) const
1933 LYXERR(Debug::LATEX, "makeDocBookFile...");
1936 if (!openFileWrite(ofs, fname))
1939 // make sure we are ready to export
1940 // this needs to be done before we validate
1942 updateMacroInstances(OutputUpdate);
1944 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1948 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1952 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1953 OutputParams const & runparams,
1954 OutputWhat output) const
1956 LaTeXFeatures features(*this, params(), runparams);
1961 DocumentClass const & tclass = params().documentClass();
1962 string const & top_element = tclass.latexname();
1964 bool const output_preamble =
1965 output == FullSource || output == OnlyPreamble;
1966 bool const output_body =
1967 output == FullSource || output == OnlyBody;
1969 if (output_preamble) {
1970 if (runparams.flavor == OutputParams::XML)
1971 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1974 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1977 if (! tclass.class_header().empty())
1978 os << from_ascii(tclass.class_header());
1979 else if (runparams.flavor == OutputParams::XML)
1980 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1981 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1983 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1985 docstring preamble = params().preamble;
1986 if (runparams.flavor != OutputParams::XML ) {
1987 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1988 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1989 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1990 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1993 string const name = runparams.nice
1994 ? changeExtension(absFileName(), ".sgml") : fname;
1995 preamble += features.getIncludedFiles(name);
1996 preamble += features.getLyXSGMLEntities();
1998 if (!preamble.empty()) {
1999 os << "\n [ " << preamble << " ]";
2005 string top = top_element;
2007 if (runparams.flavor == OutputParams::XML)
2008 top += params().language->code();
2010 top += params().language->code().substr(0, 2);
2013 if (!params().options.empty()) {
2015 top += params().options;
2018 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2019 << " file was created by LyX " << lyx_version
2020 << "\n See http://www.lyx.org/ for more information -->\n";
2022 params().documentClass().counters().reset();
2024 sgml::openTag(os, top);
2026 docbookParagraphs(text(), *this, os, runparams);
2027 sgml::closeTag(os, top_element);
2032 void Buffer::makeLyXHTMLFile(FileName const & fname,
2033 OutputParams const & runparams) const
2035 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2038 if (!openFileWrite(ofs, fname))
2041 // make sure we are ready to export
2042 // this has to be done before we validate
2043 updateBuffer(UpdateMaster, OutputUpdate);
2044 updateMacroInstances(OutputUpdate);
2046 writeLyXHTMLSource(ofs, runparams, FullSource);
2050 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2054 void Buffer::writeLyXHTMLSource(odocstream & os,
2055 OutputParams const & runparams,
2056 OutputWhat output) const
2058 LaTeXFeatures features(*this, params(), runparams);
2060 d->bibinfo_.makeCitationLabels(*this);
2062 bool const output_preamble =
2063 output == FullSource || output == OnlyPreamble;
2064 bool const output_body =
2065 output == FullSource || output == OnlyBody || output == IncludedFile;
2067 if (output_preamble) {
2068 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2069 << "<!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"
2070 // FIXME Language should be set properly.
2071 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2073 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2074 // FIXME Presumably need to set this right
2075 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2077 docstring const & doctitle = features.htmlTitle();
2079 << (doctitle.empty() ?
2080 from_ascii("LyX Document") :
2081 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2084 docstring styles = features.getTClassHTMLPreamble();
2085 if (!styles.empty())
2086 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2088 styles = features.getPreambleSnippets().str;
2089 if (!styles.empty())
2090 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2092 // we will collect CSS information in a stream, and then output it
2093 // either here, as part of the header, or else in a separate file.
2094 odocstringstream css;
2095 styles = features.getCSSSnippets();
2096 if (!styles.empty())
2097 css << "/* LyX Provided Styles */\n" << styles << '\n';
2099 styles = features.getTClassHTMLStyles();
2100 if (!styles.empty())
2101 css << "/* Layout-provided Styles */\n" << styles << '\n';
2103 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2104 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2105 if (needfg || needbg) {
2106 css << "\nbody {\n";
2109 << from_ascii(X11hexname(params().fontcolor))
2112 css << " background-color: "
2113 << from_ascii(X11hexname(params().backgroundcolor))
2118 docstring const dstyles = css.str();
2119 if (!dstyles.empty()) {
2120 bool written = false;
2121 if (params().html_css_as_file) {
2122 // open a file for CSS info
2124 string const fcssname = addName(temppath(), "docstyle.css");
2125 FileName const fcssfile = FileName(fcssname);
2126 if (openFileWrite(ocss, fcssfile)) {
2130 // write link to header
2131 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2133 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2136 // we are here if the CSS is supposed to be written to the header
2137 // or if we failed to write it to an external file.
2139 os << "<style type='text/css'>\n"
2148 bool const output_body_tag = (output != IncludedFile);
2149 if (output_body_tag)
2150 os << "<body dir=\"auto\">\n";
2152 if (output != IncludedFile)
2153 // if we're an included file, the counters are in the master.
2154 params().documentClass().counters().reset();
2155 xhtmlParagraphs(text(), *this, xs, runparams);
2156 if (output_body_tag)
2160 if (output_preamble)
2165 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2166 // Other flags: -wall -v0 -x
2167 int Buffer::runChktex()
2171 // get LaTeX-Filename
2172 FileName const path(temppath());
2173 string const name = addName(path.absFileName(), latexName());
2174 string const org_path = filePath();
2176 PathChanger p(path); // path to LaTeX file
2177 message(_("Running chktex..."));
2179 // Generate the LaTeX file if neccessary
2180 OutputParams runparams(¶ms().encoding());
2181 runparams.flavor = OutputParams::LATEX;
2182 runparams.nice = false;
2183 runparams.linelen = lyxrc.plaintext_linelen;
2184 makeLaTeXFile(FileName(name), org_path, runparams);
2187 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2188 int const res = chktex.run(terr); // run chktex
2191 Alert::error(_("chktex failure"),
2192 _("Could not run chktex successfully."));
2194 ErrorList & errlist = d->errorLists["ChkTeX"];
2196 bufferErrors(terr, errlist);
2201 if (runparams.silent)
2202 d->errorLists["ChkTeX"].clear();
2210 void Buffer::validate(LaTeXFeatures & features) const
2212 // Validate the buffer params, but not for included
2213 // files, since they also use the parent buffer's
2215 if (!features.runparams().is_child)
2216 params().validate(features);
2218 for (Paragraph const & p : paragraphs())
2219 p.validate(features);
2221 if (lyxerr.debugging(Debug::LATEX)) {
2222 features.showStruct();
2227 void Buffer::getLabelList(vector<docstring> & list) const
2229 // If this is a child document, use the master's list instead.
2231 masterBuffer()->getLabelList(list);
2236 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2237 Toc::const_iterator toc_it = toc->begin();
2238 Toc::const_iterator end = toc->end();
2239 for (; toc_it != end; ++toc_it) {
2240 if (toc_it->depth() == 0)
2241 list.push_back(toc_it->str());
2246 void Buffer::updateBibfilesCache(UpdateScope scope) const
2248 // FIXME This is probably unnecssary, given where we call this.
2249 // If this is a child document, use the parent's cache instead.
2250 if (parent() && scope != UpdateChildOnly) {
2251 masterBuffer()->updateBibfilesCache();
2255 d->bibfiles_cache_.clear();
2256 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2257 if (it->lyxCode() == BIBTEX_CODE) {
2258 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2259 support::FileNameList const bibfiles = inset.getBibFiles();
2260 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2263 } else if (it->lyxCode() == INCLUDE_CODE) {
2264 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2265 Buffer const * const incbuf = inset.getChildBuffer();
2268 support::FileNameList const & bibfiles =
2269 incbuf->getBibfilesCache(UpdateChildOnly);
2270 if (!bibfiles.empty()) {
2271 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2277 d->bibfile_cache_valid_ = true;
2278 d->bibinfo_cache_valid_ = false;
2279 d->cite_labels_valid_ = false;
2283 void Buffer::invalidateBibinfoCache() const
2285 d->bibinfo_cache_valid_ = false;
2286 d->cite_labels_valid_ = false;
2287 // also invalidate the cache for the parent buffer
2288 Buffer const * const pbuf = d->parent();
2290 pbuf->invalidateBibinfoCache();
2294 void Buffer::invalidateBibfileCache() const
2296 d->bibfile_cache_valid_ = false;
2297 d->bibinfo_cache_valid_ = false;
2298 d->cite_labels_valid_ = false;
2299 // also invalidate the cache for the parent buffer
2300 Buffer const * const pbuf = d->parent();
2302 pbuf->invalidateBibfileCache();
2306 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2308 // FIXME This is probably unnecessary, given where we call this.
2309 // If this is a child document, use the master's cache instead.
2310 Buffer const * const pbuf = masterBuffer();
2311 if (pbuf != this && scope != UpdateChildOnly)
2312 return pbuf->getBibfilesCache();
2314 if (!d->bibfile_cache_valid_)
2315 this->updateBibfilesCache(scope);
2317 return d->bibfiles_cache_;
2321 BiblioInfo const & Buffer::masterBibInfo() const
2323 Buffer const * const tmp = masterBuffer();
2325 return tmp->masterBibInfo();
2330 void Buffer::checkIfBibInfoCacheIsValid() const
2332 // use the master's cache
2333 Buffer const * const tmp = masterBuffer();
2335 tmp->checkIfBibInfoCacheIsValid();
2339 // compare the cached timestamps with the actual ones.
2340 FileNameList const & bibfiles_cache = getBibfilesCache();
2341 FileNameList::const_iterator ei = bibfiles_cache.begin();
2342 FileNameList::const_iterator en = bibfiles_cache.end();
2343 for (; ei != en; ++ ei) {
2344 time_t lastw = ei->lastModified();
2345 time_t prevw = d->bibfile_status_[*ei];
2346 if (lastw != prevw) {
2347 d->bibinfo_cache_valid_ = false;
2348 d->cite_labels_valid_ = false;
2349 d->bibfile_status_[*ei] = lastw;
2355 void Buffer::reloadBibInfoCache() const
2357 // use the master's cache
2358 Buffer const * const tmp = masterBuffer();
2360 tmp->reloadBibInfoCache();
2364 checkIfBibInfoCacheIsValid();
2365 if (d->bibinfo_cache_valid_)
2368 d->bibinfo_.clear();
2370 d->bibinfo_cache_valid_ = true;
2374 void Buffer::collectBibKeys() const
2376 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2377 it->collectBibKeys(it);
2381 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2383 Buffer const * tmp = masterBuffer();
2384 BiblioInfo & masterbi = (tmp == this) ?
2385 d->bibinfo_ : tmp->d->bibinfo_;
2386 masterbi.mergeBiblioInfo(bi);
2390 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2392 Buffer const * tmp = masterBuffer();
2393 BiblioInfo & masterbi = (tmp == this) ?
2394 d->bibinfo_ : tmp->d->bibinfo_;
2399 void Buffer::makeCitationLabels() const
2401 Buffer const * const master = masterBuffer();
2402 return d->bibinfo_.makeCitationLabels(*master);
2406 bool Buffer::citeLabelsValid() const
2408 return masterBuffer()->d->cite_labels_valid_;
2412 void Buffer::removeBiblioTempFiles() const
2414 // We remove files that contain LaTeX commands specific to the
2415 // particular bibliographic style being used, in order to avoid
2416 // LaTeX errors when we switch style.
2417 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2418 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2419 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2420 aux_file.removeFile();
2421 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2422 bbl_file.removeFile();
2423 // Also for the parent buffer
2424 Buffer const * const pbuf = parent();
2426 pbuf->removeBiblioTempFiles();
2430 bool Buffer::isDepClean(string const & name) const
2432 DepClean::const_iterator const it = d->dep_clean.find(name);
2433 if (it == d->dep_clean.end())
2439 void Buffer::markDepClean(string const & name)
2441 d->dep_clean[name] = true;
2445 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2448 // FIXME? if there is an Buffer LFUN that can be dispatched even
2449 // if internal, put a switch '(cmd.action)' here.
2455 switch (cmd.action()) {
2457 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2458 flag.setOnOff(isReadonly());
2461 // FIXME: There is need for a command-line import.
2462 //case LFUN_BUFFER_IMPORT:
2464 case LFUN_BUFFER_AUTO_SAVE:
2467 case LFUN_BUFFER_EXPORT_CUSTOM:
2468 // FIXME: Nothing to check here?
2471 case LFUN_BUFFER_EXPORT: {
2472 docstring const arg = cmd.argument();
2473 if (arg == "custom") {
2477 string format = to_utf8(arg);
2478 size_t pos = format.find(' ');
2479 if (pos != string::npos)
2480 format = format.substr(0, pos);
2481 enable = params().isExportable(format, false);
2483 flag.message(bformat(
2484 _("Don't know how to export to format: %1$s"), arg));
2488 case LFUN_BUFFER_CHKTEX:
2489 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2492 case LFUN_BUILD_PROGRAM:
2493 enable = params().isExportable("program", false);
2496 case LFUN_BRANCH_ACTIVATE:
2497 case LFUN_BRANCH_DEACTIVATE:
2498 case LFUN_BRANCH_MASTER_ACTIVATE:
2499 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2500 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2501 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2502 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2503 : params().branchlist();
2504 docstring const branchName = cmd.argument();
2505 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2509 case LFUN_BRANCH_ADD:
2510 case LFUN_BRANCHES_RENAME:
2511 // if no Buffer is present, then of course we won't be called!
2514 case LFUN_BUFFER_LANGUAGE:
2515 enable = !isReadonly();
2518 case LFUN_BUFFER_VIEW_CACHE:
2519 (d->preview_file_).refresh();
2520 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2523 case LFUN_CHANGES_TRACK:
2524 flag.setEnabled(true);
2525 flag.setOnOff(params().track_changes);
2528 case LFUN_CHANGES_OUTPUT:
2529 flag.setEnabled(true);
2530 flag.setOnOff(params().output_changes);
2533 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
2534 flag.setOnOff(params().compressed);
2538 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
2539 flag.setOnOff(params().output_sync);
2546 flag.setEnabled(enable);
2551 void Buffer::dispatch(string const & command, DispatchResult & result)
2553 return dispatch(lyxaction.lookupFunc(command), result);
2557 // NOTE We can end up here even if we have no GUI, because we are called
2558 // by LyX::exec to handled command-line requests. So we may need to check
2559 // whether we have a GUI or not. The boolean use_gui holds this information.
2560 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2563 // FIXME? if there is an Buffer LFUN that can be dispatched even
2564 // if internal, put a switch '(cmd.action())' here.
2565 dr.dispatched(false);
2568 string const argument = to_utf8(func.argument());
2569 // We'll set this back to false if need be.
2570 bool dispatched = true;
2571 undo().beginUndoGroup();
2573 switch (func.action()) {
2574 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2575 if (lyxvc().inUse()) {
2576 string log = lyxvc().toggleReadOnly();
2581 setReadonly(!isReadonly());
2584 case LFUN_BUFFER_EXPORT: {
2585 ExportStatus const status = doExport(argument, false);
2586 dr.setError(status != ExportSuccess);
2587 if (status != ExportSuccess)
2588 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2593 case LFUN_BUILD_PROGRAM: {
2594 ExportStatus const status = doExport("program", true);
2595 dr.setError(status != ExportSuccess);
2596 if (status != ExportSuccess)
2597 dr.setMessage(_("Error generating literate programming code."));
2601 case LFUN_BUFFER_CHKTEX:
2605 case LFUN_BUFFER_EXPORT_CUSTOM: {
2607 string command = split(argument, format_name, ' ');
2608 Format const * format = formats.getFormat(format_name);
2610 lyxerr << "Format \"" << format_name
2611 << "\" not recognized!"
2616 // The name of the file created by the conversion process
2619 // Output to filename
2620 if (format->name() == "lyx") {
2621 string const latexname = latexName(false);
2622 filename = changeExtension(latexname,
2623 format->extension());
2624 filename = addName(temppath(), filename);
2626 if (!writeFile(FileName(filename)))
2630 doExport(format_name, true, filename);
2633 // Substitute $$FName for filename
2634 if (!contains(command, "$$FName"))
2635 command = "( " + command + " ) < $$FName";
2636 command = subst(command, "$$FName", filename);
2638 // Execute the command in the background
2640 call.startscript(Systemcall::DontWait, command,
2641 filePath(), layoutPos());
2645 // FIXME: There is need for a command-line import.
2647 case LFUN_BUFFER_IMPORT:
2652 case LFUN_BUFFER_AUTO_SAVE:
2654 resetAutosaveTimers();
2657 case LFUN_BRANCH_ACTIVATE:
2658 case LFUN_BRANCH_DEACTIVATE:
2659 case LFUN_BRANCH_MASTER_ACTIVATE:
2660 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2661 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2662 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2663 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2666 docstring const branch_name = func.argument();
2667 // the case without a branch name is handled elsewhere
2668 if (branch_name.empty()) {
2672 Branch * branch = buf->params().branchlist().find(branch_name);
2674 LYXERR0("Branch " << branch_name << " does not exist.");
2676 docstring const msg =
2677 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2681 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2682 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2683 if (branch->isSelected() != activate) {
2684 buf->undo().recordUndoBufferParams(CursorData());
2685 branch->setSelected(activate);
2687 dr.screenUpdate(Update::Force);
2688 dr.forceBufferUpdate();
2693 case LFUN_BRANCH_ADD: {
2694 docstring branch_name = func.argument();
2695 if (branch_name.empty()) {
2699 BranchList & branch_list = params().branchlist();
2700 vector<docstring> const branches =
2701 getVectorFromString(branch_name, branch_list.separator());
2703 for (vector<docstring>::const_iterator it = branches.begin();
2704 it != branches.end(); ++it) {
2706 Branch * branch = branch_list.find(branch_name);
2708 LYXERR0("Branch " << branch_name << " already exists.");
2712 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2714 undo().recordUndoBufferParams(CursorData());
2715 branch_list.add(branch_name);
2716 branch = branch_list.find(branch_name);
2717 string const x11hexname = X11hexname(branch->color());
2718 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2719 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2721 dr.screenUpdate(Update::Force);
2729 case LFUN_BRANCHES_RENAME: {
2730 if (func.argument().empty())
2733 docstring const oldname = from_utf8(func.getArg(0));
2734 docstring const newname = from_utf8(func.getArg(1));
2735 InsetIterator it = inset_iterator_begin(inset());
2736 InsetIterator const end = inset_iterator_end(inset());
2737 bool success = false;
2738 for (; it != end; ++it) {
2739 if (it->lyxCode() == BRANCH_CODE) {
2740 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2741 if (ins.branch() == oldname) {
2742 undo().recordUndo(CursorData(it));
2743 ins.rename(newname);
2748 if (it->lyxCode() == INCLUDE_CODE) {
2749 // get buffer of external file
2750 InsetInclude const & ins =
2751 static_cast<InsetInclude const &>(*it);
2752 Buffer * child = ins.getChildBuffer();
2755 child->dispatch(func, dr);
2760 dr.screenUpdate(Update::Force);
2761 dr.forceBufferUpdate();
2766 case LFUN_BUFFER_VIEW_CACHE:
2767 if (!formats.view(*this, d->preview_file_,
2768 d->preview_format_))
2769 dr.setMessage(_("Error viewing the output file."));
2772 case LFUN_CHANGES_TRACK:
2773 if (params().save_transient_properties)
2774 undo().recordUndoBufferParams(CursorData());
2775 params().track_changes = !params().track_changes;
2776 if (!params().track_changes)
2777 dr.forceChangesUpdate();
2780 case LFUN_CHANGES_OUTPUT:
2781 if (params().save_transient_properties)
2782 undo().recordUndoBufferParams(CursorData());
2783 params().output_changes = !params().output_changes;
2784 if (params().output_changes) {
2785 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2786 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2787 LaTeXFeatures::isAvailable("xcolor");
2789 if (!dvipost && !xcolorulem) {
2790 Alert::warning(_("Changes not shown in LaTeX output"),
2791 _("Changes will not be highlighted in LaTeX output, "
2792 "because neither dvipost nor xcolor/ulem are installed.\n"
2793 "Please install these packages or redefine "
2794 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2795 } else if (!xcolorulem) {
2796 Alert::warning(_("Changes not shown in LaTeX output"),
2797 _("Changes will not be highlighted in LaTeX output "
2798 "when using pdflatex, because xcolor and ulem are not installed.\n"
2799 "Please install both packages or redefine "
2800 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2805 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2806 // turn compression on/off
2807 undo().recordUndoBufferParams(CursorData());
2808 params().compressed = !params().compressed;
2811 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2812 undo().recordUndoBufferParams(CursorData());
2813 params().output_sync = !params().output_sync;
2820 dr.dispatched(dispatched);
2821 undo().endUndoGroup();
2825 void Buffer::changeLanguage(Language const * from, Language const * to)
2827 LASSERT(from, return);
2828 LASSERT(to, return);
2830 for_each(par_iterator_begin(),
2832 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2836 bool Buffer::isMultiLingual() const
2838 ParConstIterator end = par_iterator_end();
2839 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2840 if (it->isMultiLingual(params()))
2847 std::set<Language const *> Buffer::getLanguages() const
2849 std::set<Language const *> languages;
2850 getLanguages(languages);
2855 void Buffer::getLanguages(std::set<Language const *> & languages) const
2857 ParConstIterator end = par_iterator_end();
2858 // add the buffer language, even if it's not actively used
2859 languages.insert(language());
2860 // iterate over the paragraphs
2861 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2862 it->getLanguages(languages);
2864 ListOfBuffers clist = getDescendents();
2865 ListOfBuffers::const_iterator cit = clist.begin();
2866 ListOfBuffers::const_iterator const cen = clist.end();
2867 for (; cit != cen; ++cit)
2868 (*cit)->getLanguages(languages);
2872 DocIterator Buffer::getParFromID(int const id) const
2874 Buffer * buf = const_cast<Buffer *>(this);
2876 // This means non-existent
2877 return doc_iterator_end(buf);
2879 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2880 if (it.paragraph().id() == id)
2883 return doc_iterator_end(buf);
2887 bool Buffer::hasParWithID(int const id) const
2889 return !getParFromID(id).atEnd();
2893 ParIterator Buffer::par_iterator_begin()
2895 return ParIterator(doc_iterator_begin(this));
2899 ParIterator Buffer::par_iterator_end()
2901 return ParIterator(doc_iterator_end(this));
2905 ParConstIterator Buffer::par_iterator_begin() const
2907 return ParConstIterator(doc_iterator_begin(this));
2911 ParConstIterator Buffer::par_iterator_end() const
2913 return ParConstIterator(doc_iterator_end(this));
2917 Language const * Buffer::language() const
2919 return params().language;
2923 docstring const Buffer::B_(string const & l10n) const
2925 return params().B_(l10n);
2929 bool Buffer::isClean() const
2931 return d->lyx_clean;
2935 bool Buffer::isExternallyModified(CheckMethod method) const
2937 LASSERT(d->filename.exists(), return false);
2938 // if method == timestamp, check timestamp before checksum
2939 return (method == checksum_method
2940 || d->timestamp_ != d->filename.lastModified())
2941 && d->checksum_ != d->filename.checksum();
2945 void Buffer::saveCheckSum() const
2947 FileName const & file = d->filename;
2950 if (file.exists()) {
2951 d->timestamp_ = file.lastModified();
2952 d->checksum_ = file.checksum();
2954 // in the case of save to a new file.
2961 void Buffer::markClean() const
2963 if (!d->lyx_clean) {
2964 d->lyx_clean = true;
2967 // if the .lyx file has been saved, we don't need an
2969 d->bak_clean = true;
2970 d->undo_.markDirty();
2974 void Buffer::setUnnamed(bool flag)
2980 bool Buffer::isUnnamed() const
2987 /// Don't check unnamed, here: isInternal() is used in
2988 /// newBuffer(), where the unnamed flag has not been set by anyone
2989 /// yet. Also, for an internal buffer, there should be no need for
2990 /// retrieving fileName() nor for checking if it is unnamed or not.
2991 bool Buffer::isInternal() const
2993 return d->internal_buffer;
2997 void Buffer::setInternal(bool flag)
2999 d->internal_buffer = flag;
3003 void Buffer::markDirty()
3006 d->lyx_clean = false;
3009 d->bak_clean = false;
3011 DepClean::iterator it = d->dep_clean.begin();
3012 DepClean::const_iterator const end = d->dep_clean.end();
3014 for (; it != end; ++it)
3019 FileName Buffer::fileName() const
3025 string Buffer::absFileName() const
3027 return d->filename.absFileName();
3031 string Buffer::filePath() const
3033 string const abs = d->filename.onlyPath().absFileName();
3036 int last = abs.length() - 1;
3038 return abs[last] == '/' ? abs : abs + '/';
3042 DocFileName Buffer::getReferencedFileName(string const & fn) const
3045 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3046 result.set(fn, filePath());
3048 // filePath() ends with a path separator
3049 FileName const test(filePath() + fn);
3051 result.set(fn, filePath());
3053 result.set(fn, params().origin);
3060 string Buffer::layoutPos() const
3062 return d->layout_position;
3066 void Buffer::setLayoutPos(string const & path)
3069 d->layout_position.clear();
3073 LATTEST(FileName::isAbsolute(path));
3075 d->layout_position =
3076 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3078 if (d->layout_position.empty())
3079 d->layout_position = ".";
3083 bool Buffer::isReadonly() const
3085 return d->read_only;
3089 void Buffer::setParent(Buffer const * buffer)
3091 // Avoids recursive include.
3092 d->setParent(buffer == this ? 0 : buffer);
3097 Buffer const * Buffer::parent() const
3103 ListOfBuffers Buffer::allRelatives() const
3105 ListOfBuffers lb = masterBuffer()->getDescendents();
3106 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3111 Buffer const * Buffer::masterBuffer() const
3113 // FIXME Should be make sure we are not in some kind
3114 // of recursive include? A -> B -> A will crash this.
3115 Buffer const * const pbuf = d->parent();
3119 return pbuf->masterBuffer();
3123 bool Buffer::isChild(Buffer * child) const
3125 return d->children_positions.find(child) != d->children_positions.end();
3129 DocIterator Buffer::firstChildPosition(Buffer const * child)
3131 Impl::BufferPositionMap::iterator it;
3132 it = d->children_positions.find(child);
3133 if (it == d->children_positions.end())
3134 return DocIterator(this);
3139 bool Buffer::hasChildren() const
3141 return !d->children_positions.empty();
3145 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3147 // loop over children
3148 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3149 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3150 for (; it != end; ++it) {
3151 Buffer * child = const_cast<Buffer *>(it->first);
3153 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3154 if (bit != clist.end())
3156 clist.push_back(child);
3158 // there might be grandchildren
3159 child->collectChildren(clist, true);
3164 ListOfBuffers Buffer::getChildren() const
3167 collectChildren(v, false);
3168 // Make sure we have not included ourselves.
3169 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3170 if (bit != v.end()) {
3171 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3178 ListOfBuffers Buffer::getDescendents() const
3181 collectChildren(v, true);
3182 // Make sure we have not included ourselves.
3183 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3184 if (bit != v.end()) {
3185 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3192 template<typename M>
3193 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3198 typename M::const_iterator it = m.lower_bound(x);
3199 if (it == m.begin())
3207 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3208 DocIterator const & pos) const
3210 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3212 // if paragraphs have no macro context set, pos will be empty
3216 // we haven't found anything yet
3217 DocIterator bestPos = owner_->par_iterator_begin();
3218 MacroData const * bestData = 0;
3220 // find macro definitions for name
3221 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3222 if (nameIt != macros.end()) {
3223 // find last definition in front of pos or at pos itself
3224 PositionScopeMacroMap::const_iterator it
3225 = greatest_below(nameIt->second, pos);
3226 if (it != nameIt->second.end()) {
3228 // scope ends behind pos?
3229 if (pos < it->second.scope) {
3230 // Looks good, remember this. If there
3231 // is no external macro behind this,
3232 // we found the right one already.
3233 bestPos = it->first;
3234 bestData = &it->second.macro;
3238 // try previous macro if there is one
3239 if (it == nameIt->second.begin())
3246 // find macros in included files
3247 PositionScopeBufferMap::const_iterator it
3248 = greatest_below(position_to_children, pos);
3249 if (it == position_to_children.end())
3250 // no children before
3254 // do we know something better (i.e. later) already?
3255 if (it->first < bestPos )
3258 // scope ends behind pos?
3259 if (pos < it->second.scope
3260 && (cloned_buffer_ ||
3261 theBufferList().isLoaded(it->second.buffer))) {
3262 // look for macro in external file
3264 MacroData const * data
3265 = it->second.buffer->getMacro(name, false);
3268 bestPos = it->first;
3274 // try previous file if there is one
3275 if (it == position_to_children.begin())
3280 // return the best macro we have found
3285 MacroData const * Buffer::getMacro(docstring const & name,
3286 DocIterator const & pos, bool global) const
3291 // query buffer macros
3292 MacroData const * data = d->getBufferMacro(name, pos);
3296 // If there is a master buffer, query that
3297 Buffer const * const pbuf = d->parent();
3299 d->macro_lock = true;
3300 MacroData const * macro = pbuf->getMacro(
3301 name, *this, false);
3302 d->macro_lock = false;
3308 data = MacroTable::globalMacros().get(name);
3317 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3319 // set scope end behind the last paragraph
3320 DocIterator scope = par_iterator_begin();
3321 scope.pit() = scope.lastpit() + 1;
3323 return getMacro(name, scope, global);
3327 MacroData const * Buffer::getMacro(docstring const & name,
3328 Buffer const & child, bool global) const
3330 // look where the child buffer is included first
3331 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3332 if (it == d->children_positions.end())
3335 // check for macros at the inclusion position
3336 return getMacro(name, it->second, global);
3340 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3342 pit_type const lastpit = it.lastpit();
3344 // look for macros in each paragraph
3345 while (it.pit() <= lastpit) {
3346 Paragraph & par = it.paragraph();
3348 // iterate over the insets of the current paragraph
3349 InsetList const & insets = par.insetList();
3350 InsetList::const_iterator iit = insets.begin();
3351 InsetList::const_iterator end = insets.end();
3352 for (; iit != end; ++iit) {
3353 it.pos() = iit->pos;
3355 // is it a nested text inset?
3356 if (iit->inset->asInsetText()) {
3357 // Inset needs its own scope?
3358 InsetText const * itext = iit->inset->asInsetText();
3359 bool newScope = itext->isMacroScope();
3361 // scope which ends just behind the inset
3362 DocIterator insetScope = it;
3365 // collect macros in inset
3366 it.push_back(CursorSlice(*iit->inset));
3367 updateMacros(it, newScope ? insetScope : scope);
3372 if (iit->inset->asInsetTabular()) {
3373 CursorSlice slice(*iit->inset);
3374 size_t const numcells = slice.nargs();
3375 for (; slice.idx() < numcells; slice.forwardIdx()) {
3376 it.push_back(slice);
3377 updateMacros(it, scope);
3383 // is it an external file?
3384 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3385 // get buffer of external file
3386 InsetInclude const & inset =
3387 static_cast<InsetInclude const &>(*iit->inset);
3389 Buffer * child = inset.getChildBuffer();
3394 // register its position, but only when it is
3395 // included first in the buffer
3396 if (children_positions.find(child) ==
3397 children_positions.end())
3398 children_positions[child] = it;
3400 // register child with its scope
3401 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3405 InsetMath * im = iit->inset->asInsetMath();
3406 if (doing_export && im) {
3407 InsetMathHull * hull = im->asHullInset();
3409 hull->recordLocation(it);
3412 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3416 MathMacroTemplate & macroTemplate =
3417 *iit->inset->asInsetMath()->asMacroTemplate();
3418 MacroContext mc(owner_, it);
3419 macroTemplate.updateToContext(mc);
3422 bool valid = macroTemplate.validMacro();
3423 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3424 // then the BufferView's cursor will be invalid in
3425 // some cases which leads to crashes.
3430 // FIXME (Abdel), I don't understand why we pass 'it' here
3431 // instead of 'macroTemplate' defined above... is this correct?
3432 macros[macroTemplate.name()][it] =
3433 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3443 void Buffer::updateMacros() const
3448 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3450 // start with empty table
3452 d->children_positions.clear();
3453 d->position_to_children.clear();
3455 // Iterate over buffer, starting with first paragraph
3456 // The scope must be bigger than any lookup DocIterator
3457 // later. For the global lookup, lastpit+1 is used, hence
3458 // we use lastpit+2 here.
3459 DocIterator it = par_iterator_begin();
3460 DocIterator outerScope = it;
3461 outerScope.pit() = outerScope.lastpit() + 2;
3462 d->updateMacros(it, outerScope);
3466 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3468 InsetIterator it = inset_iterator_begin(inset());
3469 InsetIterator const end = inset_iterator_end(inset());
3470 for (; it != end; ++it) {
3471 if (it->lyxCode() == BRANCH_CODE) {
3472 InsetBranch & br = static_cast<InsetBranch &>(*it);
3473 docstring const name = br.branch();
3474 if (!from_master && !params().branchlist().find(name))
3475 result.push_back(name);
3476 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3477 result.push_back(name);
3480 if (it->lyxCode() == INCLUDE_CODE) {
3481 // get buffer of external file
3482 InsetInclude const & ins =
3483 static_cast<InsetInclude const &>(*it);
3484 Buffer * child = ins.getChildBuffer();
3487 child->getUsedBranches(result, true);
3490 // remove duplicates
3495 void Buffer::updateMacroInstances(UpdateType utype) const
3497 LYXERR(Debug::MACROS, "updateMacroInstances for "
3498 << d->filename.onlyFileName());
3499 DocIterator it = doc_iterator_begin(this);
3501 DocIterator const end = doc_iterator_end(this);
3502 for (; it != end; it.forwardInset()) {
3503 // look for MathData cells in InsetMathNest insets
3504 InsetMath * minset = it.nextInset()->asInsetMath();
3508 // update macro in all cells of the InsetMathNest
3509 DocIterator::idx_type n = minset->nargs();
3510 MacroContext mc = MacroContext(this, it);
3511 for (DocIterator::idx_type i = 0; i < n; ++i) {
3512 MathData & data = minset->cell(i);
3513 data.updateMacros(0, mc, utype);
3519 void Buffer::listMacroNames(MacroNameSet & macros) const
3524 d->macro_lock = true;
3526 // loop over macro names
3527 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3528 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3529 for (; nameIt != nameEnd; ++nameIt)
3530 macros.insert(nameIt->first);
3532 // loop over children
3533 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3534 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3535 for (; it != end; ++it)
3536 it->first->listMacroNames(macros);
3539 Buffer const * const pbuf = d->parent();
3541 pbuf->listMacroNames(macros);
3543 d->macro_lock = false;
3547 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3549 Buffer const * const pbuf = d->parent();
3554 pbuf->listMacroNames(names);
3557 MacroNameSet::iterator it = names.begin();
3558 MacroNameSet::iterator end = names.end();
3559 for (; it != end; ++it) {
3561 MacroData const * data =
3562 pbuf->getMacro(*it, *this, false);
3564 macros.insert(data);
3566 // we cannot access the original MathMacroTemplate anymore
3567 // here to calls validate method. So we do its work here manually.
3568 // FIXME: somehow make the template accessible here.
3569 if (data->optionals() > 0)
3570 features.require("xargs");
3576 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3579 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3581 RefCache::iterator it = d->ref_cache_.find(label);
3582 if (it != d->ref_cache_.end())
3583 return it->second.second;
3585 static InsetLabel const * dummy_il = 0;
3586 static References const dummy_refs = References();
3587 it = d->ref_cache_.insert(
3588 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3589 return it->second.second;
3593 Buffer::References const & Buffer::references(docstring const & label) const
3595 return const_cast<Buffer *>(this)->getReferenceCache(label);
3599 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3601 References & refs = getReferenceCache(label);
3602 refs.push_back(make_pair(inset, it));
3606 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3608 masterBuffer()->d->ref_cache_[label].first = il;
3612 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3614 return masterBuffer()->d->ref_cache_[label].first;
3618 void Buffer::clearReferenceCache() const
3621 d->ref_cache_.clear();
3625 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3627 //FIXME: This does not work for child documents yet.
3628 reloadBibInfoCache();
3630 // Check if the label 'from' appears more than once
3631 BiblioInfo const & keys = masterBibInfo();
3632 BiblioInfo::const_iterator bit = keys.begin();
3633 BiblioInfo::const_iterator bend = keys.end();
3634 vector<docstring> labels;
3636 for (; bit != bend; ++bit)
3638 labels.push_back(bit->first);
3640 if (count(labels.begin(), labels.end(), from) > 1)
3643 string const paramName = "key";
3644 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3645 if (it->lyxCode() != CITE_CODE)
3647 InsetCommand * inset = it->asInsetCommand();
3648 docstring const oldValue = inset->getParam(paramName);
3649 if (oldValue == from)
3650 inset->setParam(paramName, to);
3654 // returns NULL if id-to-row conversion is unsupported
3655 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3656 pit_type par_begin, pit_type par_end,
3657 OutputWhat output, bool master) const
3659 unique_ptr<TexRow> texrow;
3660 OutputParams runparams(¶ms().encoding());
3661 runparams.nice = true;
3662 runparams.flavor = params().getOutputFlavor(format);
3663 runparams.linelen = lyxrc.plaintext_linelen;
3664 // No side effect of file copying and image conversion
3665 runparams.dryrun = true;
3667 if (output == CurrentParagraph) {
3668 runparams.par_begin = par_begin;
3669 runparams.par_end = par_end;
3670 if (par_begin + 1 == par_end) {
3672 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3676 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3677 convert<docstring>(par_begin),
3678 convert<docstring>(par_end - 1))
3681 // output paragraphs
3682 if (runparams.flavor == OutputParams::LYX) {
3683 Paragraph const & par = text().paragraphs()[par_begin];
3685 depth_type dt = par.getDepth();
3686 par.write(ods, params(), dt);
3687 os << from_utf8(ods.str());
3688 } else if (runparams.flavor == OutputParams::HTML) {
3690 setMathFlavor(runparams);
3691 xhtmlParagraphs(text(), *this, xs, runparams);
3692 } else if (runparams.flavor == OutputParams::TEXT) {
3694 // FIXME Handles only one paragraph, unlike the others.
3695 // Probably should have some routine with a signature like them.
3696 writePlaintextParagraph(*this,
3697 text().paragraphs()[par_begin], os, runparams, dummy);
3698 } else if (params().isDocBook()) {
3699 docbookParagraphs(text(), *this, os, runparams);
3701 // If we are previewing a paragraph, even if this is the
3702 // child of some other buffer, let's cut the link here,
3703 // so that no concurring settings from the master
3704 // (e.g. branch state) interfere (see #8101).
3706 d->ignore_parent = true;
3707 // We need to validate the Buffer params' features here
3708 // in order to know if we should output polyglossia
3709 // macros (instead of babel macros)
3710 LaTeXFeatures features(*this, params(), runparams);
3711 params().validate(features);
3712 runparams.use_polyglossia = features.usePolyglossia();
3713 // latex or literate
3716 ots.texrow().newlines(2);
3718 latexParagraphs(*this, text(), ots, runparams);
3719 texrow = ots.releaseTexRow();
3721 // Restore the parenthood
3723 d->ignore_parent = false;
3727 if (output == FullSource)
3728 os << _("Preview source code");
3729 else if (output == OnlyPreamble)
3730 os << _("Preview preamble");
3731 else if (output == OnlyBody)
3732 os << _("Preview body");
3734 if (runparams.flavor == OutputParams::LYX) {
3736 if (output == FullSource)
3738 else if (output == OnlyPreamble)
3739 params().writeFile(ods, this);
3740 else if (output == OnlyBody)
3742 os << from_utf8(ods.str());
3743 } else if (runparams.flavor == OutputParams::HTML) {
3744 writeLyXHTMLSource(os, runparams, output);
3745 } else if (runparams.flavor == OutputParams::TEXT) {
3746 if (output == OnlyPreamble) {
3747 os << "% "<< _("Plain text does not have a preamble.");
3749 writePlaintextFile(*this, os, runparams);
3750 } else if (params().isDocBook()) {
3751 writeDocBookSource(os, absFileName(), runparams, output);
3753 // latex or literate
3756 ots.texrow().newlines(2);
3758 runparams.is_child = true;
3759 writeLaTeXSource(ots, string(), runparams, output);
3760 texrow = ots.releaseTexRow();
3767 ErrorList & Buffer::errorList(string const & type) const
3769 return d->errorLists[type];
3773 void Buffer::updateTocItem(std::string const & type,
3774 DocIterator const & dit) const
3777 d->gui_->updateTocItem(type, dit);
3781 void Buffer::structureChanged() const
3784 d->gui_->structureChanged();
3788 void Buffer::errors(string const & err, bool from_master) const
3791 d->gui_->errors(err, from_master);
3795 void Buffer::message(docstring const & msg) const
3798 d->gui_->message(msg);
3802 void Buffer::setBusy(bool on) const
3805 d->gui_->setBusy(on);
3809 void Buffer::updateTitles() const
3812 d->wa_->updateTitles();
3816 void Buffer::resetAutosaveTimers() const
3819 d->gui_->resetAutosaveTimers();
3823 bool Buffer::hasGuiDelegate() const
3829 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3838 class AutoSaveBuffer : public ForkedProcess {
3841 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3842 : buffer_(buffer), fname_(fname) {}
3844 virtual shared_ptr<ForkedProcess> clone() const
3846 return make_shared<AutoSaveBuffer>(*this);
3851 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3852 from_utf8(fname_.absFileName())));
3853 return run(DontWait);
3857 virtual int generateChild();
3859 Buffer const & buffer_;
3864 int AutoSaveBuffer::generateChild()
3866 #if defined(__APPLE__)
3867 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3868 * We should use something else like threads.
3870 * Since I do not know how to determine at run time what is the OS X
3871 * version, I just disable forking altogether for now (JMarc)
3873 pid_t const pid = -1;
3875 // tmp_ret will be located (usually) in /tmp
3876 // will that be a problem?
3877 // Note that this calls ForkedCalls::fork(), so it's
3878 // ok cross-platform.
3879 pid_t const pid = fork();
3880 // If you want to debug the autosave
3881 // you should set pid to -1, and comment out the fork.
3882 if (pid != 0 && pid != -1)
3886 // pid = -1 signifies that lyx was unable
3887 // to fork. But we will do the save
3889 bool failed = false;
3890 TempFile tempfile("lyxautoXXXXXX.lyx");
3891 tempfile.setAutoRemove(false);
3892 FileName const tmp_ret = tempfile.name();
3893 if (!tmp_ret.empty()) {
3894 if (!buffer_.writeFile(tmp_ret))
3896 else if (!tmp_ret.moveTo(fname_))
3902 // failed to write/rename tmp_ret so try writing direct
3903 if (!buffer_.writeFile(fname_)) {
3904 // It is dangerous to do this in the child,
3905 // but safe in the parent, so...
3906 if (pid == -1) // emit message signal.
3907 buffer_.message(_("Autosave failed!"));
3911 if (pid == 0) // we are the child so...
3920 FileName Buffer::getEmergencyFileName() const
3922 return FileName(d->filename.absFileName() + ".emergency");
3926 FileName Buffer::getAutosaveFileName() const
3928 // if the document is unnamed try to save in the backup dir, else
3929 // in the default document path, and as a last try in the filePath,
3930 // which will most often be the temporary directory
3933 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3934 : lyxrc.backupdir_path;
3935 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3938 string const fname = "#" + d->filename.onlyFileName() + "#";
3940 return makeAbsPath(fname, fpath);
3944 void Buffer::removeAutosaveFile() const
3946 FileName const f = getAutosaveFileName();
3952 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3954 FileName const newauto = getAutosaveFileName();
3956 if (newauto != oldauto && oldauto.exists())
3957 if (!oldauto.moveTo(newauto))
3958 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3962 bool Buffer::autoSave() const
3964 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3965 if (buf->d->bak_clean || isReadonly())
3968 message(_("Autosaving current document..."));
3969 buf->d->bak_clean = true;
3971 FileName const fname = getAutosaveFileName();
3972 LASSERT(d->cloned_buffer_, return false);
3974 // If this buffer is cloned, we assume that
3975 // we are running in a separate thread already.
3976 TempFile tempfile("lyxautoXXXXXX.lyx");
3977 tempfile.setAutoRemove(false);
3978 FileName const tmp_ret = tempfile.name();
3979 if (!tmp_ret.empty()) {
3981 // assume successful write of tmp_ret
3982 if (tmp_ret.moveTo(fname))
3985 // failed to write/rename tmp_ret so try writing direct
3986 return writeFile(fname);
3990 void Buffer::setExportStatus(bool e) const
3992 d->doing_export = e;
3993 ListOfBuffers clist = getDescendents();
3994 ListOfBuffers::const_iterator cit = clist.begin();
3995 ListOfBuffers::const_iterator const cen = clist.end();
3996 for (; cit != cen; ++cit)
3997 (*cit)->d->doing_export = e;
4001 bool Buffer::isExporting() const
4003 return d->doing_export;
4007 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4011 return doExport(target, put_in_tempdir, result_file);
4014 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4015 string & result_file) const
4017 bool const update_unincluded =
4018 params().maintain_unincluded_children
4019 && !params().getIncludedChildren().empty();
4021 // (1) export with all included children (omit \includeonly)
4022 if (update_unincluded) {
4023 ExportStatus const status =
4024 doExport(target, put_in_tempdir, true, result_file);
4025 if (status != ExportSuccess)
4028 // (2) export with included children only
4029 return doExport(target, put_in_tempdir, false, result_file);
4033 void Buffer::setMathFlavor(OutputParams & op) const
4035 switch (params().html_math_output) {
4036 case BufferParams::MathML:
4037 op.math_flavor = OutputParams::MathAsMathML;
4039 case BufferParams::HTML:
4040 op.math_flavor = OutputParams::MathAsHTML;
4042 case BufferParams::Images:
4043 op.math_flavor = OutputParams::MathAsImages;
4045 case BufferParams::LaTeX:
4046 op.math_flavor = OutputParams::MathAsLaTeX;
4052 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4053 bool includeall, string & result_file) const
4055 LYXERR(Debug::FILES, "target=" << target);
4056 OutputParams runparams(¶ms().encoding());
4057 string format = target;
4058 string dest_filename;
4059 size_t pos = target.find(' ');
4060 if (pos != string::npos) {
4061 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4062 format = target.substr(0, pos);
4063 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4064 FileName(dest_filename).onlyPath().createPath();
4065 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4067 MarkAsExporting exporting(this);
4068 string backend_format;
4069 runparams.flavor = OutputParams::LATEX;
4070 runparams.linelen = lyxrc.plaintext_linelen;
4071 runparams.includeall = includeall;
4072 vector<string> backs = params().backends();
4073 Converters converters = theConverters();
4074 bool need_nice_file = false;
4075 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4076 // Get shortest path to format
4077 converters.buildGraph();
4078 Graph::EdgePath path;
4079 for (vector<string>::const_iterator it = backs.begin();
4080 it != backs.end(); ++it) {
4081 Graph::EdgePath p = converters.getPath(*it, format);
4082 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4083 backend_format = *it;
4088 if (!put_in_tempdir) {
4089 // Only show this alert if this is an export to a non-temporary
4090 // file (not for previewing).
4091 Alert::error(_("Couldn't export file"), bformat(
4092 _("No information for exporting the format %1$s."),
4093 formats.prettyName(format)));
4095 return ExportNoPathToFormat;
4097 runparams.flavor = converters.getFlavor(path, this);
4098 Graph::EdgePath::const_iterator it = path.begin();
4099 Graph::EdgePath::const_iterator en = path.end();
4100 for (; it != en; ++it)
4101 if (theConverters().get(*it).nice()) {
4102 need_nice_file = true;
4107 backend_format = format;
4108 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4109 // FIXME: Don't hardcode format names here, but use a flag
4110 if (backend_format == "pdflatex")
4111 runparams.flavor = OutputParams::PDFLATEX;
4112 else if (backend_format == "luatex")
4113 runparams.flavor = OutputParams::LUATEX;
4114 else if (backend_format == "dviluatex")
4115 runparams.flavor = OutputParams::DVILUATEX;
4116 else if (backend_format == "xetex")
4117 runparams.flavor = OutputParams::XETEX;
4120 string filename = latexName(false);
4121 filename = addName(temppath(), filename);
4122 filename = changeExtension(filename,
4123 formats.extension(backend_format));
4124 LYXERR(Debug::FILES, "filename=" << filename);
4126 // Plain text backend
4127 if (backend_format == "text") {
4128 runparams.flavor = OutputParams::TEXT;
4129 writePlaintextFile(*this, FileName(filename), runparams);
4132 else if (backend_format == "xhtml") {
4133 runparams.flavor = OutputParams::HTML;
4134 setMathFlavor(runparams);
4135 makeLyXHTMLFile(FileName(filename), runparams);
4136 } else if (backend_format == "lyx")
4137 writeFile(FileName(filename));
4139 else if (params().isDocBook()) {
4140 runparams.nice = !put_in_tempdir;
4141 makeDocBookFile(FileName(filename), runparams);
4144 else if (backend_format == format || need_nice_file) {
4145 runparams.nice = true;
4146 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4147 if (d->cloned_buffer_)
4148 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4151 } else if (!lyxrc.tex_allows_spaces
4152 && contains(filePath(), ' ')) {
4153 Alert::error(_("File name error"),
4154 _("The directory path to the document cannot contain spaces."));
4155 return ExportTexPathHasSpaces;
4157 runparams.nice = false;
4158 bool const success = makeLaTeXFile(
4159 FileName(filename), filePath(), runparams);
4160 if (d->cloned_buffer_)
4161 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4166 string const error_type = (format == "program")
4167 ? "Build" : params().bufferFormat();
4168 ErrorList & error_list = d->errorLists[error_type];
4169 string const ext = formats.extension(format);
4170 FileName const tmp_result_file(changeExtension(filename, ext));
4171 bool const success = converters.convert(this, FileName(filename),
4172 tmp_result_file, FileName(absFileName()), backend_format, format,
4175 // Emit the signal to show the error list or copy it back to the
4176 // cloned Buffer so that it can be emitted afterwards.
4177 if (format != backend_format) {
4178 if (runparams.silent)
4180 else if (d->cloned_buffer_)
4181 d->cloned_buffer_->d->errorLists[error_type] =
4182 d->errorLists[error_type];
4185 // also to the children, in case of master-buffer-view
4186 ListOfBuffers clist = getDescendents();
4187 ListOfBuffers::const_iterator cit = clist.begin();
4188 ListOfBuffers::const_iterator const cen = clist.end();
4189 for (; cit != cen; ++cit) {
4190 if (runparams.silent)
4191 (*cit)->d->errorLists[error_type].clear();
4192 else if (d->cloned_buffer_) {
4193 // Enable reverse search by copying back the
4194 // texrow object to the cloned buffer.
4195 // FIXME: this is not thread safe.
4196 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4197 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4198 (*cit)->d->errorLists[error_type];
4200 (*cit)->errors(error_type, true);
4204 if (d->cloned_buffer_) {
4205 // Enable reverse dvi or pdf to work by copying back the texrow
4206 // object to the cloned buffer.
4207 // FIXME: There is a possibility of concurrent access to texrow
4208 // here from the main GUI thread that should be securized.
4209 d->cloned_buffer_->d->texrow = d->texrow;
4210 string const error_type = params().bufferFormat();
4211 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4215 if (put_in_tempdir) {
4216 result_file = tmp_result_file.absFileName();
4217 return success ? ExportSuccess : ExportConverterError;
4220 if (dest_filename.empty())
4221 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4223 result_file = dest_filename;
4224 // We need to copy referenced files (e. g. included graphics
4225 // if format == "dvi") to the result dir.
4226 vector<ExportedFile> const files =
4227 runparams.exportdata->externalFiles(format);
4228 string const dest = runparams.export_folder.empty() ?
4229 onlyPath(result_file) : runparams.export_folder;
4230 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4231 : force_overwrite == ALL_FILES;
4232 CopyStatus status = use_force ? FORCE : SUCCESS;
4234 vector<ExportedFile>::const_iterator it = files.begin();
4235 vector<ExportedFile>::const_iterator const en = files.end();
4236 for (; it != en && status != CANCEL; ++it) {
4237 string const fmt = formats.getFormatFromFile(it->sourceName);
4238 string fixedName = it->exportName;
4239 if (!runparams.export_folder.empty()) {
4240 // Relative pathnames starting with ../ will be sanitized
4241 // if exporting to a different folder
4242 while (fixedName.substr(0, 3) == "../")
4243 fixedName = fixedName.substr(3, fixedName.length() - 3);
4245 FileName fixedFileName = makeAbsPath(fixedName, dest);
4246 fixedFileName.onlyPath().createPath();
4247 status = copyFile(fmt, it->sourceName,
4249 it->exportName, status == FORCE,
4250 runparams.export_folder.empty());
4253 if (status == CANCEL) {
4254 message(_("Document export cancelled."));
4255 return ExportCancel;
4258 if (tmp_result_file.exists()) {
4259 // Finally copy the main file
4260 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4261 : force_overwrite != NO_FILES;
4262 if (status == SUCCESS && use_force)
4264 status = copyFile(format, tmp_result_file,
4265 FileName(result_file), result_file,
4267 if (status == CANCEL) {
4268 message(_("Document export cancelled."));
4269 return ExportCancel;
4271 message(bformat(_("Document exported as %1$s "
4273 formats.prettyName(format),
4274 makeDisplayPath(result_file)));
4277 // This must be a dummy converter like fax (bug 1888)
4278 message(bformat(_("Document exported as %1$s"),
4279 formats.prettyName(format)));
4282 return success ? ExportSuccess : ExportConverterError;
4286 Buffer::ExportStatus Buffer::preview(string const & format) const
4288 bool const update_unincluded =
4289 params().maintain_unincluded_children
4290 && !params().getIncludedChildren().empty();
4291 return preview(format, update_unincluded);
4295 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4297 MarkAsExporting exporting(this);
4299 // (1) export with all included children (omit \includeonly)
4301 ExportStatus const status = doExport(format, true, true, result_file);
4302 if (status != ExportSuccess)
4305 // (2) export with included children only
4306 ExportStatus const status = doExport(format, true, false, result_file);
4307 FileName const previewFile(result_file);
4309 Impl * theimpl = isClone() ? d->cloned_buffer_->d : d;
4310 theimpl->preview_file_ = previewFile;
4311 theimpl->preview_format_ = format;
4312 theimpl->preview_error_ = (status != ExportSuccess);
4314 if (status != ExportSuccess)
4317 if (previewFile.exists())
4318 return formats.view(*this, previewFile, format) ?
4319 PreviewSuccess : PreviewError;
4321 // Successful export but no output file?
4322 // Probably a bug in error detection.
4323 LATTEST(status != ExportSuccess);
4328 Buffer::ReadStatus Buffer::extractFromVC()
4330 bool const found = LyXVC::file_not_found_hook(d->filename);
4332 return ReadFileNotFound;
4333 if (!d->filename.isReadableFile())
4339 Buffer::ReadStatus Buffer::loadEmergency()
4341 FileName const emergencyFile = getEmergencyFileName();
4342 if (!emergencyFile.exists()
4343 || emergencyFile.lastModified() <= d->filename.lastModified())
4344 return ReadFileNotFound;
4346 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4347 docstring const text = bformat(_("An emergency save of the document "
4348 "%1$s exists.\n\nRecover emergency save?"), file);
4350 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4351 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4357 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4358 bool const success = (ret_llf == ReadSuccess);
4361 Alert::warning(_("File is read-only"),
4362 bformat(_("An emergency file is successfully loaded, "
4363 "but the original file %1$s is marked read-only. "
4364 "Please make sure to save the document as a different "
4365 "file."), from_utf8(d->filename.absFileName())));
4368 lyxvc().file_found_hook(d->filename);
4369 str = _("Document was successfully recovered.");
4371 str = _("Document was NOT successfully recovered.");
4372 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4373 makeDisplayPath(emergencyFile.absFileName()));
4375 int const del_emerg =
4376 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4377 _("&Remove"), _("&Keep"));
4378 if (del_emerg == 0) {
4379 emergencyFile.removeFile();
4381 Alert::warning(_("Emergency file deleted"),
4382 _("Do not forget to save your file now!"), true);
4384 return success ? ReadSuccess : ReadEmergencyFailure;
4387 int const del_emerg =
4388 Alert::prompt(_("Delete emergency file?"),
4389 _("Remove emergency file now?"), 1, 1,
4390 _("&Remove"), _("&Keep"));
4392 emergencyFile.removeFile();
4393 return ReadOriginal;
4403 Buffer::ReadStatus Buffer::loadAutosave()
4405 // Now check if autosave file is newer.
4406 FileName const autosaveFile = getAutosaveFileName();
4407 if (!autosaveFile.exists()
4408 || autosaveFile.lastModified() <= d->filename.lastModified())
4409 return ReadFileNotFound;
4411 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4412 docstring const text = bformat(_("The backup of the document %1$s "
4413 "is newer.\n\nLoad the backup instead?"), file);
4414 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4415 _("&Load backup"), _("Load &original"), _("&Cancel"));
4420 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4421 // the file is not saved if we load the autosave file.
4422 if (ret_llf == ReadSuccess) {
4424 Alert::warning(_("File is read-only"),
4425 bformat(_("A backup file is successfully loaded, "
4426 "but the original file %1$s is marked read-only. "
4427 "Please make sure to save the document as a "
4429 from_utf8(d->filename.absFileName())));
4432 lyxvc().file_found_hook(d->filename);
4435 return ReadAutosaveFailure;
4438 // Here we delete the autosave
4439 autosaveFile.removeFile();
4440 return ReadOriginal;
4448 Buffer::ReadStatus Buffer::loadLyXFile()
4450 if (!d->filename.isReadableFile()) {
4451 ReadStatus const ret_rvc = extractFromVC();
4452 if (ret_rvc != ReadSuccess)
4456 ReadStatus const ret_re = loadEmergency();
4457 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4460 ReadStatus const ret_ra = loadAutosave();
4461 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4464 return loadThisLyXFile(d->filename);
4468 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4470 return readFile(fn);
4474 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4476 for (auto const & err : terr) {
4477 TexRow::TextEntry start, end = TexRow::text_none;
4478 int errorRow = err.error_in_line;
4479 Buffer const * buf = 0;
4481 if (err.child_name.empty())
4482 tie(start, end) = p->texrow.getEntriesFromRow(errorRow);
4484 // The error occurred in a child
4485 for (Buffer const * child : getDescendents()) {
4486 string const child_name =
4487 DocFileName(changeExtension(child->absFileName(), "tex")).
4489 if (err.child_name != child_name)
4491 tie(start, end) = child->d->texrow.getEntriesFromRow(errorRow);
4492 if (!TexRow::isNone(start)) {
4493 buf = d->cloned_buffer_
4494 ? child->d->cloned_buffer_->d->owner_
4501 errorList.push_back(ErrorItem(err.error_desc, err.error_text,
4507 void Buffer::setBuffersForInsets() const
4509 inset().setBuffer(const_cast<Buffer &>(*this));
4513 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4515 LBUFERR(!text().paragraphs().empty());
4517 // Use the master text class also for child documents
4518 Buffer const * const master = masterBuffer();
4519 DocumentClass const & textclass = master->params().documentClass();
4521 // do this only if we are the top-level Buffer
4522 if (master == this) {
4523 textclass.counters().reset(from_ascii("bibitem"));
4524 reloadBibInfoCache();
4527 // keep the buffers to be children in this set. If the call from the
4528 // master comes back we can see which of them were actually seen (i.e.
4529 // via an InsetInclude). The remaining ones in the set need still be updated.
4530 static std::set<Buffer const *> bufToUpdate;
4531 if (scope == UpdateMaster) {
4532 // If this is a child document start with the master
4533 if (master != this) {
4534 bufToUpdate.insert(this);
4535 master->updateBuffer(UpdateMaster, utype);
4536 // If the master buffer has no gui associated with it, then the TocModel is
4537 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4538 // (bug 5699). The same happens if the master buffer is open in a different
4539 // window. This test catches both possibilities.
4540 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4541 // There remains a problem here: If there is another child open in yet a third
4542 // window, that TOC is not updated. So some more general solution is needed at
4544 if (master->d->gui_ != d->gui_)
4547 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4548 if (bufToUpdate.find(this) == bufToUpdate.end())
4552 // start over the counters in the master
4553 textclass.counters().reset();
4556 // update will be done below for this buffer
4557 bufToUpdate.erase(this);
4559 // update all caches
4560 clearReferenceCache();
4562 setChangesPresent(false);
4564 Buffer & cbuf = const_cast<Buffer &>(*this);
4567 ParIterator parit = cbuf.par_iterator_begin();
4568 updateBuffer(parit, utype);
4571 // TocBackend update will be done later.
4574 d->bibinfo_cache_valid_ = true;
4575 d->cite_labels_valid_ = true;
4577 cbuf.tocBackend().update(true, utype);
4578 if (scope == UpdateMaster)
4579 cbuf.structureChanged();
4583 static depth_type getDepth(DocIterator const & it)
4585 depth_type depth = 0;
4586 for (size_t i = 0 ; i < it.depth() ; ++i)
4587 if (!it[i].inset().inMathed())
4588 depth += it[i].paragraph().getDepth() + 1;
4589 // remove 1 since the outer inset does not count
4590 // we should have at least one non-math inset, so
4591 // depth should nevery be 0. but maybe it is worth
4592 // marking this, just in case.
4594 // coverity[INTEGER_OVERFLOW]
4598 static depth_type getItemDepth(ParIterator const & it)
4600 Paragraph const & par = *it;
4601 LabelType const labeltype = par.layout().labeltype;
4603 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4606 // this will hold the lowest depth encountered up to now.
4607 depth_type min_depth = getDepth(it);
4608 ParIterator prev_it = it;
4611 --prev_it.top().pit();
4613 // start of nested inset: go to outer par
4615 if (prev_it.empty()) {
4616 // start of document: nothing to do
4621 // We search for the first paragraph with same label
4622 // that is not more deeply nested.
4623 Paragraph & prev_par = *prev_it;
4624 depth_type const prev_depth = getDepth(prev_it);
4625 if (labeltype == prev_par.layout().labeltype) {
4626 if (prev_depth < min_depth)
4627 return prev_par.itemdepth + 1;
4628 if (prev_depth == min_depth)
4629 return prev_par.itemdepth;
4631 min_depth = min(min_depth, prev_depth);
4632 // small optimization: if we are at depth 0, we won't
4633 // find anything else
4634 if (prev_depth == 0)
4640 static bool needEnumCounterReset(ParIterator const & it)
4642 Paragraph const & par = *it;
4643 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4644 depth_type const cur_depth = par.getDepth();
4645 ParIterator prev_it = it;
4646 while (prev_it.pit()) {
4647 --prev_it.top().pit();
4648 Paragraph const & prev_par = *prev_it;
4649 if (prev_par.getDepth() <= cur_depth)
4650 return prev_par.layout().name() != par.layout().name();
4652 // start of nested inset: reset
4657 // set the label of a paragraph. This includes the counters.
4658 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4660 BufferParams const & bp = owner_->masterBuffer()->params();
4661 DocumentClass const & textclass = bp.documentClass();
4662 Paragraph & par = it.paragraph();
4663 Layout const & layout = par.layout();
4664 Counters & counters = textclass.counters();
4666 if (par.params().startOfAppendix()) {
4667 // We want to reset the counter corresponding to toplevel sectioning
4668 Layout const & lay = textclass.getTOCLayout();
4669 docstring const cnt = lay.counter;
4671 counters.reset(cnt);
4672 counters.appendix(true);
4674 par.params().appendix(counters.appendix());
4676 // Compute the item depth of the paragraph
4677 par.itemdepth = getItemDepth(it);
4679 if (layout.margintype == MARGIN_MANUAL) {
4680 if (par.params().labelWidthString().empty())
4681 par.params().labelWidthString(par.expandLabel(layout, bp));
4682 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4683 // we do not need to do anything here, since the empty case is
4684 // handled during export.
4686 par.params().labelWidthString(docstring());
4689 switch(layout.labeltype) {
4690 case LABEL_ITEMIZE: {
4691 // At some point of time we should do something more
4692 // clever here, like:
4693 // par.params().labelString(
4694 // bp.user_defined_bullet(par.itemdepth).getText());
4695 // for now, use a simple hardcoded label
4696 docstring itemlabel;
4697 switch (par.itemdepth) {
4699 itemlabel = char_type(0x2022);
4702 itemlabel = char_type(0x2013);
4705 itemlabel = char_type(0x2217);
4708 itemlabel = char_type(0x2219); // or 0x00b7
4711 par.params().labelString(itemlabel);
4715 case LABEL_ENUMERATE: {
4716 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4718 switch (par.itemdepth) {
4727 enumcounter += "iv";
4730 // not a valid enumdepth...
4734 // Increase the master counter?
4735 if (layout.stepmastercounter && needEnumCounterReset(it))
4736 counters.stepMaster(enumcounter, utype);
4738 // Maybe we have to reset the enumeration counter.
4739 if (!layout.resumecounter && needEnumCounterReset(it))
4740 counters.reset(enumcounter);
4741 counters.step(enumcounter, utype);
4743 string const & lang = par.getParLanguage(bp)->code();
4744 par.params().labelString(counters.theCounter(enumcounter, lang));
4749 case LABEL_SENSITIVE: {
4750 string const & type = counters.current_float();
4751 docstring full_label;
4753 full_label = owner_->B_("Senseless!!! ");
4755 docstring name = owner_->B_(textclass.floats().getType(type).name());
4756 if (counters.hasCounter(from_utf8(type))) {
4757 string const & lang = par.getParLanguage(bp)->code();
4758 counters.step(from_utf8(type), utype);
4759 full_label = bformat(from_ascii("%1$s %2$s:"),
4761 counters.theCounter(from_utf8(type), lang));
4763 full_label = bformat(from_ascii("%1$s #:"), name);
4765 par.params().labelString(full_label);
4769 case LABEL_NO_LABEL:
4770 par.params().labelString(docstring());
4774 case LABEL_CENTERED:
4775 case LABEL_STATIC: {
4776 docstring const & lcounter = layout.counter;
4777 if (!lcounter.empty()) {
4778 if (layout.toclevel <= bp.secnumdepth
4779 && (layout.latextype != LATEX_ENVIRONMENT
4780 || it.text()->isFirstInSequence(it.pit()))) {
4781 if (counters.hasCounter(lcounter))
4782 counters.step(lcounter, utype);
4783 par.params().labelString(par.expandLabel(layout, bp));
4785 par.params().labelString(docstring());
4787 par.params().labelString(par.expandLabel(layout, bp));
4793 par.params().labelString(par.expandLabel(layout, bp));
4798 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4800 // LASSERT: Is it safe to continue here, or should we just return?
4801 LASSERT(parit.pit() == 0, /**/);
4803 // Set the position of the text in the buffer to be able
4804 // to resolve macros in it.
4805 parit.text()->setMacrocontextPosition(parit);
4807 depth_type maxdepth = 0;
4808 pit_type const lastpit = parit.lastpit();
4809 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4810 // reduce depth if necessary
4811 if (parit->params().depth() > maxdepth) {
4812 /** FIXME: this function is const, but
4813 * nevertheless it modifies the buffer. To be
4814 * cleaner, one should modify the buffer in
4815 * another function, which is actually
4816 * non-const. This would however be costly in
4817 * terms of code duplication.
4819 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4820 parit->params().depth(maxdepth);
4822 maxdepth = parit->getMaxDepthAfter();
4824 if (utype == OutputUpdate) {
4825 // track the active counters
4826 // we have to do this for the master buffer, since the local
4827 // buffer isn't tracking anything.
4828 masterBuffer()->params().documentClass().counters().
4829 setActiveLayout(parit->layout());
4832 // set the counter for this paragraph
4833 d->setLabel(parit, utype);
4835 // update change-tracking flag
4836 parit->addChangesToBuffer(*this);
4839 InsetList::const_iterator iit = parit->insetList().begin();
4840 InsetList::const_iterator end = parit->insetList().end();
4841 for (; iit != end; ++iit) {
4842 parit.pos() = iit->pos;
4843 iit->inset->updateBuffer(parit, utype);
4849 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4850 WordLangTuple & word_lang, docstring_list & suggestions) const
4854 suggestions.clear();
4855 word_lang = WordLangTuple();
4856 bool const to_end = to.empty();
4857 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4858 // OK, we start from here.
4859 for (; from != end; from.forwardPos()) {
4860 // This skips all insets with spell check disabled.
4861 while (!from.allowSpellCheck()) {
4865 // If from is at the end of the document (which is possible
4866 // when "from" was changed above) LyX will crash later otherwise.
4867 if (from.atEnd() || (!to_end && from >= end))
4870 from.paragraph().spellCheck();
4871 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4872 if (SpellChecker::misspelled(res)) {
4876 // Do not increase progress when from == to, otherwise the word
4877 // count will be wrong.
4887 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4889 bool inword = false;
4894 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4895 if (!dit.inTexted()) {
4900 Paragraph const & par = dit.paragraph();
4901 pos_type const pos = dit.pos();
4903 // Copied and adapted from isWordSeparator() in Paragraph
4904 if (pos == dit.lastpos()) {
4907 Inset const * ins = par.getInset(pos);
4908 if (ins && skipNoOutput && !ins->producesOutput()) {
4911 // stop if end of range was skipped
4912 if (!to.atEnd() && dit >= to)
4915 } else if (!par.isDeleted(pos)) {
4916 if (par.isWordSeparator(pos))
4922 if (ins && ins->isLetter())
4924 else if (ins && ins->isSpace())
4927 char_type const c = par.getChar(pos);
4928 if (isPrintableNonspace(c))
4930 else if (isSpace(c))
4940 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4942 d->updateStatistics(from, to, skipNoOutput);
4946 int Buffer::wordCount() const
4948 return d->wordCount();
4952 int Buffer::charCount(bool with_blanks) const
4954 return d->charCount(with_blanks);
4958 Buffer::ReadStatus Buffer::reload()
4961 // c.f. bug http://www.lyx.org/trac/ticket/6587
4962 removeAutosaveFile();
4963 // e.g., read-only status could have changed due to version control
4964 d->filename.refresh();
4965 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4967 // clear parent. this will get reset if need be.
4969 ReadStatus const status = loadLyXFile();
4970 if (status == ReadSuccess) {
4975 message(bformat(_("Document %1$s reloaded."), disp_fn));
4978 message(bformat(_("Could not reload document %1$s."), disp_fn));
4988 bool Buffer::saveAs(FileName const & fn)
4990 FileName const old_name = fileName();
4991 FileName const old_auto = getAutosaveFileName();
4992 bool const old_unnamed = isUnnamed();
4993 bool success = true;
4994 d->old_position = filePath();
5001 // bring the autosave file with us, just in case.
5002 moveAutosaveFile(old_auto);
5003 // validate version control data and
5004 // correct buffer title
5005 lyxvc().file_found_hook(fileName());
5007 // the file has now been saved to the new location.
5008 // we need to check that the locations of child buffers
5010 checkChildBuffers();
5011 checkMasterBuffer();
5014 // reset the old filename and unnamed state
5015 setFileName(old_name);
5016 setUnnamed(old_unnamed);
5020 d->old_position.clear();
5025 void Buffer::checkChildBuffers()
5027 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5028 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5029 for (; it != en; ++it) {
5030 DocIterator dit = it->second;
5031 Buffer * cbuf = const_cast<Buffer *>(it->first);
5032 if (!cbuf || !theBufferList().isLoaded(cbuf))
5034 Inset * inset = dit.nextInset();
5035 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5036 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5037 docstring const & incfile = inset_inc->getParam("filename");
5038 string oldloc = cbuf->absFileName();
5039 string newloc = makeAbsPath(to_utf8(incfile),
5040 onlyPath(absFileName())).absFileName();
5041 if (oldloc == newloc)
5043 // the location of the child file is incorrect.
5045 inset_inc->setChildBuffer(0);
5047 // invalidate cache of children
5048 d->children_positions.clear();
5049 d->position_to_children.clear();
5053 // If a child has been saved under a different name/path, it might have been
5054 // orphaned. Therefore the master needs to be reset (bug 8161).
5055 void Buffer::checkMasterBuffer()
5057 Buffer const * const master = masterBuffer();
5061 // necessary to re-register the child (bug 5873)
5062 // FIXME: clean up updateMacros (here, only
5063 // child registering is needed).
5064 master->updateMacros();
5065 // (re)set master as master buffer, but only
5066 // if we are a real child
5067 if (master->isChild(this))
5074 string Buffer::includedFilePath(string const & name, string const & ext) const
5076 if (d->old_position.empty() ||
5077 equivalent(FileName(d->old_position), FileName(filePath())))
5080 bool isabsolute = FileName::isAbsolute(name);
5081 // both old_position and filePath() end with a path separator
5082 string absname = isabsolute ? name : d->old_position + name;
5084 // if old_position is set to origin, we need to do the equivalent of
5085 // getReferencedFileName() (see readDocument())
5086 if (!isabsolute && d->old_position == params().origin) {
5087 FileName const test(addExtension(filePath() + name, ext));
5089 absname = filePath() + name;
5092 if (!FileName(addExtension(absname, ext)).exists())
5096 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5098 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5099 from_utf8(filePath())));
5103 void Buffer::setChangesPresent(bool b) const
5105 d->tracked_changes_present_ = b;
5109 bool Buffer::areChangesPresent() const
5111 return d->tracked_changes_present_;
5115 void Buffer::updateChangesPresent() const
5117 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5118 setChangesPresent(false);
5119 ParConstIterator it = par_iterator_begin();
5120 ParConstIterator const end = par_iterator_end();
5121 for (; !areChangesPresent() && it != end; ++it)
5122 it->addChangesToBuffer(*this);