3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibtex.h"
70 #include "insets/InsetBranch.h"
71 #include "insets/InsetInclude.h"
72 #include "insets/InsetTabular.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "frontends/alert.h"
81 #include "frontends/Delegates.h"
82 #include "frontends/WorkAreaManager.h"
84 #include "graphics/Previews.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include "support/bind.h"
107 #include "support/shared_ptr.h"
119 using namespace lyx::support;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 // Do not remove the comment below, so we get merge conflict in
129 // independent branches. Instead add your own.
130 int const LYX_FORMAT = 413; // rgh: html_css_as_file
132 typedef map<string, bool> DepClean;
133 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
135 void showPrintError(string const & name)
137 docstring str = bformat(_("Could not print the document %1$s.\n"
138 "Check that your printer is set up correctly."),
139 makeDisplayPath(name, 50));
140 Alert::error(_("Print document failed"), str);
149 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
160 /// search for macro in local (buffer) table or in children
161 MacroData const * getBufferMacro(docstring const & name,
162 DocIterator const & pos) const;
164 /// Update macro table starting with position of it \param it in some
166 void updateMacros(DocIterator & it, DocIterator & scope);
168 void setLabel(ParIterator & it, UpdateType utype) const;
170 /** If we have branches that use the file suffix
171 feature, return the file name with suffix appended.
173 support::FileName exportFileName() const;
180 mutable TexRow texrow;
182 /// need to regenerate .tex?
186 mutable bool lyx_clean;
188 /// is autosave needed?
189 mutable bool bak_clean;
191 /// is this an unnamed file (New...)?
197 /// name of the file the buffer is associated with.
200 /** Set to true only when the file is fully loaded.
201 * Used to prevent the premature generation of previews
202 * and by the citation inset.
204 bool file_fully_loaded;
207 mutable TocBackend toc_backend;
210 typedef pair<DocIterator, MacroData> ScopeMacro;
211 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
212 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
213 /// map from the macro name to the position map,
214 /// which maps the macro definition position to the scope and the MacroData.
215 NamePositionScopeMacroMap macros;
216 /// This seem to change the way Buffer::getMacro() works
217 mutable bool macro_lock;
219 /// positions of child buffers in the buffer
220 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
221 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
222 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
223 /// position of children buffers in this buffer
224 BufferPositionMap children_positions;
225 /// map from children inclusion positions to their scope and their buffer
226 PositionScopeBufferMap position_to_children;
228 /// Container for all sort of Buffer dependant errors.
229 map<string, ErrorList> errorLists;
231 /// timestamp and checksum used to test if the file has been externally
232 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
234 unsigned long checksum_;
237 frontend::WorkAreaManager * wa_;
239 frontend::GuiBufferDelegate * gui_;
244 /// A cache for the bibfiles (including bibfiles of loaded child
245 /// documents), needed for appropriate update of natbib labels.
246 mutable support::FileNameList bibfiles_cache_;
248 // FIXME The caching mechanism could be improved. At present, we have a
249 // cache for each Buffer, that caches all the bibliography info for that
250 // Buffer. A more efficient solution would be to have a global cache per
251 // file, and then to construct the Buffer's bibinfo from that.
252 /// A cache for bibliography info
253 mutable BiblioInfo bibinfo_;
254 /// whether the bibinfo cache is valid
255 mutable bool bibinfo_cache_valid_;
256 /// whether the bibfile cache is valid
257 mutable bool bibfile_cache_valid_;
258 /// Cache of timestamps of .bib files
259 map<FileName, time_t> bibfile_status_;
261 mutable RefCache ref_cache_;
263 /// our Text that should be wrapped in an InsetText
266 /// This is here to force the test to be done whenever parent_buffer
268 Buffer const * parent() const {
269 // if parent_buffer is not loaded, then it has been unloaded,
270 // which means that parent_buffer is an invalid pointer. So we
271 // set it to null in that case.
272 // however, the BufferList doesn't know about cloned buffers, so
273 // they will always be regarded as unloaded. in that case, we hope
275 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
277 return parent_buffer;
281 void setParent(Buffer const * pb) {
282 if (parent_buffer == pb)
285 if (!cloned_buffer_ && parent_buffer && pb)
286 LYXERR0("Warning: a buffer should not have two parents!");
288 if (!cloned_buffer_ && parent_buffer) {
289 parent_buffer->invalidateBibfileCache();
290 parent_buffer->invalidateBibinfoCache();
294 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
295 /// This one is useful for preview detached in a thread.
296 Buffer const * cloned_buffer_;
297 /// are we in the process of exporting this buffer?
298 mutable bool doing_export;
301 /// So we can force access via the accessors.
302 mutable Buffer const * parent_buffer;
307 /// Creates the per buffer temporary directory
308 static FileName createBufferTmpDir()
311 // We are in our own directory. Why bother to mangle name?
312 // In fact I wrote this code to circumvent a problematic behaviour
313 // (bug?) of EMX mkstemp().
314 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
315 convert<string>(count++));
317 if (!tmpfl.createDirectory(0777)) {
318 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
319 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
320 from_utf8(tmpfl.absFileName())));
326 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
327 Buffer const * cloned_buffer)
328 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
329 read_only(readonly_), filename(file), file_fully_loaded(false),
330 toc_backend(owner), macro_lock(false), timestamp_(0),
331 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
332 bibfile_cache_valid_(false), cloned_buffer_(cloned_buffer),
333 doing_export(false), parent_buffer(0)
335 if (!cloned_buffer_) {
336 temppath = createBufferTmpDir();
337 lyxvc.setBuffer(owner_);
339 wa_ = new frontend::WorkAreaManager;
342 temppath = cloned_buffer_->d->temppath;
343 file_fully_loaded = true;
344 params = cloned_buffer_->d->params;
345 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
346 bibinfo_ = cloned_buffer_->d->bibinfo_;
347 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
348 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
349 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
353 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
354 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
356 LYXERR(Debug::INFO, "Buffer::Buffer()");
358 d->inset = new InsetText(*cloned_buffer->d->inset);
359 d->inset->setBuffer(*this);
360 // FIXME: optimize this loop somewhat, maybe by creating a new
361 // general recursive Inset::setId().
362 DocIterator it = doc_iterator_begin(this);
363 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
364 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
365 it.paragraph().setId(cloned_it.paragraph().id());
367 d->inset = new InsetText(this);
368 d->inset->setAutoBreakRows(true);
369 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
375 LYXERR(Debug::INFO, "Buffer::~Buffer()");
376 // here the buffer should take care that it is
377 // saved properly, before it goes into the void.
379 // GuiView already destroyed
383 // No need to do additional cleanups for internal buffer.
388 // loop over children
389 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
390 Impl::BufferPositionMap::iterator end = d->children_positions.end();
391 for (; it != end; ++it) {
392 Buffer * child = const_cast<Buffer *>(it->first);
393 if (d->cloned_buffer_)
395 // The child buffer might have been closed already.
396 else if (theBufferList().isLoaded(child))
397 theBufferList().releaseChild(this, child);
401 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
402 msg += emergencyWrite();
403 Alert::warning(_("Attempting to close changed document!"), msg);
406 // clear references to children in macro tables
407 d->children_positions.clear();
408 d->position_to_children.clear();
410 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
411 Alert::warning(_("Could not remove temporary directory"),
412 bformat(_("Could not remove the temporary directory %1$s"),
413 from_utf8(d->temppath.absFileName())));
423 Buffer * Buffer::clone() const
425 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
426 buffer_clone->d->macro_lock = true;
427 buffer_clone->d->children_positions.clear();
428 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
429 // math macro caches need to be rethought and simplified.
430 // I am not sure wether we should handle Buffer cloning here or in BufferList.
431 // Right now BufferList knows nothing about buffer clones.
432 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
433 Impl::BufferPositionMap::iterator end = d->children_positions.end();
434 for (; it != end; ++it) {
435 DocIterator dit = it->second.clone(buffer_clone);
436 dit.setBuffer(buffer_clone);
437 Buffer * child = const_cast<Buffer *>(it->first);
438 Buffer * child_clone = child->clone();
439 Inset * inset = dit.nextInset();
440 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
441 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
442 inset_inc->setChildBuffer(child_clone);
443 child_clone->d->setParent(buffer_clone);
444 buffer_clone->setChild(dit, child_clone);
446 buffer_clone->d->macro_lock = false;
451 bool Buffer::isClone() const
453 return d->cloned_buffer_;
457 void Buffer::changed(bool update_metrics) const
460 d->wa_->redrawAll(update_metrics);
464 frontend::WorkAreaManager & Buffer::workAreaManager() const
466 LASSERT(d->wa_, /**/);
471 Text & Buffer::text() const
473 return d->inset->text();
477 Inset & Buffer::inset() const
483 BufferParams & Buffer::params()
489 BufferParams const & Buffer::params() const
495 ParagraphList & Buffer::paragraphs()
497 return text().paragraphs();
501 ParagraphList const & Buffer::paragraphs() const
503 return text().paragraphs();
507 LyXVC & Buffer::lyxvc()
513 LyXVC const & Buffer::lyxvc() const
519 string const Buffer::temppath() const
521 return d->temppath.absFileName();
525 TexRow & Buffer::texrow()
531 TexRow const & Buffer::texrow() const
537 TocBackend & Buffer::tocBackend() const
539 return d->toc_backend;
543 Undo & Buffer::undo()
549 void Buffer::setChild(DocIterator const & dit, Buffer * child)
551 d->children_positions[child] = dit;
555 string Buffer::latexName(bool const no_path) const
557 FileName latex_name =
558 makeLatexName(d->exportFileName());
559 return no_path ? latex_name.onlyFileName()
560 : latex_name.absFileName();
564 FileName Buffer::Impl::exportFileName() const
566 docstring const branch_suffix =
567 params.branchlist().getFileNameSuffix();
568 if (branch_suffix.empty())
571 string const name = filename.onlyFileNameWithoutExt()
572 + to_utf8(branch_suffix);
573 FileName res(filename.onlyPath().absFileName() + "/" + name);
574 res.changeExtension(filename.extension());
580 string Buffer::logName(LogType * type) const
582 string const filename = latexName(false);
584 if (filename.empty()) {
590 string const path = temppath();
592 FileName const fname(addName(temppath(),
593 onlyFileName(changeExtension(filename,
596 // FIXME: how do we know this is the name of the build log?
597 FileName const bname(
598 addName(path, onlyFileName(
599 changeExtension(filename,
600 formats.extension(bufferFormat()) + ".out"))));
602 // Also consider the master buffer log file
603 FileName masterfname = fname;
605 if (masterBuffer() != this) {
606 string const mlogfile = masterBuffer()->logName(&mtype);
607 masterfname = FileName(mlogfile);
610 // If no Latex log or Build log is newer, show Build log
611 if (bname.exists() &&
612 ((!fname.exists() && !masterfname.exists())
613 || (fname.lastModified() < bname.lastModified()
614 && masterfname.lastModified() < bname.lastModified()))) {
615 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
618 return bname.absFileName();
619 // If we have a newer master file log or only a master log, show this
620 } else if (fname != masterfname
621 && (!fname.exists() && (masterfname.exists()
622 || fname.lastModified() < masterfname.lastModified()))) {
623 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
626 return masterfname.absFileName();
628 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
631 return fname.absFileName();
635 void Buffer::setReadonly(bool const flag)
637 if (d->read_only != flag) {
644 void Buffer::setFileName(FileName const & fname)
647 setReadonly(d->filename.isReadOnly());
653 int Buffer::readHeader(Lexer & lex)
655 int unknown_tokens = 0;
657 int begin_header_line = -1;
659 // Initialize parameters that may be/go lacking in header:
660 params().branchlist().clear();
661 params().preamble.erase();
662 params().options.erase();
663 params().master.erase();
664 params().float_placement.erase();
665 params().paperwidth.erase();
666 params().paperheight.erase();
667 params().leftmargin.erase();
668 params().rightmargin.erase();
669 params().topmargin.erase();
670 params().bottommargin.erase();
671 params().headheight.erase();
672 params().headsep.erase();
673 params().footskip.erase();
674 params().columnsep.erase();
675 params().fonts_cjk.erase();
676 params().listings_params.clear();
677 params().clearLayoutModules();
678 params().clearRemovedModules();
679 params().clearIncludedChildren();
680 params().pdfoptions().clear();
681 params().indiceslist().clear();
682 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
683 params().isbackgroundcolor = false;
684 params().fontcolor = lyx::rgbFromHexName("#000000");
685 params().isfontcolor = false;
686 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
687 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
688 params().html_latex_start.clear();
689 params().html_latex_end.clear();
690 params().html_math_img_scale = 1.0;
691 params().output_sync_macro.erase();
693 for (int i = 0; i < 4; ++i) {
694 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
695 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
698 ErrorList & errorList = d->errorLists["Parse"];
707 if (token == "\\end_header")
711 if (token == "\\begin_header") {
712 begin_header_line = line;
716 LYXERR(Debug::PARSER, "Handling document header token: `"
719 string unknown = params().readToken(lex, token, d->filename.onlyPath());
720 if (!unknown.empty()) {
721 if (unknown[0] != '\\' && token == "\\textclass") {
722 Alert::warning(_("Unknown document class"),
723 bformat(_("Using the default document class, because the "
724 "class %1$s is unknown."), from_utf8(unknown)));
727 docstring const s = bformat(_("Unknown token: "
731 errorList.push_back(ErrorItem(_("Document header error"),
736 if (begin_header_line) {
737 docstring const s = _("\\begin_header is missing");
738 errorList.push_back(ErrorItem(_("Document header error"),
742 params().makeDocumentClass();
744 return unknown_tokens;
749 // changed to be public and have one parameter
750 // Returns true if "\end_document" is not read (Asger)
751 bool Buffer::readDocument(Lexer & lex)
753 ErrorList & errorList = d->errorLists["Parse"];
756 // remove dummy empty par
757 paragraphs().clear();
759 if (!lex.checkFor("\\begin_document")) {
760 docstring const s = _("\\begin_document is missing");
761 errorList.push_back(ErrorItem(_("Document header error"),
767 if (params().outputChanges) {
768 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
769 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
770 LaTeXFeatures::isAvailable("xcolor");
772 if (!dvipost && !xcolorulem) {
773 Alert::warning(_("Changes not shown in LaTeX output"),
774 _("Changes will not be highlighted in LaTeX output, "
775 "because neither dvipost nor xcolor/ulem are installed.\n"
776 "Please install these packages or redefine "
777 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
778 } else if (!xcolorulem) {
779 Alert::warning(_("Changes not shown in LaTeX output"),
780 _("Changes will not be highlighted in LaTeX output "
781 "when using pdflatex, because xcolor and ulem are not installed.\n"
782 "Please install both packages or redefine "
783 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
787 if (!params().master.empty()) {
788 FileName const master_file = makeAbsPath(params().master,
789 onlyPath(absFileName()));
790 if (isLyXFileName(master_file.absFileName())) {
792 checkAndLoadLyXFile(master_file, true);
794 // necessary e.g. after a reload
795 // to re-register the child (bug 5873)
796 // FIXME: clean up updateMacros (here, only
797 // child registering is needed).
798 master->updateMacros();
799 // set master as master buffer, but only
800 // if we are a real child
801 if (master->isChild(this))
803 // if the master is not fully loaded
804 // it is probably just loading this
805 // child. No warning needed then.
806 else if (master->isFullyLoaded())
807 LYXERR0("The master '"
809 << "' assigned to this document ("
811 << ") does not include "
812 "this document. Ignoring the master assignment.");
817 // assure we have a default index
818 params().indiceslist().addDefault(B_("Index"));
821 bool const res = text().read(lex, errorList, d->inset);
823 // inform parent buffer about local macros
825 Buffer const * pbuf = parent();
826 UserMacroSet::const_iterator cit = usermacros.begin();
827 UserMacroSet::const_iterator end = usermacros.end();
828 for (; cit != end; ++cit)
829 pbuf->usermacros.insert(*cit);
833 updateMacroInstances();
838 bool Buffer::readString(string const & s)
840 params().compressed = false;
845 FileName const fn = FileName::tempName("Buffer_readString");
848 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
849 if (ret_plf != ReadSuccess)
852 if (file_format != LYX_FORMAT) {
853 // We need to call lyx2lyx, so write the input to a file
854 ofstream os(fn.toFilesystemEncoding().c_str());
858 return readFile(fn) == ReadSuccess;
861 if (readDocument(lex))
867 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
874 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
875 if (ret_plf != ReadSuccess)
878 if (file_format != LYX_FORMAT) {
880 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
881 if (ret_clf != ReadSuccess)
883 return readFile(tmpFile);
886 // FIXME: InsetInfo needs to know whether the file is under VCS
887 // during the parse process, so this has to be done before.
888 lyxvc().file_found_hook(d->filename);
890 if (readDocument(lex)) {
891 Alert::error(_("Document format failure"),
892 bformat(_("%1$s ended unexpectedly, which means"
893 " that it is probably corrupted."),
894 from_utf8(fn.absFileName())));
895 return ReadDocumentFailure;
898 d->file_fully_loaded = true;
899 d->read_only = !d->filename.isWritable();
900 params().compressed = d->filename.isZippedFile();
906 bool Buffer::isFullyLoaded() const
908 return d->file_fully_loaded;
912 void Buffer::setFullyLoaded(bool value)
914 d->file_fully_loaded = value;
918 void Buffer::updatePreviews() const
920 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
921 thePreviews().generateBufferPreviews(*this);
925 void Buffer::removePreviews() const
927 thePreviews().removeLoader(*this);
931 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
932 FileName const & fn, int & file_format) const
934 if(!lex.checkFor("\\lyxformat")) {
935 Alert::error(_("Document format failure"),
936 bformat(_("%1$s is not a readable LyX document."),
937 from_utf8(fn.absFileName())));
938 return ReadNoLyXFormat;
944 // LyX formats 217 and earlier were written as 2.17. This corresponds
945 // to files from LyX versions < 1.1.6.3. We just remove the dot in
946 // these cases. See also: www.lyx.org/trac/changeset/1313.
947 size_t dot = tmp_format.find_first_of(".,");
948 if (dot != string::npos)
949 tmp_format.erase(dot, 1);
951 file_format = convert<int>(tmp_format);
956 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
957 FileName & tmpfile, int from_format)
959 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
960 if(tmpfile.empty()) {
961 Alert::error(_("Conversion failed"),
962 bformat(_("%1$s is from a different"
963 " version of LyX, but a temporary"
964 " file for converting it could"
966 from_utf8(fn.absFileName())));
967 return LyX2LyXNoTempFile;
970 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
971 if (lyx2lyx.empty()) {
972 Alert::error(_("Conversion script not found"),
973 bformat(_("%1$s is from a different"
974 " version of LyX, but the"
975 " conversion script lyx2lyx"
976 " could not be found."),
977 from_utf8(fn.absFileName())));
978 return LyX2LyXNotFound;
982 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
983 ostringstream command;
984 command << os::python()
985 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
986 << " -t " << convert<string>(LYX_FORMAT)
987 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
988 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
989 string const command_str = command.str();
991 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
993 cmd_ret const ret = runCommand(command_str);
994 if (ret.first != 0) {
995 if (from_format < LYX_FORMAT) {
996 Alert::error(_("Conversion script failed"),
997 bformat(_("%1$s is from an older version"
998 " of LyX and the lyx2lyx script"
999 " failed to convert it."),
1000 from_utf8(fn.absFileName())));
1001 return LyX2LyXOlderFormat;
1003 Alert::error(_("Conversion script failed"),
1004 bformat(_("%1$s is from a newer version"
1005 " of LyX and the lyx2lyx script"
1006 " failed to convert it."),
1007 from_utf8(fn.absFileName())));
1008 return LyX2LyXNewerFormat;
1015 // Should probably be moved to somewhere else: BufferView? GuiView?
1016 bool Buffer::save() const
1018 docstring const file = makeDisplayPath(absFileName(), 20);
1019 d->filename.refresh();
1021 // check the read-only status before moving the file as a backup
1022 if (d->filename.exists()) {
1023 bool const read_only = !d->filename.isWritable();
1025 Alert::warning(_("File is read-only"),
1026 bformat(_("The file %1$s cannot be written because it "
1027 "is marked as read-only."), file));
1032 // ask if the disk file has been externally modified (use checksum method)
1033 if (fileName().exists() && isExternallyModified(checksum_method)) {
1035 bformat(_("Document %1$s has been externally modified. "
1036 "Are you sure you want to overwrite this file?"), file);
1037 int const ret = Alert::prompt(_("Overwrite modified file?"),
1038 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1043 // We don't need autosaves in the immediate future. (Asger)
1044 resetAutosaveTimers();
1046 FileName backupName;
1047 bool madeBackup = false;
1049 // make a backup if the file already exists
1050 if (lyxrc.make_backup && fileName().exists()) {
1051 backupName = FileName(absFileName() + '~');
1052 if (!lyxrc.backupdir_path.empty()) {
1053 string const mangledName =
1054 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1055 backupName = FileName(addName(lyxrc.backupdir_path,
1059 // Except file is symlink do not copy because of #6587.
1060 // Hard links have bad luck.
1061 if (fileName().isSymLink())
1062 madeBackup = fileName().copyTo(backupName);
1064 madeBackup = fileName().moveTo(backupName);
1067 Alert::error(_("Backup failure"),
1068 bformat(_("Cannot create backup file %1$s.\n"
1069 "Please check whether the directory exists and is writable."),
1070 from_utf8(backupName.absFileName())));
1071 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1075 if (writeFile(d->filename)) {
1079 // Saving failed, so backup is not backup
1081 backupName.moveTo(d->filename);
1087 bool Buffer::writeFile(FileName const & fname) const
1089 if (d->read_only && fname == d->filename)
1092 bool retval = false;
1094 docstring const str = bformat(_("Saving document %1$s..."),
1095 makeDisplayPath(fname.absFileName()));
1098 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1100 if (params().compressed) {
1101 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1102 retval = ofs && write(ofs);
1104 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1105 retval = ofs && write(ofs);
1109 message(str + _(" could not write file!"));
1114 // removeAutosaveFile();
1117 message(str + _(" done."));
1123 docstring Buffer::emergencyWrite()
1125 // No need to save if the buffer has not changed.
1129 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1131 docstring user_message = bformat(
1132 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1134 // We try to save three places:
1135 // 1) Same place as document. Unless it is an unnamed doc.
1137 string s = absFileName();
1140 if (writeFile(FileName(s))) {
1142 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1143 return user_message;
1145 user_message += " " + _("Save failed! Trying again...\n");
1149 // 2) In HOME directory.
1150 string s = addName(package().home_dir().absFileName(), absFileName());
1152 lyxerr << ' ' << s << endl;
1153 if (writeFile(FileName(s))) {
1155 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1156 return user_message;
1159 user_message += " " + _("Save failed! Trying yet again...\n");
1161 // 3) In "/tmp" directory.
1162 // MakeAbsPath to prepend the current
1163 // drive letter on OS/2
1164 s = addName(package().temp_dir().absFileName(), absFileName());
1166 lyxerr << ' ' << s << endl;
1167 if (writeFile(FileName(s))) {
1169 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1170 return user_message;
1173 user_message += " " + _("Save failed! Bummer. Document is lost.");
1176 return user_message;
1180 bool Buffer::write(ostream & ofs) const
1183 // Use the standard "C" locale for file output.
1184 ofs.imbue(locale::classic());
1187 // The top of the file should not be written by params().
1189 // write out a comment in the top of the file
1190 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1191 << " created this file. For more info see http://www.lyx.org/\n"
1192 << "\\lyxformat " << LYX_FORMAT << "\n"
1193 << "\\begin_document\n";
1195 /// For each author, set 'used' to true if there is a change
1196 /// by this author in the document; otherwise set it to 'false'.
1197 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1198 AuthorList::Authors::const_iterator a_end = params().authors().end();
1199 for (; a_it != a_end; ++a_it)
1200 a_it->setUsed(false);
1202 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1203 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1204 for ( ; it != end; ++it)
1205 it->checkAuthors(params().authors());
1207 // now write out the buffer parameters.
1208 ofs << "\\begin_header\n";
1209 params().writeFile(ofs);
1210 ofs << "\\end_header\n";
1213 ofs << "\n\\begin_body\n";
1215 ofs << "\n\\end_body\n";
1217 // Write marker that shows file is complete
1218 ofs << "\\end_document" << endl;
1220 // Shouldn't really be needed....
1223 // how to check if close went ok?
1224 // Following is an attempt... (BE 20001011)
1226 // good() returns false if any error occured, including some
1227 // formatting error.
1228 // bad() returns true if something bad happened in the buffer,
1229 // which should include file system full errors.
1234 lyxerr << "File was not closed properly." << endl;
1241 bool Buffer::makeLaTeXFile(FileName const & fname,
1242 string const & original_path,
1243 OutputParams const & runparams_in,
1244 bool output_preamble, bool output_body) const
1246 OutputParams runparams = runparams_in;
1248 // This is necessary for LuaTeX/XeTeX with tex fonts.
1249 // See FIXME in BufferParams::encoding()
1250 if (runparams.isFullUnicode())
1251 runparams.encoding = encodings.fromLyXName("utf8-plain");
1253 string const encoding = runparams.encoding->iconvName();
1254 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1257 try { ofs.reset(encoding); }
1258 catch (iconv_codecvt_facet_exception & e) {
1259 lyxerr << "Caught iconv exception: " << e.what() << endl;
1260 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1261 "verify that the support software for your encoding (%1$s) is "
1262 "properly installed"), from_ascii(encoding)));
1265 if (!openFileWrite(ofs, fname))
1268 //TexStream ts(ofs.rdbuf(), &texrow());
1269 ErrorList & errorList = d->errorLists["Export"];
1271 bool failed_export = false;
1272 otexstream os(ofs, d->texrow);
1274 os.texrow().reset();
1275 writeLaTeXSource(os, original_path,
1276 runparams, output_preamble, output_body);
1278 catch (EncodingException & e) {
1279 odocstringstream ods;
1280 ods.put(e.failed_char);
1282 oss << "0x" << hex << e.failed_char << dec;
1283 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1284 " (code point %2$s)"),
1285 ods.str(), from_utf8(oss.str()));
1286 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1287 "representable in the chosen encoding.\n"
1288 "Changing the document encoding to utf8 could help."),
1289 e.par_id, e.pos, e.pos + 1));
1290 failed_export = true;
1292 catch (iconv_codecvt_facet_exception & e) {
1293 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1294 _(e.what()), -1, 0, 0));
1295 failed_export = true;
1297 catch (exception const & e) {
1298 errorList.push_back(ErrorItem(_("conversion failed"),
1299 _(e.what()), -1, 0, 0));
1300 failed_export = true;
1303 lyxerr << "Caught some really weird exception..." << endl;
1309 failed_export = true;
1310 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1314 return !failed_export;
1318 void Buffer::writeLaTeXSource(otexstream & os,
1319 string const & original_path,
1320 OutputParams const & runparams_in,
1321 bool const output_preamble, bool const output_body) const
1323 // The child documents, if any, shall be already loaded at this point.
1325 OutputParams runparams = runparams_in;
1327 // Classify the unicode characters appearing in math insets
1328 Encodings::initUnicodeMath(*this);
1330 // validate the buffer.
1331 LYXERR(Debug::LATEX, " Validating buffer...");
1332 LaTeXFeatures features(*this, params(), runparams);
1334 LYXERR(Debug::LATEX, " Buffer validation done.");
1336 // The starting paragraph of the coming rows is the
1337 // first paragraph of the document. (Asger)
1338 if (output_preamble && runparams.nice) {
1339 os << "%% LyX " << lyx_version << " created this file. "
1340 "For more info, see http://www.lyx.org/.\n"
1341 "%% Do not edit unless you really know what "
1344 LYXERR(Debug::INFO, "lyx document header finished");
1346 // Don't move this behind the parent_buffer=0 code below,
1347 // because then the macros will not get the right "redefinition"
1348 // flag as they don't see the parent macros which are output before.
1351 // fold macros if possible, still with parent buffer as the
1352 // macros will be put in the prefix anyway.
1353 updateMacroInstances();
1355 // There are a few differences between nice LaTeX and usual files:
1356 // usual is \batchmode and has a
1357 // special input@path to allow the including of figures
1358 // with either \input or \includegraphics (what figinsets do).
1359 // input@path is set when the actual parameter
1360 // original_path is set. This is done for usual tex-file, but not
1361 // for nice-latex-file. (Matthias 250696)
1362 // Note that input@path is only needed for something the user does
1363 // in the preamble, included .tex files or ERT, files included by
1364 // LyX work without it.
1365 if (output_preamble) {
1366 if (!runparams.nice) {
1367 // code for usual, NOT nice-latex-file
1368 os << "\\batchmode\n"; // changed from \nonstopmode
1370 if (!original_path.empty()) {
1372 // We don't know the encoding of inputpath
1373 docstring const inputpath = from_utf8(support::latex_path(original_path));
1374 docstring uncodable_glyphs;
1375 Encoding const * const enc = runparams.encoding;
1377 for (size_t n = 0; n < inputpath.size(); ++n) {
1378 docstring const glyph =
1379 docstring(1, inputpath[n]);
1380 if (enc->latexChar(inputpath[n], true) != glyph) {
1381 LYXERR0("Uncodable character '"
1383 << "' in input path!");
1384 uncodable_glyphs += glyph;
1389 // warn user if we found uncodable glyphs.
1390 if (!uncodable_glyphs.empty()) {
1391 frontend::Alert::warning(_("Uncodable character in file path"),
1392 support::bformat(_("The path of your document\n"
1394 "contains glyphs that are unknown in the\n"
1395 "current document encoding (namely %2$s).\n"
1396 "This will likely result in incomplete output.\n\n"
1397 "Choose an appropriate document encoding (such as utf8)\n"
1398 "or change the file path name."), inputpath, uncodable_glyphs));
1400 os << "\\makeatletter\n"
1401 << "\\def\\input@path{{"
1402 << inputpath << "/}}\n"
1403 << "\\makeatother\n";
1407 // get parent macros (if this buffer has a parent) which will be
1408 // written at the document begin further down.
1409 MacroSet parentMacros;
1410 listParentMacros(parentMacros, features);
1412 runparams.use_polyglossia = features.usePolyglossia();
1413 // Write the preamble
1414 runparams.use_babel = params().writeLaTeX(os, features,
1415 d->filename.onlyPath());
1417 runparams.use_japanese = features.isRequired("japanese");
1423 os << "\\begin{document}\n";
1425 // output the parent macros
1426 MacroSet::iterator it = parentMacros.begin();
1427 MacroSet::iterator end = parentMacros.end();
1428 for (; it != end; ++it) {
1429 int num_lines = (*it)->write(os.os(), true);
1430 os.texrow().newlines(num_lines);
1433 } // output_preamble
1435 os.texrow().start(paragraphs().begin()->id(), 0);
1437 LYXERR(Debug::INFO, "preamble finished, now the body.");
1439 // if we are doing a real file with body, even if this is the
1440 // child of some other buffer, let's cut the link here.
1441 // This happens for example if only a child document is printed.
1442 Buffer const * save_parent = 0;
1443 if (output_preamble) {
1444 save_parent = d->parent();
1449 latexParagraphs(*this, text(), os, runparams);
1451 // Restore the parenthood if needed
1452 if (output_preamble)
1453 d->setParent(save_parent);
1455 // add this just in case after all the paragraphs
1458 if (output_preamble) {
1459 os << "\\end{document}\n";
1460 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1462 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1464 runparams_in.encoding = runparams.encoding;
1466 // Just to be sure. (Asger)
1467 os.texrow().newline();
1469 //for (int i = 0; i<d->texrow.rows(); i++) {
1471 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1472 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1475 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1476 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1480 bool Buffer::isLatex() const
1482 return params().documentClass().outputType() == LATEX;
1486 bool Buffer::isLiterate() const
1488 return params().documentClass().outputType() == LITERATE;
1492 bool Buffer::isDocBook() const
1494 return params().documentClass().outputType() == DOCBOOK;
1498 void Buffer::makeDocBookFile(FileName const & fname,
1499 OutputParams const & runparams,
1500 bool const body_only) const
1502 LYXERR(Debug::LATEX, "makeDocBookFile...");
1505 if (!openFileWrite(ofs, fname))
1508 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1512 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1516 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1517 OutputParams const & runparams,
1518 bool const only_body) const
1520 LaTeXFeatures features(*this, params(), runparams);
1525 DocumentClass const & tclass = params().documentClass();
1526 string const top_element = tclass.latexname();
1529 if (runparams.flavor == OutputParams::XML)
1530 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1533 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1536 if (! tclass.class_header().empty())
1537 os << from_ascii(tclass.class_header());
1538 else if (runparams.flavor == OutputParams::XML)
1539 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1540 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1542 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1544 docstring preamble = from_utf8(params().preamble);
1545 if (runparams.flavor != OutputParams::XML ) {
1546 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1547 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1548 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1549 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1552 string const name = runparams.nice
1553 ? changeExtension(absFileName(), ".sgml") : fname;
1554 preamble += features.getIncludedFiles(name);
1555 preamble += features.getLyXSGMLEntities();
1557 if (!preamble.empty()) {
1558 os << "\n [ " << preamble << " ]";
1563 string top = top_element;
1565 if (runparams.flavor == OutputParams::XML)
1566 top += params().language->code();
1568 top += params().language->code().substr(0, 2);
1571 if (!params().options.empty()) {
1573 top += params().options;
1576 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1577 << " file was created by LyX " << lyx_version
1578 << "\n See http://www.lyx.org/ for more information -->\n";
1580 params().documentClass().counters().reset();
1584 sgml::openTag(os, top);
1586 docbookParagraphs(text(), *this, os, runparams);
1587 sgml::closeTag(os, top_element);
1591 void Buffer::makeLyXHTMLFile(FileName const & fname,
1592 OutputParams const & runparams,
1593 bool const body_only) const
1595 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1598 if (!openFileWrite(ofs, fname))
1601 writeLyXHTMLSource(ofs, runparams, body_only);
1605 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1609 void Buffer::writeLyXHTMLSource(odocstream & os,
1610 OutputParams const & runparams,
1611 bool const only_body) const
1613 LaTeXFeatures features(*this, params(), runparams);
1615 updateBuffer(UpdateMaster, OutputUpdate);
1616 d->bibinfo_.makeCitationLabels(*this);
1618 updateMacroInstances();
1621 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1622 << "<!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"
1623 // FIXME Language should be set properly.
1624 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1626 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1627 // FIXME Presumably need to set this right
1628 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1630 docstring const & doctitle = features.htmlTitle();
1632 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1635 os << "\n<!-- Text Class Preamble -->\n"
1636 << features.getTClassHTMLPreamble()
1637 << "\n<!-- Preamble Snippets -->\n"
1638 << from_utf8(features.getPreambleSnippets());
1640 os << "\n<!-- Layout-provided Styles -->\n";
1641 docstring const styleinfo = features.getTClassHTMLStyles();
1642 if (!styleinfo.empty()) {
1643 os << "<style type='text/css'>\n"
1647 os << "</head>\n<body>\n";
1651 params().documentClass().counters().reset();
1652 xhtmlParagraphs(text(), *this, xs, runparams);
1654 os << "</body>\n</html>\n";
1658 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1659 // Other flags: -wall -v0 -x
1660 int Buffer::runChktex()
1664 // get LaTeX-Filename
1665 FileName const path(temppath());
1666 string const name = addName(path.absFileName(), latexName());
1667 string const org_path = filePath();
1669 PathChanger p(path); // path to LaTeX file
1670 message(_("Running chktex..."));
1672 // Generate the LaTeX file if neccessary
1673 OutputParams runparams(¶ms().encoding());
1674 runparams.flavor = OutputParams::LATEX;
1675 runparams.nice = false;
1676 runparams.linelen = lyxrc.plaintext_linelen;
1677 makeLaTeXFile(FileName(name), org_path, runparams);
1680 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1681 int const res = chktex.run(terr); // run chktex
1684 Alert::error(_("chktex failure"),
1685 _("Could not run chktex successfully."));
1686 } else if (res > 0) {
1687 ErrorList & errlist = d->errorLists["ChkTeX"];
1689 bufferErrors(terr, errlist);
1700 void Buffer::validate(LaTeXFeatures & features) const
1702 params().validate(features);
1706 for_each(paragraphs().begin(), paragraphs().end(),
1707 bind(&Paragraph::validate, _1, ref(features)));
1709 if (lyxerr.debugging(Debug::LATEX)) {
1710 features.showStruct();
1715 void Buffer::getLabelList(vector<docstring> & list) const
1717 // If this is a child document, use the master's list instead.
1719 masterBuffer()->getLabelList(list);
1724 Toc & toc = d->toc_backend.toc("label");
1725 TocIterator toc_it = toc.begin();
1726 TocIterator end = toc.end();
1727 for (; toc_it != end; ++toc_it) {
1728 if (toc_it->depth() == 0)
1729 list.push_back(toc_it->str());
1734 void Buffer::updateBibfilesCache(UpdateScope scope) const
1736 // FIXME This is probably unnecssary, given where we call this.
1737 // If this is a child document, use the parent's cache instead.
1738 if (parent() && scope != UpdateChildOnly) {
1739 masterBuffer()->updateBibfilesCache();
1743 d->bibfiles_cache_.clear();
1744 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1745 if (it->lyxCode() == BIBTEX_CODE) {
1746 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1747 support::FileNameList const bibfiles = inset.getBibFiles();
1748 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1751 } else if (it->lyxCode() == INCLUDE_CODE) {
1752 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1753 Buffer const * const incbuf = inset.getChildBuffer();
1756 support::FileNameList const & bibfiles =
1757 incbuf->getBibfilesCache(UpdateChildOnly);
1758 if (!bibfiles.empty()) {
1759 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1765 d->bibfile_cache_valid_ = true;
1766 d->bibinfo_cache_valid_ = false;
1770 void Buffer::invalidateBibinfoCache() const
1772 d->bibinfo_cache_valid_ = false;
1773 // also invalidate the cache for the parent buffer
1774 Buffer const * const pbuf = d->parent();
1776 pbuf->invalidateBibinfoCache();
1780 void Buffer::invalidateBibfileCache() const
1782 d->bibfile_cache_valid_ = false;
1783 d->bibinfo_cache_valid_ = false;
1784 // also invalidate the cache for the parent buffer
1785 Buffer const * const pbuf = d->parent();
1787 pbuf->invalidateBibfileCache();
1791 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1793 // FIXME This is probably unnecessary, given where we call this.
1794 // If this is a child document, use the master's cache instead.
1795 Buffer const * const pbuf = masterBuffer();
1796 if (pbuf != this && scope != UpdateChildOnly)
1797 return pbuf->getBibfilesCache();
1799 if (!d->bibfile_cache_valid_)
1800 this->updateBibfilesCache(scope);
1802 return d->bibfiles_cache_;
1806 BiblioInfo const & Buffer::masterBibInfo() const
1808 Buffer const * const tmp = masterBuffer();
1810 return tmp->masterBibInfo();
1815 void Buffer::checkIfBibInfoCacheIsValid() const
1817 // use the master's cache
1818 Buffer const * const tmp = masterBuffer();
1820 tmp->checkIfBibInfoCacheIsValid();
1824 // compare the cached timestamps with the actual ones.
1825 FileNameList const & bibfiles_cache = getBibfilesCache();
1826 FileNameList::const_iterator ei = bibfiles_cache.begin();
1827 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;
1839 void Buffer::reloadBibInfoCache() const
1841 // use the master's cache
1842 Buffer const * const tmp = masterBuffer();
1844 tmp->reloadBibInfoCache();
1848 checkIfBibInfoCacheIsValid();
1849 if (d->bibinfo_cache_valid_)
1852 d->bibinfo_.clear();
1854 d->bibinfo_cache_valid_ = true;
1858 void Buffer::collectBibKeys() const
1860 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1861 it->collectBibKeys(it);
1865 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1867 Buffer const * tmp = masterBuffer();
1868 BiblioInfo & masterbi = (tmp == this) ?
1869 d->bibinfo_ : tmp->d->bibinfo_;
1870 masterbi.mergeBiblioInfo(bi);
1874 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1876 Buffer const * tmp = masterBuffer();
1877 BiblioInfo & masterbi = (tmp == this) ?
1878 d->bibinfo_ : tmp->d->bibinfo_;
1883 bool Buffer::isDepClean(string const & name) const
1885 DepClean::const_iterator const it = d->dep_clean.find(name);
1886 if (it == d->dep_clean.end())
1892 void Buffer::markDepClean(string const & name)
1894 d->dep_clean[name] = true;
1898 bool Buffer::isExportableFormat(string const & format) const
1900 typedef vector<Format const *> Formats;
1902 formats = exportableFormats(true);
1903 Formats::const_iterator fit = formats.begin();
1904 Formats::const_iterator end = formats.end();
1905 for (; fit != end ; ++fit) {
1906 if ((*fit)->name() == format)
1913 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1916 // FIXME? if there is an Buffer LFUN that can be dispatched even
1917 // if internal, put a switch '(cmd.action)' here.
1923 switch (cmd.action()) {
1925 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1926 flag.setOnOff(isReadonly());
1929 // FIXME: There is need for a command-line import.
1930 //case LFUN_BUFFER_IMPORT:
1932 case LFUN_BUFFER_AUTO_SAVE:
1935 case LFUN_BUFFER_EXPORT_CUSTOM:
1936 // FIXME: Nothing to check here?
1939 case LFUN_BUFFER_EXPORT: {
1940 docstring const arg = cmd.argument();
1941 enable = arg == "custom" || isExportable(to_utf8(arg));
1943 flag.message(bformat(
1944 _("Don't know how to export to format: %1$s"), arg));
1948 case LFUN_BUFFER_CHKTEX:
1949 enable = isLatex() && !lyxrc.chktex_command.empty();
1952 case LFUN_BUILD_PROGRAM:
1953 enable = isExportable("program");
1956 case LFUN_BRANCH_ACTIVATE:
1957 case LFUN_BRANCH_DEACTIVATE: {
1958 BranchList const & branchList = params().branchlist();
1959 docstring const branchName = cmd.argument();
1960 enable = !branchName.empty() && branchList.find(branchName);
1964 case LFUN_BRANCH_ADD:
1965 case LFUN_BRANCHES_RENAME:
1966 case LFUN_BUFFER_PRINT:
1967 // if no Buffer is present, then of course we won't be called!
1970 case LFUN_BUFFER_LANGUAGE:
1971 enable = !isReadonly();
1977 flag.setEnabled(enable);
1982 void Buffer::dispatch(string const & command, DispatchResult & result)
1984 return dispatch(lyxaction.lookupFunc(command), result);
1988 // NOTE We can end up here even if we have no GUI, because we are called
1989 // by LyX::exec to handled command-line requests. So we may need to check
1990 // whether we have a GUI or not. The boolean use_gui holds this information.
1991 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1994 // FIXME? if there is an Buffer LFUN that can be dispatched even
1995 // if internal, put a switch '(cmd.action())' here.
1996 dr.dispatched(false);
1999 string const argument = to_utf8(func.argument());
2000 // We'll set this back to false if need be.
2001 bool dispatched = true;
2002 undo().beginUndoGroup();
2004 switch (func.action()) {
2005 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2006 if (lyxvc().inUse())
2007 lyxvc().toggleReadOnly();
2009 setReadonly(!isReadonly());
2012 case LFUN_BUFFER_EXPORT: {
2013 bool success = doExport(argument, false, false);
2014 dr.setError(!success);
2016 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2021 case LFUN_BUILD_PROGRAM:
2022 doExport("program", true, false);
2025 case LFUN_BUFFER_CHKTEX:
2029 case LFUN_BUFFER_EXPORT_CUSTOM: {
2031 string command = split(argument, format_name, ' ');
2032 Format const * format = formats.getFormat(format_name);
2034 lyxerr << "Format \"" << format_name
2035 << "\" not recognized!"
2040 // The name of the file created by the conversion process
2043 // Output to filename
2044 if (format->name() == "lyx") {
2045 string const latexname = latexName(false);
2046 filename = changeExtension(latexname,
2047 format->extension());
2048 filename = addName(temppath(), filename);
2050 if (!writeFile(FileName(filename)))
2054 doExport(format_name, true, false, filename);
2057 // Substitute $$FName for filename
2058 if (!contains(command, "$$FName"))
2059 command = "( " + command + " ) < $$FName";
2060 command = subst(command, "$$FName", filename);
2062 // Execute the command in the background
2064 call.startscript(Systemcall::DontWait, command);
2068 // FIXME: There is need for a command-line import.
2070 case LFUN_BUFFER_IMPORT:
2075 case LFUN_BUFFER_AUTO_SAVE:
2077 resetAutosaveTimers();
2080 case LFUN_BRANCH_ADD: {
2081 docstring branch_name = func.argument();
2082 if (branch_name.empty()) {
2086 BranchList & branch_list = params().branchlist();
2087 vector<docstring> const branches =
2088 getVectorFromString(branch_name, branch_list.separator());
2090 for (vector<docstring>::const_iterator it = branches.begin();
2091 it != branches.end(); ++it) {
2093 Branch * branch = branch_list.find(branch_name);
2095 LYXERR0("Branch " << branch_name << " already exists.");
2099 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2101 branch_list.add(branch_name);
2102 branch = branch_list.find(branch_name);
2103 string const x11hexname = X11hexname(branch->color());
2104 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2105 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2107 dr.screenUpdate(Update::Force);
2115 case LFUN_BRANCH_ACTIVATE:
2116 case LFUN_BRANCH_DEACTIVATE: {
2117 BranchList & branchList = params().branchlist();
2118 docstring const branchName = func.argument();
2119 // the case without a branch name is handled elsewhere
2120 if (branchName.empty()) {
2124 Branch * branch = branchList.find(branchName);
2126 LYXERR0("Branch " << branchName << " does not exist.");
2128 docstring const msg =
2129 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2132 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2134 dr.screenUpdate(Update::Force);
2135 dr.forceBufferUpdate();
2140 case LFUN_BRANCHES_RENAME: {
2141 if (func.argument().empty())
2144 docstring const oldname = from_utf8(func.getArg(0));
2145 docstring const newname = from_utf8(func.getArg(1));
2146 InsetIterator it = inset_iterator_begin(inset());
2147 InsetIterator const end = inset_iterator_end(inset());
2148 bool success = false;
2149 for (; it != end; ++it) {
2150 if (it->lyxCode() == BRANCH_CODE) {
2151 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2152 if (ins.branch() == oldname) {
2153 undo().recordUndo(it);
2154 ins.rename(newname);
2159 if (it->lyxCode() == INCLUDE_CODE) {
2160 // get buffer of external file
2161 InsetInclude const & ins =
2162 static_cast<InsetInclude const &>(*it);
2163 Buffer * child = ins.getChildBuffer();
2166 child->dispatch(func, dr);
2171 dr.screenUpdate(Update::Force);
2172 dr.forceBufferUpdate();
2177 case LFUN_BUFFER_PRINT: {
2178 // we'll assume there's a problem until we succeed
2180 string target = func.getArg(0);
2181 string target_name = func.getArg(1);
2182 string command = func.getArg(2);
2185 || target_name.empty()
2186 || command.empty()) {
2187 LYXERR0("Unable to parse " << func.argument());
2188 docstring const msg =
2189 bformat(_("Unable to parse \"%1$s\""), func.argument());
2193 if (target != "printer" && target != "file") {
2194 LYXERR0("Unrecognized target \"" << target << '"');
2195 docstring const msg =
2196 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2201 bool const update_unincluded =
2202 params().maintain_unincluded_children
2203 && !params().getIncludedChildren().empty();
2204 if (!doExport("dvi", true, update_unincluded)) {
2205 showPrintError(absFileName());
2206 dr.setMessage(_("Error exporting to DVI."));
2210 // Push directory path.
2211 string const path = temppath();
2212 // Prevent the compiler from optimizing away p
2216 // there are three cases here:
2217 // 1. we print to a file
2218 // 2. we print directly to a printer
2219 // 3. we print using a spool command (print to file first)
2222 string const dviname = changeExtension(latexName(true), "dvi");
2224 if (target == "printer") {
2225 if (!lyxrc.print_spool_command.empty()) {
2226 // case 3: print using a spool
2227 string const psname = changeExtension(dviname,".ps");
2228 command += ' ' + lyxrc.print_to_file
2231 + quoteName(dviname);
2233 string command2 = lyxrc.print_spool_command + ' ';
2234 if (target_name != "default") {
2235 command2 += lyxrc.print_spool_printerprefix
2239 command2 += quoteName(psname);
2241 // If successful, then spool command
2242 res = one.startscript(Systemcall::Wait, command);
2245 // If there's no GUI, we have to wait on this command. Otherwise,
2246 // LyX deletes the temporary directory, and with it the spooled
2247 // file, before it can be printed!!
2248 Systemcall::Starttype stype = use_gui ?
2249 Systemcall::DontWait : Systemcall::Wait;
2250 res = one.startscript(stype, command2);
2253 // case 2: print directly to a printer
2254 if (target_name != "default")
2255 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2257 Systemcall::Starttype stype = use_gui ?
2258 Systemcall::DontWait : Systemcall::Wait;
2259 res = one.startscript(stype, command + quoteName(dviname));
2263 // case 1: print to a file
2264 FileName const filename(makeAbsPath(target_name, filePath()));
2265 FileName const dvifile(makeAbsPath(dviname, path));
2266 if (filename.exists()) {
2267 docstring text = bformat(
2268 _("The file %1$s already exists.\n\n"
2269 "Do you want to overwrite that file?"),
2270 makeDisplayPath(filename.absFileName()));
2271 if (Alert::prompt(_("Overwrite file?"),
2272 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2275 command += ' ' + lyxrc.print_to_file
2276 + quoteName(filename.toFilesystemEncoding())
2278 + quoteName(dvifile.toFilesystemEncoding());
2280 Systemcall::Starttype stype = use_gui ?
2281 Systemcall::DontWait : Systemcall::Wait;
2282 res = one.startscript(stype, command);
2288 dr.setMessage(_("Error running external commands."));
2289 showPrintError(absFileName());
2294 case LFUN_BUFFER_LANGUAGE: {
2295 Language const * oldL = params().language;
2296 Language const * newL = languages.getLanguage(argument);
2297 if (!newL || oldL == newL)
2299 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2300 changeLanguage(oldL, newL);
2301 dr.forceBufferUpdate();
2310 dr.dispatched(dispatched);
2311 undo().endUndoGroup();
2315 void Buffer::changeLanguage(Language const * from, Language const * to)
2317 LASSERT(from, /**/);
2320 for_each(par_iterator_begin(),
2322 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2326 bool Buffer::isMultiLingual() const
2328 ParConstIterator end = par_iterator_end();
2329 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2330 if (it->isMultiLingual(params()))
2337 std::set<Language const *> Buffer::getLanguages() const
2339 std::set<Language const *> languages;
2340 getLanguages(languages);
2345 void Buffer::getLanguages(std::set<Language const *> & languages) const
2347 ParConstIterator end = par_iterator_end();
2348 // add the buffer language, even if it's not actively used
2349 languages.insert(language());
2350 // iterate over the paragraphs
2351 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2352 it->getLanguages(languages);
2354 ListOfBuffers clist = getDescendents();
2355 ListOfBuffers::const_iterator cit = clist.begin();
2356 ListOfBuffers::const_iterator const cen = clist.end();
2357 for (; cit != cen; ++cit)
2358 (*cit)->getLanguages(languages);
2362 DocIterator Buffer::getParFromID(int const id) const
2364 Buffer * buf = const_cast<Buffer *>(this);
2366 // John says this is called with id == -1 from undo
2367 lyxerr << "getParFromID(), id: " << id << endl;
2368 return doc_iterator_end(buf);
2371 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2372 if (it.paragraph().id() == id)
2375 return doc_iterator_end(buf);
2379 bool Buffer::hasParWithID(int const id) const
2381 return !getParFromID(id).atEnd();
2385 ParIterator Buffer::par_iterator_begin()
2387 return ParIterator(doc_iterator_begin(this));
2391 ParIterator Buffer::par_iterator_end()
2393 return ParIterator(doc_iterator_end(this));
2397 ParConstIterator Buffer::par_iterator_begin() const
2399 return ParConstIterator(doc_iterator_begin(this));
2403 ParConstIterator Buffer::par_iterator_end() const
2405 return ParConstIterator(doc_iterator_end(this));
2409 Language const * Buffer::language() const
2411 return params().language;
2415 docstring const Buffer::B_(string const & l10n) const
2417 return params().B_(l10n);
2421 bool Buffer::isClean() const
2423 return d->lyx_clean;
2427 bool Buffer::isExternallyModified(CheckMethod method) const
2429 LASSERT(d->filename.exists(), /**/);
2430 // if method == timestamp, check timestamp before checksum
2431 return (method == checksum_method
2432 || d->timestamp_ != d->filename.lastModified())
2433 && d->checksum_ != d->filename.checksum();
2437 void Buffer::saveCheckSum() const
2439 FileName const & file = d->filename;
2442 if (file.exists()) {
2443 d->timestamp_ = file.lastModified();
2444 d->checksum_ = file.checksum();
2446 // in the case of save to a new file.
2453 void Buffer::markClean() const
2455 if (!d->lyx_clean) {
2456 d->lyx_clean = true;
2459 // if the .lyx file has been saved, we don't need an
2461 d->bak_clean = true;
2462 d->undo_.markDirty();
2466 void Buffer::setUnnamed(bool flag)
2472 bool Buffer::isUnnamed() const
2479 /// Don't check unnamed, here: isInternal() is used in
2480 /// newBuffer(), where the unnamed flag has not been set by anyone
2481 /// yet. Also, for an internal buffer, there should be no need for
2482 /// retrieving fileName() nor for checking if it is unnamed or not.
2483 bool Buffer::isInternal() const
2485 return fileName().extension() == "internal";
2489 void Buffer::markDirty()
2492 d->lyx_clean = false;
2495 d->bak_clean = false;
2497 DepClean::iterator it = d->dep_clean.begin();
2498 DepClean::const_iterator const end = d->dep_clean.end();
2500 for (; it != end; ++it)
2505 FileName Buffer::fileName() const
2511 string Buffer::absFileName() const
2513 return d->filename.absFileName();
2517 string Buffer::filePath() const
2519 return d->filename.onlyPath().absFileName() + "/";
2523 bool Buffer::isReadonly() const
2525 return d->read_only;
2529 void Buffer::setParent(Buffer const * buffer)
2531 // Avoids recursive include.
2532 d->setParent(buffer == this ? 0 : buffer);
2537 Buffer const * Buffer::parent() const
2543 ListOfBuffers Buffer::allRelatives() const
2545 ListOfBuffers lb = masterBuffer()->getDescendents();
2546 lb.push_front(const_cast<Buffer *>(this));
2551 Buffer const * Buffer::masterBuffer() const
2553 // FIXME Should be make sure we are not in some kind
2554 // of recursive include? A -> B -> A will crash this.
2555 Buffer const * const pbuf = d->parent();
2559 return pbuf->masterBuffer();
2563 bool Buffer::isChild(Buffer * child) const
2565 return d->children_positions.find(child) != d->children_positions.end();
2569 DocIterator Buffer::firstChildPosition(Buffer const * child)
2571 Impl::BufferPositionMap::iterator it;
2572 it = d->children_positions.find(child);
2573 if (it == d->children_positions.end())
2574 return DocIterator(this);
2579 bool Buffer::hasChildren() const
2581 return !d->children_positions.empty();
2585 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2587 // loop over children
2588 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2589 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2590 for (; it != end; ++it) {
2591 Buffer * child = const_cast<Buffer *>(it->first);
2593 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2594 if (bit != clist.end())
2596 clist.push_back(child);
2598 // there might be grandchildren
2599 child->collectChildren(clist, true);
2604 ListOfBuffers Buffer::getChildren() const
2607 collectChildren(v, false);
2612 ListOfBuffers Buffer::getDescendents() const
2615 collectChildren(v, true);
2620 template<typename M>
2621 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2626 typename M::const_iterator it = m.lower_bound(x);
2627 if (it == m.begin())
2635 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2636 DocIterator const & pos) const
2638 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2640 // if paragraphs have no macro context set, pos will be empty
2644 // we haven't found anything yet
2645 DocIterator bestPos = owner_->par_iterator_begin();
2646 MacroData const * bestData = 0;
2648 // find macro definitions for name
2649 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2650 if (nameIt != macros.end()) {
2651 // find last definition in front of pos or at pos itself
2652 PositionScopeMacroMap::const_iterator it
2653 = greatest_below(nameIt->second, pos);
2654 if (it != nameIt->second.end()) {
2656 // scope ends behind pos?
2657 if (pos < it->second.first) {
2658 // Looks good, remember this. If there
2659 // is no external macro behind this,
2660 // we found the right one already.
2661 bestPos = it->first;
2662 bestData = &it->second.second;
2666 // try previous macro if there is one
2667 if (it == nameIt->second.begin())
2674 // find macros in included files
2675 PositionScopeBufferMap::const_iterator it
2676 = greatest_below(position_to_children, pos);
2677 if (it == position_to_children.end())
2678 // no children before
2682 // do we know something better (i.e. later) already?
2683 if (it->first < bestPos )
2686 // scope ends behind pos?
2687 if (pos < it->second.first
2688 && (cloned_buffer_ ||
2689 theBufferList().isLoaded(it->second.second))) {
2690 // look for macro in external file
2692 MacroData const * data
2693 = it->second.second->getMacro(name, false);
2696 bestPos = it->first;
2702 // try previous file if there is one
2703 if (it == position_to_children.begin())
2708 // return the best macro we have found
2713 MacroData const * Buffer::getMacro(docstring const & name,
2714 DocIterator const & pos, bool global) const
2719 // query buffer macros
2720 MacroData const * data = d->getBufferMacro(name, pos);
2724 // If there is a master buffer, query that
2725 Buffer const * const pbuf = d->parent();
2727 d->macro_lock = true;
2728 MacroData const * macro = pbuf->getMacro(
2729 name, *this, false);
2730 d->macro_lock = false;
2736 data = MacroTable::globalMacros().get(name);
2745 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2747 // set scope end behind the last paragraph
2748 DocIterator scope = par_iterator_begin();
2749 scope.pit() = scope.lastpit() + 1;
2751 return getMacro(name, scope, global);
2755 MacroData const * Buffer::getMacro(docstring const & name,
2756 Buffer const & child, bool global) const
2758 // look where the child buffer is included first
2759 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2760 if (it == d->children_positions.end())
2763 // check for macros at the inclusion position
2764 return getMacro(name, it->second, global);
2768 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2770 pit_type const lastpit = it.lastpit();
2772 // look for macros in each paragraph
2773 while (it.pit() <= lastpit) {
2774 Paragraph & par = it.paragraph();
2776 // iterate over the insets of the current paragraph
2777 InsetList const & insets = par.insetList();
2778 InsetList::const_iterator iit = insets.begin();
2779 InsetList::const_iterator end = insets.end();
2780 for (; iit != end; ++iit) {
2781 it.pos() = iit->pos;
2783 // is it a nested text inset?
2784 if (iit->inset->asInsetText()) {
2785 // Inset needs its own scope?
2786 InsetText const * itext = iit->inset->asInsetText();
2787 bool newScope = itext->isMacroScope();
2789 // scope which ends just behind the inset
2790 DocIterator insetScope = it;
2793 // collect macros in inset
2794 it.push_back(CursorSlice(*iit->inset));
2795 updateMacros(it, newScope ? insetScope : scope);
2800 if (iit->inset->asInsetTabular()) {
2801 CursorSlice slice(*iit->inset);
2802 size_t const numcells = slice.nargs();
2803 for (; slice.idx() < numcells; slice.forwardIdx()) {
2804 it.push_back(slice);
2805 updateMacros(it, scope);
2811 // is it an external file?
2812 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2813 // get buffer of external file
2814 InsetInclude const & inset =
2815 static_cast<InsetInclude const &>(*iit->inset);
2817 Buffer * child = inset.getChildBuffer();
2822 // register its position, but only when it is
2823 // included first in the buffer
2824 if (children_positions.find(child) ==
2825 children_positions.end())
2826 children_positions[child] = it;
2828 // register child with its scope
2829 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2833 InsetMath * im = iit->inset->asInsetMath();
2834 if (doing_export && im) {
2835 InsetMathHull * hull = im->asHullInset();
2837 hull->recordLocation(it);
2840 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2844 MathMacroTemplate & macroTemplate =
2845 *iit->inset->asInsetMath()->asMacroTemplate();
2846 MacroContext mc(owner_, it);
2847 macroTemplate.updateToContext(mc);
2850 bool valid = macroTemplate.validMacro();
2851 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2852 // then the BufferView's cursor will be invalid in
2853 // some cases which leads to crashes.
2858 // FIXME (Abdel), I don't understandt why we pass 'it' here
2859 // instead of 'macroTemplate' defined above... is this correct?
2860 macros[macroTemplate.name()][it] =
2861 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2871 void Buffer::updateMacros() const
2876 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2878 // start with empty table
2880 d->children_positions.clear();
2881 d->position_to_children.clear();
2883 // Iterate over buffer, starting with first paragraph
2884 // The scope must be bigger than any lookup DocIterator
2885 // later. For the global lookup, lastpit+1 is used, hence
2886 // we use lastpit+2 here.
2887 DocIterator it = par_iterator_begin();
2888 DocIterator outerScope = it;
2889 outerScope.pit() = outerScope.lastpit() + 2;
2890 d->updateMacros(it, outerScope);
2894 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2896 InsetIterator it = inset_iterator_begin(inset());
2897 InsetIterator const end = inset_iterator_end(inset());
2898 for (; it != end; ++it) {
2899 if (it->lyxCode() == BRANCH_CODE) {
2900 InsetBranch & br = static_cast<InsetBranch &>(*it);
2901 docstring const name = br.branch();
2902 if (!from_master && !params().branchlist().find(name))
2903 result.push_back(name);
2904 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2905 result.push_back(name);
2908 if (it->lyxCode() == INCLUDE_CODE) {
2909 // get buffer of external file
2910 InsetInclude const & ins =
2911 static_cast<InsetInclude const &>(*it);
2912 Buffer * child = ins.getChildBuffer();
2915 child->getUsedBranches(result, true);
2918 // remove duplicates
2923 void Buffer::updateMacroInstances() const
2925 LYXERR(Debug::MACROS, "updateMacroInstances for "
2926 << d->filename.onlyFileName());
2927 DocIterator it = doc_iterator_begin(this);
2929 DocIterator const end = doc_iterator_end(this);
2930 for (; it != end; it.forwardInset()) {
2931 // look for MathData cells in InsetMathNest insets
2932 InsetMath * minset = it.nextInset()->asInsetMath();
2936 // update macro in all cells of the InsetMathNest
2937 DocIterator::idx_type n = minset->nargs();
2938 MacroContext mc = MacroContext(this, it);
2939 for (DocIterator::idx_type i = 0; i < n; ++i) {
2940 MathData & data = minset->cell(i);
2941 data.updateMacros(0, mc);
2947 void Buffer::listMacroNames(MacroNameSet & macros) const
2952 d->macro_lock = true;
2954 // loop over macro names
2955 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2956 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2957 for (; nameIt != nameEnd; ++nameIt)
2958 macros.insert(nameIt->first);
2960 // loop over children
2961 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2962 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2963 for (; it != end; ++it)
2964 it->first->listMacroNames(macros);
2967 Buffer const * const pbuf = d->parent();
2969 pbuf->listMacroNames(macros);
2971 d->macro_lock = false;
2975 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2977 Buffer const * const pbuf = d->parent();
2982 pbuf->listMacroNames(names);
2985 MacroNameSet::iterator it = names.begin();
2986 MacroNameSet::iterator end = names.end();
2987 for (; it != end; ++it) {
2989 MacroData const * data =
2990 pbuf->getMacro(*it, *this, false);
2992 macros.insert(data);
2994 // we cannot access the original MathMacroTemplate anymore
2995 // here to calls validate method. So we do its work here manually.
2996 // FIXME: somehow make the template accessible here.
2997 if (data->optionals() > 0)
2998 features.require("xargs");
3004 Buffer::References & Buffer::references(docstring const & label)
3007 return const_cast<Buffer *>(masterBuffer())->references(label);
3009 RefCache::iterator it = d->ref_cache_.find(label);
3010 if (it != d->ref_cache_.end())
3011 return it->second.second;
3013 static InsetLabel const * dummy_il = 0;
3014 static References const dummy_refs;
3015 it = d->ref_cache_.insert(
3016 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3017 return it->second.second;
3021 Buffer::References const & Buffer::references(docstring const & label) const
3023 return const_cast<Buffer *>(this)->references(label);
3027 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3029 masterBuffer()->d->ref_cache_[label].first = il;
3033 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3035 return masterBuffer()->d->ref_cache_[label].first;
3039 void Buffer::clearReferenceCache() const
3042 d->ref_cache_.clear();
3046 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3049 //FIXME: This does not work for child documents yet.
3050 LASSERT(code == CITE_CODE, /**/);
3052 reloadBibInfoCache();
3054 // Check if the label 'from' appears more than once
3055 BiblioInfo const & keys = masterBibInfo();
3056 BiblioInfo::const_iterator bit = keys.begin();
3057 BiblioInfo::const_iterator bend = keys.end();
3058 vector<docstring> labels;
3060 for (; bit != bend; ++bit)
3062 labels.push_back(bit->first);
3064 if (count(labels.begin(), labels.end(), from) > 1)
3067 string const paramName = "key";
3068 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3069 if (it->lyxCode() == code) {
3070 InsetCommand * inset = it->asInsetCommand();
3073 docstring const oldValue = inset->getParam(paramName);
3074 if (oldValue == from)
3075 inset->setParam(paramName, to);
3081 void Buffer::getSourceCode(odocstream & os, string const format,
3082 pit_type par_begin, pit_type par_end,
3083 bool full_source) const
3085 OutputParams runparams(¶ms().encoding());
3086 runparams.nice = true;
3087 runparams.flavor = getOutputFlavor(format);
3088 runparams.linelen = lyxrc.plaintext_linelen;
3089 // No side effect of file copying and image conversion
3090 runparams.dryrun = true;
3093 os << "% " << _("Preview source code") << "\n\n";
3095 d->texrow.newline();
3096 d->texrow.newline();
3098 writeDocBookSource(os, absFileName(), runparams, false);
3099 else if (runparams.flavor == OutputParams::HTML)
3100 writeLyXHTMLSource(os, runparams, false);
3102 // latex or literate
3103 otexstream ots(os, d->texrow);
3104 writeLaTeXSource(ots, string(), runparams, true, true);
3107 runparams.par_begin = par_begin;
3108 runparams.par_end = par_end;
3109 if (par_begin + 1 == par_end) {
3111 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3115 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3116 convert<docstring>(par_begin),
3117 convert<docstring>(par_end - 1))
3124 // output paragraphs
3126 docbookParagraphs(text(), *this, os, runparams);
3127 else if (runparams.flavor == OutputParams::HTML) {
3129 xhtmlParagraphs(text(), *this, xs, runparams);
3131 // latex or literate
3132 otexstream ots(os, texrow);
3133 latexParagraphs(*this, text(), ots, runparams);
3139 ErrorList & Buffer::errorList(string const & type) const
3141 static ErrorList emptyErrorList;
3142 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3143 if (it == d->errorLists.end())
3144 return emptyErrorList;
3150 void Buffer::updateTocItem(std::string const & type,
3151 DocIterator const & dit) const
3154 d->gui_->updateTocItem(type, dit);
3158 void Buffer::structureChanged() const
3161 d->gui_->structureChanged();
3165 void Buffer::errors(string const & err, bool from_master) const
3168 d->gui_->errors(err, from_master);
3172 void Buffer::message(docstring const & msg) const
3175 d->gui_->message(msg);
3179 void Buffer::setBusy(bool on) const
3182 d->gui_->setBusy(on);
3186 void Buffer::updateTitles() const
3189 d->wa_->updateTitles();
3193 void Buffer::resetAutosaveTimers() const
3196 d->gui_->resetAutosaveTimers();
3200 bool Buffer::hasGuiDelegate() const
3206 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3215 class AutoSaveBuffer : public ForkedProcess {
3218 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3219 : buffer_(buffer), fname_(fname) {}
3221 virtual shared_ptr<ForkedProcess> clone() const
3223 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3228 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3229 from_utf8(fname_.absFileName())));
3230 return run(DontWait);
3234 virtual int generateChild();
3236 Buffer const & buffer_;
3241 int AutoSaveBuffer::generateChild()
3243 #if defined(__APPLE__)
3244 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3245 * We should use something else like threads.
3247 * Since I do not know how to determine at run time what is the OS X
3248 * version, I just disable forking altogether for now (JMarc)
3250 pid_t const pid = -1;
3252 // tmp_ret will be located (usually) in /tmp
3253 // will that be a problem?
3254 // Note that this calls ForkedCalls::fork(), so it's
3255 // ok cross-platform.
3256 pid_t const pid = fork();
3257 // If you want to debug the autosave
3258 // you should set pid to -1, and comment out the fork.
3259 if (pid != 0 && pid != -1)
3263 // pid = -1 signifies that lyx was unable
3264 // to fork. But we will do the save
3266 bool failed = false;
3267 FileName const tmp_ret = FileName::tempName("lyxauto");
3268 if (!tmp_ret.empty()) {
3269 buffer_.writeFile(tmp_ret);
3270 // assume successful write of tmp_ret
3271 if (!tmp_ret.moveTo(fname_))
3277 // failed to write/rename tmp_ret so try writing direct
3278 if (!buffer_.writeFile(fname_)) {
3279 // It is dangerous to do this in the child,
3280 // but safe in the parent, so...
3281 if (pid == -1) // emit message signal.
3282 buffer_.message(_("Autosave failed!"));
3286 if (pid == 0) // we are the child so...
3295 FileName Buffer::getEmergencyFileName() const
3297 return FileName(d->filename.absFileName() + ".emergency");
3301 FileName Buffer::getAutosaveFileName() const
3303 // if the document is unnamed try to save in the backup dir, else
3304 // in the default document path, and as a last try in the filePath,
3305 // which will most often be the temporary directory
3308 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3309 : lyxrc.backupdir_path;
3310 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3313 string const fname = "#" + d->filename.onlyFileName() + "#";
3315 return makeAbsPath(fname, fpath);
3319 void Buffer::removeAutosaveFile() const
3321 FileName const f = getAutosaveFileName();
3327 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3329 FileName const newauto = getAutosaveFileName();
3331 if (newauto != oldauto && oldauto.exists())
3332 if (!oldauto.moveTo(newauto))
3333 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3337 bool Buffer::autoSave() const
3339 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3340 if (buf->d->bak_clean || isReadonly())
3343 message(_("Autosaving current document..."));
3344 buf->d->bak_clean = true;
3346 FileName const fname = getAutosaveFileName();
3347 if (d->cloned_buffer_) {
3348 // If this buffer is cloned, we assume that
3349 // we are running in a separate thread already.
3350 FileName const tmp_ret = FileName::tempName("lyxauto");
3351 if (!tmp_ret.empty()) {
3353 // assume successful write of tmp_ret
3354 if (tmp_ret.moveTo(fname))
3357 // failed to write/rename tmp_ret so try writing direct
3358 return writeFile(fname);
3360 /// This function is deprecated as the frontend needs to take care
3361 /// of cloning the buffer and autosaving it in another thread. It
3362 /// is still here to allow (QT_VERSION < 0x040400).
3363 AutoSaveBuffer autosave(*this, fname);
3370 string Buffer::bufferFormat() const
3372 string format = params().documentClass().outputFormat();
3373 if (format == "latex") {
3374 if (params().useNonTeXFonts)
3376 if (params().encoding().package() == Encoding::japanese)
3383 string Buffer::getDefaultOutputFormat() const
3385 if (!params().default_output_format.empty()
3386 && params().default_output_format != "default")
3387 return params().default_output_format;
3389 || params().useNonTeXFonts
3390 || params().encoding().package() == Encoding::japanese) {
3391 vector<Format const *> const formats = exportableFormats(true);
3392 if (formats.empty())
3394 // return the first we find
3395 return formats.front()->name();
3397 return lyxrc.default_view_format;
3401 OutputParams::FLAVOR Buffer::getOutputFlavor(string const format) const
3403 string const dformat = (format.empty() || format == "default") ?
3404 getDefaultOutputFormat() : format;
3405 DefaultFlavorCache::const_iterator it =
3406 default_flavors_.find(dformat);
3408 if (it != default_flavors_.end())
3411 OutputParams::FLAVOR result = OutputParams::LATEX;
3413 if (dformat == "xhtml")
3414 result = OutputParams::HTML;
3416 // Try to determine flavor of default output format
3417 vector<string> backs = backends();
3418 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
3419 // Get shortest path to format
3420 Graph::EdgePath path;
3421 for (vector<string>::const_iterator it = backs.begin();
3422 it != backs.end(); ++it) {
3423 Graph::EdgePath p = theConverters().getPath(*it, dformat);
3424 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3429 result = theConverters().getFlavor(path);
3432 // cache this flavor
3433 default_flavors_[dformat] = result;
3439 // helper class, to guarantee this gets reset properly
3440 class MarkAsExporting {
3442 MarkAsExporting(Buffer const * buf) : buf_(buf)
3444 LASSERT(buf_, /* */);
3445 buf_->setExportStatus(true);
3449 buf_->setExportStatus(false);
3452 Buffer const * const buf_;
3457 void Buffer::setExportStatus(bool e) const
3459 d->doing_export = e;
3463 bool Buffer::isExporting() const
3465 return d->doing_export;
3469 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3470 bool includeall, string & result_file) const
3472 MarkAsExporting exporting(this);
3473 string backend_format;
3474 OutputParams runparams(¶ms().encoding());
3475 runparams.flavor = OutputParams::LATEX;
3476 runparams.linelen = lyxrc.plaintext_linelen;
3477 runparams.includeall = includeall;
3478 vector<string> backs = backends();
3479 Converters converters = theConverters();
3480 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3481 // Get shortest path to format
3482 converters.buildGraph();
3483 Graph::EdgePath path;
3484 for (vector<string>::const_iterator it = backs.begin();
3485 it != backs.end(); ++it) {
3486 Graph::EdgePath p = converters.getPath(*it, format);
3487 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3488 backend_format = *it;
3493 if (!put_in_tempdir) {
3494 // Only show this alert if this is an export to a non-temporary
3495 // file (not for previewing).
3496 Alert::error(_("Couldn't export file"), bformat(
3497 _("No information for exporting the format %1$s."),
3498 formats.prettyName(format)));
3502 runparams.flavor = converters.getFlavor(path);
3505 backend_format = format;
3506 // FIXME: Don't hardcode format names here, but use a flag
3507 if (backend_format == "pdflatex")
3508 runparams.flavor = OutputParams::PDFLATEX;
3509 else if (backend_format == "luatex")
3510 runparams.flavor = OutputParams::LUATEX;
3511 else if (backend_format == "xetex")
3512 runparams.flavor = OutputParams::XETEX;
3515 string filename = latexName(false);
3516 filename = addName(temppath(), filename);
3517 filename = changeExtension(filename,
3518 formats.extension(backend_format));
3521 updateMacroInstances();
3523 // Plain text backend
3524 if (backend_format == "text") {
3525 runparams.flavor = OutputParams::TEXT;
3526 writePlaintextFile(*this, FileName(filename), runparams);
3529 else if (backend_format == "xhtml") {
3530 runparams.flavor = OutputParams::HTML;
3531 switch (params().html_math_output) {
3532 case BufferParams::MathML:
3533 runparams.math_flavor = OutputParams::MathAsMathML;
3535 case BufferParams::HTML:
3536 runparams.math_flavor = OutputParams::MathAsHTML;
3538 case BufferParams::Images:
3539 runparams.math_flavor = OutputParams::MathAsImages;
3541 case BufferParams::LaTeX:
3542 runparams.math_flavor = OutputParams::MathAsLaTeX;
3545 makeLyXHTMLFile(FileName(filename), runparams);
3546 } else if (backend_format == "lyx")
3547 writeFile(FileName(filename));
3549 else if (isDocBook()) {
3550 runparams.nice = !put_in_tempdir;
3551 makeDocBookFile(FileName(filename), runparams);
3554 else if (backend_format == format) {
3555 runparams.nice = true;
3556 if (!makeLaTeXFile(FileName(filename), string(), runparams)) {
3557 if (d->cloned_buffer_) {
3558 d->cloned_buffer_->d->errorLists["Export"] =
3559 d->errorLists["Export"];
3563 } else if (!lyxrc.tex_allows_spaces
3564 && contains(filePath(), ' ')) {
3565 Alert::error(_("File name error"),
3566 _("The directory path to the document cannot contain spaces."));
3569 runparams.nice = false;
3570 if (!makeLaTeXFile(FileName(filename), filePath(), runparams)) {
3571 if (d->cloned_buffer_) {
3572 d->cloned_buffer_->d->errorLists["Export"] =
3573 d->errorLists["Export"];
3579 string const error_type = (format == "program")
3580 ? "Build" : bufferFormat();
3581 ErrorList & error_list = d->errorLists[error_type];
3582 string const ext = formats.extension(format);
3583 FileName const tmp_result_file(changeExtension(filename, ext));
3584 bool const success = converters.convert(this, FileName(filename),
3585 tmp_result_file, FileName(absFileName()), backend_format, format,
3588 // Emit the signal to show the error list or copy it back to the
3589 // cloned Buffer so that it can be emitted afterwards.
3590 if (format != backend_format) {
3591 if (d->cloned_buffer_) {
3592 d->cloned_buffer_->d->errorLists[error_type] =
3593 d->errorLists[error_type];
3596 // also to the children, in case of master-buffer-view
3597 ListOfBuffers clist = getDescendents();
3598 ListOfBuffers::const_iterator cit = clist.begin();
3599 ListOfBuffers::const_iterator const cen = clist.end();
3600 for (; cit != cen; ++cit) {
3601 if (d->cloned_buffer_) {
3602 // Enable reverse search by copying back the
3603 // texrow object to the cloned buffer.
3604 // FIXME: this is not thread safe.
3605 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3606 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3607 (*cit)->d->errorLists[error_type];
3609 (*cit)->errors(error_type, true);
3613 if (d->cloned_buffer_) {
3614 // Enable reverse dvi or pdf to work by copying back the texrow
3615 // object to the cloned buffer.
3616 // FIXME: There is a possibility of concurrent access to texrow
3617 // here from the main GUI thread that should be securized.
3618 d->cloned_buffer_->d->texrow = d->texrow;
3619 string const error_type = bufferFormat();
3620 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3626 if (put_in_tempdir) {
3627 result_file = tmp_result_file.absFileName();
3631 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3632 // We need to copy referenced files (e. g. included graphics
3633 // if format == "dvi") to the result dir.
3634 vector<ExportedFile> const files =
3635 runparams.exportdata->externalFiles(format);
3636 string const dest = onlyPath(result_file);
3637 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3638 : force_overwrite == ALL_FILES;
3639 CopyStatus status = use_force ? FORCE : SUCCESS;
3641 vector<ExportedFile>::const_iterator it = files.begin();
3642 vector<ExportedFile>::const_iterator const en = files.end();
3643 for (; it != en && status != CANCEL; ++it) {
3644 string const fmt = formats.getFormatFromFile(it->sourceName);
3645 status = copyFile(fmt, it->sourceName,
3646 makeAbsPath(it->exportName, dest),
3647 it->exportName, status == FORCE);
3650 if (status == CANCEL) {
3651 message(_("Document export cancelled."));
3652 } else if (tmp_result_file.exists()) {
3653 // Finally copy the main file
3654 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3655 : force_overwrite != NO_FILES;
3656 if (status == SUCCESS && use_force)
3658 status = copyFile(format, tmp_result_file,
3659 FileName(result_file), result_file,
3661 message(bformat(_("Document exported as %1$s "
3663 formats.prettyName(format),
3664 makeDisplayPath(result_file)));
3666 // This must be a dummy converter like fax (bug 1888)
3667 message(bformat(_("Document exported as %1$s"),
3668 formats.prettyName(format)));
3675 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3676 bool includeall) const
3679 // (1) export with all included children (omit \includeonly)
3680 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3682 // (2) export with included children only
3683 return doExport(format, put_in_tempdir, false, result_file);
3687 bool Buffer::preview(string const & format, bool includeall) const
3689 MarkAsExporting exporting(this);
3691 // (1) export with all included children (omit \includeonly)
3692 if (includeall && !doExport(format, true, true))
3694 // (2) export with included children only
3695 if (!doExport(format, true, false, result_file))
3697 return formats.view(*this, FileName(result_file), format);
3701 bool Buffer::isExportable(string const & format) const
3703 vector<string> backs = backends();
3704 for (vector<string>::const_iterator it = backs.begin();
3705 it != backs.end(); ++it)
3706 if (theConverters().isReachable(*it, format))
3712 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3714 vector<string> const backs = backends();
3715 vector<Format const *> result =
3716 theConverters().getReachable(backs[0], only_viewable, true);
3717 for (vector<string>::const_iterator it = backs.begin() + 1;
3718 it != backs.end(); ++it) {
3719 vector<Format const *> r =
3720 theConverters().getReachable(*it, only_viewable, false);
3721 result.insert(result.end(), r.begin(), r.end());
3727 vector<string> Buffer::backends() const
3730 v.push_back(bufferFormat());
3731 // FIXME: Don't hardcode format names here, but use a flag
3732 if (v.back() == "latex") {
3733 v.push_back("pdflatex");
3734 v.push_back("luatex");
3735 v.push_back("xetex");
3736 } else if (v.back() == "xetex")
3737 v.push_back("luatex");
3738 v.push_back("xhtml");
3739 v.push_back("text");
3745 Buffer::ReadStatus Buffer::extractFromVC()
3747 bool const found = LyXVC::file_not_found_hook(d->filename);
3749 return ReadFileNotFound;
3750 if (!d->filename.isReadableFile())
3756 Buffer::ReadStatus Buffer::loadEmergency()
3758 FileName const emergencyFile = getEmergencyFileName();
3759 if (!emergencyFile.exists()
3760 || emergencyFile.lastModified() <= d->filename.lastModified())
3761 return ReadFileNotFound;
3763 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3764 docstring const text = bformat(_("An emergency save of the document "
3765 "%1$s exists.\n\nRecover emergency save?"), file);
3767 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3768 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3774 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3775 bool const success = (ret_llf == ReadSuccess);
3778 Alert::warning(_("File is read-only"),
3779 bformat(_("An emergency file is successfully loaded, "
3780 "but the original file %1$s is marked read-only. "
3781 "Please make sure to save the document as a different "
3782 "file."), from_utf8(d->filename.absFileName())));
3785 str = _("Document was successfully recovered.");
3787 str = _("Document was NOT successfully recovered.");
3788 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3789 makeDisplayPath(emergencyFile.absFileName()));
3791 int const del_emerg =
3792 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3793 _("&Remove"), _("&Keep"));
3794 if (del_emerg == 0) {
3795 emergencyFile.removeFile();
3797 Alert::warning(_("Emergency file deleted"),
3798 _("Do not forget to save your file now!"), true);
3800 return success ? ReadSuccess : ReadEmergencyFailure;
3803 int const del_emerg =
3804 Alert::prompt(_("Delete emergency file?"),
3805 _("Remove emergency file now?"), 1, 1,
3806 _("&Remove"), _("&Keep"));
3808 emergencyFile.removeFile();
3809 return ReadOriginal;
3819 Buffer::ReadStatus Buffer::loadAutosave()
3821 // Now check if autosave file is newer.
3822 FileName const autosaveFile = getAutosaveFileName();
3823 if (!autosaveFile.exists()
3824 || autosaveFile.lastModified() <= d->filename.lastModified())
3825 return ReadFileNotFound;
3827 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3828 docstring const text = bformat(_("The backup of the document %1$s "
3829 "is newer.\n\nLoad the backup instead?"), file);
3830 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3831 _("&Load backup"), _("Load &original"), _("&Cancel"));
3836 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3837 // the file is not saved if we load the autosave file.
3838 if (ret_llf == ReadSuccess) {
3840 Alert::warning(_("File is read-only"),
3841 bformat(_("A backup file is successfully loaded, "
3842 "but the original file %1$s is marked read-only. "
3843 "Please make sure to save the document as a "
3845 from_utf8(d->filename.absFileName())));
3850 return ReadAutosaveFailure;
3853 // Here we delete the autosave
3854 autosaveFile.removeFile();
3855 return ReadOriginal;
3863 Buffer::ReadStatus Buffer::loadLyXFile()
3865 if (!d->filename.isReadableFile()) {
3866 ReadStatus const ret_rvc = extractFromVC();
3867 if (ret_rvc != ReadSuccess)
3871 ReadStatus const ret_re = loadEmergency();
3872 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3875 ReadStatus const ret_ra = loadAutosave();
3876 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3879 return loadThisLyXFile(d->filename);
3883 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3885 return readFile(fn);
3889 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3891 TeXErrors::Errors::const_iterator cit = terr.begin();
3892 TeXErrors::Errors::const_iterator end = terr.end();
3894 for (; cit != end; ++cit) {
3897 int errorRow = cit->error_in_line;
3898 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3904 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3905 } while (found && id_start == id_end && pos_start == pos_end);
3907 errorList.push_back(ErrorItem(cit->error_desc,
3908 cit->error_text, id_start, pos_start, pos_end));
3913 void Buffer::setBuffersForInsets() const
3915 inset().setBuffer(const_cast<Buffer &>(*this));
3919 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3921 // Use the master text class also for child documents
3922 Buffer const * const master = masterBuffer();
3923 DocumentClass const & textclass = master->params().documentClass();
3925 // do this only if we are the top-level Buffer
3927 reloadBibInfoCache();
3929 // keep the buffers to be children in this set. If the call from the
3930 // master comes back we can see which of them were actually seen (i.e.
3931 // via an InsetInclude). The remaining ones in the set need still be updated.
3932 static std::set<Buffer const *> bufToUpdate;
3933 if (scope == UpdateMaster) {
3934 // If this is a child document start with the master
3935 if (master != this) {
3936 bufToUpdate.insert(this);
3937 master->updateBuffer(UpdateMaster, utype);
3938 // Do this here in case the master has no gui associated with it. Then,
3939 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3940 if (!master->d->gui_)
3943 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3944 if (bufToUpdate.find(this) == bufToUpdate.end())
3948 // start over the counters in the master
3949 textclass.counters().reset();
3952 // update will be done below for this buffer
3953 bufToUpdate.erase(this);
3955 // update all caches
3956 clearReferenceCache();
3959 Buffer & cbuf = const_cast<Buffer &>(*this);
3961 LASSERT(!text().paragraphs().empty(), /**/);
3964 ParIterator parit = cbuf.par_iterator_begin();
3965 updateBuffer(parit, utype);
3968 // TocBackend update will be done later.
3971 d->bibinfo_cache_valid_ = true;
3972 cbuf.tocBackend().update();
3973 if (scope == UpdateMaster)
3974 cbuf.structureChanged();
3978 static depth_type getDepth(DocIterator const & it)
3980 depth_type depth = 0;
3981 for (size_t i = 0 ; i < it.depth() ; ++i)
3982 if (!it[i].inset().inMathed())
3983 depth += it[i].paragraph().getDepth() + 1;
3984 // remove 1 since the outer inset does not count
3988 static depth_type getItemDepth(ParIterator const & it)
3990 Paragraph const & par = *it;
3991 LabelType const labeltype = par.layout().labeltype;
3993 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3996 // this will hold the lowest depth encountered up to now.
3997 depth_type min_depth = getDepth(it);
3998 ParIterator prev_it = it;
4001 --prev_it.top().pit();
4003 // start of nested inset: go to outer par
4005 if (prev_it.empty()) {
4006 // start of document: nothing to do
4011 // We search for the first paragraph with same label
4012 // that is not more deeply nested.
4013 Paragraph & prev_par = *prev_it;
4014 depth_type const prev_depth = getDepth(prev_it);
4015 if (labeltype == prev_par.layout().labeltype) {
4016 if (prev_depth < min_depth)
4017 return prev_par.itemdepth + 1;
4018 if (prev_depth == min_depth)
4019 return prev_par.itemdepth;
4021 min_depth = min(min_depth, prev_depth);
4022 // small optimization: if we are at depth 0, we won't
4023 // find anything else
4024 if (prev_depth == 0)
4030 static bool needEnumCounterReset(ParIterator const & it)
4032 Paragraph const & par = *it;
4033 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4034 depth_type const cur_depth = par.getDepth();
4035 ParIterator prev_it = it;
4036 while (prev_it.pit()) {
4037 --prev_it.top().pit();
4038 Paragraph const & prev_par = *prev_it;
4039 if (prev_par.getDepth() <= cur_depth)
4040 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4042 // start of nested inset: reset
4047 // set the label of a paragraph. This includes the counters.
4048 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4050 BufferParams const & bp = owner_->masterBuffer()->params();
4051 DocumentClass const & textclass = bp.documentClass();
4052 Paragraph & par = it.paragraph();
4053 Layout const & layout = par.layout();
4054 Counters & counters = textclass.counters();
4056 if (par.params().startOfAppendix()) {
4057 // FIXME: only the counter corresponding to toplevel
4058 // sectioning should be reset
4060 counters.appendix(true);
4062 par.params().appendix(counters.appendix());
4064 // Compute the item depth of the paragraph
4065 par.itemdepth = getItemDepth(it);
4067 if (layout.margintype == MARGIN_MANUAL
4068 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
4069 if (par.params().labelWidthString().empty())
4070 par.params().labelWidthString(par.expandLabel(layout, bp));
4072 par.params().labelWidthString(docstring());
4075 switch(layout.labeltype) {
4077 if (layout.toclevel <= bp.secnumdepth
4078 && (layout.latextype != LATEX_ENVIRONMENT
4079 || it.text()->isFirstInSequence(it.pit()))) {
4080 if (counters.hasCounter(layout.counter))
4081 counters.step(layout.counter, utype);
4082 par.params().labelString(par.expandLabel(layout, bp));
4084 par.params().labelString(docstring());
4087 case LABEL_ITEMIZE: {
4088 // At some point of time we should do something more
4089 // clever here, like:
4090 // par.params().labelString(
4091 // bp.user_defined_bullet(par.itemdepth).getText());
4092 // for now, use a simple hardcoded label
4093 docstring itemlabel;
4094 switch (par.itemdepth) {
4096 itemlabel = char_type(0x2022);
4099 itemlabel = char_type(0x2013);
4102 itemlabel = char_type(0x2217);
4105 itemlabel = char_type(0x2219); // or 0x00b7
4108 par.params().labelString(itemlabel);
4112 case LABEL_ENUMERATE: {
4113 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4115 switch (par.itemdepth) {
4124 enumcounter += "iv";
4127 // not a valid enumdepth...
4131 // Maybe we have to reset the enumeration counter.
4132 if (needEnumCounterReset(it))
4133 counters.reset(enumcounter);
4134 counters.step(enumcounter, utype);
4136 string const & lang = par.getParLanguage(bp)->code();
4137 par.params().labelString(counters.theCounter(enumcounter, lang));
4142 case LABEL_SENSITIVE: {
4143 string const & type = counters.current_float();
4144 docstring full_label;
4146 full_label = owner_->B_("Senseless!!! ");
4148 docstring name = owner_->B_(textclass.floats().getType(type).name());
4149 if (counters.hasCounter(from_utf8(type))) {
4150 string const & lang = par.getParLanguage(bp)->code();
4151 counters.step(from_utf8(type), utype);
4152 full_label = bformat(from_ascii("%1$s %2$s:"),
4154 counters.theCounter(from_utf8(type), lang));
4156 full_label = bformat(from_ascii("%1$s #:"), name);
4158 par.params().labelString(full_label);
4162 case LABEL_NO_LABEL:
4163 par.params().labelString(docstring());
4167 case LABEL_TOP_ENVIRONMENT:
4168 case LABEL_CENTERED_TOP_ENVIRONMENT:
4171 par.params().labelString(par.expandLabel(layout, bp));
4177 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4179 LASSERT(parit.pit() == 0, /**/);
4181 // Set the position of the text in the buffer to be able
4182 // to resolve macros in it.
4183 parit.text()->setMacrocontextPosition(parit);
4185 depth_type maxdepth = 0;
4186 pit_type const lastpit = parit.lastpit();
4187 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4188 // reduce depth if necessary
4189 parit->params().depth(min(parit->params().depth(), maxdepth));
4190 maxdepth = parit->getMaxDepthAfter();
4192 if (utype == OutputUpdate) {
4193 // track the active counters
4194 // we have to do this for the master buffer, since the local
4195 // buffer isn't tracking anything.
4196 masterBuffer()->params().documentClass().counters().
4197 setActiveLayout(parit->layout());
4200 // set the counter for this paragraph
4201 d->setLabel(parit, utype);
4204 InsetList::const_iterator iit = parit->insetList().begin();
4205 InsetList::const_iterator end = parit->insetList().end();
4206 for (; iit != end; ++iit) {
4207 parit.pos() = iit->pos;
4208 iit->inset->updateBuffer(parit, utype);
4214 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4215 WordLangTuple & word_lang, docstring_list & suggestions) const
4219 suggestions.clear();
4220 word_lang = WordLangTuple();
4221 // OK, we start from here.
4222 DocIterator const end = doc_iterator_end(this);
4223 for (; from != end; from.forwardPos()) {
4224 // We are only interested in text so remove the math CursorSlice.
4225 while (from.inMathed()) {
4229 // If from is at the end of the document (which is possible
4230 // when leaving the mathed) LyX will crash later.
4234 from.paragraph().spellCheck();
4235 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4236 if (SpellChecker::misspelled(res)) {
4241 // Do not increase progress when from == to, otherwise the word
4242 // count will be wrong.
4252 Buffer::ReadStatus Buffer::reload()
4255 // c.f. bug http://www.lyx.org/trac/ticket/6587
4256 removeAutosaveFile();
4257 // e.g., read-only status could have changed due to version control
4258 d->filename.refresh();
4259 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4261 ReadStatus const status = loadLyXFile();
4262 if (status == ReadSuccess) {
4267 message(bformat(_("Document %1$s reloaded."), disp_fn));
4270 message(bformat(_("Could not reload document %1$s."), disp_fn));
4280 bool Buffer::saveAs(FileName const & fn)
4282 FileName const old_name = fileName();
4283 FileName const old_auto = getAutosaveFileName();
4284 bool const old_unnamed = isUnnamed();
4291 // bring the autosave file with us, just in case.
4292 moveAutosaveFile(old_auto);
4293 // validate version control data and
4294 // correct buffer title
4295 lyxvc().file_found_hook(fileName());
4297 // the file has now been saved to the new location.
4298 // we need to check that the locations of child buffers
4300 checkChildBuffers();
4304 // reset the old filename and unnamed state
4305 setFileName(old_name);
4306 setUnnamed(old_unnamed);
4312 // FIXME We could do better here, but it is complicated. What would be
4313 // nice is to offer either (a) to save the child buffer to an appropriate
4314 // location, so that it would "move with the master", or else (b) to update
4315 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4316 // complicated, because the code for this lives in GuiView.
4317 void Buffer::checkChildBuffers()
4319 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4320 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4321 for (; it != en; ++it) {
4322 DocIterator dit = it->second;
4323 Buffer * cbuf = const_cast<Buffer *>(it->first);
4324 if (!cbuf || !theBufferList().isLoaded(cbuf))
4326 Inset * inset = dit.nextInset();
4327 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4328 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4329 docstring const & incfile = inset_inc->getParam("filename");
4330 string oldloc = cbuf->absFileName();
4331 string newloc = makeAbsPath(to_utf8(incfile),
4332 onlyPath(absFileName())).absFileName();
4333 if (oldloc == newloc)
4335 // the location of the child file is incorrect.
4336 Alert::warning(_("Included File Invalid"),
4337 bformat(_("Saving this document to a new location has made the file:\n"
4339 "inaccessible. You will need to update the included filename."),
4340 from_utf8(oldloc)));
4342 inset_inc->setChildBuffer(0);
4344 // invalidate cache of children
4345 d->children_positions.clear();
4346 d->position_to_children.clear();