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/InsetBibitem.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetTabular.h"
74 #include "insets/InsetText.h"
76 #include "mathed/InsetMathHull.h"
77 #include "mathed/MacroTable.h"
78 #include "mathed/MathMacroTemplate.h"
79 #include "mathed/MathSupport.h"
81 #include "frontends/alert.h"
82 #include "frontends/Delegates.h"
83 #include "frontends/WorkAreaManager.h"
85 #include "graphics/Previews.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileName.h"
93 #include "support/FileNameList.h"
94 #include "support/filetools.h"
95 #include "support/ForkedCalls.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/lyxalgo.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/Path.h"
103 #include "support/Systemcall.h"
104 #include "support/textutils.h"
105 #include "support/types.h"
107 #include "support/bind.h"
108 #include "support/shared_ptr.h"
120 using namespace lyx::support;
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 = 410; // rgh: dummy format for list->labeling
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);
161 /// search for macro in local (buffer) table or in children
162 MacroData const * getBufferMacro(docstring const & name,
163 DocIterator const & pos) const;
165 /// Update macro table starting with position of it \param it in some
167 void updateMacros(DocIterator & it, DocIterator & scope);
169 void setLabel(ParIterator & it, UpdateType utype) const;
171 /** If we have branches that use the file suffix
172 feature, return the file name with suffix appended.
174 support::FileName exportFileName() const;
181 mutable TexRow texrow;
183 /// need to regenerate .tex?
187 mutable bool lyx_clean;
189 /// is autosave needed?
190 mutable bool bak_clean;
192 /// is this an unnamed file (New...)?
198 /// name of the file the buffer is associated with.
201 /** Set to true only when the file is fully loaded.
202 * Used to prevent the premature generation of previews
203 * and by the citation inset.
205 bool file_fully_loaded;
208 mutable TocBackend toc_backend;
211 typedef pair<DocIterator, MacroData> ScopeMacro;
212 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
213 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
214 /// map from the macro name to the position map,
215 /// which maps the macro definition position to the scope and the MacroData.
216 NamePositionScopeMacroMap macros;
217 /// This seem to change the way Buffer::getMacro() works
218 mutable bool macro_lock;
220 /// positions of child buffers in the buffer
221 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
222 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
223 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
224 /// position of children buffers in this buffer
225 BufferPositionMap children_positions;
226 /// map from children inclusion positions to their scope and their buffer
227 PositionScopeBufferMap position_to_children;
229 /// Container for all sort of Buffer dependant errors.
230 map<string, ErrorList> errorLists;
232 /// timestamp and checksum used to test if the file has been externally
233 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
235 unsigned long checksum_;
238 frontend::WorkAreaManager * wa_;
240 frontend::GuiBufferDelegate * gui_;
245 /// A cache for the bibfiles (including bibfiles of loaded child
246 /// documents), needed for appropriate update of natbib labels.
247 mutable support::FileNameList bibfiles_cache_;
249 // FIXME The caching mechanism could be improved. At present, we have a
250 // cache for each Buffer, that caches all the bibliography info for that
251 // Buffer. A more efficient solution would be to have a global cache per
252 // file, and then to construct the Buffer's bibinfo from that.
253 /// A cache for bibliography info
254 mutable BiblioInfo bibinfo_;
255 /// whether the bibinfo cache is valid
256 mutable bool bibinfo_cache_valid_;
257 /// whether the bibfile cache is valid
258 mutable bool bibfile_cache_valid_;
259 /// Cache of timestamps of .bib files
260 map<FileName, time_t> bibfile_status_;
262 mutable RefCache ref_cache_;
264 /// our Text that should be wrapped in an InsetText
267 /// This is here to force the test to be done whenever parent_buffer
269 Buffer const * parent() const {
270 // if parent_buffer is not loaded, then it has been unloaded,
271 // which means that parent_buffer is an invalid pointer. So we
272 // set it to null in that case.
273 // however, the BufferList doesn't know about cloned buffers, so
274 // they will always be regarded as unloaded. in that case, we hope
276 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
278 return parent_buffer;
282 void setParent(Buffer const * pb) {
283 if (parent_buffer == pb)
286 if (!cloned_buffer_ && parent_buffer && pb)
287 LYXERR0("Warning: a buffer should not have two parents!");
289 if (!cloned_buffer_ && parent_buffer) {
290 parent_buffer->invalidateBibfileCache();
291 parent_buffer->invalidateBibinfoCache();
295 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
296 /// This one is useful for preview detached in a thread.
297 Buffer const * cloned_buffer_;
298 /// are we in the process of exporting this buffer?
299 mutable bool doing_export;
302 /// So we can force access via the accessors.
303 mutable Buffer const * parent_buffer;
308 /// Creates the per buffer temporary directory
309 static FileName createBufferTmpDir()
312 // We are in our own directory. Why bother to mangle name?
313 // In fact I wrote this code to circumvent a problematic behaviour
314 // (bug?) of EMX mkstemp().
315 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
316 convert<string>(count++));
318 if (!tmpfl.createDirectory(0777)) {
319 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
320 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
321 from_utf8(tmpfl.absFileName())));
327 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
328 Buffer const * cloned_buffer)
329 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
330 read_only(readonly_), filename(file), file_fully_loaded(false),
331 toc_backend(owner), macro_lock(false), timestamp_(0),
332 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
333 bibfile_cache_valid_(false), cloned_buffer_(cloned_buffer),
334 doing_export(false), parent_buffer(0)
336 if (!cloned_buffer_) {
337 temppath = createBufferTmpDir();
338 lyxvc.setBuffer(owner_);
340 wa_ = new frontend::WorkAreaManager;
343 temppath = cloned_buffer_->d->temppath;
344 file_fully_loaded = true;
345 params = cloned_buffer_->d->params;
346 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
347 bibinfo_ = cloned_buffer_->d->bibinfo_;
348 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
349 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
350 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
354 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
355 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
357 LYXERR(Debug::INFO, "Buffer::Buffer()");
359 d->inset = new InsetText(*cloned_buffer->d->inset);
360 d->inset->setBuffer(*this);
361 // FIXME: optimize this loop somewhat, maybe by creating a new
362 // general recursive Inset::setId().
363 DocIterator it = doc_iterator_begin(this);
364 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
365 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
366 it.paragraph().setId(cloned_it.paragraph().id());
368 d->inset = new InsetText(this);
369 d->inset->setAutoBreakRows(true);
370 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
376 LYXERR(Debug::INFO, "Buffer::~Buffer()");
377 // here the buffer should take care that it is
378 // saved properly, before it goes into the void.
380 // GuiView already destroyed
384 // No need to do additional cleanups for internal buffer.
389 // loop over children
390 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
391 Impl::BufferPositionMap::iterator end = d->children_positions.end();
392 for (; it != end; ++it) {
393 Buffer * child = const_cast<Buffer *>(it->first);
394 if (d->cloned_buffer_)
396 // The child buffer might have been closed already.
397 else if (theBufferList().isLoaded(child))
398 theBufferList().releaseChild(this, child);
402 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
403 msg += emergencyWrite();
404 Alert::warning(_("Attempting to close changed document!"), msg);
407 // clear references to children in macro tables
408 d->children_positions.clear();
409 d->position_to_children.clear();
411 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
412 Alert::warning(_("Could not remove temporary directory"),
413 bformat(_("Could not remove the temporary directory %1$s"),
414 from_utf8(d->temppath.absFileName())));
424 Buffer * Buffer::clone() const
426 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
427 buffer_clone->d->macro_lock = true;
428 buffer_clone->d->children_positions.clear();
429 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
430 // math macro caches need to be rethought and simplified.
431 // I am not sure wether we should handle Buffer cloning here or in BufferList.
432 // Right now BufferList knows nothing about buffer clones.
433 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
434 Impl::BufferPositionMap::iterator end = d->children_positions.end();
435 for (; it != end; ++it) {
436 DocIterator dit = it->second.clone(buffer_clone);
437 dit.setBuffer(buffer_clone);
438 Buffer * child = const_cast<Buffer *>(it->first);
439 Buffer * child_clone = child->clone();
440 Inset * inset = dit.nextInset();
441 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
442 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
443 inset_inc->setChildBuffer(child_clone);
444 child_clone->d->setParent(buffer_clone);
445 buffer_clone->setChild(dit, child_clone);
447 buffer_clone->d->macro_lock = false;
452 bool Buffer::isClone() const
454 return d->cloned_buffer_;
458 void Buffer::changed(bool update_metrics) const
461 d->wa_->redrawAll(update_metrics);
465 frontend::WorkAreaManager & Buffer::workAreaManager() const
467 LASSERT(d->wa_, /**/);
472 Text & Buffer::text() const
474 return d->inset->text();
478 Inset & Buffer::inset() const
484 BufferParams & Buffer::params()
490 BufferParams const & Buffer::params() const
496 ParagraphList & Buffer::paragraphs()
498 return text().paragraphs();
502 ParagraphList const & Buffer::paragraphs() const
504 return text().paragraphs();
508 LyXVC & Buffer::lyxvc()
514 LyXVC const & Buffer::lyxvc() const
520 string const Buffer::temppath() const
522 return d->temppath.absFileName();
526 TexRow & Buffer::texrow()
532 TexRow const & Buffer::texrow() const
538 TocBackend & Buffer::tocBackend() const
540 return d->toc_backend;
544 Undo & Buffer::undo()
550 void Buffer::setChild(DocIterator const & dit, Buffer * child)
552 d->children_positions[child] = dit;
556 string Buffer::latexName(bool const no_path) const
558 FileName latex_name =
559 makeLatexName(d->exportFileName());
560 return no_path ? latex_name.onlyFileName()
561 : latex_name.absFileName();
565 FileName Buffer::Impl::exportFileName() const
567 docstring const branch_suffix =
568 params.branchlist().getFileNameSuffix();
569 if (branch_suffix.empty())
572 string const name = filename.onlyFileNameWithoutExt()
573 + to_utf8(branch_suffix);
574 FileName res(filename.onlyPath().absFileName() + "/" + name);
575 res.changeExtension(filename.extension());
581 string Buffer::logName(LogType * type) const
583 string const filename = latexName(false);
585 if (filename.empty()) {
591 string const path = temppath();
593 FileName const fname(addName(temppath(),
594 onlyFileName(changeExtension(filename,
597 // FIXME: how do we know this is the name of the build log?
598 FileName const bname(
599 addName(path, onlyFileName(
600 changeExtension(filename,
601 formats.extension(bufferFormat()) + ".out"))));
603 // Also consider the master buffer log file
604 FileName masterfname = fname;
606 if (masterBuffer() != this) {
607 string const mlogfile = masterBuffer()->logName(&mtype);
608 masterfname = FileName(mlogfile);
611 // If no Latex log or Build log is newer, show Build log
612 if (bname.exists() &&
613 ((!fname.exists() && !masterfname.exists())
614 || (fname.lastModified() < bname.lastModified()
615 && masterfname.lastModified() < bname.lastModified()))) {
616 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
619 return bname.absFileName();
620 // If we have a newer master file log or only a master log, show this
621 } else if (fname != masterfname
622 && (!fname.exists() && (masterfname.exists()
623 || fname.lastModified() < masterfname.lastModified()))) {
624 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
627 return masterfname.absFileName();
629 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
632 return fname.absFileName();
636 void Buffer::setReadonly(bool const flag)
638 if (d->read_only != flag) {
645 void Buffer::setFileName(FileName const & fname)
648 setReadonly(d->filename.isReadOnly());
654 int Buffer::readHeader(Lexer & lex)
656 int unknown_tokens = 0;
658 int begin_header_line = -1;
660 // Initialize parameters that may be/go lacking in header:
661 params().branchlist().clear();
662 params().preamble.erase();
663 params().options.erase();
664 params().master.erase();
665 params().float_placement.erase();
666 params().paperwidth.erase();
667 params().paperheight.erase();
668 params().leftmargin.erase();
669 params().rightmargin.erase();
670 params().topmargin.erase();
671 params().bottommargin.erase();
672 params().headheight.erase();
673 params().headsep.erase();
674 params().footskip.erase();
675 params().columnsep.erase();
676 params().fonts_cjk.erase();
677 params().listings_params.clear();
678 params().clearLayoutModules();
679 params().clearRemovedModules();
680 params().clearIncludedChildren();
681 params().pdfoptions().clear();
682 params().indiceslist().clear();
683 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
684 params().isbackgroundcolor = false;
685 params().fontcolor = lyx::rgbFromHexName("#000000");
686 params().isfontcolor = false;
687 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
688 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
689 params().html_latex_start.clear();
690 params().html_latex_end.clear();
691 params().html_math_img_scale = 1.0;
692 params().output_sync_macro.erase();
694 for (int i = 0; i < 4; ++i) {
695 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
696 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
699 ErrorList & errorList = d->errorLists["Parse"];
708 if (token == "\\end_header")
712 if (token == "\\begin_header") {
713 begin_header_line = line;
717 LYXERR(Debug::PARSER, "Handling document header token: `"
720 string unknown = params().readToken(lex, token, d->filename.onlyPath());
721 if (!unknown.empty()) {
722 if (unknown[0] != '\\' && token == "\\textclass") {
723 Alert::warning(_("Unknown document class"),
724 bformat(_("Using the default document class, because the "
725 "class %1$s is unknown."), from_utf8(unknown)));
728 docstring const s = bformat(_("Unknown token: "
732 errorList.push_back(ErrorItem(_("Document header error"),
737 if (begin_header_line) {
738 docstring const s = _("\\begin_header is missing");
739 errorList.push_back(ErrorItem(_("Document header error"),
743 params().makeDocumentClass();
745 return unknown_tokens;
750 // changed to be public and have one parameter
751 // Returns true if "\end_document" is not read (Asger)
752 bool Buffer::readDocument(Lexer & lex)
754 ErrorList & errorList = d->errorLists["Parse"];
757 // remove dummy empty par
758 paragraphs().clear();
760 if (!lex.checkFor("\\begin_document")) {
761 docstring const s = _("\\begin_document is missing");
762 errorList.push_back(ErrorItem(_("Document header error"),
768 if (params().outputChanges) {
769 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
770 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
771 LaTeXFeatures::isAvailable("xcolor");
773 if (!dvipost && !xcolorulem) {
774 Alert::warning(_("Changes not shown in LaTeX output"),
775 _("Changes will not be highlighted in LaTeX output, "
776 "because neither dvipost nor xcolor/ulem are installed.\n"
777 "Please install these packages or redefine "
778 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
779 } else if (!xcolorulem) {
780 Alert::warning(_("Changes not shown in LaTeX output"),
781 _("Changes will not be highlighted in LaTeX output "
782 "when using pdflatex, because xcolor and ulem are not installed.\n"
783 "Please install both packages or redefine "
784 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
788 if (!params().master.empty()) {
789 FileName const master_file = makeAbsPath(params().master,
790 onlyPath(absFileName()));
791 if (isLyXFileName(master_file.absFileName())) {
793 checkAndLoadLyXFile(master_file, true);
795 // necessary e.g. after a reload
796 // to re-register the child (bug 5873)
797 // FIXME: clean up updateMacros (here, only
798 // child registering is needed).
799 master->updateMacros();
800 // set master as master buffer, but only
801 // if we are a real child
802 if (master->isChild(this))
804 // if the master is not fully loaded
805 // it is probably just loading this
806 // child. No warning needed then.
807 else if (master->isFullyLoaded())
808 LYXERR0("The master '"
810 << "' assigned to this document ("
812 << ") does not include "
813 "this document. Ignoring the master assignment.");
818 // assure we have a default index
819 params().indiceslist().addDefault(B_("Index"));
822 bool const res = text().read(lex, errorList, d->inset);
826 updateMacroInstances();
831 bool Buffer::readString(string const & s)
833 params().compressed = false;
838 FileName const fn = FileName::tempName("Buffer_readString");
841 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
842 if (ret_plf != ReadSuccess)
845 if (file_format != LYX_FORMAT) {
846 // We need to call lyx2lyx, so write the input to a file
847 ofstream os(fn.toFilesystemEncoding().c_str());
851 return readFile(fn) == ReadSuccess;
854 if (readDocument(lex))
860 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
867 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
868 if (ret_plf != ReadSuccess)
871 if (file_format != LYX_FORMAT) {
873 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
874 if (ret_clf != ReadSuccess)
876 return readFile(tmpFile);
879 // FIXME: InsetInfo needs to know whether the file is under VCS
880 // during the parse process, so this has to be done before.
881 lyxvc().file_found_hook(d->filename);
883 if (readDocument(lex)) {
884 Alert::error(_("Document format failure"),
885 bformat(_("%1$s ended unexpectedly, which means"
886 " that it is probably corrupted."),
887 from_utf8(fn.absFileName())));
888 return ReadDocumentFailure;
891 d->file_fully_loaded = true;
892 d->read_only = !d->filename.isWritable();
893 params().compressed = d->filename.isZippedFile();
899 bool Buffer::isFullyLoaded() const
901 return d->file_fully_loaded;
905 void Buffer::setFullyLoaded(bool value)
907 d->file_fully_loaded = value;
911 void Buffer::updatePreviews() const
913 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
914 thePreviews().generateBufferPreviews(*this);
918 void Buffer::removePreviews() const
920 thePreviews().removeLoader(*this);
924 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
925 FileName const & fn, int & file_format) const
927 if(!lex.checkFor("\\lyxformat")) {
928 Alert::error(_("Document format failure"),
929 bformat(_("%1$s is not a readable LyX document."),
930 from_utf8(fn.absFileName())));
931 return ReadNoLyXFormat;
937 // LyX formats 217 and earlier were written as 2.17. This corresponds
938 // to files from LyX versions < 1.1.6.3. We just remove the dot in
939 // these cases. See also: www.lyx.org/trac/changeset/1313.
940 size_t dot = tmp_format.find_first_of(".,");
941 if (dot != string::npos)
942 tmp_format.erase(dot, 1);
944 file_format = convert<int>(tmp_format);
949 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
950 FileName & tmpfile, int from_format)
952 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
953 if(tmpfile.empty()) {
954 Alert::error(_("Conversion failed"),
955 bformat(_("%1$s is from a different"
956 " version of LyX, but a temporary"
957 " file for converting it could"
959 from_utf8(fn.absFileName())));
960 return LyX2LyXNoTempFile;
963 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
964 if (lyx2lyx.empty()) {
965 Alert::error(_("Conversion script not found"),
966 bformat(_("%1$s is from a different"
967 " version of LyX, but the"
968 " conversion script lyx2lyx"
969 " could not be found."),
970 from_utf8(fn.absFileName())));
971 return LyX2LyXNotFound;
975 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
976 ostringstream command;
977 command << os::python()
978 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
979 << " -t " << convert<string>(LYX_FORMAT)
980 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
981 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
982 string const command_str = command.str();
984 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
986 cmd_ret const ret = runCommand(command_str);
987 if (ret.first != 0) {
988 if (from_format < LYX_FORMAT) {
989 Alert::error(_("Conversion script failed"),
990 bformat(_("%1$s is from an older version"
991 " of LyX and the lyx2lyx script"
992 " failed to convert it."),
993 from_utf8(fn.absFileName())));
994 return LyX2LyXOlderFormat;
996 Alert::error(_("Conversion script failed"),
997 bformat(_("%1$s is from a newer version"
998 " of LyX and the lyx2lyx script"
999 " failed to convert it."),
1000 from_utf8(fn.absFileName())));
1001 return LyX2LyXNewerFormat;
1008 // Should probably be moved to somewhere else: BufferView? GuiView?
1009 bool Buffer::save() const
1011 docstring const file = makeDisplayPath(absFileName(), 20);
1012 d->filename.refresh();
1014 // check the read-only status before moving the file as a backup
1015 if (d->filename.exists()) {
1016 bool const read_only = !d->filename.isWritable();
1018 Alert::warning(_("File is read-only"),
1019 bformat(_("The file %1$s cannot be written because it "
1020 "is marked as read-only."), file));
1025 // ask if the disk file has been externally modified (use checksum method)
1026 if (fileName().exists() && isExternallyModified(checksum_method)) {
1028 bformat(_("Document %1$s has been externally modified. "
1029 "Are you sure you want to overwrite this file?"), file);
1030 int const ret = Alert::prompt(_("Overwrite modified file?"),
1031 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1036 // We don't need autosaves in the immediate future. (Asger)
1037 resetAutosaveTimers();
1039 FileName backupName;
1040 bool madeBackup = false;
1042 // make a backup if the file already exists
1043 if (lyxrc.make_backup && fileName().exists()) {
1044 backupName = FileName(absFileName() + '~');
1045 if (!lyxrc.backupdir_path.empty()) {
1046 string const mangledName =
1047 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1048 backupName = FileName(addName(lyxrc.backupdir_path,
1051 // do not copy because of #6587
1052 if (fileName().moveTo(backupName)) {
1055 Alert::error(_("Backup failure"),
1056 bformat(_("Cannot create backup file %1$s.\n"
1057 "Please check whether the directory exists and is writeable."),
1058 from_utf8(backupName.absFileName())));
1059 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1063 if (writeFile(d->filename)) {
1067 // Saving failed, so backup is not backup
1069 backupName.moveTo(d->filename);
1075 bool Buffer::writeFile(FileName const & fname) const
1077 if (d->read_only && fname == d->filename)
1080 bool retval = false;
1082 docstring const str = bformat(_("Saving document %1$s..."),
1083 makeDisplayPath(fname.absFileName()));
1086 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1088 if (params().compressed) {
1089 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1090 retval = ofs && write(ofs);
1092 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1093 retval = ofs && write(ofs);
1097 message(str + _(" could not write file!"));
1102 // removeAutosaveFile();
1105 message(str + _(" done."));
1111 docstring Buffer::emergencyWrite()
1113 // No need to save if the buffer has not changed.
1117 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1119 docstring user_message = bformat(
1120 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1122 // We try to save three places:
1123 // 1) Same place as document. Unless it is an unnamed doc.
1125 string s = absFileName();
1128 if (writeFile(FileName(s))) {
1130 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1131 return user_message;
1133 user_message += " " + _("Save failed! Trying again...\n");
1137 // 2) In HOME directory.
1138 string s = addName(package().home_dir().absFileName(), absFileName());
1140 lyxerr << ' ' << s << endl;
1141 if (writeFile(FileName(s))) {
1143 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1144 return user_message;
1147 user_message += " " + _("Save failed! Trying yet again...\n");
1149 // 3) In "/tmp" directory.
1150 // MakeAbsPath to prepend the current
1151 // drive letter on OS/2
1152 s = addName(package().temp_dir().absFileName(), absFileName());
1154 lyxerr << ' ' << s << endl;
1155 if (writeFile(FileName(s))) {
1157 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1158 return user_message;
1161 user_message += " " + _("Save failed! Bummer. Document is lost.");
1164 return user_message;
1168 bool Buffer::write(ostream & ofs) const
1171 // Use the standard "C" locale for file output.
1172 ofs.imbue(locale::classic());
1175 // The top of the file should not be written by params().
1177 // write out a comment in the top of the file
1178 ofs << "#LyX " << lyx_version
1179 << " created this file. For more info see http://www.lyx.org/\n"
1180 << "\\lyxformat " << LYX_FORMAT << "\n"
1181 << "\\begin_document\n";
1183 /// For each author, set 'used' to true if there is a change
1184 /// by this author in the document; otherwise set it to 'false'.
1185 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1186 AuthorList::Authors::const_iterator a_end = params().authors().end();
1187 for (; a_it != a_end; ++a_it)
1188 a_it->setUsed(false);
1190 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1191 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1192 for ( ; it != end; ++it)
1193 it->checkAuthors(params().authors());
1195 // now write out the buffer parameters.
1196 ofs << "\\begin_header\n";
1197 params().writeFile(ofs);
1198 ofs << "\\end_header\n";
1201 ofs << "\n\\begin_body\n";
1203 ofs << "\n\\end_body\n";
1205 // Write marker that shows file is complete
1206 ofs << "\\end_document" << endl;
1208 // Shouldn't really be needed....
1211 // how to check if close went ok?
1212 // Following is an attempt... (BE 20001011)
1214 // good() returns false if any error occured, including some
1215 // formatting error.
1216 // bad() returns true if something bad happened in the buffer,
1217 // which should include file system full errors.
1222 lyxerr << "File was not closed properly." << endl;
1229 bool Buffer::makeLaTeXFile(FileName const & fname,
1230 string const & original_path,
1231 OutputParams const & runparams_in,
1232 bool output_preamble, bool output_body) const
1234 OutputParams runparams = runparams_in;
1236 // This is necessary for LuaTeX/XeTeX with tex fonts.
1237 // See FIXME in BufferParams::encoding()
1238 if (runparams.isFullUnicode())
1239 runparams.encoding = encodings.fromLyXName("utf8-plain");
1241 string const encoding = runparams.encoding->iconvName();
1242 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1245 try { ofs.reset(encoding); }
1246 catch (iconv_codecvt_facet_exception & e) {
1247 lyxerr << "Caught iconv exception: " << e.what() << endl;
1248 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1249 "verify that the support software for your encoding (%1$s) is "
1250 "properly installed"), from_ascii(encoding)));
1253 if (!openFileWrite(ofs, fname))
1256 //TexStream ts(ofs.rdbuf(), &texrow());
1257 ErrorList & errorList = d->errorLists["Export"];
1259 bool failed_export = false;
1262 writeLaTeXSource(ofs, original_path,
1263 runparams, output_preamble, output_body);
1265 catch (EncodingException & e) {
1266 odocstringstream ods;
1267 ods.put(e.failed_char);
1269 oss << "0x" << hex << e.failed_char << dec;
1270 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1271 " (code point %2$s)"),
1272 ods.str(), from_utf8(oss.str()));
1273 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1274 "representable in the chosen encoding.\n"
1275 "Changing the document encoding to utf8 could help."),
1276 e.par_id, e.pos, e.pos + 1));
1277 failed_export = true;
1279 catch (iconv_codecvt_facet_exception & e) {
1280 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1281 _(e.what()), -1, 0, 0));
1282 failed_export = true;
1284 catch (exception const & e) {
1285 errorList.push_back(ErrorItem(_("conversion failed"),
1286 _(e.what()), -1, 0, 0));
1287 failed_export = true;
1290 lyxerr << "Caught some really weird exception..." << endl;
1296 failed_export = true;
1297 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1301 return !failed_export;
1305 void Buffer::writeLaTeXSource(odocstream & os,
1306 string const & original_path,
1307 OutputParams const & runparams_in,
1308 bool const output_preamble, bool const output_body) const
1310 // The child documents, if any, shall be already loaded at this point.
1312 OutputParams runparams = runparams_in;
1314 // Classify the unicode characters appearing in math insets
1315 Encodings::initUnicodeMath(*this);
1317 // validate the buffer.
1318 LYXERR(Debug::LATEX, " Validating buffer...");
1319 LaTeXFeatures features(*this, params(), runparams);
1321 LYXERR(Debug::LATEX, " Buffer validation done.");
1323 // The starting paragraph of the coming rows is the
1324 // first paragraph of the document. (Asger)
1325 if (output_preamble && runparams.nice) {
1326 os << "%% LyX " << lyx_version << " created this file. "
1327 "For more info, see http://www.lyx.org/.\n"
1328 "%% Do not edit unless you really know what "
1330 d->texrow.newline();
1331 d->texrow.newline();
1333 LYXERR(Debug::INFO, "lyx document header finished");
1335 // Don't move this behind the parent_buffer=0 code below,
1336 // because then the macros will not get the right "redefinition"
1337 // flag as they don't see the parent macros which are output before.
1340 // fold macros if possible, still with parent buffer as the
1341 // macros will be put in the prefix anyway.
1342 updateMacroInstances();
1344 // There are a few differences between nice LaTeX and usual files:
1345 // usual is \batchmode and has a
1346 // special input@path to allow the including of figures
1347 // with either \input or \includegraphics (what figinsets do).
1348 // input@path is set when the actual parameter
1349 // original_path is set. This is done for usual tex-file, but not
1350 // for nice-latex-file. (Matthias 250696)
1351 // Note that input@path is only needed for something the user does
1352 // in the preamble, included .tex files or ERT, files included by
1353 // LyX work without it.
1354 if (output_preamble) {
1355 if (!runparams.nice) {
1356 // code for usual, NOT nice-latex-file
1357 os << "\\batchmode\n"; // changed
1358 // from \nonstopmode
1359 d->texrow.newline();
1361 if (!original_path.empty()) {
1363 // We don't know the encoding of inputpath
1364 docstring const inputpath = from_utf8(support::latex_path(original_path));
1365 docstring uncodable_glyphs;
1366 Encoding const * const enc = runparams.encoding;
1368 for (size_t n = 0; n < inputpath.size(); ++n) {
1369 docstring const glyph =
1370 docstring(1, inputpath[n]);
1371 if (enc->latexChar(inputpath[n], true) != glyph) {
1372 LYXERR0("Uncodable character '"
1374 << "' in input path!");
1375 uncodable_glyphs += glyph;
1380 // warn user if we found uncodable glyphs.
1381 if (!uncodable_glyphs.empty()) {
1382 frontend::Alert::warning(_("Uncodable character in file path"),
1383 support::bformat(_("The path of your document\n"
1385 "contains glyphs that are unknown in the\n"
1386 "current document encoding (namely %2$s).\n"
1387 "This will likely result in incomplete output.\n\n"
1388 "Choose an appropriate document encoding (such as utf8)\n"
1389 "or change the file path name."), inputpath, uncodable_glyphs));
1391 os << "\\makeatletter\n"
1392 << "\\def\\input@path{{"
1393 << inputpath << "/}}\n"
1394 << "\\makeatother\n";
1395 d->texrow.newline();
1396 d->texrow.newline();
1397 d->texrow.newline();
1401 // get parent macros (if this buffer has a parent) which will be
1402 // written at the document begin further down.
1403 MacroSet parentMacros;
1404 listParentMacros(parentMacros, features);
1406 runparams.use_polyglossia = features.usePolyglossia();
1407 // Write the preamble
1408 runparams.use_babel = params().writeLaTeX(os, features,
1410 d->filename.onlyPath());
1412 runparams.use_japanese = features.isRequired("japanese");
1418 os << "\\begin{document}\n";
1419 d->texrow.newline();
1421 // output the parent macros
1422 MacroSet::iterator it = parentMacros.begin();
1423 MacroSet::iterator end = parentMacros.end();
1424 for (; it != end; ++it) {
1425 int num_lines = (*it)->write(os, true);
1426 d->texrow.newlines(num_lines);
1429 } // output_preamble
1431 d->texrow.start(paragraphs().begin()->id(), 0);
1433 LYXERR(Debug::INFO, "preamble finished, now the body.");
1435 // if we are doing a real file with body, even if this is the
1436 // child of some other buffer, let's cut the link here.
1437 // This happens for example if only a child document is printed.
1438 Buffer const * save_parent = 0;
1439 if (output_preamble) {
1440 save_parent = d->parent();
1445 latexParagraphs(*this, text(), os, d->texrow, runparams);
1447 // Restore the parenthood if needed
1448 if (output_preamble)
1449 d->setParent(save_parent);
1451 // add this just in case after all the paragraphs
1453 d->texrow.newline();
1455 if (output_preamble) {
1456 os << "\\end{document}\n";
1457 d->texrow.newline();
1458 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1460 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1462 runparams_in.encoding = runparams.encoding;
1464 // Just to be sure. (Asger)
1465 d->texrow.newline();
1467 //for (int i = 0; i<d->texrow.rows(); i++) {
1469 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1470 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1473 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1474 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1478 bool Buffer::isLatex() const
1480 return params().documentClass().outputType() == LATEX;
1484 bool Buffer::isLiterate() const
1486 return params().documentClass().outputType() == LITERATE;
1490 bool Buffer::isDocBook() const
1492 return params().documentClass().outputType() == DOCBOOK;
1496 void Buffer::makeDocBookFile(FileName const & fname,
1497 OutputParams const & runparams,
1498 bool const body_only) const
1500 LYXERR(Debug::LATEX, "makeDocBookFile...");
1503 if (!openFileWrite(ofs, fname))
1506 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1510 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1514 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1515 OutputParams const & runparams,
1516 bool const only_body) const
1518 LaTeXFeatures features(*this, params(), runparams);
1523 DocumentClass const & tclass = params().documentClass();
1524 string const top_element = tclass.latexname();
1527 if (runparams.flavor == OutputParams::XML)
1528 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1531 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1534 if (! tclass.class_header().empty())
1535 os << from_ascii(tclass.class_header());
1536 else if (runparams.flavor == OutputParams::XML)
1537 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1538 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1540 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1542 docstring preamble = from_utf8(params().preamble);
1543 if (runparams.flavor != OutputParams::XML ) {
1544 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1545 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1546 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1547 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1550 string const name = runparams.nice
1551 ? changeExtension(absFileName(), ".sgml") : fname;
1552 preamble += features.getIncludedFiles(name);
1553 preamble += features.getLyXSGMLEntities();
1555 if (!preamble.empty()) {
1556 os << "\n [ " << preamble << " ]";
1561 string top = top_element;
1563 if (runparams.flavor == OutputParams::XML)
1564 top += params().language->code();
1566 top += params().language->code().substr(0, 2);
1569 if (!params().options.empty()) {
1571 top += params().options;
1574 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1575 << " file was created by LyX " << lyx_version
1576 << "\n See http://www.lyx.org/ for more information -->\n";
1578 params().documentClass().counters().reset();
1582 sgml::openTag(os, top);
1584 docbookParagraphs(text(), *this, os, runparams);
1585 sgml::closeTag(os, top_element);
1589 void Buffer::makeLyXHTMLFile(FileName const & fname,
1590 OutputParams const & runparams,
1591 bool const body_only) const
1593 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1596 if (!openFileWrite(ofs, fname))
1599 writeLyXHTMLSource(ofs, runparams, body_only);
1603 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1607 void Buffer::writeLyXHTMLSource(odocstream & os,
1608 OutputParams const & runparams,
1609 bool const only_body) const
1611 LaTeXFeatures features(*this, params(), runparams);
1613 updateBuffer(UpdateMaster, OutputUpdate);
1614 d->bibinfo_.makeCitationLabels(*this);
1616 updateMacroInstances();
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());
1665 string const org_path = filePath();
1667 PathChanger p(path); // path to LaTeX file
1668 message(_("Running chktex..."));
1670 // Generate the LaTeX file if neccessary
1671 OutputParams runparams(¶ms().encoding());
1672 runparams.flavor = OutputParams::LATEX;
1673 runparams.nice = false;
1674 runparams.linelen = lyxrc.plaintext_linelen;
1675 makeLaTeXFile(FileName(name), org_path, runparams);
1678 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1679 int const res = chktex.run(terr); // run chktex
1682 Alert::error(_("chktex failure"),
1683 _("Could not run chktex successfully."));
1684 } else if (res > 0) {
1685 ErrorList & errlist = d->errorLists["ChkTeX"];
1687 bufferErrors(terr, errlist);
1698 void Buffer::validate(LaTeXFeatures & features) const
1700 params().validate(features);
1704 for_each(paragraphs().begin(), paragraphs().end(),
1705 bind(&Paragraph::validate, _1, ref(features)));
1707 if (lyxerr.debugging(Debug::LATEX)) {
1708 features.showStruct();
1713 void Buffer::getLabelList(vector<docstring> & list) const
1715 // If this is a child document, use the master's list instead.
1717 masterBuffer()->getLabelList(list);
1722 Toc & toc = d->toc_backend.toc("label");
1723 TocIterator toc_it = toc.begin();
1724 TocIterator end = toc.end();
1725 for (; toc_it != end; ++toc_it) {
1726 if (toc_it->depth() == 0)
1727 list.push_back(toc_it->str());
1732 void Buffer::updateBibfilesCache(UpdateScope scope) const
1734 // FIXME This is probably unnecssary, given where we call this.
1735 // If this is a child document, use the parent's cache instead.
1736 if (parent() && scope != UpdateChildOnly) {
1737 masterBuffer()->updateBibfilesCache();
1741 d->bibfiles_cache_.clear();
1742 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1743 if (it->lyxCode() == BIBTEX_CODE) {
1744 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1745 support::FileNameList const bibfiles = inset.getBibFiles();
1746 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1749 } else if (it->lyxCode() == INCLUDE_CODE) {
1750 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1751 Buffer const * const incbuf = inset.getChildBuffer();
1754 support::FileNameList const & bibfiles =
1755 incbuf->getBibfilesCache(UpdateChildOnly);
1756 if (!bibfiles.empty()) {
1757 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1763 d->bibfile_cache_valid_ = true;
1764 d->bibinfo_cache_valid_ = false;
1768 void Buffer::invalidateBibinfoCache() const
1770 d->bibinfo_cache_valid_ = false;
1771 // also invalidate the cache for the parent buffer
1772 Buffer const * const pbuf = d->parent();
1774 pbuf->invalidateBibinfoCache();
1778 void Buffer::invalidateBibfileCache() const
1780 d->bibfile_cache_valid_ = false;
1781 d->bibinfo_cache_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::checkBibInfoCache() const
1815 // use the master's cache
1816 Buffer const * const tmp = masterBuffer();
1818 tmp->checkBibInfoCache();
1822 // this will also reload the cache if it is invalid
1823 support::FileNameList const & bibfiles_cache = getBibfilesCache();
1825 // compare the cached timestamps with the actual ones.
1826 support::FileNameList::const_iterator ei = bibfiles_cache.begin();
1827 support::FileNameList::const_iterator en = bibfiles_cache.end();
1828 for (; ei != en; ++ ei) {
1829 time_t lastw = ei->lastModified();
1830 time_t prevw = d->bibfile_status_[*ei];
1831 if (lastw != prevw) {
1832 d->bibinfo_cache_valid_ = false;
1833 d->bibfile_status_[*ei] = lastw;
1837 // if not valid, then reload the info
1838 if (!d->bibinfo_cache_valid_) {
1839 d->bibinfo_.clear();
1840 fillWithBibKeys(d->bibinfo_);
1841 d->bibinfo_cache_valid_ = true;
1846 void Buffer::fillWithBibKeys(BiblioInfo & keys) const
1848 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1849 it->fillWithBibKeys(keys, it);
1853 bool Buffer::isDepClean(string const & name) const
1855 DepClean::const_iterator const it = d->dep_clean.find(name);
1856 if (it == d->dep_clean.end())
1862 void Buffer::markDepClean(string const & name)
1864 d->dep_clean[name] = true;
1868 bool Buffer::isExportableFormat(string const & format) const
1870 typedef vector<Format const *> Formats;
1872 formats = exportableFormats(true);
1873 Formats::const_iterator fit = formats.begin();
1874 Formats::const_iterator end = formats.end();
1875 for (; fit != end ; ++fit) {
1876 if ((*fit)->name() == format)
1883 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1886 // FIXME? if there is an Buffer LFUN that can be dispatched even
1887 // if internal, put a switch '(cmd.action)' here.
1893 switch (cmd.action()) {
1895 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1896 flag.setOnOff(isReadonly());
1899 // FIXME: There is need for a command-line import.
1900 //case LFUN_BUFFER_IMPORT:
1902 case LFUN_BUFFER_AUTO_SAVE:
1905 case LFUN_BUFFER_EXPORT_CUSTOM:
1906 // FIXME: Nothing to check here?
1909 case LFUN_BUFFER_EXPORT: {
1910 docstring const arg = cmd.argument();
1911 enable = arg == "custom" || isExportable(to_utf8(arg));
1913 flag.message(bformat(
1914 _("Don't know how to export to format: %1$s"), arg));
1918 case LFUN_BUFFER_CHKTEX:
1919 enable = isLatex() && !lyxrc.chktex_command.empty();
1922 case LFUN_BUILD_PROGRAM:
1923 enable = isExportable("program");
1926 case LFUN_BRANCH_ACTIVATE:
1927 case LFUN_BRANCH_DEACTIVATE: {
1928 BranchList const & branchList = params().branchlist();
1929 docstring const branchName = cmd.argument();
1930 enable = !branchName.empty() && branchList.find(branchName);
1934 case LFUN_BRANCH_ADD:
1935 case LFUN_BRANCHES_RENAME:
1936 case LFUN_BUFFER_PRINT:
1937 // if no Buffer is present, then of course we won't be called!
1940 case LFUN_BUFFER_LANGUAGE:
1941 enable = !isReadonly();
1947 flag.setEnabled(enable);
1952 void Buffer::dispatch(string const & command, DispatchResult & result)
1954 return dispatch(lyxaction.lookupFunc(command), result);
1958 // NOTE We can end up here even if we have no GUI, because we are called
1959 // by LyX::exec to handled command-line requests. So we may need to check
1960 // whether we have a GUI or not. The boolean use_gui holds this information.
1961 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1964 // FIXME? if there is an Buffer LFUN that can be dispatched even
1965 // if internal, put a switch '(cmd.action())' here.
1966 dr.dispatched(false);
1969 string const argument = to_utf8(func.argument());
1970 // We'll set this back to false if need be.
1971 bool dispatched = true;
1972 undo().beginUndoGroup();
1974 switch (func.action()) {
1975 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1976 if (lyxvc().inUse())
1977 lyxvc().toggleReadOnly();
1979 setReadonly(!isReadonly());
1982 case LFUN_BUFFER_EXPORT: {
1983 bool success = doExport(argument, false, false);
1984 dr.setError(!success);
1986 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1991 case LFUN_BUILD_PROGRAM:
1992 doExport("program", true, false);
1995 case LFUN_BUFFER_CHKTEX:
1999 case LFUN_BUFFER_EXPORT_CUSTOM: {
2001 string command = split(argument, format_name, ' ');
2002 Format const * format = formats.getFormat(format_name);
2004 lyxerr << "Format \"" << format_name
2005 << "\" not recognized!"
2010 // The name of the file created by the conversion process
2013 // Output to filename
2014 if (format->name() == "lyx") {
2015 string const latexname = latexName(false);
2016 filename = changeExtension(latexname,
2017 format->extension());
2018 filename = addName(temppath(), filename);
2020 if (!writeFile(FileName(filename)))
2024 doExport(format_name, true, false, filename);
2027 // Substitute $$FName for filename
2028 if (!contains(command, "$$FName"))
2029 command = "( " + command + " ) < $$FName";
2030 command = subst(command, "$$FName", filename);
2032 // Execute the command in the background
2034 call.startscript(Systemcall::DontWait, command);
2038 // FIXME: There is need for a command-line import.
2040 case LFUN_BUFFER_IMPORT:
2045 case LFUN_BUFFER_AUTO_SAVE:
2047 resetAutosaveTimers();
2050 case LFUN_BRANCH_ADD: {
2051 docstring branch_name = func.argument();
2052 if (branch_name.empty()) {
2056 BranchList & branch_list = params().branchlist();
2057 vector<docstring> const branches =
2058 getVectorFromString(branch_name, branch_list.separator());
2060 for (vector<docstring>::const_iterator it = branches.begin();
2061 it != branches.end(); ++it) {
2063 Branch * branch = branch_list.find(branch_name);
2065 LYXERR0("Branch " << branch_name << " already exists.");
2069 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2071 branch_list.add(branch_name);
2072 branch = branch_list.find(branch_name);
2073 string const x11hexname = X11hexname(branch->color());
2074 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2075 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2077 dr.screenUpdate(Update::Force);
2085 case LFUN_BRANCH_ACTIVATE:
2086 case LFUN_BRANCH_DEACTIVATE: {
2087 BranchList & branchList = params().branchlist();
2088 docstring const branchName = func.argument();
2089 // the case without a branch name is handled elsewhere
2090 if (branchName.empty()) {
2094 Branch * branch = branchList.find(branchName);
2096 LYXERR0("Branch " << branchName << " does not exist.");
2098 docstring const msg =
2099 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2102 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2104 dr.screenUpdate(Update::Force);
2105 dr.forceBufferUpdate();
2110 case LFUN_BRANCHES_RENAME: {
2111 if (func.argument().empty())
2114 docstring const oldname = from_utf8(func.getArg(0));
2115 docstring const newname = from_utf8(func.getArg(1));
2116 InsetIterator it = inset_iterator_begin(inset());
2117 InsetIterator const end = inset_iterator_end(inset());
2118 bool success = false;
2119 for (; it != end; ++it) {
2120 if (it->lyxCode() == BRANCH_CODE) {
2121 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2122 if (ins.branch() == oldname) {
2123 undo().recordUndo(it);
2124 ins.rename(newname);
2129 if (it->lyxCode() == INCLUDE_CODE) {
2130 // get buffer of external file
2131 InsetInclude const & ins =
2132 static_cast<InsetInclude const &>(*it);
2133 Buffer * child = ins.getChildBuffer();
2136 child->dispatch(func, dr);
2141 dr.screenUpdate(Update::Force);
2142 dr.forceBufferUpdate();
2147 case LFUN_BUFFER_PRINT: {
2148 // we'll assume there's a problem until we succeed
2150 string target = func.getArg(0);
2151 string target_name = func.getArg(1);
2152 string command = func.getArg(2);
2155 || target_name.empty()
2156 || command.empty()) {
2157 LYXERR0("Unable to parse " << func.argument());
2158 docstring const msg =
2159 bformat(_("Unable to parse \"%1$s\""), func.argument());
2163 if (target != "printer" && target != "file") {
2164 LYXERR0("Unrecognized target \"" << target << '"');
2165 docstring const msg =
2166 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2171 bool const update_unincluded =
2172 params().maintain_unincluded_children
2173 && !params().getIncludedChildren().empty();
2174 if (!doExport("dvi", true, update_unincluded)) {
2175 showPrintError(absFileName());
2176 dr.setMessage(_("Error exporting to DVI."));
2180 // Push directory path.
2181 string const path = temppath();
2182 // Prevent the compiler from optimizing away p
2186 // there are three cases here:
2187 // 1. we print to a file
2188 // 2. we print directly to a printer
2189 // 3. we print using a spool command (print to file first)
2192 string const dviname = changeExtension(latexName(true), "dvi");
2194 if (target == "printer") {
2195 if (!lyxrc.print_spool_command.empty()) {
2196 // case 3: print using a spool
2197 string const psname = changeExtension(dviname,".ps");
2198 command += ' ' + lyxrc.print_to_file
2201 + quoteName(dviname);
2203 string command2 = lyxrc.print_spool_command + ' ';
2204 if (target_name != "default") {
2205 command2 += lyxrc.print_spool_printerprefix
2209 command2 += quoteName(psname);
2211 // If successful, then spool command
2212 res = one.startscript(Systemcall::Wait, command);
2215 // If there's no GUI, we have to wait on this command. Otherwise,
2216 // LyX deletes the temporary directory, and with it the spooled
2217 // file, before it can be printed!!
2218 Systemcall::Starttype stype = use_gui ?
2219 Systemcall::DontWait : Systemcall::Wait;
2220 res = one.startscript(stype, command2);
2223 // case 2: print directly to a printer
2224 if (target_name != "default")
2225 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2227 Systemcall::Starttype stype = use_gui ?
2228 Systemcall::DontWait : Systemcall::Wait;
2229 res = one.startscript(stype, command + quoteName(dviname));
2233 // case 1: print to a file
2234 FileName const filename(makeAbsPath(target_name, filePath()));
2235 FileName const dvifile(makeAbsPath(dviname, path));
2236 if (filename.exists()) {
2237 docstring text = bformat(
2238 _("The file %1$s already exists.\n\n"
2239 "Do you want to overwrite that file?"),
2240 makeDisplayPath(filename.absFileName()));
2241 if (Alert::prompt(_("Overwrite file?"),
2242 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2245 command += ' ' + lyxrc.print_to_file
2246 + quoteName(filename.toFilesystemEncoding())
2248 + quoteName(dvifile.toFilesystemEncoding());
2250 Systemcall::Starttype stype = use_gui ?
2251 Systemcall::DontWait : Systemcall::Wait;
2252 res = one.startscript(stype, command);
2258 dr.setMessage(_("Error running external commands."));
2259 showPrintError(absFileName());
2264 case LFUN_BUFFER_LANGUAGE: {
2265 Language const * oldL = params().language;
2266 Language const * newL = languages.getLanguage(argument);
2267 if (!newL || oldL == newL)
2269 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2270 changeLanguage(oldL, newL);
2271 dr.forceBufferUpdate();
2280 dr.dispatched(dispatched);
2281 undo().endUndoGroup();
2285 void Buffer::changeLanguage(Language const * from, Language const * to)
2287 LASSERT(from, /**/);
2290 for_each(par_iterator_begin(),
2292 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2296 bool Buffer::isMultiLingual() const
2298 ParConstIterator end = par_iterator_end();
2299 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2300 if (it->isMultiLingual(params()))
2307 std::set<Language const *> Buffer::getLanguages() const
2309 std::set<Language const *> languages;
2310 getLanguages(languages);
2315 void Buffer::getLanguages(std::set<Language const *> & languages) const
2317 ParConstIterator end = par_iterator_end();
2318 // add the buffer language, even if it's not actively used
2319 languages.insert(language());
2320 // iterate over the paragraphs
2321 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2322 it->getLanguages(languages);
2324 ListOfBuffers clist = getDescendents();
2325 ListOfBuffers::const_iterator cit = clist.begin();
2326 ListOfBuffers::const_iterator const cen = clist.end();
2327 for (; cit != cen; ++cit)
2328 (*cit)->getLanguages(languages);
2332 DocIterator Buffer::getParFromID(int const id) const
2334 Buffer * buf = const_cast<Buffer *>(this);
2336 // John says this is called with id == -1 from undo
2337 lyxerr << "getParFromID(), id: " << id << endl;
2338 return doc_iterator_end(buf);
2341 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2342 if (it.paragraph().id() == id)
2345 return doc_iterator_end(buf);
2349 bool Buffer::hasParWithID(int const id) const
2351 return !getParFromID(id).atEnd();
2355 ParIterator Buffer::par_iterator_begin()
2357 return ParIterator(doc_iterator_begin(this));
2361 ParIterator Buffer::par_iterator_end()
2363 return ParIterator(doc_iterator_end(this));
2367 ParConstIterator Buffer::par_iterator_begin() const
2369 return ParConstIterator(doc_iterator_begin(this));
2373 ParConstIterator Buffer::par_iterator_end() const
2375 return ParConstIterator(doc_iterator_end(this));
2379 Language const * Buffer::language() const
2381 return params().language;
2385 docstring const Buffer::B_(string const & l10n) const
2387 return params().B_(l10n);
2391 bool Buffer::isClean() const
2393 return d->lyx_clean;
2397 bool Buffer::isExternallyModified(CheckMethod method) const
2399 LASSERT(d->filename.exists(), /**/);
2400 // if method == timestamp, check timestamp before checksum
2401 return (method == checksum_method
2402 || d->timestamp_ != d->filename.lastModified())
2403 && d->checksum_ != d->filename.checksum();
2407 void Buffer::saveCheckSum() const
2409 FileName const & file = d->filename;
2410 if (file.exists()) {
2411 d->timestamp_ = file.lastModified();
2412 d->checksum_ = file.checksum();
2414 // in the case of save to a new file.
2421 void Buffer::markClean() const
2423 if (!d->lyx_clean) {
2424 d->lyx_clean = true;
2427 // if the .lyx file has been saved, we don't need an
2429 d->bak_clean = true;
2430 d->undo_.markDirty();
2434 void Buffer::setUnnamed(bool flag)
2440 bool Buffer::isUnnamed() const
2447 /// Don't check unnamed, here: isInternal() is used in
2448 /// newBuffer(), where the unnamed flag has not been set by anyone
2449 /// yet. Also, for an internal buffer, there should be no need for
2450 /// retrieving fileName() nor for checking if it is unnamed or not.
2451 bool Buffer::isInternal() const
2453 return fileName().extension() == "internal";
2457 void Buffer::markDirty()
2460 d->lyx_clean = false;
2463 d->bak_clean = false;
2465 DepClean::iterator it = d->dep_clean.begin();
2466 DepClean::const_iterator const end = d->dep_clean.end();
2468 for (; it != end; ++it)
2473 FileName Buffer::fileName() const
2479 string Buffer::absFileName() const
2481 return d->filename.absFileName();
2485 string Buffer::filePath() const
2487 return d->filename.onlyPath().absFileName() + "/";
2491 bool Buffer::isReadonly() const
2493 return d->read_only;
2497 void Buffer::setParent(Buffer const * buffer)
2499 // Avoids recursive include.
2500 d->setParent(buffer == this ? 0 : buffer);
2505 Buffer const * Buffer::parent() const
2511 ListOfBuffers Buffer::allRelatives() const
2513 ListOfBuffers lb = masterBuffer()->getDescendents();
2514 lb.push_front(const_cast<Buffer *>(this));
2519 Buffer const * Buffer::masterBuffer() const
2521 // FIXME Should be make sure we are not in some kind
2522 // of recursive include? A -> B -> A will crash this.
2523 Buffer const * const pbuf = d->parent();
2527 return pbuf->masterBuffer();
2531 bool Buffer::isChild(Buffer * child) const
2533 return d->children_positions.find(child) != d->children_positions.end();
2537 DocIterator Buffer::firstChildPosition(Buffer const * child)
2539 Impl::BufferPositionMap::iterator it;
2540 it = d->children_positions.find(child);
2541 if (it == d->children_positions.end())
2542 return DocIterator(this);
2547 bool Buffer::hasChildren() const
2549 return !d->children_positions.empty();
2553 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2555 // loop over children
2556 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2557 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2558 for (; it != end; ++it) {
2559 Buffer * child = const_cast<Buffer *>(it->first);
2561 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2562 if (bit != clist.end())
2564 clist.push_back(child);
2566 // there might be grandchildren
2567 child->collectChildren(clist, true);
2572 ListOfBuffers Buffer::getChildren() const
2575 collectChildren(v, false);
2580 ListOfBuffers Buffer::getDescendents() const
2583 collectChildren(v, true);
2588 template<typename M>
2589 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2594 typename M::const_iterator it = m.lower_bound(x);
2595 if (it == m.begin())
2603 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2604 DocIterator const & pos) const
2606 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2608 // if paragraphs have no macro context set, pos will be empty
2612 // we haven't found anything yet
2613 DocIterator bestPos = owner_->par_iterator_begin();
2614 MacroData const * bestData = 0;
2616 // find macro definitions for name
2617 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2618 if (nameIt != macros.end()) {
2619 // find last definition in front of pos or at pos itself
2620 PositionScopeMacroMap::const_iterator it
2621 = greatest_below(nameIt->second, pos);
2622 if (it != nameIt->second.end()) {
2624 // scope ends behind pos?
2625 if (pos < it->second.first) {
2626 // Looks good, remember this. If there
2627 // is no external macro behind this,
2628 // we found the right one already.
2629 bestPos = it->first;
2630 bestData = &it->second.second;
2634 // try previous macro if there is one
2635 if (it == nameIt->second.begin())
2642 // find macros in included files
2643 PositionScopeBufferMap::const_iterator it
2644 = greatest_below(position_to_children, pos);
2645 if (it == position_to_children.end())
2646 // no children before
2650 // do we know something better (i.e. later) already?
2651 if (it->first < bestPos )
2654 // scope ends behind pos?
2655 if (pos < it->second.first) {
2656 // look for macro in external file
2658 MacroData const * data
2659 = it->second.second->getMacro(name, false);
2662 bestPos = it->first;
2668 // try previous file if there is one
2669 if (it == position_to_children.begin())
2674 // return the best macro we have found
2679 MacroData const * Buffer::getMacro(docstring const & name,
2680 DocIterator const & pos, bool global) const
2685 // query buffer macros
2686 MacroData const * data = d->getBufferMacro(name, pos);
2690 // If there is a master buffer, query that
2691 Buffer const * const pbuf = d->parent();
2693 d->macro_lock = true;
2694 MacroData const * macro = pbuf->getMacro(
2695 name, *this, false);
2696 d->macro_lock = false;
2702 data = MacroTable::globalMacros().get(name);
2711 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2713 // set scope end behind the last paragraph
2714 DocIterator scope = par_iterator_begin();
2715 scope.pit() = scope.lastpit() + 1;
2717 return getMacro(name, scope, global);
2721 MacroData const * Buffer::getMacro(docstring const & name,
2722 Buffer const & child, bool global) const
2724 // look where the child buffer is included first
2725 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2726 if (it == d->children_positions.end())
2729 // check for macros at the inclusion position
2730 return getMacro(name, it->second, global);
2734 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2736 pit_type const lastpit = it.lastpit();
2738 // look for macros in each paragraph
2739 while (it.pit() <= lastpit) {
2740 Paragraph & par = it.paragraph();
2742 // iterate over the insets of the current paragraph
2743 InsetList const & insets = par.insetList();
2744 InsetList::const_iterator iit = insets.begin();
2745 InsetList::const_iterator end = insets.end();
2746 for (; iit != end; ++iit) {
2747 it.pos() = iit->pos;
2749 // is it a nested text inset?
2750 if (iit->inset->asInsetText()) {
2751 // Inset needs its own scope?
2752 InsetText const * itext = iit->inset->asInsetText();
2753 bool newScope = itext->isMacroScope();
2755 // scope which ends just behind the inset
2756 DocIterator insetScope = it;
2759 // collect macros in inset
2760 it.push_back(CursorSlice(*iit->inset));
2761 updateMacros(it, newScope ? insetScope : scope);
2766 if (iit->inset->asInsetTabular()) {
2767 CursorSlice slice(*iit->inset);
2768 size_t const numcells = slice.nargs();
2769 for (; slice.idx() < numcells; slice.forwardIdx()) {
2770 it.push_back(slice);
2771 updateMacros(it, scope);
2777 // is it an external file?
2778 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2779 // get buffer of external file
2780 InsetInclude const & inset =
2781 static_cast<InsetInclude const &>(*iit->inset);
2783 Buffer * child = inset.getChildBuffer();
2788 // register its position, but only when it is
2789 // included first in the buffer
2790 if (children_positions.find(child) ==
2791 children_positions.end())
2792 children_positions[child] = it;
2794 // register child with its scope
2795 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2799 InsetMath * im = iit->inset->asInsetMath();
2800 if (doing_export && im) {
2801 InsetMathHull * hull = im->asHullInset();
2803 hull->recordLocation(it);
2806 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2810 MathMacroTemplate & macroTemplate =
2811 *iit->inset->asInsetMath()->asMacroTemplate();
2812 MacroContext mc(owner_, it);
2813 macroTemplate.updateToContext(mc);
2816 bool valid = macroTemplate.validMacro();
2817 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2818 // then the BufferView's cursor will be invalid in
2819 // some cases which leads to crashes.
2824 // FIXME (Abdel), I don't understandt why we pass 'it' here
2825 // instead of 'macroTemplate' defined above... is this correct?
2826 macros[macroTemplate.name()][it] =
2827 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2837 void Buffer::updateMacros() const
2842 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2844 // start with empty table
2846 d->children_positions.clear();
2847 d->position_to_children.clear();
2849 // Iterate over buffer, starting with first paragraph
2850 // The scope must be bigger than any lookup DocIterator
2851 // later. For the global lookup, lastpit+1 is used, hence
2852 // we use lastpit+2 here.
2853 DocIterator it = par_iterator_begin();
2854 DocIterator outerScope = it;
2855 outerScope.pit() = outerScope.lastpit() + 2;
2856 d->updateMacros(it, outerScope);
2860 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2862 InsetIterator it = inset_iterator_begin(inset());
2863 InsetIterator const end = inset_iterator_end(inset());
2864 for (; it != end; ++it) {
2865 if (it->lyxCode() == BRANCH_CODE) {
2866 InsetBranch & br = static_cast<InsetBranch &>(*it);
2867 docstring const name = br.branch();
2868 if (!from_master && !params().branchlist().find(name))
2869 result.push_back(name);
2870 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2871 result.push_back(name);
2874 if (it->lyxCode() == INCLUDE_CODE) {
2875 // get buffer of external file
2876 InsetInclude const & ins =
2877 static_cast<InsetInclude const &>(*it);
2878 Buffer * child = ins.getChildBuffer();
2881 child->getUsedBranches(result, true);
2884 // remove duplicates
2889 void Buffer::updateMacroInstances() const
2891 LYXERR(Debug::MACROS, "updateMacroInstances for "
2892 << d->filename.onlyFileName());
2893 DocIterator it = doc_iterator_begin(this);
2895 DocIterator const end = doc_iterator_end(this);
2896 for (; it != end; it.forwardInset()) {
2897 // look for MathData cells in InsetMathNest insets
2898 InsetMath * minset = it.nextInset()->asInsetMath();
2902 // update macro in all cells of the InsetMathNest
2903 DocIterator::idx_type n = minset->nargs();
2904 MacroContext mc = MacroContext(this, it);
2905 for (DocIterator::idx_type i = 0; i < n; ++i) {
2906 MathData & data = minset->cell(i);
2907 data.updateMacros(0, mc);
2913 void Buffer::listMacroNames(MacroNameSet & macros) const
2918 d->macro_lock = true;
2920 // loop over macro names
2921 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2922 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2923 for (; nameIt != nameEnd; ++nameIt)
2924 macros.insert(nameIt->first);
2926 // loop over children
2927 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2928 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2929 for (; it != end; ++it)
2930 it->first->listMacroNames(macros);
2933 Buffer const * const pbuf = d->parent();
2935 pbuf->listMacroNames(macros);
2937 d->macro_lock = false;
2941 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2943 Buffer const * const pbuf = d->parent();
2948 pbuf->listMacroNames(names);
2951 MacroNameSet::iterator it = names.begin();
2952 MacroNameSet::iterator end = names.end();
2953 for (; it != end; ++it) {
2955 MacroData const * data =
2956 pbuf->getMacro(*it, *this, false);
2958 macros.insert(data);
2960 // we cannot access the original MathMacroTemplate anymore
2961 // here to calls validate method. So we do its work here manually.
2962 // FIXME: somehow make the template accessible here.
2963 if (data->optionals() > 0)
2964 features.require("xargs");
2970 Buffer::References & Buffer::references(docstring const & label)
2973 return const_cast<Buffer *>(masterBuffer())->references(label);
2975 RefCache::iterator it = d->ref_cache_.find(label);
2976 if (it != d->ref_cache_.end())
2977 return it->second.second;
2979 static InsetLabel const * dummy_il = 0;
2980 static References const dummy_refs;
2981 it = d->ref_cache_.insert(
2982 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2983 return it->second.second;
2987 Buffer::References const & Buffer::references(docstring const & label) const
2989 return const_cast<Buffer *>(this)->references(label);
2993 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2995 masterBuffer()->d->ref_cache_[label].first = il;
2999 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3001 return masterBuffer()->d->ref_cache_[label].first;
3005 void Buffer::clearReferenceCache() const
3008 d->ref_cache_.clear();
3012 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3015 //FIXME: This does not work for child documents yet.
3016 LASSERT(code == CITE_CODE, /**/);
3017 // Check if the label 'from' appears more than once
3018 vector<docstring> labels;
3020 checkBibInfoCache();
3021 BiblioInfo const & keys = masterBibInfo();
3022 BiblioInfo::const_iterator bit = keys.begin();
3023 BiblioInfo::const_iterator bend = keys.end();
3025 for (; bit != bend; ++bit)
3027 labels.push_back(bit->first);
3030 if (count(labels.begin(), labels.end(), from) > 1)
3033 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3034 if (it->lyxCode() == code) {
3035 InsetCommand * inset = it->asInsetCommand();
3038 docstring const oldValue = inset->getParam(paramName);
3039 if (oldValue == from)
3040 inset->setParam(paramName, to);
3046 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
3047 pit_type par_end, bool full_source) const
3049 OutputParams runparams(¶ms().encoding());
3050 runparams.nice = true;
3051 runparams.flavor = params().useNonTeXFonts ?
3052 OutputParams::XETEX : OutputParams::LATEX;
3053 runparams.linelen = lyxrc.plaintext_linelen;
3054 // No side effect of file copying and image conversion
3055 runparams.dryrun = true;
3058 os << "% " << _("Preview source code") << "\n\n";
3060 d->texrow.newline();
3061 d->texrow.newline();
3063 writeDocBookSource(os, absFileName(), runparams, false);
3065 // latex or literate
3066 writeLaTeXSource(os, string(), runparams, true, true);
3068 runparams.par_begin = par_begin;
3069 runparams.par_end = par_end;
3070 if (par_begin + 1 == par_end) {
3072 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3076 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3077 convert<docstring>(par_begin),
3078 convert<docstring>(par_end - 1))
3085 // output paragraphs
3087 docbookParagraphs(text(), *this, os, runparams);
3089 // latex or literate
3090 latexParagraphs(*this, text(), os, texrow, runparams);
3095 ErrorList & Buffer::errorList(string const & type) const
3097 static ErrorList emptyErrorList;
3098 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3099 if (it == d->errorLists.end())
3100 return emptyErrorList;
3106 void Buffer::updateTocItem(std::string const & type,
3107 DocIterator const & dit) const
3110 d->gui_->updateTocItem(type, dit);
3114 void Buffer::structureChanged() const
3117 d->gui_->structureChanged();
3121 void Buffer::errors(string const & err, bool from_master) const
3124 d->gui_->errors(err, from_master);
3128 void Buffer::message(docstring const & msg) const
3131 d->gui_->message(msg);
3135 void Buffer::setBusy(bool on) const
3138 d->gui_->setBusy(on);
3142 void Buffer::updateTitles() const
3145 d->wa_->updateTitles();
3149 void Buffer::resetAutosaveTimers() const
3152 d->gui_->resetAutosaveTimers();
3156 bool Buffer::hasGuiDelegate() const
3162 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3171 class AutoSaveBuffer : public ForkedProcess {
3174 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3175 : buffer_(buffer), fname_(fname) {}
3177 virtual shared_ptr<ForkedProcess> clone() const
3179 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3184 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3185 from_utf8(fname_.absFileName())));
3186 return run(DontWait);
3190 virtual int generateChild();
3192 Buffer const & buffer_;
3197 int AutoSaveBuffer::generateChild()
3199 #if defined(__APPLE__)
3200 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3201 * We should use something else like threads.
3203 * Since I do not know how to determine at run time what is the OS X
3204 * version, I just disable forking altogether for now (JMarc)
3206 pid_t const pid = -1;
3208 // tmp_ret will be located (usually) in /tmp
3209 // will that be a problem?
3210 // Note that this calls ForkedCalls::fork(), so it's
3211 // ok cross-platform.
3212 pid_t const pid = fork();
3213 // If you want to debug the autosave
3214 // you should set pid to -1, and comment out the fork.
3215 if (pid != 0 && pid != -1)
3219 // pid = -1 signifies that lyx was unable
3220 // to fork. But we will do the save
3222 bool failed = false;
3223 FileName const tmp_ret = FileName::tempName("lyxauto");
3224 if (!tmp_ret.empty()) {
3225 buffer_.writeFile(tmp_ret);
3226 // assume successful write of tmp_ret
3227 if (!tmp_ret.moveTo(fname_))
3233 // failed to write/rename tmp_ret so try writing direct
3234 if (!buffer_.writeFile(fname_)) {
3235 // It is dangerous to do this in the child,
3236 // but safe in the parent, so...
3237 if (pid == -1) // emit message signal.
3238 buffer_.message(_("Autosave failed!"));
3242 if (pid == 0) // we are the child so...
3251 FileName Buffer::getEmergencyFileName() const
3253 return FileName(d->filename.absFileName() + ".emergency");
3257 FileName Buffer::getAutosaveFileName() const
3259 // if the document is unnamed try to save in the backup dir, else
3260 // in the default document path, and as a last try in the filePath,
3261 // which will most often be the temporary directory
3264 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3265 : lyxrc.backupdir_path;
3266 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3269 string const fname = "#" + d->filename.onlyFileName() + "#";
3271 return makeAbsPath(fname, fpath);
3275 void Buffer::removeAutosaveFile() const
3277 FileName const f = getAutosaveFileName();
3283 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3285 FileName const newauto = getAutosaveFileName();
3287 if (newauto != oldauto && oldauto.exists())
3288 if (!oldauto.moveTo(newauto))
3289 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3293 bool Buffer::autoSave() const
3295 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3296 if (buf->d->bak_clean || isReadonly())
3299 message(_("Autosaving current document..."));
3300 buf->d->bak_clean = true;
3302 FileName const fname = getAutosaveFileName();
3303 if (d->cloned_buffer_) {
3304 // If this buffer is cloned, we assume that
3305 // we are running in a separate thread already.
3306 FileName const tmp_ret = FileName::tempName("lyxauto");
3307 if (!tmp_ret.empty()) {
3309 // assume successful write of tmp_ret
3310 if (tmp_ret.moveTo(fname))
3313 // failed to write/rename tmp_ret so try writing direct
3314 return writeFile(fname);
3316 /// This function is deprecated as the frontend needs to take care
3317 /// of cloning the buffer and autosaving it in another thread. It
3318 /// is still here to allow (QT_VERSION < 0x040400).
3319 AutoSaveBuffer autosave(*this, fname);
3326 string Buffer::bufferFormat() const
3328 string format = params().documentClass().outputFormat();
3329 if (format == "latex") {
3330 if (params().useNonTeXFonts)
3332 if (params().encoding().package() == Encoding::japanese)
3339 string Buffer::getDefaultOutputFormat() const
3341 if (!params().default_output_format.empty()
3342 && params().default_output_format != "default")
3343 return params().default_output_format;
3344 typedef vector<Format const *> Formats;
3345 Formats formats = exportableFormats(true);
3348 || params().useNonTeXFonts
3349 || params().encoding().package() == Encoding::japanese) {
3350 if (formats.empty())
3352 // return the first we find
3353 return formats.front()->name();
3355 return lyxrc.default_view_format;
3360 // helper class, to guarantee this gets reset properly
3361 class MarkAsExporting {
3363 MarkAsExporting(Buffer const * buf) : buf_(buf)
3365 LASSERT(buf_, /* */);
3366 buf_->setExportStatus(true);
3370 buf_->setExportStatus(false);
3373 Buffer const * const buf_;
3378 void Buffer::setExportStatus(bool e) const
3380 d->doing_export = e;
3384 bool Buffer::isExporting() const
3386 return d->doing_export;
3390 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3391 bool includeall, string & result_file) const
3393 MarkAsExporting exporting(this);
3394 string backend_format;
3395 OutputParams runparams(¶ms().encoding());
3396 runparams.flavor = OutputParams::LATEX;
3397 runparams.linelen = lyxrc.plaintext_linelen;
3398 runparams.includeall = includeall;
3399 vector<string> backs = backends();
3400 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3401 // Get shortest path to format
3402 Graph::EdgePath path;
3403 for (vector<string>::const_iterator it = backs.begin();
3404 it != backs.end(); ++it) {
3405 Graph::EdgePath p = theConverters().getPath(*it, format);
3406 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3407 backend_format = *it;
3412 if (!put_in_tempdir) {
3413 // Only show this alert if this is an export to a non-temporary
3414 // file (not for previewing).
3415 Alert::error(_("Couldn't export file"), bformat(
3416 _("No information for exporting the format %1$s."),
3417 formats.prettyName(format)));
3421 runparams.flavor = theConverters().getFlavor(path);
3424 backend_format = format;
3425 // FIXME: Don't hardcode format names here, but use a flag
3426 if (backend_format == "pdflatex")
3427 runparams.flavor = OutputParams::PDFLATEX;
3428 else if (backend_format == "luatex")
3429 runparams.flavor = OutputParams::LUATEX;
3430 else if (backend_format == "xetex")
3431 runparams.flavor = OutputParams::XETEX;
3434 string filename = latexName(false);
3435 filename = addName(temppath(), filename);
3436 filename = changeExtension(filename,
3437 formats.extension(backend_format));
3440 updateMacroInstances();
3442 // Plain text backend
3443 if (backend_format == "text") {
3444 runparams.flavor = OutputParams::TEXT;
3445 writePlaintextFile(*this, FileName(filename), runparams);
3448 else if (backend_format == "xhtml") {
3449 runparams.flavor = OutputParams::HTML;
3450 switch (params().html_math_output) {
3451 case BufferParams::MathML:
3452 runparams.math_flavor = OutputParams::MathAsMathML;
3454 case BufferParams::HTML:
3455 runparams.math_flavor = OutputParams::MathAsHTML;
3457 case BufferParams::Images:
3458 runparams.math_flavor = OutputParams::MathAsImages;
3460 case BufferParams::LaTeX:
3461 runparams.math_flavor = OutputParams::MathAsLaTeX;
3464 makeLyXHTMLFile(FileName(filename), runparams);
3465 } else if (backend_format == "lyx")
3466 writeFile(FileName(filename));
3468 else if (isDocBook()) {
3469 runparams.nice = !put_in_tempdir;
3470 makeDocBookFile(FileName(filename), runparams);
3473 else if (backend_format == format) {
3474 runparams.nice = true;
3475 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3477 } else if (!lyxrc.tex_allows_spaces
3478 && contains(filePath(), ' ')) {
3479 Alert::error(_("File name error"),
3480 _("The directory path to the document cannot contain spaces."));
3483 runparams.nice = false;
3484 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3488 string const error_type = (format == "program")
3489 ? "Build" : bufferFormat();
3490 ErrorList & error_list = d->errorLists[error_type];
3491 string const ext = formats.extension(format);
3492 FileName const tmp_result_file(changeExtension(filename, ext));
3493 bool const success = theConverters().convert(this, FileName(filename),
3494 tmp_result_file, FileName(absFileName()), backend_format, format,
3497 // Emit the signal to show the error list or copy it back to the
3498 // cloned Buffer so that it cab be emitted afterwards.
3499 if (format != backend_format) {
3500 if (d->cloned_buffer_) {
3501 d->cloned_buffer_->d->errorLists[error_type] =
3502 d->errorLists[error_type];
3505 // also to the children, in case of master-buffer-view
3506 ListOfBuffers clist = getDescendents();
3507 ListOfBuffers::const_iterator cit = clist.begin();
3508 ListOfBuffers::const_iterator const cen = clist.end();
3509 for (; cit != cen; ++cit) {
3510 if (d->cloned_buffer_) {
3511 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3512 (*cit)->d->errorLists[error_type];
3514 (*cit)->errors(error_type, true);
3518 if (d->cloned_buffer_) {
3519 // Enable reverse dvi or pdf to work by copying back the texrow
3520 // object to the cloned buffer.
3521 // FIXME: There is a possibility of concurrent access to texrow
3522 // here from the main GUI thread that should be securized.
3523 d->cloned_buffer_->d->texrow = d->texrow;
3524 string const error_type = bufferFormat();
3525 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3531 if (put_in_tempdir) {
3532 result_file = tmp_result_file.absFileName();
3536 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3537 // We need to copy referenced files (e. g. included graphics
3538 // if format == "dvi") to the result dir.
3539 vector<ExportedFile> const files =
3540 runparams.exportdata->externalFiles(format);
3541 string const dest = onlyPath(result_file);
3542 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3543 : force_overwrite == ALL_FILES;
3544 CopyStatus status = use_force ? FORCE : SUCCESS;
3546 vector<ExportedFile>::const_iterator it = files.begin();
3547 vector<ExportedFile>::const_iterator const en = files.end();
3548 for (; it != en && status != CANCEL; ++it) {
3549 string const fmt = formats.getFormatFromFile(it->sourceName);
3550 status = copyFile(fmt, it->sourceName,
3551 makeAbsPath(it->exportName, dest),
3552 it->exportName, status == FORCE);
3555 if (status == CANCEL) {
3556 message(_("Document export cancelled."));
3557 } else if (tmp_result_file.exists()) {
3558 // Finally copy the main file
3559 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3560 : force_overwrite != NO_FILES;
3561 if (status == SUCCESS && use_force)
3563 status = copyFile(format, tmp_result_file,
3564 FileName(result_file), result_file,
3566 message(bformat(_("Document exported as %1$s "
3568 formats.prettyName(format),
3569 makeDisplayPath(result_file)));
3571 // This must be a dummy converter like fax (bug 1888)
3572 message(bformat(_("Document exported as %1$s"),
3573 formats.prettyName(format)));
3580 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3581 bool includeall) const
3584 // (1) export with all included children (omit \includeonly)
3585 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3587 // (2) export with included children only
3588 return doExport(format, put_in_tempdir, false, result_file);
3592 bool Buffer::preview(string const & format, bool includeall) const
3594 MarkAsExporting exporting(this);
3596 // (1) export with all included children (omit \includeonly)
3597 if (includeall && !doExport(format, true, true))
3599 // (2) export with included children only
3600 if (!doExport(format, true, false, result_file))
3602 return formats.view(*this, FileName(result_file), format);
3606 bool Buffer::isExportable(string const & format) const
3608 vector<string> backs = backends();
3609 for (vector<string>::const_iterator it = backs.begin();
3610 it != backs.end(); ++it)
3611 if (theConverters().isReachable(*it, format))
3617 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3619 vector<string> const backs = backends();
3620 vector<Format const *> result =
3621 theConverters().getReachable(backs[0], only_viewable, true);
3622 for (vector<string>::const_iterator it = backs.begin() + 1;
3623 it != backs.end(); ++it) {
3624 vector<Format const *> r =
3625 theConverters().getReachable(*it, only_viewable, false);
3626 result.insert(result.end(), r.begin(), r.end());
3632 vector<string> Buffer::backends() const
3635 v.push_back(bufferFormat());
3636 // FIXME: Don't hardcode format names here, but use a flag
3637 if (v.back() == "latex") {
3638 v.push_back("pdflatex");
3639 v.push_back("luatex");
3640 v.push_back("xetex");
3641 } else if (v.back() == "xetex")
3642 v.push_back("luatex");
3643 v.push_back("xhtml");
3644 v.push_back("text");
3650 Buffer::ReadStatus Buffer::extractFromVC()
3652 bool const found = LyXVC::file_not_found_hook(d->filename);
3654 return ReadFileNotFound;
3655 if (!d->filename.isReadableFile())
3661 Buffer::ReadStatus Buffer::loadEmergency()
3663 FileName const emergencyFile = getEmergencyFileName();
3664 if (!emergencyFile.exists()
3665 || emergencyFile.lastModified() <= d->filename.lastModified())
3666 return ReadFileNotFound;
3668 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3669 docstring const text = bformat(_("An emergency save of the document "
3670 "%1$s exists.\n\nRecover emergency save?"), file);
3672 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3673 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3679 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3680 bool const success = (ret_llf == ReadSuccess);
3683 Alert::warning(_("File is read-only"),
3684 bformat(_("An emergency file is succesfully loaded, "
3685 "but the original file %1$s is marked read-only. "
3686 "Please make sure to save the document as a different "
3687 "file."), from_utf8(d->filename.absFileName())));
3690 str = _("Document was successfully recovered.");
3692 str = _("Document was NOT successfully recovered.");
3693 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3694 makeDisplayPath(emergencyFile.absFileName()));
3696 int const del_emerg =
3697 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3698 _("&Remove"), _("&Keep"));
3699 if (del_emerg == 0) {
3700 emergencyFile.removeFile();
3702 Alert::warning(_("Emergency file deleted"),
3703 _("Do not forget to save your file now!"), true);
3705 return success ? ReadSuccess : ReadEmergencyFailure;
3708 int const del_emerg =
3709 Alert::prompt(_("Delete emergency file?"),
3710 _("Remove emergency file now?"), 1, 1,
3711 _("&Remove"), _("&Keep"));
3713 emergencyFile.removeFile();
3714 return ReadOriginal;
3724 Buffer::ReadStatus Buffer::loadAutosave()
3726 // Now check if autosave file is newer.
3727 FileName const autosaveFile = getAutosaveFileName();
3728 if (!autosaveFile.exists()
3729 || autosaveFile.lastModified() <= d->filename.lastModified())
3730 return ReadFileNotFound;
3732 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3733 docstring const text = bformat(_("The backup of the document %1$s "
3734 "is newer.\n\nLoad the backup instead?"), file);
3735 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3736 _("&Load backup"), _("Load &original"), _("&Cancel"));
3741 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3742 // the file is not saved if we load the autosave file.
3743 if (ret_llf == ReadSuccess) {
3745 Alert::warning(_("File is read-only"),
3746 bformat(_("A backup file is succesfully loaded, "
3747 "but the original file %1$s is marked read-only. "
3748 "Please make sure to save the document as a "
3750 from_utf8(d->filename.absFileName())));
3755 return ReadAutosaveFailure;
3758 // Here we delete the autosave
3759 autosaveFile.removeFile();
3760 return ReadOriginal;
3768 Buffer::ReadStatus Buffer::loadLyXFile()
3770 if (!d->filename.isReadableFile()) {
3771 ReadStatus const ret_rvc = extractFromVC();
3772 if (ret_rvc != ReadSuccess)
3776 ReadStatus const ret_re = loadEmergency();
3777 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3780 ReadStatus const ret_ra = loadAutosave();
3781 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3784 return loadThisLyXFile(d->filename);
3788 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3790 return readFile(fn);
3794 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3796 TeXErrors::Errors::const_iterator cit = terr.begin();
3797 TeXErrors::Errors::const_iterator end = terr.end();
3799 for (; cit != end; ++cit) {
3802 int errorRow = cit->error_in_line;
3803 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3809 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3810 } while (found && id_start == id_end && pos_start == pos_end);
3812 errorList.push_back(ErrorItem(cit->error_desc,
3813 cit->error_text, id_start, pos_start, pos_end));
3818 void Buffer::setBuffersForInsets() const
3820 inset().setBuffer(const_cast<Buffer &>(*this));
3824 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3826 // Use the master text class also for child documents
3827 Buffer const * const master = masterBuffer();
3828 DocumentClass const & textclass = master->params().documentClass();
3830 // do this only if we are the top-level Buffer
3832 checkBibInfoCache();
3834 // keep the buffers to be children in this set. If the call from the
3835 // master comes back we can see which of them were actually seen (i.e.
3836 // via an InsetInclude). The remaining ones in the set need still be updated.
3837 static std::set<Buffer const *> bufToUpdate;
3838 if (scope == UpdateMaster) {
3839 // If this is a child document start with the master
3840 if (master != this) {
3841 bufToUpdate.insert(this);
3842 master->updateBuffer(UpdateMaster, utype);
3843 // Do this here in case the master has no gui associated with it. Then,
3844 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3845 if (!master->d->gui_)
3848 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3849 if (bufToUpdate.find(this) == bufToUpdate.end())
3853 // start over the counters in the master
3854 textclass.counters().reset();
3857 // update will be done below for this buffer
3858 bufToUpdate.erase(this);
3860 // update all caches
3861 clearReferenceCache();
3864 Buffer & cbuf = const_cast<Buffer &>(*this);
3866 LASSERT(!text().paragraphs().empty(), /**/);
3869 ParIterator parit = cbuf.par_iterator_begin();
3870 updateBuffer(parit, utype);
3873 // TocBackend update will be done later.
3876 cbuf.tocBackend().update();
3877 if (scope == UpdateMaster)
3878 cbuf.structureChanged();
3882 static depth_type getDepth(DocIterator const & it)
3884 depth_type depth = 0;
3885 for (size_t i = 0 ; i < it.depth() ; ++i)
3886 if (!it[i].inset().inMathed())
3887 depth += it[i].paragraph().getDepth() + 1;
3888 // remove 1 since the outer inset does not count
3892 static depth_type getItemDepth(ParIterator const & it)
3894 Paragraph const & par = *it;
3895 LabelType const labeltype = par.layout().labeltype;
3897 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3900 // this will hold the lowest depth encountered up to now.
3901 depth_type min_depth = getDepth(it);
3902 ParIterator prev_it = it;
3905 --prev_it.top().pit();
3907 // start of nested inset: go to outer par
3909 if (prev_it.empty()) {
3910 // start of document: nothing to do
3915 // We search for the first paragraph with same label
3916 // that is not more deeply nested.
3917 Paragraph & prev_par = *prev_it;
3918 depth_type const prev_depth = getDepth(prev_it);
3919 if (labeltype == prev_par.layout().labeltype) {
3920 if (prev_depth < min_depth)
3921 return prev_par.itemdepth + 1;
3922 if (prev_depth == min_depth)
3923 return prev_par.itemdepth;
3925 min_depth = min(min_depth, prev_depth);
3926 // small optimization: if we are at depth 0, we won't
3927 // find anything else
3928 if (prev_depth == 0)
3934 static bool needEnumCounterReset(ParIterator const & it)
3936 Paragraph const & par = *it;
3937 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3938 depth_type const cur_depth = par.getDepth();
3939 ParIterator prev_it = it;
3940 while (prev_it.pit()) {
3941 --prev_it.top().pit();
3942 Paragraph const & prev_par = *prev_it;
3943 if (prev_par.getDepth() <= cur_depth)
3944 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3946 // start of nested inset: reset
3951 // set the label of a paragraph. This includes the counters.
3952 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3954 BufferParams const & bp = owner_->masterBuffer()->params();
3955 DocumentClass const & textclass = bp.documentClass();
3956 Paragraph & par = it.paragraph();
3957 Layout const & layout = par.layout();
3958 Counters & counters = textclass.counters();
3960 if (par.params().startOfAppendix()) {
3961 // FIXME: only the counter corresponding to toplevel
3962 // sectioning should be reset
3964 counters.appendix(true);
3966 par.params().appendix(counters.appendix());
3968 // Compute the item depth of the paragraph
3969 par.itemdepth = getItemDepth(it);
3971 if (layout.margintype == MARGIN_MANUAL
3972 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3973 if (par.params().labelWidthString().empty())
3974 par.params().labelWidthString(par.expandLabel(layout, bp));
3976 par.params().labelWidthString(docstring());
3979 switch(layout.labeltype) {
3981 if (layout.toclevel <= bp.secnumdepth
3982 && (layout.latextype != LATEX_ENVIRONMENT
3983 || it.text()->isFirstInSequence(it.pit()))) {
3984 counters.step(layout.counter, utype);
3985 par.params().labelString(
3986 par.expandLabel(layout, bp));
3988 par.params().labelString(docstring());
3991 case LABEL_ITEMIZE: {
3992 // At some point of time we should do something more
3993 // clever here, like:
3994 // par.params().labelString(
3995 // bp.user_defined_bullet(par.itemdepth).getText());
3996 // for now, use a simple hardcoded label
3997 docstring itemlabel;
3998 switch (par.itemdepth) {
4000 itemlabel = char_type(0x2022);
4003 itemlabel = char_type(0x2013);
4006 itemlabel = char_type(0x2217);
4009 itemlabel = char_type(0x2219); // or 0x00b7
4012 par.params().labelString(itemlabel);
4016 case LABEL_ENUMERATE: {
4017 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4019 switch (par.itemdepth) {
4028 enumcounter += "iv";
4031 // not a valid enumdepth...
4035 // Maybe we have to reset the enumeration counter.
4036 if (needEnumCounterReset(it))
4037 counters.reset(enumcounter);
4038 counters.step(enumcounter, utype);
4040 string const & lang = par.getParLanguage(bp)->code();
4041 par.params().labelString(counters.theCounter(enumcounter, lang));
4046 case LABEL_SENSITIVE: {
4047 string const & type = counters.current_float();
4048 docstring full_label;
4050 full_label = owner_->B_("Senseless!!! ");
4052 docstring name = owner_->B_(textclass.floats().getType(type).name());
4053 if (counters.hasCounter(from_utf8(type))) {
4054 string const & lang = par.getParLanguage(bp)->code();
4055 counters.step(from_utf8(type), utype);
4056 full_label = bformat(from_ascii("%1$s %2$s:"),
4058 counters.theCounter(from_utf8(type), lang));
4060 full_label = bformat(from_ascii("%1$s #:"), name);
4062 par.params().labelString(full_label);
4066 case LABEL_NO_LABEL:
4067 par.params().labelString(docstring());
4071 case LABEL_TOP_ENVIRONMENT:
4072 case LABEL_CENTERED_TOP_ENVIRONMENT:
4075 par.params().labelString(par.expandLabel(layout, bp));
4081 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4083 LASSERT(parit.pit() == 0, /**/);
4085 // Set the position of the text in the buffer to be able
4086 // to resolve macros in it.
4087 parit.text()->setMacrocontextPosition(parit);
4089 depth_type maxdepth = 0;
4090 pit_type const lastpit = parit.lastpit();
4091 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4092 // reduce depth if necessary
4093 parit->params().depth(min(parit->params().depth(), maxdepth));
4094 maxdepth = parit->getMaxDepthAfter();
4096 if (utype == OutputUpdate) {
4097 // track the active counters
4098 // we have to do this for the master buffer, since the local
4099 // buffer isn't tracking anything.
4100 masterBuffer()->params().documentClass().counters().
4101 setActiveLayout(parit->layout());
4104 // set the counter for this paragraph
4105 d->setLabel(parit, utype);
4108 InsetList::const_iterator iit = parit->insetList().begin();
4109 InsetList::const_iterator end = parit->insetList().end();
4110 for (; iit != end; ++iit) {
4111 parit.pos() = iit->pos;
4112 iit->inset->updateBuffer(parit, utype);
4118 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4119 WordLangTuple & word_lang, docstring_list & suggestions) const
4123 suggestions.clear();
4124 word_lang = WordLangTuple();
4125 // OK, we start from here.
4126 DocIterator const end = doc_iterator_end(this);
4127 for (; from != end; from.forwardPos()) {
4128 // We are only interested in text so remove the math CursorSlice.
4129 while (from.inMathed()) {
4133 // If from is at the end of the document (which is possible
4134 // when leaving the mathed) LyX will crash later.
4138 from.paragraph().spellCheck();
4139 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4140 if (SpellChecker::misspelled(res)) {
4145 // Do not increase progress when from == to, otherwise the word
4146 // count will be wrong.
4156 Buffer::ReadStatus Buffer::reload()
4159 // c.f. bug http://www.lyx.org/trac/ticket/6587
4160 removeAutosaveFile();
4161 // e.g., read-only status could have changed due to version control
4162 d->filename.refresh();
4163 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4165 ReadStatus const status = loadLyXFile();
4166 if (status == ReadSuccess) {
4171 message(bformat(_("Document %1$s reloaded."), disp_fn));
4173 message(bformat(_("Could not reload document %1$s."), disp_fn));
4183 bool Buffer::saveAs(FileName const & fn)
4185 FileName const old_name = fileName();
4186 FileName const old_auto = getAutosaveFileName();
4187 bool const old_unnamed = isUnnamed();
4194 // bring the autosave file with us, just in case.
4195 moveAutosaveFile(old_auto);
4196 // validate version control data and
4197 // correct buffer title
4198 lyxvc().file_found_hook(fileName());
4200 // the file has now been saved to the new location.
4201 // we need to check that the locations of child buffers
4203 checkChildBuffers();
4207 // reset the old filename and unnamed state
4208 setFileName(old_name);
4209 setUnnamed(old_unnamed);
4215 // FIXME We could do better here, but it is complicated. What would be
4216 // nice is to offer either (a) to save the child buffer to an appropriate
4217 // location, so that it would "move with the master", or else (b) to update
4218 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4219 // complicated, because the code for this lives in GuiView.
4220 void Buffer::checkChildBuffers()
4222 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4223 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4224 for (; it != en; ++it) {
4225 DocIterator dit = it->second;
4226 Buffer * cbuf = const_cast<Buffer *>(it->first);
4227 if (!cbuf || !theBufferList().isLoaded(cbuf))
4229 Inset * inset = dit.nextInset();
4230 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4231 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4232 docstring const & incfile = inset_inc->getParam("filename");
4233 string oldloc = cbuf->absFileName();
4234 string newloc = makeAbsPath(to_utf8(incfile),
4235 onlyPath(absFileName())).absFileName();
4236 if (oldloc == newloc)
4238 // the location of the child file is incorrect.
4239 Alert::warning(_("Included File Invalid"),
4240 bformat(_("Saving this document to a new location has made the file:\n"
4242 "inaccessible. You will need to update the included filename."),
4243 from_utf8(oldloc)));
4245 inset_inc->setChildBuffer(0);
4247 // invalidate cache of children
4248 d->children_positions.clear();
4249 d->position_to_children.clear();