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"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibtex.h"
70 #include "insets/InsetBranch.h"
71 #include "insets/InsetInclude.h"
72 #include "insets/InsetTabular.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/alert.h"
83 #include "frontends/Delegates.h"
84 #include "frontends/WorkAreaManager.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include "support/bind.h"
107 #include "support/shared_ptr.h"
119 using namespace lyx::support;
120 using namespace lyx::graphics;
124 namespace Alert = frontend::Alert;
125 namespace os = support::os;
129 // Do not remove the comment below, so we get merge conflict in
130 // independent branches. Instead add your own.
131 int const LYX_FORMAT = 416; //uwestoehr : support for horizontal spaces (bug 7728)
133 typedef map<string, bool> DepClean;
134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
136 void showPrintError(string const & name)
138 docstring str = bformat(_("Could not print the document %1$s.\n"
139 "Check that your printer is set up correctly."),
140 makeDisplayPath(name, 50));
141 Alert::error(_("Print document failed"), str);
150 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
154 delete preview_loader_;
162 /// search for macro in local (buffer) table or in children
163 MacroData const * getBufferMacro(docstring const & name,
164 DocIterator const & pos) const;
166 /// Update macro table starting with position of it \param it in some
168 void updateMacros(DocIterator & it, DocIterator & scope);
170 void setLabel(ParIterator & it, UpdateType utype) const;
172 /** If we have branches that use the file suffix
173 feature, return the file name with suffix appended.
175 support::FileName exportFileName() const;
182 mutable TexRow texrow;
184 /// need to regenerate .tex?
188 mutable bool lyx_clean;
190 /// is autosave needed?
191 mutable bool bak_clean;
193 /// is this an unnamed file (New...)?
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;
209 mutable TocBackend toc_backend;
212 typedef pair<DocIterator, MacroData> ScopeMacro;
213 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
214 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
215 /// map from the macro name to the position map,
216 /// which maps the macro definition position to the scope and the MacroData.
217 NamePositionScopeMacroMap macros;
218 /// This seem to change the way Buffer::getMacro() works
219 mutable bool macro_lock;
221 /// positions of child buffers in the buffer
222 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
223 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
224 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
225 /// position of children buffers in this buffer
226 BufferPositionMap children_positions;
227 /// map from children inclusion positions to their scope and their buffer
228 PositionScopeBufferMap position_to_children;
230 /// Container for all sort of Buffer dependant errors.
231 map<string, ErrorList> errorLists;
233 /// timestamp and checksum used to test if the file has been externally
234 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
236 unsigned long checksum_;
239 frontend::WorkAreaManager * wa_;
241 frontend::GuiBufferDelegate * gui_;
246 /// A cache for the bibfiles (including bibfiles of loaded child
247 /// documents), needed for appropriate update of natbib labels.
248 mutable support::FileNameList bibfiles_cache_;
250 // FIXME The caching mechanism could be improved. At present, we have a
251 // cache for each Buffer, that caches all the bibliography info for that
252 // Buffer. A more efficient solution would be to have a global cache per
253 // file, and then to construct the Buffer's bibinfo from that.
254 /// A cache for bibliography info
255 mutable BiblioInfo bibinfo_;
256 /// whether the bibinfo cache is valid
257 mutable bool bibinfo_cache_valid_;
258 /// whether the bibfile cache is valid
259 mutable bool bibfile_cache_valid_;
260 /// Cache of timestamps of .bib files
261 map<FileName, time_t> bibfile_status_;
262 /// Indicates whether the bibinfo has changed since the last time
263 /// we ran updateBuffer(), i.e., whether citation labels may need
265 mutable bool cite_labels_valid_;
267 mutable RefCache ref_cache_;
269 /// our Text that should be wrapped in an InsetText
273 PreviewLoader * preview_loader_;
275 /// This is here to force the test to be done whenever parent_buffer
277 Buffer const * parent() const {
278 // if parent_buffer is not loaded, then it has been unloaded,
279 // which means that parent_buffer is an invalid pointer. So we
280 // set it to null in that case.
281 // however, the BufferList doesn't know about cloned buffers, so
282 // they will always be regarded as unloaded. in that case, we hope
284 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
286 return parent_buffer;
290 void setParent(Buffer const * pb) {
291 if (parent_buffer == pb)
294 if (!cloned_buffer_ && parent_buffer && pb)
295 LYXERR0("Warning: a buffer should not have two parents!");
297 if (!cloned_buffer_ && parent_buffer) {
298 parent_buffer->invalidateBibfileCache();
299 parent_buffer->invalidateBibinfoCache();
303 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
304 /// This one is useful for preview detached in a thread.
305 Buffer const * cloned_buffer_;
306 /// are we in the process of exporting this buffer?
307 mutable bool doing_export;
310 /// So we can force access via the accessors.
311 mutable Buffer const * parent_buffer;
316 /// Creates the per buffer temporary directory
317 static FileName createBufferTmpDir()
320 // We are in our own directory. Why bother to mangle name?
321 // In fact I wrote this code to circumvent a problematic behaviour
322 // (bug?) of EMX mkstemp().
323 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
324 convert<string>(count++));
326 if (!tmpfl.createDirectory(0777)) {
327 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
328 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
329 from_utf8(tmpfl.absFileName())));
335 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
336 Buffer const * cloned_buffer)
337 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
338 read_only(readonly_), filename(file), file_fully_loaded(false),
339 toc_backend(owner), macro_lock(false), timestamp_(0), checksum_(0),
340 wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
341 bibfile_cache_valid_(false), cite_labels_valid_(false),
342 preview_loader_(0), cloned_buffer_(cloned_buffer),
343 doing_export(false), parent_buffer(0)
345 if (!cloned_buffer_) {
346 temppath = createBufferTmpDir();
347 lyxvc.setBuffer(owner_);
349 wa_ = new frontend::WorkAreaManager;
352 temppath = cloned_buffer_->d->temppath;
353 file_fully_loaded = true;
354 params = cloned_buffer_->d->params;
355 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
356 bibinfo_ = cloned_buffer_->d->bibinfo_;
357 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
358 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
359 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
360 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
364 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
365 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
367 LYXERR(Debug::INFO, "Buffer::Buffer()");
369 d->inset = new InsetText(*cloned_buffer->d->inset);
370 d->inset->setBuffer(*this);
371 // FIXME: optimize this loop somewhat, maybe by creating a new
372 // general recursive Inset::setId().
373 DocIterator it = doc_iterator_begin(this);
374 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
375 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
376 it.paragraph().setId(cloned_it.paragraph().id());
378 d->inset = new InsetText(this);
379 d->inset->setAutoBreakRows(true);
380 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
386 LYXERR(Debug::INFO, "Buffer::~Buffer()");
387 // here the buffer should take care that it is
388 // saved properly, before it goes into the void.
390 // GuiView already destroyed
394 // No need to do additional cleanups for internal buffer.
399 // loop over children
400 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
401 Impl::BufferPositionMap::iterator end = d->children_positions.end();
402 for (; it != end; ++it) {
403 Buffer * child = const_cast<Buffer *>(it->first);
404 if (d->cloned_buffer_)
406 // The child buffer might have been closed already.
407 else if (theBufferList().isLoaded(child))
408 theBufferList().releaseChild(this, child);
412 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
413 msg += emergencyWrite();
414 Alert::warning(_("Attempting to close changed document!"), msg);
417 // clear references to children in macro tables
418 d->children_positions.clear();
419 d->position_to_children.clear();
421 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
422 Alert::warning(_("Could not remove temporary directory"),
423 bformat(_("Could not remove the temporary directory %1$s"),
424 from_utf8(d->temppath.absFileName())));
434 Buffer * Buffer::clone() const
437 masterBuffer()->clone(bufmap);
438 BufferMap::iterator it = bufmap.find(this);
439 LASSERT(it != bufmap.end(), return 0);
444 void Buffer::clone(BufferMap & bufmap) const
446 // have we already been cloned?
447 if (bufmap.find(this) != bufmap.end())
450 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
451 bufmap[this] = buffer_clone;
452 buffer_clone->d->macro_lock = true;
453 buffer_clone->d->children_positions.clear();
454 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
455 // math macro caches need to be rethought and simplified.
456 // I am not sure wether we should handle Buffer cloning here or in BufferList.
457 // Right now BufferList knows nothing about buffer clones.
458 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
459 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
460 for (; it != end; ++it) {
461 DocIterator dit = it->first.clone(buffer_clone);
462 dit.setBuffer(buffer_clone);
463 Buffer * child = const_cast<Buffer *>(it->second.second);
465 child->clone(bufmap);
466 BufferMap::iterator const bit = bufmap.find(child);
467 LASSERT(bit != bufmap.end(), continue);
468 Buffer * child_clone = bit->second;
470 Inset * inset = dit.nextInset();
471 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
472 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
473 inset_inc->setChildBuffer(child_clone);
474 child_clone->d->setParent(buffer_clone);
475 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
476 buffer_clone->setChild(dit, child_clone);
478 buffer_clone->d->macro_lock = false;
483 bool Buffer::isClone() const
485 return d->cloned_buffer_;
489 void Buffer::changed(bool update_metrics) const
492 d->wa_->redrawAll(update_metrics);
496 frontend::WorkAreaManager & Buffer::workAreaManager() const
498 LASSERT(d->wa_, /**/);
503 Text & Buffer::text() const
505 return d->inset->text();
509 Inset & Buffer::inset() const
515 BufferParams & Buffer::params()
521 BufferParams const & Buffer::params() const
527 ParagraphList & Buffer::paragraphs()
529 return text().paragraphs();
533 ParagraphList const & Buffer::paragraphs() const
535 return text().paragraphs();
539 LyXVC & Buffer::lyxvc()
545 LyXVC const & Buffer::lyxvc() const
551 string const Buffer::temppath() const
553 return d->temppath.absFileName();
557 TexRow & Buffer::texrow()
563 TexRow const & Buffer::texrow() const
569 TocBackend & Buffer::tocBackend() const
571 return d->toc_backend;
575 Undo & Buffer::undo()
581 void Buffer::setChild(DocIterator const & dit, Buffer * child)
583 d->children_positions[child] = dit;
587 string Buffer::latexName(bool const no_path) const
589 FileName latex_name =
590 makeLatexName(d->exportFileName());
591 return no_path ? latex_name.onlyFileName()
592 : latex_name.absFileName();
596 FileName Buffer::Impl::exportFileName() const
598 docstring const branch_suffix =
599 params.branchlist().getFileNameSuffix();
600 if (branch_suffix.empty())
603 string const name = filename.onlyFileNameWithoutExt()
604 + to_utf8(branch_suffix);
605 FileName res(filename.onlyPath().absFileName() + "/" + name);
606 res.changeExtension(filename.extension());
612 string Buffer::logName(LogType * type) const
614 string const filename = latexName(false);
616 if (filename.empty()) {
622 string const path = temppath();
624 FileName const fname(addName(temppath(),
625 onlyFileName(changeExtension(filename,
628 // FIXME: how do we know this is the name of the build log?
629 FileName const bname(
630 addName(path, onlyFileName(
631 changeExtension(filename,
632 formats.extension(params().bufferFormat()) + ".out"))));
634 // Also consider the master buffer log file
635 FileName masterfname = fname;
637 if (masterBuffer() != this) {
638 string const mlogfile = masterBuffer()->logName(&mtype);
639 masterfname = FileName(mlogfile);
642 // If no Latex log or Build log is newer, show Build log
643 if (bname.exists() &&
644 ((!fname.exists() && !masterfname.exists())
645 || (fname.lastModified() < bname.lastModified()
646 && masterfname.lastModified() < bname.lastModified()))) {
647 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
650 return bname.absFileName();
651 // If we have a newer master file log or only a master log, show this
652 } else if (fname != masterfname
653 && (!fname.exists() && (masterfname.exists()
654 || fname.lastModified() < masterfname.lastModified()))) {
655 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
658 return masterfname.absFileName();
660 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
663 return fname.absFileName();
667 void Buffer::setReadonly(bool const flag)
669 if (d->read_only != flag) {
676 void Buffer::setFileName(FileName const & fname)
679 setReadonly(d->filename.isReadOnly());
685 int Buffer::readHeader(Lexer & lex)
687 int unknown_tokens = 0;
689 int begin_header_line = -1;
691 // Initialize parameters that may be/go lacking in header:
692 params().branchlist().clear();
693 params().preamble.erase();
694 params().options.erase();
695 params().master.erase();
696 params().float_placement.erase();
697 params().paperwidth.erase();
698 params().paperheight.erase();
699 params().leftmargin.erase();
700 params().rightmargin.erase();
701 params().topmargin.erase();
702 params().bottommargin.erase();
703 params().headheight.erase();
704 params().headsep.erase();
705 params().footskip.erase();
706 params().columnsep.erase();
707 params().fonts_cjk.erase();
708 params().listings_params.clear();
709 params().clearLayoutModules();
710 params().clearRemovedModules();
711 params().clearIncludedChildren();
712 params().pdfoptions().clear();
713 params().indiceslist().clear();
714 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
715 params().isbackgroundcolor = false;
716 params().fontcolor = lyx::rgbFromHexName("#000000");
717 params().isfontcolor = false;
718 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
719 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
720 params().html_latex_start.clear();
721 params().html_latex_end.clear();
722 params().html_math_img_scale = 1.0;
723 params().output_sync_macro.erase();
725 for (int i = 0; i < 4; ++i) {
726 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
727 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
730 ErrorList & errorList = d->errorLists["Parse"];
739 if (token == "\\end_header")
743 if (token == "\\begin_header") {
744 begin_header_line = line;
748 LYXERR(Debug::PARSER, "Handling document header token: `"
751 string unknown = params().readToken(lex, token, d->filename.onlyPath());
752 if (!unknown.empty()) {
753 if (unknown[0] != '\\' && token == "\\textclass") {
754 Alert::warning(_("Unknown document class"),
755 bformat(_("Using the default document class, because the "
756 "class %1$s is unknown."), from_utf8(unknown)));
759 docstring const s = bformat(_("Unknown token: "
763 errorList.push_back(ErrorItem(_("Document header error"),
768 if (begin_header_line) {
769 docstring const s = _("\\begin_header is missing");
770 errorList.push_back(ErrorItem(_("Document header error"),
774 params().makeDocumentClass();
776 return unknown_tokens;
781 // changed to be public and have one parameter
782 // Returns true if "\end_document" is not read (Asger)
783 bool Buffer::readDocument(Lexer & lex)
785 ErrorList & errorList = d->errorLists["Parse"];
788 // remove dummy empty par
789 paragraphs().clear();
791 if (!lex.checkFor("\\begin_document")) {
792 docstring const s = _("\\begin_document is missing");
793 errorList.push_back(ErrorItem(_("Document header error"),
799 if (params().outputChanges) {
800 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
801 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
802 LaTeXFeatures::isAvailable("xcolor");
804 if (!dvipost && !xcolorulem) {
805 Alert::warning(_("Changes not shown in LaTeX output"),
806 _("Changes will not be highlighted in LaTeX output, "
807 "because neither dvipost nor xcolor/ulem are installed.\n"
808 "Please install these packages or redefine "
809 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
810 } else if (!xcolorulem) {
811 Alert::warning(_("Changes not shown in LaTeX output"),
812 _("Changes will not be highlighted in LaTeX output "
813 "when using pdflatex, because xcolor and ulem are not installed.\n"
814 "Please install both packages or redefine "
815 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
819 if (!params().master.empty()) {
820 FileName const master_file = makeAbsPath(params().master,
821 onlyPath(absFileName()));
822 if (isLyXFileName(master_file.absFileName())) {
824 checkAndLoadLyXFile(master_file, true);
826 // necessary e.g. after a reload
827 // to re-register the child (bug 5873)
828 // FIXME: clean up updateMacros (here, only
829 // child registering is needed).
830 master->updateMacros();
831 // set master as master buffer, but only
832 // if we are a real child
833 if (master->isChild(this))
835 // if the master is not fully loaded
836 // it is probably just loading this
837 // child. No warning needed then.
838 else if (master->isFullyLoaded())
839 LYXERR0("The master '"
841 << "' assigned to this document ("
843 << ") does not include "
844 "this document. Ignoring the master assignment.");
849 // assure we have a default index
850 params().indiceslist().addDefault(B_("Index"));
853 bool const res = text().read(lex, errorList, d->inset);
855 // inform parent buffer about local macros
857 Buffer const * pbuf = parent();
858 UserMacroSet::const_iterator cit = usermacros.begin();
859 UserMacroSet::const_iterator end = usermacros.end();
860 for (; cit != end; ++cit)
861 pbuf->usermacros.insert(*cit);
865 updateMacroInstances(InternalUpdate);
870 bool Buffer::readString(string const & s)
872 params().compressed = false;
877 FileName const fn = FileName::tempName("Buffer_readString");
880 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
881 if (ret_plf != ReadSuccess)
884 if (file_format != LYX_FORMAT) {
885 // We need to call lyx2lyx, so write the input to a file
886 ofstream os(fn.toFilesystemEncoding().c_str());
890 return readFile(fn) == ReadSuccess;
893 if (readDocument(lex))
899 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
903 if (!lex.setFile(fname)) {
904 Alert::error(_("File Not Found"),
905 bformat(_("Unable to open file `%1$s'."),
906 from_utf8(fn.absFileName())));
907 return ReadFileNotFound;
911 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
912 if (ret_plf != ReadSuccess)
915 if (file_format != LYX_FORMAT) {
917 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
918 if (ret_clf != ReadSuccess)
920 return readFile(tmpFile);
923 // FIXME: InsetInfo needs to know whether the file is under VCS
924 // during the parse process, so this has to be done before.
925 lyxvc().file_found_hook(d->filename);
927 if (readDocument(lex)) {
928 Alert::error(_("Document format failure"),
929 bformat(_("%1$s ended unexpectedly, which means"
930 " that it is probably corrupted."),
931 from_utf8(fn.absFileName())));
932 return ReadDocumentFailure;
935 d->file_fully_loaded = true;
936 d->read_only = !d->filename.isWritable();
937 params().compressed = d->filename.isZippedFile();
943 bool Buffer::isFullyLoaded() const
945 return d->file_fully_loaded;
949 void Buffer::setFullyLoaded(bool value)
951 d->file_fully_loaded = value;
955 PreviewLoader * Buffer::loader() const
957 if (lyxrc.preview == LyXRC::PREVIEW_OFF)
959 if (!d->preview_loader_)
960 d->preview_loader_ = new PreviewLoader(*this);
961 return d->preview_loader_;
965 void Buffer::removePreviews() const
967 delete d->preview_loader_;
968 d->preview_loader_ = 0;
972 void Buffer::updatePreviews() const
974 PreviewLoader * ploader = loader();
978 InsetIterator it = inset_iterator_begin(*d->inset);
979 InsetIterator const end = inset_iterator_end(*d->inset);
980 for (; it != end; ++it)
981 it->addPreview(it, *ploader);
983 ploader->startLoading();
987 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
988 FileName const & fn, int & file_format) const
990 if(!lex.checkFor("\\lyxformat")) {
991 Alert::error(_("Document format failure"),
992 bformat(_("%1$s is not a readable LyX document."),
993 from_utf8(fn.absFileName())));
994 return ReadNoLyXFormat;
1000 // LyX formats 217 and earlier were written as 2.17. This corresponds
1001 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1002 // these cases. See also: www.lyx.org/trac/changeset/1313.
1003 size_t dot = tmp_format.find_first_of(".,");
1004 if (dot != string::npos)
1005 tmp_format.erase(dot, 1);
1007 file_format = convert<int>(tmp_format);
1012 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1013 FileName & tmpfile, int from_format)
1015 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
1016 if(tmpfile.empty()) {
1017 Alert::error(_("Conversion failed"),
1018 bformat(_("%1$s is from a different"
1019 " version of LyX, but a temporary"
1020 " file for converting it could"
1021 " not be created."),
1022 from_utf8(fn.absFileName())));
1023 return LyX2LyXNoTempFile;
1026 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1027 if (lyx2lyx.empty()) {
1028 Alert::error(_("Conversion script not found"),
1029 bformat(_("%1$s is from a different"
1030 " version of LyX, but the"
1031 " conversion script lyx2lyx"
1032 " could not be found."),
1033 from_utf8(fn.absFileName())));
1034 return LyX2LyXNotFound;
1038 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1039 ostringstream command;
1040 command << os::python()
1041 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1042 << " -t " << convert<string>(LYX_FORMAT)
1043 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1044 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1045 string const command_str = command.str();
1047 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1049 cmd_ret const ret = runCommand(command_str);
1050 if (ret.first != 0) {
1051 if (from_format < LYX_FORMAT) {
1052 Alert::error(_("Conversion script failed"),
1053 bformat(_("%1$s is from an older version"
1054 " of LyX and the lyx2lyx script"
1055 " failed to convert it."),
1056 from_utf8(fn.absFileName())));
1057 return LyX2LyXOlderFormat;
1059 Alert::error(_("Conversion script failed"),
1060 bformat(_("%1$s is from a newer version"
1061 " of LyX and the lyx2lyx script"
1062 " failed to convert it."),
1063 from_utf8(fn.absFileName())));
1064 return LyX2LyXNewerFormat;
1071 // Should probably be moved to somewhere else: BufferView? GuiView?
1072 bool Buffer::save() const
1074 docstring const file = makeDisplayPath(absFileName(), 20);
1075 d->filename.refresh();
1077 // check the read-only status before moving the file as a backup
1078 if (d->filename.exists()) {
1079 bool const read_only = !d->filename.isWritable();
1081 Alert::warning(_("File is read-only"),
1082 bformat(_("The file %1$s cannot be written because it "
1083 "is marked as read-only."), file));
1088 // ask if the disk file has been externally modified (use checksum method)
1089 if (fileName().exists() && isExternallyModified(checksum_method)) {
1091 bformat(_("Document %1$s has been externally modified. "
1092 "Are you sure you want to overwrite this file?"), file);
1093 int const ret = Alert::prompt(_("Overwrite modified file?"),
1094 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1099 // We don't need autosaves in the immediate future. (Asger)
1100 resetAutosaveTimers();
1102 FileName backupName;
1103 bool madeBackup = false;
1105 // make a backup if the file already exists
1106 if (lyxrc.make_backup && fileName().exists()) {
1107 backupName = FileName(absFileName() + '~');
1108 if (!lyxrc.backupdir_path.empty()) {
1109 string const mangledName =
1110 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1111 backupName = FileName(addName(lyxrc.backupdir_path,
1115 // Except file is symlink do not copy because of #6587.
1116 // Hard links have bad luck.
1117 if (fileName().isSymLink())
1118 madeBackup = fileName().copyTo(backupName);
1120 madeBackup = fileName().moveTo(backupName);
1123 Alert::error(_("Backup failure"),
1124 bformat(_("Cannot create backup file %1$s.\n"
1125 "Please check whether the directory exists and is writable."),
1126 from_utf8(backupName.absFileName())));
1127 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1131 if (writeFile(d->filename)) {
1135 // Saving failed, so backup is not backup
1137 backupName.moveTo(d->filename);
1143 bool Buffer::writeFile(FileName const & fname) const
1145 // FIXME Do we need to do these here? I don't think writing
1146 // the LyX file depends upon it. (RGH)
1148 // updateMacroInstances();
1150 if (d->read_only && fname == d->filename)
1153 bool retval = false;
1155 docstring const str = bformat(_("Saving document %1$s..."),
1156 makeDisplayPath(fname.absFileName()));
1159 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1161 if (params().compressed) {
1162 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1163 retval = ofs && write(ofs);
1165 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1166 retval = ofs && write(ofs);
1170 message(str + _(" could not write file!"));
1175 // removeAutosaveFile();
1178 message(str + _(" done."));
1184 docstring Buffer::emergencyWrite()
1186 // No need to save if the buffer has not changed.
1190 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1192 docstring user_message = bformat(
1193 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1195 // We try to save three places:
1196 // 1) Same place as document. Unless it is an unnamed doc.
1198 string s = absFileName();
1201 if (writeFile(FileName(s))) {
1203 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1204 return user_message;
1206 user_message += " " + _("Save failed! Trying again...\n");
1210 // 2) In HOME directory.
1211 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1213 lyxerr << ' ' << s << endl;
1214 if (writeFile(FileName(s))) {
1216 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1217 return user_message;
1220 user_message += " " + _("Save failed! Trying yet again...\n");
1222 // 3) In "/tmp" directory.
1223 // MakeAbsPath to prepend the current
1224 // drive letter on OS/2
1225 s = addName(package().temp_dir().absFileName(), absFileName());
1227 lyxerr << ' ' << s << endl;
1228 if (writeFile(FileName(s))) {
1230 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1231 return user_message;
1234 user_message += " " + _("Save failed! Bummer. Document is lost.");
1237 return user_message;
1241 bool Buffer::write(ostream & ofs) const
1244 // Use the standard "C" locale for file output.
1245 ofs.imbue(locale::classic());
1248 // The top of the file should not be written by params().
1250 // write out a comment in the top of the file
1251 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1252 << " created this file. For more info see http://www.lyx.org/\n"
1253 << "\\lyxformat " << LYX_FORMAT << "\n"
1254 << "\\begin_document\n";
1256 /// For each author, set 'used' to true if there is a change
1257 /// by this author in the document; otherwise set it to 'false'.
1258 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1259 AuthorList::Authors::const_iterator a_end = params().authors().end();
1260 for (; a_it != a_end; ++a_it)
1261 a_it->setUsed(false);
1263 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1264 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1265 for ( ; it != end; ++it)
1266 it->checkAuthors(params().authors());
1268 // now write out the buffer parameters.
1269 ofs << "\\begin_header\n";
1270 params().writeFile(ofs);
1271 ofs << "\\end_header\n";
1274 ofs << "\n\\begin_body\n";
1276 ofs << "\n\\end_body\n";
1278 // Write marker that shows file is complete
1279 ofs << "\\end_document" << endl;
1281 // Shouldn't really be needed....
1284 // how to check if close went ok?
1285 // Following is an attempt... (BE 20001011)
1287 // good() returns false if any error occured, including some
1288 // formatting error.
1289 // bad() returns true if something bad happened in the buffer,
1290 // which should include file system full errors.
1295 lyxerr << "File was not closed properly." << endl;
1302 bool Buffer::makeLaTeXFile(FileName const & fname,
1303 OutputParams const & runparams_in,
1304 bool output_preamble, bool output_body) const
1306 OutputParams runparams = runparams_in;
1308 // This is necessary for LuaTeX/XeTeX with tex fonts.
1309 // See FIXME in BufferParams::encoding()
1310 if (runparams.isFullUnicode())
1311 runparams.encoding = encodings.fromLyXName("utf8-plain");
1313 string const encoding = runparams.encoding->iconvName();
1314 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1317 try { ofs.reset(encoding); }
1318 catch (iconv_codecvt_facet_exception & e) {
1319 lyxerr << "Caught iconv exception: " << e.what() << endl;
1320 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1321 "verify that the support software for your encoding (%1$s) is "
1322 "properly installed"), from_ascii(encoding)));
1325 if (!openFileWrite(ofs, fname))
1328 //TexStream ts(ofs.rdbuf(), &texrow());
1329 ErrorList & errorList = d->errorLists["Export"];
1331 bool failed_export = false;
1332 otexstream os(ofs, d->texrow);
1334 // make sure we are ready to export
1335 // this needs to be done before we validate
1336 // FIXME Do we need to do this all the time? I.e., in children
1337 // of a master we are exporting?
1339 updateMacroInstances(OutputUpdate);
1342 os.texrow().reset();
1343 writeLaTeXSource(os, runparams, output_preamble, output_body);
1345 catch (EncodingException & e) {
1346 odocstringstream ods;
1347 ods.put(e.failed_char);
1349 oss << "0x" << hex << e.failed_char << dec;
1350 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1351 " (code point %2$s)"),
1352 ods.str(), from_utf8(oss.str()));
1353 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1354 "representable in the chosen encoding.\n"
1355 "Changing the document encoding to utf8 could help."),
1356 e.par_id, e.pos, e.pos + 1));
1357 failed_export = true;
1359 catch (iconv_codecvt_facet_exception & e) {
1360 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1361 _(e.what()), -1, 0, 0));
1362 failed_export = true;
1364 catch (exception const & e) {
1365 errorList.push_back(ErrorItem(_("conversion failed"),
1366 _(e.what()), -1, 0, 0));
1367 failed_export = true;
1370 lyxerr << "Caught some really weird exception..." << endl;
1376 failed_export = true;
1377 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1381 return !failed_export;
1385 void Buffer::writeLaTeXSource(otexstream & os,
1386 OutputParams const & runparams_in,
1387 bool const output_preamble, bool const output_body) const
1389 // The child documents, if any, shall be already loaded at this point.
1391 OutputParams runparams = runparams_in;
1393 // Classify the unicode characters appearing in math insets
1394 Encodings::initUnicodeMath(*this);
1396 // validate the buffer.
1397 LYXERR(Debug::LATEX, " Validating buffer...");
1398 LaTeXFeatures features(*this, params(), runparams);
1400 LYXERR(Debug::LATEX, " Buffer validation done.");
1402 // The starting paragraph of the coming rows is the
1403 // first paragraph of the document. (Asger)
1404 if (output_preamble && runparams.nice) {
1405 os << "%% LyX " << lyx_version << " created this file. "
1406 "For more info, see http://www.lyx.org/.\n"
1407 "%% Do not edit unless you really know what "
1410 LYXERR(Debug::INFO, "lyx document header finished");
1412 // With respect to nice LaTeX, usual files have \batchmode
1413 if (output_preamble) {
1414 if (!runparams.nice) {
1415 // code for usual, NOT nice-latex-file
1416 os << "\\batchmode\n"; // changed from \nonstopmode
1419 // get parent macros (if this buffer has a parent) which will be
1420 // written at the document begin further down.
1421 MacroSet parentMacros;
1422 listParentMacros(parentMacros, features);
1424 runparams.use_polyglossia = features.usePolyglossia();
1425 // Write the preamble
1426 runparams.use_babel = params().writeLaTeX(os, features,
1427 d->filename.onlyPath());
1429 runparams.use_japanese = features.isRequired("japanese");
1435 os << "\\begin{document}\n";
1437 // output the parent macros
1438 MacroSet::iterator it = parentMacros.begin();
1439 MacroSet::iterator end = parentMacros.end();
1440 for (; it != end; ++it) {
1441 int num_lines = (*it)->write(os.os(), true);
1442 os.texrow().newlines(num_lines);
1445 } // output_preamble
1447 os.texrow().start(paragraphs().begin()->id(), 0);
1449 LYXERR(Debug::INFO, "preamble finished, now the body.");
1451 // if we are doing a real file with body, even if this is the
1452 // child of some other buffer, let's cut the link here.
1453 // This happens for example if only a child document is printed.
1454 Buffer const * save_parent = 0;
1455 if (output_preamble) {
1456 save_parent = d->parent();
1461 latexParagraphs(*this, text(), os, runparams);
1463 // Restore the parenthood if needed
1464 if (output_preamble)
1465 d->setParent(save_parent);
1467 // add this just in case after all the paragraphs
1470 if (output_preamble) {
1471 os << "\\end{document}\n";
1472 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1474 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1476 runparams_in.encoding = runparams.encoding;
1478 // Just to be sure. (Asger)
1479 os.texrow().newline();
1481 //for (int i = 0; i<d->texrow.rows(); i++) {
1483 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1484 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1487 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1488 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1492 void Buffer::makeDocBookFile(FileName const & fname,
1493 OutputParams const & runparams,
1494 bool const body_only) const
1496 LYXERR(Debug::LATEX, "makeDocBookFile...");
1499 if (!openFileWrite(ofs, fname))
1502 // make sure we are ready to export
1503 // this needs to be done before we validate
1505 updateMacroInstances(OutputUpdate);
1507 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1511 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1515 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1516 OutputParams const & runparams,
1517 bool const only_body) const
1519 LaTeXFeatures features(*this, params(), runparams);
1524 DocumentClass const & tclass = params().documentClass();
1525 string const top_element = tclass.latexname();
1528 if (runparams.flavor == OutputParams::XML)
1529 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1532 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1535 if (! tclass.class_header().empty())
1536 os << from_ascii(tclass.class_header());
1537 else if (runparams.flavor == OutputParams::XML)
1538 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1539 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1541 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1543 docstring preamble = from_utf8(params().preamble);
1544 if (runparams.flavor != OutputParams::XML ) {
1545 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1546 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1547 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1548 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1551 string const name = runparams.nice
1552 ? changeExtension(absFileName(), ".sgml") : fname;
1553 preamble += features.getIncludedFiles(name);
1554 preamble += features.getLyXSGMLEntities();
1556 if (!preamble.empty()) {
1557 os << "\n [ " << preamble << " ]";
1562 string top = top_element;
1564 if (runparams.flavor == OutputParams::XML)
1565 top += params().language->code();
1567 top += params().language->code().substr(0, 2);
1570 if (!params().options.empty()) {
1572 top += params().options;
1575 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1576 << " file was created by LyX " << lyx_version
1577 << "\n See http://www.lyx.org/ for more information -->\n";
1579 params().documentClass().counters().reset();
1581 sgml::openTag(os, top);
1583 docbookParagraphs(text(), *this, os, runparams);
1584 sgml::closeTag(os, top_element);
1588 void Buffer::makeLyXHTMLFile(FileName const & fname,
1589 OutputParams const & runparams) const
1591 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1594 if (!openFileWrite(ofs, fname))
1597 // make sure we are ready to export
1598 // this has to be done before we validate
1599 updateBuffer(UpdateMaster, OutputUpdate);
1600 updateMacroInstances(OutputUpdate);
1602 writeLyXHTMLSource(ofs, runparams);
1606 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1610 void Buffer::writeLyXHTMLSource(odocstream & os,
1611 OutputParams const & runparams,
1612 bool const only_body) const
1614 LaTeXFeatures features(*this, params(), runparams);
1616 d->bibinfo_.makeCitationLabels(*this);
1619 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1620 << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd\">\n"
1621 // FIXME Language should be set properly.
1622 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1624 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1625 // FIXME Presumably need to set this right
1626 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1628 docstring const & doctitle = features.htmlTitle();
1630 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1633 os << "\n<!-- Text Class Preamble -->\n"
1634 << features.getTClassHTMLPreamble()
1635 << "\n<!-- Preamble Snippets -->\n"
1636 << from_utf8(features.getPreambleSnippets());
1638 os << "\n<!-- Layout-provided Styles -->\n";
1639 docstring const styleinfo = features.getTClassHTMLStyles();
1640 if (!styleinfo.empty()) {
1641 os << "<style type='text/css'>\n"
1645 os << "</head>\n<body>\n";
1649 params().documentClass().counters().reset();
1650 xhtmlParagraphs(text(), *this, xs, runparams);
1652 os << "</body>\n</html>\n";
1656 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1657 // Other flags: -wall -v0 -x
1658 int Buffer::runChktex()
1662 // get LaTeX-Filename
1663 FileName const path(temppath());
1664 string const name = addName(path.absFileName(), latexName());
1666 PathChanger p(path); // path to LaTeX file
1667 message(_("Running chktex..."));
1669 // Generate the LaTeX file if neccessary
1670 OutputParams runparams(¶ms().encoding());
1671 runparams.flavor = OutputParams::LATEX;
1672 runparams.nice = false;
1673 runparams.linelen = lyxrc.plaintext_linelen;
1674 makeLaTeXFile(FileName(name), runparams);
1677 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1678 int const res = chktex.run(terr); // run chktex
1681 Alert::error(_("chktex failure"),
1682 _("Could not run chktex successfully."));
1683 } else if (res > 0) {
1684 ErrorList & errlist = d->errorLists["ChkTeX"];
1686 bufferErrors(terr, errlist);
1697 void Buffer::validate(LaTeXFeatures & features) const
1699 params().validate(features);
1701 for_each(paragraphs().begin(), paragraphs().end(),
1702 bind(&Paragraph::validate, _1, ref(features)));
1704 if (lyxerr.debugging(Debug::LATEX)) {
1705 features.showStruct();
1710 void Buffer::getLabelList(vector<docstring> & list) const
1712 // If this is a child document, use the master's list instead.
1714 masterBuffer()->getLabelList(list);
1719 Toc & toc = d->toc_backend.toc("label");
1720 TocIterator toc_it = toc.begin();
1721 TocIterator end = toc.end();
1722 for (; toc_it != end; ++toc_it) {
1723 if (toc_it->depth() == 0)
1724 list.push_back(toc_it->str());
1729 void Buffer::updateBibfilesCache(UpdateScope scope) const
1731 // FIXME This is probably unnecssary, given where we call this.
1732 // If this is a child document, use the parent's cache instead.
1733 if (parent() && scope != UpdateChildOnly) {
1734 masterBuffer()->updateBibfilesCache();
1738 d->bibfiles_cache_.clear();
1739 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1740 if (it->lyxCode() == BIBTEX_CODE) {
1741 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1742 support::FileNameList const bibfiles = inset.getBibFiles();
1743 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1746 } else if (it->lyxCode() == INCLUDE_CODE) {
1747 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1748 Buffer const * const incbuf = inset.getChildBuffer();
1751 support::FileNameList const & bibfiles =
1752 incbuf->getBibfilesCache(UpdateChildOnly);
1753 if (!bibfiles.empty()) {
1754 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1760 d->bibfile_cache_valid_ = true;
1761 d->bibinfo_cache_valid_ = false;
1762 d->cite_labels_valid_ = false;
1766 void Buffer::invalidateBibinfoCache() const
1768 d->bibinfo_cache_valid_ = false;
1769 d->cite_labels_valid_ = false;
1770 // also invalidate the cache for the parent buffer
1771 Buffer const * const pbuf = d->parent();
1773 pbuf->invalidateBibinfoCache();
1777 void Buffer::invalidateBibfileCache() const
1779 d->bibfile_cache_valid_ = false;
1780 d->bibinfo_cache_valid_ = false;
1781 d->cite_labels_valid_ = false;
1782 // also invalidate the cache for the parent buffer
1783 Buffer const * const pbuf = d->parent();
1785 pbuf->invalidateBibfileCache();
1789 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1791 // FIXME This is probably unnecessary, given where we call this.
1792 // If this is a child document, use the master's cache instead.
1793 Buffer const * const pbuf = masterBuffer();
1794 if (pbuf != this && scope != UpdateChildOnly)
1795 return pbuf->getBibfilesCache();
1797 if (!d->bibfile_cache_valid_)
1798 this->updateBibfilesCache(scope);
1800 return d->bibfiles_cache_;
1804 BiblioInfo const & Buffer::masterBibInfo() const
1806 Buffer const * const tmp = masterBuffer();
1808 return tmp->masterBibInfo();
1813 void Buffer::checkIfBibInfoCacheIsValid() const
1815 // use the master's cache
1816 Buffer const * const tmp = masterBuffer();
1818 tmp->checkIfBibInfoCacheIsValid();
1822 // compare the cached timestamps with the actual ones.
1823 FileNameList const & bibfiles_cache = getBibfilesCache();
1824 FileNameList::const_iterator ei = bibfiles_cache.begin();
1825 FileNameList::const_iterator en = bibfiles_cache.end();
1826 for (; ei != en; ++ ei) {
1827 time_t lastw = ei->lastModified();
1828 time_t prevw = d->bibfile_status_[*ei];
1829 if (lastw != prevw) {
1830 d->bibinfo_cache_valid_ = false;
1831 d->cite_labels_valid_ = false;
1832 d->bibfile_status_[*ei] = lastw;
1838 void Buffer::reloadBibInfoCache() const
1840 // use the master's cache
1841 Buffer const * const tmp = masterBuffer();
1843 tmp->reloadBibInfoCache();
1847 checkIfBibInfoCacheIsValid();
1848 if (d->bibinfo_cache_valid_)
1851 d->bibinfo_.clear();
1853 d->bibinfo_cache_valid_ = true;
1857 void Buffer::collectBibKeys() const
1859 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1860 it->collectBibKeys(it);
1864 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1866 Buffer const * tmp = masterBuffer();
1867 BiblioInfo & masterbi = (tmp == this) ?
1868 d->bibinfo_ : tmp->d->bibinfo_;
1869 masterbi.mergeBiblioInfo(bi);
1873 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1875 Buffer const * tmp = masterBuffer();
1876 BiblioInfo & masterbi = (tmp == this) ?
1877 d->bibinfo_ : tmp->d->bibinfo_;
1882 bool Buffer::citeLabelsValid() const
1884 return masterBuffer()->d->cite_labels_valid_;
1888 bool Buffer::isDepClean(string const & name) const
1890 DepClean::const_iterator const it = d->dep_clean.find(name);
1891 if (it == d->dep_clean.end())
1897 void Buffer::markDepClean(string const & name)
1899 d->dep_clean[name] = true;
1903 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1906 // FIXME? if there is an Buffer LFUN that can be dispatched even
1907 // if internal, put a switch '(cmd.action)' here.
1913 switch (cmd.action()) {
1915 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1916 flag.setOnOff(isReadonly());
1919 // FIXME: There is need for a command-line import.
1920 //case LFUN_BUFFER_IMPORT:
1922 case LFUN_BUFFER_AUTO_SAVE:
1925 case LFUN_BUFFER_EXPORT_CUSTOM:
1926 // FIXME: Nothing to check here?
1929 case LFUN_BUFFER_EXPORT: {
1930 docstring const arg = cmd.argument();
1931 enable = arg == "custom" || params().isExportable(to_utf8(arg));
1933 flag.message(bformat(
1934 _("Don't know how to export to format: %1$s"), arg));
1938 case LFUN_BUFFER_CHKTEX:
1939 enable = params().isLatex() && !lyxrc.chktex_command.empty();
1942 case LFUN_BUILD_PROGRAM:
1943 enable = params().isExportable("program");
1946 case LFUN_BRANCH_ACTIVATE:
1947 case LFUN_BRANCH_DEACTIVATE: {
1948 BranchList const & branchList = params().branchlist();
1949 docstring const branchName = cmd.argument();
1950 enable = !branchName.empty() && branchList.find(branchName);
1954 case LFUN_BRANCH_ADD:
1955 case LFUN_BRANCHES_RENAME:
1956 case LFUN_BUFFER_PRINT:
1957 // if no Buffer is present, then of course we won't be called!
1960 case LFUN_BUFFER_LANGUAGE:
1961 enable = !isReadonly();
1967 flag.setEnabled(enable);
1972 void Buffer::dispatch(string const & command, DispatchResult & result)
1974 return dispatch(lyxaction.lookupFunc(command), result);
1978 // NOTE We can end up here even if we have no GUI, because we are called
1979 // by LyX::exec to handled command-line requests. So we may need to check
1980 // whether we have a GUI or not. The boolean use_gui holds this information.
1981 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1984 // FIXME? if there is an Buffer LFUN that can be dispatched even
1985 // if internal, put a switch '(cmd.action())' here.
1986 dr.dispatched(false);
1989 string const argument = to_utf8(func.argument());
1990 // We'll set this back to false if need be.
1991 bool dispatched = true;
1992 undo().beginUndoGroup();
1994 switch (func.action()) {
1995 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1996 if (lyxvc().inUse())
1997 lyxvc().toggleReadOnly();
1999 setReadonly(!isReadonly());
2002 case LFUN_BUFFER_EXPORT: {
2003 bool success = doExport(argument, false, false);
2004 dr.setError(!success);
2006 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2011 case LFUN_BUILD_PROGRAM:
2012 doExport("program", true, false);
2015 case LFUN_BUFFER_CHKTEX:
2019 case LFUN_BUFFER_EXPORT_CUSTOM: {
2021 string command = split(argument, format_name, ' ');
2022 Format const * format = formats.getFormat(format_name);
2024 lyxerr << "Format \"" << format_name
2025 << "\" not recognized!"
2030 // The name of the file created by the conversion process
2033 // Output to filename
2034 if (format->name() == "lyx") {
2035 string const latexname = latexName(false);
2036 filename = changeExtension(latexname,
2037 format->extension());
2038 filename = addName(temppath(), filename);
2040 if (!writeFile(FileName(filename)))
2044 doExport(format_name, true, false, filename);
2047 // Substitute $$FName for filename
2048 if (!contains(command, "$$FName"))
2049 command = "( " + command + " ) < $$FName";
2050 command = subst(command, "$$FName", filename);
2052 // Execute the command in the background
2054 call.startscript(Systemcall::DontWait, command, filePath());
2058 // FIXME: There is need for a command-line import.
2060 case LFUN_BUFFER_IMPORT:
2065 case LFUN_BUFFER_AUTO_SAVE:
2067 resetAutosaveTimers();
2070 case LFUN_BRANCH_ADD: {
2071 docstring branch_name = func.argument();
2072 if (branch_name.empty()) {
2076 BranchList & branch_list = params().branchlist();
2077 vector<docstring> const branches =
2078 getVectorFromString(branch_name, branch_list.separator());
2080 for (vector<docstring>::const_iterator it = branches.begin();
2081 it != branches.end(); ++it) {
2083 Branch * branch = branch_list.find(branch_name);
2085 LYXERR0("Branch " << branch_name << " already exists.");
2089 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2091 branch_list.add(branch_name);
2092 branch = branch_list.find(branch_name);
2093 string const x11hexname = X11hexname(branch->color());
2094 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2095 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2097 dr.screenUpdate(Update::Force);
2105 case LFUN_BRANCH_ACTIVATE:
2106 case LFUN_BRANCH_DEACTIVATE: {
2107 BranchList & branchList = params().branchlist();
2108 docstring const branchName = func.argument();
2109 // the case without a branch name is handled elsewhere
2110 if (branchName.empty()) {
2114 Branch * branch = branchList.find(branchName);
2116 LYXERR0("Branch " << branchName << " does not exist.");
2118 docstring const msg =
2119 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2122 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2124 dr.screenUpdate(Update::Force);
2125 dr.forceBufferUpdate();
2130 case LFUN_BRANCHES_RENAME: {
2131 if (func.argument().empty())
2134 docstring const oldname = from_utf8(func.getArg(0));
2135 docstring const newname = from_utf8(func.getArg(1));
2136 InsetIterator it = inset_iterator_begin(inset());
2137 InsetIterator const end = inset_iterator_end(inset());
2138 bool success = false;
2139 for (; it != end; ++it) {
2140 if (it->lyxCode() == BRANCH_CODE) {
2141 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2142 if (ins.branch() == oldname) {
2143 undo().recordUndo(it);
2144 ins.rename(newname);
2149 if (it->lyxCode() == INCLUDE_CODE) {
2150 // get buffer of external file
2151 InsetInclude const & ins =
2152 static_cast<InsetInclude const &>(*it);
2153 Buffer * child = ins.getChildBuffer();
2156 child->dispatch(func, dr);
2161 dr.screenUpdate(Update::Force);
2162 dr.forceBufferUpdate();
2167 case LFUN_BUFFER_PRINT: {
2168 // we'll assume there's a problem until we succeed
2170 string target = func.getArg(0);
2171 string target_name = func.getArg(1);
2172 string command = func.getArg(2);
2175 || target_name.empty()
2176 || command.empty()) {
2177 LYXERR0("Unable to parse " << func.argument());
2178 docstring const msg =
2179 bformat(_("Unable to parse \"%1$s\""), func.argument());
2183 if (target != "printer" && target != "file") {
2184 LYXERR0("Unrecognized target \"" << target << '"');
2185 docstring const msg =
2186 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2191 bool const update_unincluded =
2192 params().maintain_unincluded_children
2193 && !params().getIncludedChildren().empty();
2194 if (!doExport("dvi", true, update_unincluded)) {
2195 showPrintError(absFileName());
2196 dr.setMessage(_("Error exporting to DVI."));
2200 // Push directory path.
2201 string const path = temppath();
2202 // Prevent the compiler from optimizing away p
2206 // there are three cases here:
2207 // 1. we print to a file
2208 // 2. we print directly to a printer
2209 // 3. we print using a spool command (print to file first)
2212 string const dviname = changeExtension(latexName(true), "dvi");
2214 if (target == "printer") {
2215 if (!lyxrc.print_spool_command.empty()) {
2216 // case 3: print using a spool
2217 string const psname = changeExtension(dviname,".ps");
2218 command += ' ' + lyxrc.print_to_file
2221 + quoteName(dviname);
2223 string command2 = lyxrc.print_spool_command + ' ';
2224 if (target_name != "default") {
2225 command2 += lyxrc.print_spool_printerprefix
2229 command2 += quoteName(psname);
2231 // If successful, then spool command
2232 res = one.startscript(Systemcall::Wait, command,
2236 // If there's no GUI, we have to wait on this command. Otherwise,
2237 // LyX deletes the temporary directory, and with it the spooled
2238 // file, before it can be printed!!
2239 Systemcall::Starttype stype = use_gui ?
2240 Systemcall::DontWait : Systemcall::Wait;
2241 res = one.startscript(stype, command2,
2245 // case 2: print directly to a printer
2246 if (target_name != "default")
2247 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2249 Systemcall::Starttype stype = use_gui ?
2250 Systemcall::DontWait : Systemcall::Wait;
2251 res = one.startscript(stype, command +
2252 quoteName(dviname), filePath());
2256 // case 1: print to a file
2257 FileName const filename(makeAbsPath(target_name, filePath()));
2258 FileName const dvifile(makeAbsPath(dviname, path));
2259 if (filename.exists()) {
2260 docstring text = bformat(
2261 _("The file %1$s already exists.\n\n"
2262 "Do you want to overwrite that file?"),
2263 makeDisplayPath(filename.absFileName()));
2264 if (Alert::prompt(_("Overwrite file?"),
2265 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2268 command += ' ' + lyxrc.print_to_file
2269 + quoteName(filename.toFilesystemEncoding())
2271 + quoteName(dvifile.toFilesystemEncoding());
2273 Systemcall::Starttype stype = use_gui ?
2274 Systemcall::DontWait : Systemcall::Wait;
2275 res = one.startscript(stype, command, filePath());
2281 dr.setMessage(_("Error running external commands."));
2282 showPrintError(absFileName());
2291 dr.dispatched(dispatched);
2292 undo().endUndoGroup();
2296 void Buffer::changeLanguage(Language const * from, Language const * to)
2298 LASSERT(from, /**/);
2301 for_each(par_iterator_begin(),
2303 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2307 bool Buffer::isMultiLingual() const
2309 ParConstIterator end = par_iterator_end();
2310 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2311 if (it->isMultiLingual(params()))
2318 std::set<Language const *> Buffer::getLanguages() const
2320 std::set<Language const *> languages;
2321 getLanguages(languages);
2326 void Buffer::getLanguages(std::set<Language const *> & languages) const
2328 ParConstIterator end = par_iterator_end();
2329 // add the buffer language, even if it's not actively used
2330 languages.insert(language());
2331 // iterate over the paragraphs
2332 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2333 it->getLanguages(languages);
2335 ListOfBuffers clist = getDescendents();
2336 ListOfBuffers::const_iterator cit = clist.begin();
2337 ListOfBuffers::const_iterator const cen = clist.end();
2338 for (; cit != cen; ++cit)
2339 (*cit)->getLanguages(languages);
2343 DocIterator Buffer::getParFromID(int const id) const
2345 Buffer * buf = const_cast<Buffer *>(this);
2347 // John says this is called with id == -1 from undo
2348 lyxerr << "getParFromID(), id: " << id << endl;
2349 return doc_iterator_end(buf);
2352 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2353 if (it.paragraph().id() == id)
2356 return doc_iterator_end(buf);
2360 bool Buffer::hasParWithID(int const id) const
2362 return !getParFromID(id).atEnd();
2366 ParIterator Buffer::par_iterator_begin()
2368 return ParIterator(doc_iterator_begin(this));
2372 ParIterator Buffer::par_iterator_end()
2374 return ParIterator(doc_iterator_end(this));
2378 ParConstIterator Buffer::par_iterator_begin() const
2380 return ParConstIterator(doc_iterator_begin(this));
2384 ParConstIterator Buffer::par_iterator_end() const
2386 return ParConstIterator(doc_iterator_end(this));
2390 Language const * Buffer::language() const
2392 return params().language;
2396 docstring const Buffer::B_(string const & l10n) const
2398 return params().B_(l10n);
2402 bool Buffer::isClean() const
2404 return d->lyx_clean;
2408 bool Buffer::isExternallyModified(CheckMethod method) const
2410 LASSERT(d->filename.exists(), /**/);
2411 // if method == timestamp, check timestamp before checksum
2412 return (method == checksum_method
2413 || d->timestamp_ != d->filename.lastModified())
2414 && d->checksum_ != d->filename.checksum();
2418 void Buffer::saveCheckSum() const
2420 FileName const & file = d->filename;
2423 if (file.exists()) {
2424 d->timestamp_ = file.lastModified();
2425 d->checksum_ = file.checksum();
2427 // in the case of save to a new file.
2434 void Buffer::markClean() const
2436 if (!d->lyx_clean) {
2437 d->lyx_clean = true;
2440 // if the .lyx file has been saved, we don't need an
2442 d->bak_clean = true;
2443 d->undo_.markDirty();
2447 void Buffer::setUnnamed(bool flag)
2453 bool Buffer::isUnnamed() const
2460 /// Don't check unnamed, here: isInternal() is used in
2461 /// newBuffer(), where the unnamed flag has not been set by anyone
2462 /// yet. Also, for an internal buffer, there should be no need for
2463 /// retrieving fileName() nor for checking if it is unnamed or not.
2464 bool Buffer::isInternal() const
2466 return fileName().extension() == "internal";
2470 void Buffer::markDirty()
2473 d->lyx_clean = false;
2476 d->bak_clean = false;
2478 DepClean::iterator it = d->dep_clean.begin();
2479 DepClean::const_iterator const end = d->dep_clean.end();
2481 for (; it != end; ++it)
2486 FileName Buffer::fileName() const
2492 string Buffer::absFileName() const
2494 return d->filename.absFileName();
2498 string Buffer::filePath() const
2500 return d->filename.onlyPath().absFileName() + "/";
2504 bool Buffer::isReadonly() const
2506 return d->read_only;
2510 void Buffer::setParent(Buffer const * buffer)
2512 // Avoids recursive include.
2513 d->setParent(buffer == this ? 0 : buffer);
2518 Buffer const * Buffer::parent() const
2524 ListOfBuffers Buffer::allRelatives() const
2526 ListOfBuffers lb = masterBuffer()->getDescendents();
2527 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2532 Buffer const * Buffer::masterBuffer() const
2534 // FIXME Should be make sure we are not in some kind
2535 // of recursive include? A -> B -> A will crash this.
2536 Buffer const * const pbuf = d->parent();
2540 return pbuf->masterBuffer();
2544 bool Buffer::isChild(Buffer * child) const
2546 return d->children_positions.find(child) != d->children_positions.end();
2550 DocIterator Buffer::firstChildPosition(Buffer const * child)
2552 Impl::BufferPositionMap::iterator it;
2553 it = d->children_positions.find(child);
2554 if (it == d->children_positions.end())
2555 return DocIterator(this);
2560 bool Buffer::hasChildren() const
2562 return !d->children_positions.empty();
2566 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2568 // loop over children
2569 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2570 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2571 for (; it != end; ++it) {
2572 Buffer * child = const_cast<Buffer *>(it->first);
2574 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2575 if (bit != clist.end())
2577 clist.push_back(child);
2579 // there might be grandchildren
2580 child->collectChildren(clist, true);
2585 ListOfBuffers Buffer::getChildren() const
2588 collectChildren(v, false);
2589 // Make sure we have not included ourselves.
2590 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2591 if (bit != v.end()) {
2592 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2599 ListOfBuffers Buffer::getDescendents() const
2602 collectChildren(v, true);
2603 // Make sure we have not included ourselves.
2604 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2605 if (bit != v.end()) {
2606 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2613 template<typename M>
2614 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2619 typename M::const_iterator it = m.lower_bound(x);
2620 if (it == m.begin())
2628 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2629 DocIterator const & pos) const
2631 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2633 // if paragraphs have no macro context set, pos will be empty
2637 // we haven't found anything yet
2638 DocIterator bestPos = owner_->par_iterator_begin();
2639 MacroData const * bestData = 0;
2641 // find macro definitions for name
2642 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2643 if (nameIt != macros.end()) {
2644 // find last definition in front of pos or at pos itself
2645 PositionScopeMacroMap::const_iterator it
2646 = greatest_below(nameIt->second, pos);
2647 if (it != nameIt->second.end()) {
2649 // scope ends behind pos?
2650 if (pos < it->second.first) {
2651 // Looks good, remember this. If there
2652 // is no external macro behind this,
2653 // we found the right one already.
2654 bestPos = it->first;
2655 bestData = &it->second.second;
2659 // try previous macro if there is one
2660 if (it == nameIt->second.begin())
2667 // find macros in included files
2668 PositionScopeBufferMap::const_iterator it
2669 = greatest_below(position_to_children, pos);
2670 if (it == position_to_children.end())
2671 // no children before
2675 // do we know something better (i.e. later) already?
2676 if (it->first < bestPos )
2679 // scope ends behind pos?
2680 if (pos < it->second.first
2681 && (cloned_buffer_ ||
2682 theBufferList().isLoaded(it->second.second))) {
2683 // look for macro in external file
2685 MacroData const * data
2686 = it->second.second->getMacro(name, false);
2689 bestPos = it->first;
2695 // try previous file if there is one
2696 if (it == position_to_children.begin())
2701 // return the best macro we have found
2706 MacroData const * Buffer::getMacro(docstring const & name,
2707 DocIterator const & pos, bool global) const
2712 // query buffer macros
2713 MacroData const * data = d->getBufferMacro(name, pos);
2717 // If there is a master buffer, query that
2718 Buffer const * const pbuf = d->parent();
2720 d->macro_lock = true;
2721 MacroData const * macro = pbuf->getMacro(
2722 name, *this, false);
2723 d->macro_lock = false;
2729 data = MacroTable::globalMacros().get(name);
2738 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2740 // set scope end behind the last paragraph
2741 DocIterator scope = par_iterator_begin();
2742 scope.pit() = scope.lastpit() + 1;
2744 return getMacro(name, scope, global);
2748 MacroData const * Buffer::getMacro(docstring const & name,
2749 Buffer const & child, bool global) const
2751 // look where the child buffer is included first
2752 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2753 if (it == d->children_positions.end())
2756 // check for macros at the inclusion position
2757 return getMacro(name, it->second, global);
2761 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2763 pit_type const lastpit = it.lastpit();
2765 // look for macros in each paragraph
2766 while (it.pit() <= lastpit) {
2767 Paragraph & par = it.paragraph();
2769 // iterate over the insets of the current paragraph
2770 InsetList const & insets = par.insetList();
2771 InsetList::const_iterator iit = insets.begin();
2772 InsetList::const_iterator end = insets.end();
2773 for (; iit != end; ++iit) {
2774 it.pos() = iit->pos;
2776 // is it a nested text inset?
2777 if (iit->inset->asInsetText()) {
2778 // Inset needs its own scope?
2779 InsetText const * itext = iit->inset->asInsetText();
2780 bool newScope = itext->isMacroScope();
2782 // scope which ends just behind the inset
2783 DocIterator insetScope = it;
2786 // collect macros in inset
2787 it.push_back(CursorSlice(*iit->inset));
2788 updateMacros(it, newScope ? insetScope : scope);
2793 if (iit->inset->asInsetTabular()) {
2794 CursorSlice slice(*iit->inset);
2795 size_t const numcells = slice.nargs();
2796 for (; slice.idx() < numcells; slice.forwardIdx()) {
2797 it.push_back(slice);
2798 updateMacros(it, scope);
2804 // is it an external file?
2805 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2806 // get buffer of external file
2807 InsetInclude const & inset =
2808 static_cast<InsetInclude const &>(*iit->inset);
2810 Buffer * child = inset.getChildBuffer();
2815 // register its position, but only when it is
2816 // included first in the buffer
2817 if (children_positions.find(child) ==
2818 children_positions.end())
2819 children_positions[child] = it;
2821 // register child with its scope
2822 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2826 InsetMath * im = iit->inset->asInsetMath();
2827 if (doing_export && im) {
2828 InsetMathHull * hull = im->asHullInset();
2830 hull->recordLocation(it);
2833 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2837 MathMacroTemplate & macroTemplate =
2838 *iit->inset->asInsetMath()->asMacroTemplate();
2839 MacroContext mc(owner_, it);
2840 macroTemplate.updateToContext(mc);
2843 bool valid = macroTemplate.validMacro();
2844 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2845 // then the BufferView's cursor will be invalid in
2846 // some cases which leads to crashes.
2851 // FIXME (Abdel), I don't understandt why we pass 'it' here
2852 // instead of 'macroTemplate' defined above... is this correct?
2853 macros[macroTemplate.name()][it] =
2854 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2864 void Buffer::updateMacros() const
2869 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2871 // start with empty table
2873 d->children_positions.clear();
2874 d->position_to_children.clear();
2876 // Iterate over buffer, starting with first paragraph
2877 // The scope must be bigger than any lookup DocIterator
2878 // later. For the global lookup, lastpit+1 is used, hence
2879 // we use lastpit+2 here.
2880 DocIterator it = par_iterator_begin();
2881 DocIterator outerScope = it;
2882 outerScope.pit() = outerScope.lastpit() + 2;
2883 d->updateMacros(it, outerScope);
2887 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2889 InsetIterator it = inset_iterator_begin(inset());
2890 InsetIterator const end = inset_iterator_end(inset());
2891 for (; it != end; ++it) {
2892 if (it->lyxCode() == BRANCH_CODE) {
2893 InsetBranch & br = static_cast<InsetBranch &>(*it);
2894 docstring const name = br.branch();
2895 if (!from_master && !params().branchlist().find(name))
2896 result.push_back(name);
2897 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2898 result.push_back(name);
2901 if (it->lyxCode() == INCLUDE_CODE) {
2902 // get buffer of external file
2903 InsetInclude const & ins =
2904 static_cast<InsetInclude const &>(*it);
2905 Buffer * child = ins.getChildBuffer();
2908 child->getUsedBranches(result, true);
2911 // remove duplicates
2916 void Buffer::updateMacroInstances(UpdateType utype) const
2918 LYXERR(Debug::MACROS, "updateMacroInstances for "
2919 << d->filename.onlyFileName());
2920 DocIterator it = doc_iterator_begin(this);
2922 DocIterator const end = doc_iterator_end(this);
2923 for (; it != end; it.forwardInset()) {
2924 // look for MathData cells in InsetMathNest insets
2925 InsetMath * minset = it.nextInset()->asInsetMath();
2929 // update macro in all cells of the InsetMathNest
2930 DocIterator::idx_type n = minset->nargs();
2931 MacroContext mc = MacroContext(this, it);
2932 for (DocIterator::idx_type i = 0; i < n; ++i) {
2933 MathData & data = minset->cell(i);
2934 data.updateMacros(0, mc, utype);
2940 void Buffer::listMacroNames(MacroNameSet & macros) const
2945 d->macro_lock = true;
2947 // loop over macro names
2948 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2949 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2950 for (; nameIt != nameEnd; ++nameIt)
2951 macros.insert(nameIt->first);
2953 // loop over children
2954 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2955 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2956 for (; it != end; ++it)
2957 it->first->listMacroNames(macros);
2960 Buffer const * const pbuf = d->parent();
2962 pbuf->listMacroNames(macros);
2964 d->macro_lock = false;
2968 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2970 Buffer const * const pbuf = d->parent();
2975 pbuf->listMacroNames(names);
2978 MacroNameSet::iterator it = names.begin();
2979 MacroNameSet::iterator end = names.end();
2980 for (; it != end; ++it) {
2982 MacroData const * data =
2983 pbuf->getMacro(*it, *this, false);
2985 macros.insert(data);
2987 // we cannot access the original MathMacroTemplate anymore
2988 // here to calls validate method. So we do its work here manually.
2989 // FIXME: somehow make the template accessible here.
2990 if (data->optionals() > 0)
2991 features.require("xargs");
2997 Buffer::References & Buffer::references(docstring const & label)
3000 return const_cast<Buffer *>(masterBuffer())->references(label);
3002 RefCache::iterator it = d->ref_cache_.find(label);
3003 if (it != d->ref_cache_.end())
3004 return it->second.second;
3006 static InsetLabel const * dummy_il = 0;
3007 static References const dummy_refs;
3008 it = d->ref_cache_.insert(
3009 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3010 return it->second.second;
3014 Buffer::References const & Buffer::references(docstring const & label) const
3016 return const_cast<Buffer *>(this)->references(label);
3020 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3022 masterBuffer()->d->ref_cache_[label].first = il;
3026 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3028 return masterBuffer()->d->ref_cache_[label].first;
3032 void Buffer::clearReferenceCache() const
3035 d->ref_cache_.clear();
3039 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3042 //FIXME: This does not work for child documents yet.
3043 LASSERT(code == CITE_CODE, /**/);
3045 reloadBibInfoCache();
3047 // Check if the label 'from' appears more than once
3048 BiblioInfo const & keys = masterBibInfo();
3049 BiblioInfo::const_iterator bit = keys.begin();
3050 BiblioInfo::const_iterator bend = keys.end();
3051 vector<docstring> labels;
3053 for (; bit != bend; ++bit)
3055 labels.push_back(bit->first);
3057 if (count(labels.begin(), labels.end(), from) > 1)
3060 string const paramName = "key";
3061 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3062 if (it->lyxCode() == code) {
3063 InsetCommand * inset = it->asInsetCommand();
3066 docstring const oldValue = inset->getParam(paramName);
3067 if (oldValue == from)
3068 inset->setParam(paramName, to);
3074 void Buffer::getSourceCode(odocstream & os, string const format,
3075 pit_type par_begin, pit_type par_end,
3076 bool full_source) const
3078 OutputParams runparams(¶ms().encoding());
3079 runparams.nice = true;
3080 runparams.flavor = params().getOutputFlavor(format);
3081 runparams.linelen = lyxrc.plaintext_linelen;
3082 // No side effect of file copying and image conversion
3083 runparams.dryrun = true;
3086 os << "% " << _("Preview source code") << "\n\n";
3088 d->texrow.newline();
3089 d->texrow.newline();
3090 if (params().isDocBook())
3091 writeDocBookSource(os, absFileName(), runparams, false);
3092 else if (runparams.flavor == OutputParams::HTML)
3093 writeLyXHTMLSource(os, runparams, false);
3095 // latex or literate
3096 otexstream ots(os, d->texrow);
3097 writeLaTeXSource(ots, runparams, true, true);
3100 runparams.par_begin = par_begin;
3101 runparams.par_end = par_end;
3102 if (par_begin + 1 == par_end) {
3104 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3108 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3109 convert<docstring>(par_begin),
3110 convert<docstring>(par_end - 1))
3117 // output paragraphs
3118 if (params().isDocBook())
3119 docbookParagraphs(text(), *this, os, runparams);
3120 else if (runparams.flavor == OutputParams::HTML) {
3122 xhtmlParagraphs(text(), *this, xs, runparams);
3124 // latex or literate
3125 otexstream ots(os, texrow);
3126 latexParagraphs(*this, text(), ots, runparams);
3132 ErrorList & Buffer::errorList(string const & type) const
3134 return d->errorLists[type];
3138 void Buffer::updateTocItem(std::string const & type,
3139 DocIterator const & dit) const
3142 d->gui_->updateTocItem(type, dit);
3146 void Buffer::structureChanged() const
3149 d->gui_->structureChanged();
3153 void Buffer::errors(string const & err, bool from_master) const
3156 d->gui_->errors(err, from_master);
3160 void Buffer::message(docstring const & msg) const
3163 d->gui_->message(msg);
3167 void Buffer::setBusy(bool on) const
3170 d->gui_->setBusy(on);
3174 void Buffer::updateTitles() const
3177 d->wa_->updateTitles();
3181 void Buffer::resetAutosaveTimers() const
3184 d->gui_->resetAutosaveTimers();
3188 bool Buffer::hasGuiDelegate() const
3194 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3203 class AutoSaveBuffer : public ForkedProcess {
3206 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3207 : buffer_(buffer), fname_(fname) {}
3209 virtual shared_ptr<ForkedProcess> clone() const
3211 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3216 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3217 from_utf8(fname_.absFileName())));
3218 return run(DontWait);
3222 virtual int generateChild();
3224 Buffer const & buffer_;
3229 int AutoSaveBuffer::generateChild()
3231 #if defined(__APPLE__)
3232 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3233 * We should use something else like threads.
3235 * Since I do not know how to determine at run time what is the OS X
3236 * version, I just disable forking altogether for now (JMarc)
3238 pid_t const pid = -1;
3240 // tmp_ret will be located (usually) in /tmp
3241 // will that be a problem?
3242 // Note that this calls ForkedCalls::fork(), so it's
3243 // ok cross-platform.
3244 pid_t const pid = fork();
3245 // If you want to debug the autosave
3246 // you should set pid to -1, and comment out the fork.
3247 if (pid != 0 && pid != -1)
3251 // pid = -1 signifies that lyx was unable
3252 // to fork. But we will do the save
3254 bool failed = false;
3255 FileName const tmp_ret = FileName::tempName("lyxauto");
3256 if (!tmp_ret.empty()) {
3257 buffer_.writeFile(tmp_ret);
3258 // assume successful write of tmp_ret
3259 if (!tmp_ret.moveTo(fname_))
3265 // failed to write/rename tmp_ret so try writing direct
3266 if (!buffer_.writeFile(fname_)) {
3267 // It is dangerous to do this in the child,
3268 // but safe in the parent, so...
3269 if (pid == -1) // emit message signal.
3270 buffer_.message(_("Autosave failed!"));
3274 if (pid == 0) // we are the child so...
3283 FileName Buffer::getEmergencyFileName() const
3285 return FileName(d->filename.absFileName() + ".emergency");
3289 FileName Buffer::getAutosaveFileName() const
3291 // if the document is unnamed try to save in the backup dir, else
3292 // in the default document path, and as a last try in the filePath,
3293 // which will most often be the temporary directory
3296 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3297 : lyxrc.backupdir_path;
3298 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3301 string const fname = "#" + d->filename.onlyFileName() + "#";
3303 return makeAbsPath(fname, fpath);
3307 void Buffer::removeAutosaveFile() const
3309 FileName const f = getAutosaveFileName();
3315 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3317 FileName const newauto = getAutosaveFileName();
3319 if (newauto != oldauto && oldauto.exists())
3320 if (!oldauto.moveTo(newauto))
3321 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3325 bool Buffer::autoSave() const
3327 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3328 if (buf->d->bak_clean || isReadonly())
3331 message(_("Autosaving current document..."));
3332 buf->d->bak_clean = true;
3334 FileName const fname = getAutosaveFileName();
3335 if (d->cloned_buffer_) {
3336 // If this buffer is cloned, we assume that
3337 // we are running in a separate thread already.
3338 FileName const tmp_ret = FileName::tempName("lyxauto");
3339 if (!tmp_ret.empty()) {
3341 // assume successful write of tmp_ret
3342 if (tmp_ret.moveTo(fname))
3345 // failed to write/rename tmp_ret so try writing direct
3346 return writeFile(fname);
3348 /// This function is deprecated as the frontend needs to take care
3349 /// of cloning the buffer and autosaving it in another thread. It
3350 /// is still here to allow (QT_VERSION < 0x040400).
3351 AutoSaveBuffer autosave(*this, fname);
3359 // helper class, to guarantee this gets reset properly
3360 class MarkAsExporting {
3362 MarkAsExporting(Buffer const * buf) : buf_(buf)
3364 LASSERT(buf_, /* */);
3365 buf_->setExportStatus(true);
3369 buf_->setExportStatus(false);
3372 Buffer const * const buf_;
3377 void Buffer::setExportStatus(bool e) const
3379 d->doing_export = e;
3380 ListOfBuffers clist = getDescendents();
3381 ListOfBuffers::const_iterator cit = clist.begin();
3382 ListOfBuffers::const_iterator const cen = clist.end();
3383 for (; cit != cen; ++cit)
3384 (*cit)->d->doing_export = e;
3388 bool Buffer::isExporting() const
3390 return d->doing_export;
3394 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3395 bool includeall, string & result_file) const
3397 MarkAsExporting exporting(this);
3398 string backend_format;
3399 OutputParams runparams(¶ms().encoding());
3400 runparams.flavor = OutputParams::LATEX;
3401 runparams.linelen = lyxrc.plaintext_linelen;
3402 runparams.includeall = includeall;
3403 vector<string> backs = params().backends();
3404 Converters converters = theConverters();
3405 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3406 // Get shortest path to format
3407 converters.buildGraph();
3408 Graph::EdgePath path;
3409 for (vector<string>::const_iterator it = backs.begin();
3410 it != backs.end(); ++it) {
3411 Graph::EdgePath p = converters.getPath(*it, format);
3412 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3413 backend_format = *it;
3418 if (!put_in_tempdir) {
3419 // Only show this alert if this is an export to a non-temporary
3420 // file (not for previewing).
3421 Alert::error(_("Couldn't export file"), bformat(
3422 _("No information for exporting the format %1$s."),
3423 formats.prettyName(format)));
3427 runparams.flavor = converters.getFlavor(path);
3430 backend_format = format;
3431 // FIXME: Don't hardcode format names here, but use a flag
3432 if (backend_format == "pdflatex")
3433 runparams.flavor = OutputParams::PDFLATEX;
3434 else if (backend_format == "luatex")
3435 runparams.flavor = OutputParams::LUATEX;
3436 else if (backend_format == "dviluatex")
3437 runparams.flavor = OutputParams::DVILUATEX;
3438 else if (backend_format == "xetex")
3439 runparams.flavor = OutputParams::XETEX;
3442 string filename = latexName(false);
3443 filename = addName(temppath(), filename);
3444 filename = changeExtension(filename,
3445 formats.extension(backend_format));
3447 // Plain text backend
3448 if (backend_format == "text") {
3449 runparams.flavor = OutputParams::TEXT;
3450 writePlaintextFile(*this, FileName(filename), runparams);
3453 else if (backend_format == "xhtml") {
3454 runparams.flavor = OutputParams::HTML;
3455 switch (params().html_math_output) {
3456 case BufferParams::MathML:
3457 runparams.math_flavor = OutputParams::MathAsMathML;
3459 case BufferParams::HTML:
3460 runparams.math_flavor = OutputParams::MathAsHTML;
3462 case BufferParams::Images:
3463 runparams.math_flavor = OutputParams::MathAsImages;
3465 case BufferParams::LaTeX:
3466 runparams.math_flavor = OutputParams::MathAsLaTeX;
3469 makeLyXHTMLFile(FileName(filename), runparams);
3470 } else if (backend_format == "lyx")
3471 writeFile(FileName(filename));
3473 else if (params().isDocBook()) {
3474 runparams.nice = !put_in_tempdir;
3475 makeDocBookFile(FileName(filename), runparams);
3478 else if (backend_format == format) {
3479 runparams.nice = true;
3480 if (!makeLaTeXFile(FileName(filename), runparams)) {
3481 if (d->cloned_buffer_) {
3482 d->cloned_buffer_->d->errorLists["Export"] =
3483 d->errorLists["Export"];
3487 } else if (!lyxrc.tex_allows_spaces
3488 && contains(filePath(), ' ')) {
3489 Alert::error(_("File name error"),
3490 _("The directory path to the document cannot contain spaces."));
3493 runparams.nice = false;
3494 if (!makeLaTeXFile(FileName(filename), runparams)) {
3495 if (d->cloned_buffer_) {
3496 d->cloned_buffer_->d->errorLists["Export"] =
3497 d->errorLists["Export"];
3503 string const error_type = (format == "program")
3504 ? "Build" : params().bufferFormat();
3505 ErrorList & error_list = d->errorLists[error_type];
3506 string const ext = formats.extension(format);
3507 FileName const tmp_result_file(changeExtension(filename, ext));
3508 bool const success = converters.convert(this, FileName(filename),
3509 tmp_result_file, FileName(absFileName()), backend_format, format,
3512 // Emit the signal to show the error list or copy it back to the
3513 // cloned Buffer so that it can be emitted afterwards.
3514 if (format != backend_format) {
3515 if (d->cloned_buffer_) {
3516 d->cloned_buffer_->d->errorLists[error_type] =
3517 d->errorLists[error_type];
3520 // also to the children, in case of master-buffer-view
3521 ListOfBuffers clist = getDescendents();
3522 ListOfBuffers::const_iterator cit = clist.begin();
3523 ListOfBuffers::const_iterator const cen = clist.end();
3524 for (; cit != cen; ++cit) {
3525 if (d->cloned_buffer_) {
3526 // Enable reverse search by copying back the
3527 // texrow object to the cloned buffer.
3528 // FIXME: this is not thread safe.
3529 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3530 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3531 (*cit)->d->errorLists[error_type];
3533 (*cit)->errors(error_type, true);
3537 if (d->cloned_buffer_) {
3538 // Enable reverse dvi or pdf to work by copying back the texrow
3539 // object to the cloned buffer.
3540 // FIXME: There is a possibility of concurrent access to texrow
3541 // here from the main GUI thread that should be securized.
3542 d->cloned_buffer_->d->texrow = d->texrow;
3543 string const error_type = params().bufferFormat();
3544 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3550 if (put_in_tempdir) {
3551 result_file = tmp_result_file.absFileName();
3555 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3556 // We need to copy referenced files (e. g. included graphics
3557 // if format == "dvi") to the result dir.
3558 vector<ExportedFile> const files =
3559 runparams.exportdata->externalFiles(format);
3560 string const dest = onlyPath(result_file);
3561 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3562 : force_overwrite == ALL_FILES;
3563 CopyStatus status = use_force ? FORCE : SUCCESS;
3565 vector<ExportedFile>::const_iterator it = files.begin();
3566 vector<ExportedFile>::const_iterator const en = files.end();
3567 for (; it != en && status != CANCEL; ++it) {
3568 string const fmt = formats.getFormatFromFile(it->sourceName);
3569 status = copyFile(fmt, it->sourceName,
3570 makeAbsPath(it->exportName, dest),
3571 it->exportName, status == FORCE);
3574 if (status == CANCEL) {
3575 message(_("Document export cancelled."));
3576 } else if (tmp_result_file.exists()) {
3577 // Finally copy the main file
3578 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3579 : force_overwrite != NO_FILES;
3580 if (status == SUCCESS && use_force)
3582 status = copyFile(format, tmp_result_file,
3583 FileName(result_file), result_file,
3585 message(bformat(_("Document exported as %1$s "
3587 formats.prettyName(format),
3588 makeDisplayPath(result_file)));
3590 // This must be a dummy converter like fax (bug 1888)
3591 message(bformat(_("Document exported as %1$s"),
3592 formats.prettyName(format)));
3599 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3600 bool includeall) const
3603 // (1) export with all included children (omit \includeonly)
3604 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3606 // (2) export with included children only
3607 return doExport(format, put_in_tempdir, false, result_file);
3611 bool Buffer::preview(string const & format, bool includeall) const
3613 MarkAsExporting exporting(this);
3615 // (1) export with all included children (omit \includeonly)
3616 if (includeall && !doExport(format, true, true))
3618 // (2) export with included children only
3619 if (!doExport(format, true, false, result_file))
3621 return formats.view(*this, FileName(result_file), format);
3625 Buffer::ReadStatus Buffer::extractFromVC()
3627 bool const found = LyXVC::file_not_found_hook(d->filename);
3629 return ReadFileNotFound;
3630 if (!d->filename.isReadableFile())
3636 Buffer::ReadStatus Buffer::loadEmergency()
3638 FileName const emergencyFile = getEmergencyFileName();
3639 if (!emergencyFile.exists()
3640 || emergencyFile.lastModified() <= d->filename.lastModified())
3641 return ReadFileNotFound;
3643 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3644 docstring const text = bformat(_("An emergency save of the document "
3645 "%1$s exists.\n\nRecover emergency save?"), file);
3647 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3648 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3654 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3655 bool const success = (ret_llf == ReadSuccess);
3658 Alert::warning(_("File is read-only"),
3659 bformat(_("An emergency file is successfully loaded, "
3660 "but the original file %1$s is marked read-only. "
3661 "Please make sure to save the document as a different "
3662 "file."), from_utf8(d->filename.absFileName())));
3665 str = _("Document was successfully recovered.");
3667 str = _("Document was NOT successfully recovered.");
3668 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3669 makeDisplayPath(emergencyFile.absFileName()));
3671 int const del_emerg =
3672 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3673 _("&Remove"), _("&Keep"));
3674 if (del_emerg == 0) {
3675 emergencyFile.removeFile();
3677 Alert::warning(_("Emergency file deleted"),
3678 _("Do not forget to save your file now!"), true);
3680 return success ? ReadSuccess : ReadEmergencyFailure;
3683 int const del_emerg =
3684 Alert::prompt(_("Delete emergency file?"),
3685 _("Remove emergency file now?"), 1, 1,
3686 _("&Remove"), _("&Keep"));
3688 emergencyFile.removeFile();
3689 return ReadOriginal;
3699 Buffer::ReadStatus Buffer::loadAutosave()
3701 // Now check if autosave file is newer.
3702 FileName const autosaveFile = getAutosaveFileName();
3703 if (!autosaveFile.exists()
3704 || autosaveFile.lastModified() <= d->filename.lastModified())
3705 return ReadFileNotFound;
3707 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3708 docstring const text = bformat(_("The backup of the document %1$s "
3709 "is newer.\n\nLoad the backup instead?"), file);
3710 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3711 _("&Load backup"), _("Load &original"), _("&Cancel"));
3716 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3717 // the file is not saved if we load the autosave file.
3718 if (ret_llf == ReadSuccess) {
3720 Alert::warning(_("File is read-only"),
3721 bformat(_("A backup file is successfully loaded, "
3722 "but the original file %1$s is marked read-only. "
3723 "Please make sure to save the document as a "
3725 from_utf8(d->filename.absFileName())));
3730 return ReadAutosaveFailure;
3733 // Here we delete the autosave
3734 autosaveFile.removeFile();
3735 return ReadOriginal;
3743 Buffer::ReadStatus Buffer::loadLyXFile()
3745 if (!d->filename.isReadableFile()) {
3746 ReadStatus const ret_rvc = extractFromVC();
3747 if (ret_rvc != ReadSuccess)
3751 ReadStatus const ret_re = loadEmergency();
3752 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3755 ReadStatus const ret_ra = loadAutosave();
3756 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3759 return loadThisLyXFile(d->filename);
3763 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3765 return readFile(fn);
3769 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3771 TeXErrors::Errors::const_iterator it = terr.begin();
3772 TeXErrors::Errors::const_iterator end = terr.end();
3773 ListOfBuffers clist = getDescendents();
3774 ListOfBuffers::const_iterator cen = clist.end();
3776 for (; it != end; ++it) {
3779 int errorRow = it->error_in_line;
3780 Buffer const * buf = 0;
3782 if (it->child_name.empty())
3783 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
3785 // The error occurred in a child
3786 ListOfBuffers::const_iterator cit = clist.begin();
3787 for (; cit != cen; ++cit) {
3788 string const child_name =
3789 DocFileName(changeExtension(
3790 (*cit)->absFileName(), "tex")).
3792 if (it->child_name != child_name)
3794 (*cit)->d->texrow.getIdFromRow(errorRow,
3795 id_start, pos_start);
3796 if (id_start != -1) {
3797 buf = d->cloned_buffer_
3798 ? (*cit)->d->cloned_buffer_->d->owner_
3799 : (*cit)->d->owner_;
3810 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
3811 } while (found && id_start == id_end && pos_start == pos_end);
3813 if (id_start != id_end) {
3814 // Next registered position is outside the inset where
3815 // the error occurred, so signal end-of-paragraph
3819 errorList.push_back(ErrorItem(it->error_desc,
3820 it->error_text, id_start, pos_start, pos_end, buf));
3825 void Buffer::setBuffersForInsets() const
3827 inset().setBuffer(const_cast<Buffer &>(*this));
3831 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3833 // Use the master text class also for child documents
3834 Buffer const * const master = masterBuffer();
3835 DocumentClass const & textclass = master->params().documentClass();
3837 // do this only if we are the top-level Buffer
3839 reloadBibInfoCache();
3841 // keep the buffers to be children in this set. If the call from the
3842 // master comes back we can see which of them were actually seen (i.e.
3843 // via an InsetInclude). The remaining ones in the set need still be updated.
3844 static std::set<Buffer const *> bufToUpdate;
3845 if (scope == UpdateMaster) {
3846 // If this is a child document start with the master
3847 if (master != this) {
3848 bufToUpdate.insert(this);
3849 master->updateBuffer(UpdateMaster, utype);
3850 // Do this here in case the master has no gui associated with it. Then,
3851 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3852 if (!master->d->gui_)
3855 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3856 if (bufToUpdate.find(this) == bufToUpdate.end())
3860 // start over the counters in the master
3861 textclass.counters().reset();
3864 // update will be done below for this buffer
3865 bufToUpdate.erase(this);
3867 // update all caches
3868 clearReferenceCache();
3871 Buffer & cbuf = const_cast<Buffer &>(*this);
3873 LASSERT(!text().paragraphs().empty(), /**/);
3876 ParIterator parit = cbuf.par_iterator_begin();
3877 updateBuffer(parit, utype);
3880 // TocBackend update will be done later.
3883 d->bibinfo_cache_valid_ = true;
3884 d->cite_labels_valid_ = true;
3885 cbuf.tocBackend().update();
3886 if (scope == UpdateMaster)
3887 cbuf.structureChanged();
3891 static depth_type getDepth(DocIterator const & it)
3893 depth_type depth = 0;
3894 for (size_t i = 0 ; i < it.depth() ; ++i)
3895 if (!it[i].inset().inMathed())
3896 depth += it[i].paragraph().getDepth() + 1;
3897 // remove 1 since the outer inset does not count
3901 static depth_type getItemDepth(ParIterator const & it)
3903 Paragraph const & par = *it;
3904 LabelType const labeltype = par.layout().labeltype;
3906 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3909 // this will hold the lowest depth encountered up to now.
3910 depth_type min_depth = getDepth(it);
3911 ParIterator prev_it = it;
3914 --prev_it.top().pit();
3916 // start of nested inset: go to outer par
3918 if (prev_it.empty()) {
3919 // start of document: nothing to do
3924 // We search for the first paragraph with same label
3925 // that is not more deeply nested.
3926 Paragraph & prev_par = *prev_it;
3927 depth_type const prev_depth = getDepth(prev_it);
3928 if (labeltype == prev_par.layout().labeltype) {
3929 if (prev_depth < min_depth)
3930 return prev_par.itemdepth + 1;
3931 if (prev_depth == min_depth)
3932 return prev_par.itemdepth;
3934 min_depth = min(min_depth, prev_depth);
3935 // small optimization: if we are at depth 0, we won't
3936 // find anything else
3937 if (prev_depth == 0)
3943 static bool needEnumCounterReset(ParIterator const & it)
3945 Paragraph const & par = *it;
3946 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3947 depth_type const cur_depth = par.getDepth();
3948 ParIterator prev_it = it;
3949 while (prev_it.pit()) {
3950 --prev_it.top().pit();
3951 Paragraph const & prev_par = *prev_it;
3952 if (prev_par.getDepth() <= cur_depth)
3953 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3955 // start of nested inset: reset
3960 // set the label of a paragraph. This includes the counters.
3961 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3963 BufferParams const & bp = owner_->masterBuffer()->params();
3964 DocumentClass const & textclass = bp.documentClass();
3965 Paragraph & par = it.paragraph();
3966 Layout const & layout = par.layout();
3967 Counters & counters = textclass.counters();
3969 if (par.params().startOfAppendix()) {
3970 // FIXME: only the counter corresponding to toplevel
3971 // sectioning should be reset
3973 counters.appendix(true);
3975 par.params().appendix(counters.appendix());
3977 // Compute the item depth of the paragraph
3978 par.itemdepth = getItemDepth(it);
3980 if (layout.margintype == MARGIN_MANUAL) {
3981 if (par.params().labelWidthString().empty())
3982 par.params().labelWidthString(par.expandLabel(layout, bp));
3983 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
3984 // we do not need to do anything here, since the empty case is
3985 // handled during export.
3987 par.params().labelWidthString(docstring());
3990 switch(layout.labeltype) {
3992 if (layout.toclevel <= bp.secnumdepth
3993 && (layout.latextype != LATEX_ENVIRONMENT
3994 || it.text()->isFirstInSequence(it.pit()))) {
3995 if (counters.hasCounter(layout.counter))
3996 counters.step(layout.counter, utype);
3997 par.params().labelString(par.expandLabel(layout, bp));
3999 par.params().labelString(docstring());
4002 case LABEL_ITEMIZE: {
4003 // At some point of time we should do something more
4004 // clever here, like:
4005 // par.params().labelString(
4006 // bp.user_defined_bullet(par.itemdepth).getText());
4007 // for now, use a simple hardcoded label
4008 docstring itemlabel;
4009 switch (par.itemdepth) {
4011 itemlabel = char_type(0x2022);
4014 itemlabel = char_type(0x2013);
4017 itemlabel = char_type(0x2217);
4020 itemlabel = char_type(0x2219); // or 0x00b7
4023 par.params().labelString(itemlabel);
4027 case LABEL_ENUMERATE: {
4028 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4030 switch (par.itemdepth) {
4039 enumcounter += "iv";
4042 // not a valid enumdepth...
4046 // Maybe we have to reset the enumeration counter.
4047 if (needEnumCounterReset(it))
4048 counters.reset(enumcounter);
4049 counters.step(enumcounter, utype);
4051 string const & lang = par.getParLanguage(bp)->code();
4052 par.params().labelString(counters.theCounter(enumcounter, lang));
4057 case LABEL_SENSITIVE: {
4058 string const & type = counters.current_float();
4059 docstring full_label;
4061 full_label = owner_->B_("Senseless!!! ");
4063 docstring name = owner_->B_(textclass.floats().getType(type).name());
4064 if (counters.hasCounter(from_utf8(type))) {
4065 string const & lang = par.getParLanguage(bp)->code();
4066 counters.step(from_utf8(type), utype);
4067 full_label = bformat(from_ascii("%1$s %2$s:"),
4069 counters.theCounter(from_utf8(type), lang));
4071 full_label = bformat(from_ascii("%1$s #:"), name);
4073 par.params().labelString(full_label);
4077 case LABEL_NO_LABEL:
4078 par.params().labelString(docstring());
4082 case LABEL_TOP_ENVIRONMENT:
4083 case LABEL_CENTERED_TOP_ENVIRONMENT:
4086 par.params().labelString(par.expandLabel(layout, bp));
4092 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4094 LASSERT(parit.pit() == 0, /**/);
4096 // Set the position of the text in the buffer to be able
4097 // to resolve macros in it.
4098 parit.text()->setMacrocontextPosition(parit);
4100 depth_type maxdepth = 0;
4101 pit_type const lastpit = parit.lastpit();
4102 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4103 // reduce depth if necessary
4104 parit->params().depth(min(parit->params().depth(), maxdepth));
4105 maxdepth = parit->getMaxDepthAfter();
4107 if (utype == OutputUpdate) {
4108 // track the active counters
4109 // we have to do this for the master buffer, since the local
4110 // buffer isn't tracking anything.
4111 masterBuffer()->params().documentClass().counters().
4112 setActiveLayout(parit->layout());
4115 // set the counter for this paragraph
4116 d->setLabel(parit, utype);
4119 InsetList::const_iterator iit = parit->insetList().begin();
4120 InsetList::const_iterator end = parit->insetList().end();
4121 for (; iit != end; ++iit) {
4122 parit.pos() = iit->pos;
4123 iit->inset->updateBuffer(parit, utype);
4129 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4130 WordLangTuple & word_lang, docstring_list & suggestions) const
4134 suggestions.clear();
4135 word_lang = WordLangTuple();
4136 // OK, we start from here.
4137 DocIterator const end = doc_iterator_end(this);
4138 for (; from != end; from.forwardPos()) {
4139 // We are only interested in text so remove the math CursorSlice.
4140 while (from.inMathed()) {
4144 // If from is at the end of the document (which is possible
4145 // when leaving the mathed) LyX will crash later.
4149 from.paragraph().spellCheck();
4150 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4151 if (SpellChecker::misspelled(res)) {
4156 // Do not increase progress when from == to, otherwise the word
4157 // count will be wrong.
4167 Buffer::ReadStatus Buffer::reload()
4170 // c.f. bug http://www.lyx.org/trac/ticket/6587
4171 removeAutosaveFile();
4172 // e.g., read-only status could have changed due to version control
4173 d->filename.refresh();
4174 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4176 ReadStatus const status = loadLyXFile();
4177 if (status == ReadSuccess) {
4182 message(bformat(_("Document %1$s reloaded."), disp_fn));
4185 message(bformat(_("Could not reload document %1$s."), disp_fn));
4195 bool Buffer::saveAs(FileName const & fn)
4197 FileName const old_name = fileName();
4198 FileName const old_auto = getAutosaveFileName();
4199 bool const old_unnamed = isUnnamed();
4206 // bring the autosave file with us, just in case.
4207 moveAutosaveFile(old_auto);
4208 // validate version control data and
4209 // correct buffer title
4210 lyxvc().file_found_hook(fileName());
4212 // the file has now been saved to the new location.
4213 // we need to check that the locations of child buffers
4215 checkChildBuffers();
4219 // reset the old filename and unnamed state
4220 setFileName(old_name);
4221 setUnnamed(old_unnamed);
4227 // FIXME We could do better here, but it is complicated. What would be
4228 // nice is to offer either (a) to save the child buffer to an appropriate
4229 // location, so that it would "move with the master", or else (b) to update
4230 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4231 // complicated, because the code for this lives in GuiView.
4232 void Buffer::checkChildBuffers()
4234 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4235 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4236 for (; it != en; ++it) {
4237 DocIterator dit = it->second;
4238 Buffer * cbuf = const_cast<Buffer *>(it->first);
4239 if (!cbuf || !theBufferList().isLoaded(cbuf))
4241 Inset * inset = dit.nextInset();
4242 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4243 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4244 docstring const & incfile = inset_inc->getParam("filename");
4245 string oldloc = cbuf->absFileName();
4246 string newloc = makeAbsPath(to_utf8(incfile),
4247 onlyPath(absFileName())).absFileName();
4248 if (oldloc == newloc)
4250 // the location of the child file is incorrect.
4251 Alert::warning(_("Included File Invalid"),
4252 bformat(_("Saving this document to a new location has made the file:\n"
4254 "inaccessible. You will need to update the included filename."),
4255 from_utf8(oldloc)));
4257 inset_inc->setChildBuffer(0);
4259 // invalidate cache of children
4260 d->children_positions.clear();
4261 d->position_to_children.clear();