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 = 410; // rgh: dummy format for list->labeling
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,
1058 // do not copy because of #6587
1059 if (fileName().moveTo(backupName)) {
1062 Alert::error(_("Backup failure"),
1063 bformat(_("Cannot create backup file %1$s.\n"
1064 "Please check whether the directory exists and is writable."),
1065 from_utf8(backupName.absFileName())));
1066 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1070 if (writeFile(d->filename)) {
1074 // Saving failed, so backup is not backup
1076 backupName.moveTo(d->filename);
1082 bool Buffer::writeFile(FileName const & fname) const
1084 if (d->read_only && fname == d->filename)
1087 bool retval = false;
1089 docstring const str = bformat(_("Saving document %1$s..."),
1090 makeDisplayPath(fname.absFileName()));
1093 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1095 if (params().compressed) {
1096 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1097 retval = ofs && write(ofs);
1099 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1100 retval = ofs && write(ofs);
1104 message(str + _(" could not write file!"));
1109 // removeAutosaveFile();
1112 message(str + _(" done."));
1118 docstring Buffer::emergencyWrite()
1120 // No need to save if the buffer has not changed.
1124 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1126 docstring user_message = bformat(
1127 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1129 // We try to save three places:
1130 // 1) Same place as document. Unless it is an unnamed doc.
1132 string s = absFileName();
1135 if (writeFile(FileName(s))) {
1137 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1138 return user_message;
1140 user_message += " " + _("Save failed! Trying again...\n");
1144 // 2) In HOME directory.
1145 string s = addName(package().home_dir().absFileName(), absFileName());
1147 lyxerr << ' ' << s << endl;
1148 if (writeFile(FileName(s))) {
1150 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1151 return user_message;
1154 user_message += " " + _("Save failed! Trying yet again...\n");
1156 // 3) In "/tmp" directory.
1157 // MakeAbsPath to prepend the current
1158 // drive letter on OS/2
1159 s = addName(package().temp_dir().absFileName(), absFileName());
1161 lyxerr << ' ' << s << endl;
1162 if (writeFile(FileName(s))) {
1164 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1165 return user_message;
1168 user_message += " " + _("Save failed! Bummer. Document is lost.");
1171 return user_message;
1175 bool Buffer::write(ostream & ofs) const
1178 // Use the standard "C" locale for file output.
1179 ofs.imbue(locale::classic());
1182 // The top of the file should not be written by params().
1184 // write out a comment in the top of the file
1185 ofs << "#LyX " << lyx_version
1186 << " created this file. For more info see http://www.lyx.org/\n"
1187 << "\\lyxformat " << LYX_FORMAT << "\n"
1188 << "\\begin_document\n";
1190 /// For each author, set 'used' to true if there is a change
1191 /// by this author in the document; otherwise set it to 'false'.
1192 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1193 AuthorList::Authors::const_iterator a_end = params().authors().end();
1194 for (; a_it != a_end; ++a_it)
1195 a_it->setUsed(false);
1197 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1198 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1199 for ( ; it != end; ++it)
1200 it->checkAuthors(params().authors());
1202 // now write out the buffer parameters.
1203 ofs << "\\begin_header\n";
1204 params().writeFile(ofs);
1205 ofs << "\\end_header\n";
1208 ofs << "\n\\begin_body\n";
1210 ofs << "\n\\end_body\n";
1212 // Write marker that shows file is complete
1213 ofs << "\\end_document" << endl;
1215 // Shouldn't really be needed....
1218 // how to check if close went ok?
1219 // Following is an attempt... (BE 20001011)
1221 // good() returns false if any error occured, including some
1222 // formatting error.
1223 // bad() returns true if something bad happened in the buffer,
1224 // which should include file system full errors.
1229 lyxerr << "File was not closed properly." << endl;
1236 bool Buffer::makeLaTeXFile(FileName const & fname,
1237 string const & original_path,
1238 OutputParams const & runparams_in,
1239 bool output_preamble, bool output_body) const
1241 OutputParams runparams = runparams_in;
1243 // This is necessary for LuaTeX/XeTeX with tex fonts.
1244 // See FIXME in BufferParams::encoding()
1245 if (runparams.isFullUnicode())
1246 runparams.encoding = encodings.fromLyXName("utf8-plain");
1248 string const encoding = runparams.encoding->iconvName();
1249 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1252 try { ofs.reset(encoding); }
1253 catch (iconv_codecvt_facet_exception & e) {
1254 lyxerr << "Caught iconv exception: " << e.what() << endl;
1255 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1256 "verify that the support software for your encoding (%1$s) is "
1257 "properly installed"), from_ascii(encoding)));
1260 if (!openFileWrite(ofs, fname))
1263 //TexStream ts(ofs.rdbuf(), &texrow());
1264 ErrorList & errorList = d->errorLists["Export"];
1266 bool failed_export = false;
1269 writeLaTeXSource(ofs, original_path,
1270 runparams, output_preamble, output_body);
1272 catch (EncodingException & e) {
1273 odocstringstream ods;
1274 ods.put(e.failed_char);
1276 oss << "0x" << hex << e.failed_char << dec;
1277 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1278 " (code point %2$s)"),
1279 ods.str(), from_utf8(oss.str()));
1280 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1281 "representable in the chosen encoding.\n"
1282 "Changing the document encoding to utf8 could help."),
1283 e.par_id, e.pos, e.pos + 1));
1284 failed_export = true;
1286 catch (iconv_codecvt_facet_exception & e) {
1287 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1288 _(e.what()), -1, 0, 0));
1289 failed_export = true;
1291 catch (exception const & e) {
1292 errorList.push_back(ErrorItem(_("conversion failed"),
1293 _(e.what()), -1, 0, 0));
1294 failed_export = true;
1297 lyxerr << "Caught some really weird exception..." << endl;
1303 failed_export = true;
1304 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1308 return !failed_export;
1312 void Buffer::writeLaTeXSource(odocstream & os,
1313 string const & original_path,
1314 OutputParams const & runparams_in,
1315 bool const output_preamble, bool const output_body) const
1317 // The child documents, if any, shall be already loaded at this point.
1319 OutputParams runparams = runparams_in;
1321 // Classify the unicode characters appearing in math insets
1322 Encodings::initUnicodeMath(*this);
1324 // validate the buffer.
1325 LYXERR(Debug::LATEX, " Validating buffer...");
1326 LaTeXFeatures features(*this, params(), runparams);
1328 LYXERR(Debug::LATEX, " Buffer validation done.");
1330 // The starting paragraph of the coming rows is the
1331 // first paragraph of the document. (Asger)
1332 if (output_preamble && runparams.nice) {
1333 os << "%% LyX " << lyx_version << " created this file. "
1334 "For more info, see http://www.lyx.org/.\n"
1335 "%% Do not edit unless you really know what "
1337 d->texrow.newline();
1338 d->texrow.newline();
1340 LYXERR(Debug::INFO, "lyx document header finished");
1342 // Don't move this behind the parent_buffer=0 code below,
1343 // because then the macros will not get the right "redefinition"
1344 // flag as they don't see the parent macros which are output before.
1347 // fold macros if possible, still with parent buffer as the
1348 // macros will be put in the prefix anyway.
1349 updateMacroInstances();
1351 // There are a few differences between nice LaTeX and usual files:
1352 // usual is \batchmode and has a
1353 // special input@path to allow the including of figures
1354 // with either \input or \includegraphics (what figinsets do).
1355 // input@path is set when the actual parameter
1356 // original_path is set. This is done for usual tex-file, but not
1357 // for nice-latex-file. (Matthias 250696)
1358 // Note that input@path is only needed for something the user does
1359 // in the preamble, included .tex files or ERT, files included by
1360 // LyX work without it.
1361 if (output_preamble) {
1362 if (!runparams.nice) {
1363 // code for usual, NOT nice-latex-file
1364 os << "\\batchmode\n"; // changed
1365 // from \nonstopmode
1366 d->texrow.newline();
1368 if (!original_path.empty()) {
1370 // We don't know the encoding of inputpath
1371 docstring const inputpath = from_utf8(support::latex_path(original_path));
1372 docstring uncodable_glyphs;
1373 Encoding const * const enc = runparams.encoding;
1375 for (size_t n = 0; n < inputpath.size(); ++n) {
1376 docstring const glyph =
1377 docstring(1, inputpath[n]);
1378 if (enc->latexChar(inputpath[n], true) != glyph) {
1379 LYXERR0("Uncodable character '"
1381 << "' in input path!");
1382 uncodable_glyphs += glyph;
1387 // warn user if we found uncodable glyphs.
1388 if (!uncodable_glyphs.empty()) {
1389 frontend::Alert::warning(_("Uncodable character in file path"),
1390 support::bformat(_("The path of your document\n"
1392 "contains glyphs that are unknown in the\n"
1393 "current document encoding (namely %2$s).\n"
1394 "This will likely result in incomplete output.\n\n"
1395 "Choose an appropriate document encoding (such as utf8)\n"
1396 "or change the file path name."), inputpath, uncodable_glyphs));
1398 os << "\\makeatletter\n"
1399 << "\\def\\input@path{{"
1400 << inputpath << "/}}\n"
1401 << "\\makeatother\n";
1402 d->texrow.newline();
1403 d->texrow.newline();
1404 d->texrow.newline();
1408 // get parent macros (if this buffer has a parent) which will be
1409 // written at the document begin further down.
1410 MacroSet parentMacros;
1411 listParentMacros(parentMacros, features);
1413 runparams.use_polyglossia = features.usePolyglossia();
1414 // Write the preamble
1415 runparams.use_babel = params().writeLaTeX(os, features,
1417 d->filename.onlyPath());
1419 runparams.use_japanese = features.isRequired("japanese");
1425 os << "\\begin{document}\n";
1426 d->texrow.newline();
1428 // output the parent macros
1429 MacroSet::iterator it = parentMacros.begin();
1430 MacroSet::iterator end = parentMacros.end();
1431 for (; it != end; ++it) {
1432 int num_lines = (*it)->write(os, true);
1433 d->texrow.newlines(num_lines);
1436 } // output_preamble
1438 d->texrow.start(paragraphs().begin()->id(), 0);
1440 LYXERR(Debug::INFO, "preamble finished, now the body.");
1442 // if we are doing a real file with body, even if this is the
1443 // child of some other buffer, let's cut the link here.
1444 // This happens for example if only a child document is printed.
1445 Buffer const * save_parent = 0;
1446 if (output_preamble) {
1447 save_parent = d->parent();
1452 latexParagraphs(*this, text(), os, d->texrow, runparams);
1454 // Restore the parenthood if needed
1455 if (output_preamble)
1456 d->setParent(save_parent);
1458 // add this just in case after all the paragraphs
1460 d->texrow.newline();
1462 if (output_preamble) {
1463 os << "\\end{document}\n";
1464 d->texrow.newline();
1465 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1467 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1469 runparams_in.encoding = runparams.encoding;
1471 // Just to be sure. (Asger)
1472 d->texrow.newline();
1474 //for (int i = 0; i<d->texrow.rows(); i++) {
1476 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1477 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1480 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1481 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1485 bool Buffer::isLatex() const
1487 return params().documentClass().outputType() == LATEX;
1491 bool Buffer::isLiterate() const
1493 return params().documentClass().outputType() == LITERATE;
1497 bool Buffer::isDocBook() const
1499 return params().documentClass().outputType() == DOCBOOK;
1503 void Buffer::makeDocBookFile(FileName const & fname,
1504 OutputParams const & runparams,
1505 bool const body_only) const
1507 LYXERR(Debug::LATEX, "makeDocBookFile...");
1510 if (!openFileWrite(ofs, fname))
1513 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1517 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1521 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1522 OutputParams const & runparams,
1523 bool const only_body) const
1525 LaTeXFeatures features(*this, params(), runparams);
1530 DocumentClass const & tclass = params().documentClass();
1531 string const top_element = tclass.latexname();
1534 if (runparams.flavor == OutputParams::XML)
1535 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1538 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1541 if (! tclass.class_header().empty())
1542 os << from_ascii(tclass.class_header());
1543 else if (runparams.flavor == OutputParams::XML)
1544 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1545 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1547 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1549 docstring preamble = from_utf8(params().preamble);
1550 if (runparams.flavor != OutputParams::XML ) {
1551 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1552 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1553 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1554 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1557 string const name = runparams.nice
1558 ? changeExtension(absFileName(), ".sgml") : fname;
1559 preamble += features.getIncludedFiles(name);
1560 preamble += features.getLyXSGMLEntities();
1562 if (!preamble.empty()) {
1563 os << "\n [ " << preamble << " ]";
1568 string top = top_element;
1570 if (runparams.flavor == OutputParams::XML)
1571 top += params().language->code();
1573 top += params().language->code().substr(0, 2);
1576 if (!params().options.empty()) {
1578 top += params().options;
1581 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1582 << " file was created by LyX " << lyx_version
1583 << "\n See http://www.lyx.org/ for more information -->\n";
1585 params().documentClass().counters().reset();
1589 sgml::openTag(os, top);
1591 docbookParagraphs(text(), *this, os, runparams);
1592 sgml::closeTag(os, top_element);
1596 void Buffer::makeLyXHTMLFile(FileName const & fname,
1597 OutputParams const & runparams,
1598 bool const body_only) const
1600 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1603 if (!openFileWrite(ofs, fname))
1606 writeLyXHTMLSource(ofs, runparams, body_only);
1610 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1614 void Buffer::writeLyXHTMLSource(odocstream & os,
1615 OutputParams const & runparams,
1616 bool const only_body) const
1618 LaTeXFeatures features(*this, params(), runparams);
1620 updateBuffer(UpdateMaster, OutputUpdate);
1621 d->bibinfo_.makeCitationLabels(*this);
1623 updateMacroInstances();
1626 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1627 << "<!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"
1628 // FIXME Language should be set properly.
1629 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1631 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1632 // FIXME Presumably need to set this right
1633 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1635 docstring const & doctitle = features.htmlTitle();
1637 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1640 os << "\n<!-- Text Class Preamble -->\n"
1641 << features.getTClassHTMLPreamble()
1642 << "\n<!-- Preamble Snippets -->\n"
1643 << from_utf8(features.getPreambleSnippets());
1645 os << "\n<!-- Layout-provided Styles -->\n";
1646 docstring const styleinfo = features.getTClassHTMLStyles();
1647 if (!styleinfo.empty()) {
1648 os << "<style type='text/css'>\n"
1652 os << "</head>\n<body>\n";
1656 params().documentClass().counters().reset();
1657 xhtmlParagraphs(text(), *this, xs, runparams);
1659 os << "</body>\n</html>\n";
1663 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1664 // Other flags: -wall -v0 -x
1665 int Buffer::runChktex()
1669 // get LaTeX-Filename
1670 FileName const path(temppath());
1671 string const name = addName(path.absFileName(), latexName());
1672 string const org_path = filePath();
1674 PathChanger p(path); // path to LaTeX file
1675 message(_("Running chktex..."));
1677 // Generate the LaTeX file if neccessary
1678 OutputParams runparams(¶ms().encoding());
1679 runparams.flavor = OutputParams::LATEX;
1680 runparams.nice = false;
1681 runparams.linelen = lyxrc.plaintext_linelen;
1682 makeLaTeXFile(FileName(name), org_path, runparams);
1685 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1686 int const res = chktex.run(terr); // run chktex
1689 Alert::error(_("chktex failure"),
1690 _("Could not run chktex successfully."));
1691 } else if (res > 0) {
1692 ErrorList & errlist = d->errorLists["ChkTeX"];
1694 bufferErrors(terr, errlist);
1705 void Buffer::validate(LaTeXFeatures & features) const
1707 params().validate(features);
1711 for_each(paragraphs().begin(), paragraphs().end(),
1712 bind(&Paragraph::validate, _1, ref(features)));
1714 if (lyxerr.debugging(Debug::LATEX)) {
1715 features.showStruct();
1720 void Buffer::getLabelList(vector<docstring> & list) const
1722 // If this is a child document, use the master's list instead.
1724 masterBuffer()->getLabelList(list);
1729 Toc & toc = d->toc_backend.toc("label");
1730 TocIterator toc_it = toc.begin();
1731 TocIterator end = toc.end();
1732 for (; toc_it != end; ++toc_it) {
1733 if (toc_it->depth() == 0)
1734 list.push_back(toc_it->str());
1739 void Buffer::updateBibfilesCache(UpdateScope scope) const
1741 // FIXME This is probably unnecssary, given where we call this.
1742 // If this is a child document, use the parent's cache instead.
1743 if (parent() && scope != UpdateChildOnly) {
1744 masterBuffer()->updateBibfilesCache();
1748 d->bibfiles_cache_.clear();
1749 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1750 if (it->lyxCode() == BIBTEX_CODE) {
1751 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1752 support::FileNameList const bibfiles = inset.getBibFiles();
1753 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1756 } else if (it->lyxCode() == INCLUDE_CODE) {
1757 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1758 Buffer const * const incbuf = inset.getChildBuffer();
1761 support::FileNameList const & bibfiles =
1762 incbuf->getBibfilesCache(UpdateChildOnly);
1763 if (!bibfiles.empty()) {
1764 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1770 d->bibfile_cache_valid_ = true;
1771 d->bibinfo_cache_valid_ = false;
1775 void Buffer::invalidateBibinfoCache() const
1777 d->bibinfo_cache_valid_ = false;
1778 // also invalidate the cache for the parent buffer
1779 Buffer const * const pbuf = d->parent();
1781 pbuf->invalidateBibinfoCache();
1785 void Buffer::invalidateBibfileCache() const
1787 d->bibfile_cache_valid_ = false;
1788 d->bibinfo_cache_valid_ = false;
1789 // also invalidate the cache for the parent buffer
1790 Buffer const * const pbuf = d->parent();
1792 pbuf->invalidateBibfileCache();
1796 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1798 // FIXME This is probably unnecessary, given where we call this.
1799 // If this is a child document, use the master's cache instead.
1800 Buffer const * const pbuf = masterBuffer();
1801 if (pbuf != this && scope != UpdateChildOnly)
1802 return pbuf->getBibfilesCache();
1804 if (!d->bibfile_cache_valid_)
1805 this->updateBibfilesCache(scope);
1807 return d->bibfiles_cache_;
1811 BiblioInfo const & Buffer::masterBibInfo() const
1813 Buffer const * const tmp = masterBuffer();
1815 return tmp->masterBibInfo();
1820 void Buffer::checkIfBibInfoCacheIsValid() const
1822 // use the master's cache
1823 Buffer const * const tmp = masterBuffer();
1825 tmp->checkIfBibInfoCacheIsValid();
1829 // compare the cached timestamps with the actual ones.
1830 FileNameList const & bibfiles_cache = getBibfilesCache();
1831 FileNameList::const_iterator ei = bibfiles_cache.begin();
1832 FileNameList::const_iterator en = bibfiles_cache.end();
1833 for (; ei != en; ++ ei) {
1834 time_t lastw = ei->lastModified();
1835 time_t prevw = d->bibfile_status_[*ei];
1836 if (lastw != prevw) {
1837 d->bibinfo_cache_valid_ = false;
1838 d->bibfile_status_[*ei] = lastw;
1844 void Buffer::reloadBibInfoCache() const
1846 // use the master's cache
1847 Buffer const * const tmp = masterBuffer();
1849 tmp->reloadBibInfoCache();
1853 checkIfBibInfoCacheIsValid();
1854 if (d->bibinfo_cache_valid_)
1857 d->bibinfo_.clear();
1859 d->bibinfo_cache_valid_ = true;
1863 void Buffer::collectBibKeys() const
1865 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1866 it->collectBibKeys(it);
1870 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1872 Buffer const * tmp = masterBuffer();
1873 BiblioInfo & masterbi = (tmp == this) ?
1874 d->bibinfo_ : tmp->d->bibinfo_;
1875 masterbi.mergeBiblioInfo(bi);
1879 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1881 Buffer const * tmp = masterBuffer();
1882 BiblioInfo & masterbi = (tmp == this) ?
1883 d->bibinfo_ : tmp->d->bibinfo_;
1888 bool Buffer::isDepClean(string const & name) const
1890 DepClean::const_iterator const it = d->dep_clean.find(name);
1891 if (it == d->dep_clean.end())
1897 void Buffer::markDepClean(string const & name)
1899 d->dep_clean[name] = true;
1903 bool Buffer::isExportableFormat(string const & format) const
1905 typedef vector<Format const *> Formats;
1907 formats = exportableFormats(true);
1908 Formats::const_iterator fit = formats.begin();
1909 Formats::const_iterator end = formats.end();
1910 for (; fit != end ; ++fit) {
1911 if ((*fit)->name() == format)
1918 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1921 // FIXME? if there is an Buffer LFUN that can be dispatched even
1922 // if internal, put a switch '(cmd.action)' here.
1928 switch (cmd.action()) {
1930 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1931 flag.setOnOff(isReadonly());
1934 // FIXME: There is need for a command-line import.
1935 //case LFUN_BUFFER_IMPORT:
1937 case LFUN_BUFFER_AUTO_SAVE:
1940 case LFUN_BUFFER_EXPORT_CUSTOM:
1941 // FIXME: Nothing to check here?
1944 case LFUN_BUFFER_EXPORT: {
1945 docstring const arg = cmd.argument();
1946 enable = arg == "custom" || isExportable(to_utf8(arg));
1948 flag.message(bformat(
1949 _("Don't know how to export to format: %1$s"), arg));
1953 case LFUN_BUFFER_CHKTEX:
1954 enable = isLatex() && !lyxrc.chktex_command.empty();
1957 case LFUN_BUILD_PROGRAM:
1958 enable = isExportable("program");
1961 case LFUN_BRANCH_ACTIVATE:
1962 case LFUN_BRANCH_DEACTIVATE: {
1963 BranchList const & branchList = params().branchlist();
1964 docstring const branchName = cmd.argument();
1965 enable = !branchName.empty() && branchList.find(branchName);
1969 case LFUN_BRANCH_ADD:
1970 case LFUN_BRANCHES_RENAME:
1971 case LFUN_BUFFER_PRINT:
1972 // if no Buffer is present, then of course we won't be called!
1975 case LFUN_BUFFER_LANGUAGE:
1976 enable = !isReadonly();
1982 flag.setEnabled(enable);
1987 void Buffer::dispatch(string const & command, DispatchResult & result)
1989 return dispatch(lyxaction.lookupFunc(command), result);
1993 // NOTE We can end up here even if we have no GUI, because we are called
1994 // by LyX::exec to handled command-line requests. So we may need to check
1995 // whether we have a GUI or not. The boolean use_gui holds this information.
1996 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1999 // FIXME? if there is an Buffer LFUN that can be dispatched even
2000 // if internal, put a switch '(cmd.action())' here.
2001 dr.dispatched(false);
2004 string const argument = to_utf8(func.argument());
2005 // We'll set this back to false if need be.
2006 bool dispatched = true;
2007 undo().beginUndoGroup();
2009 switch (func.action()) {
2010 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2011 if (lyxvc().inUse())
2012 lyxvc().toggleReadOnly();
2014 setReadonly(!isReadonly());
2017 case LFUN_BUFFER_EXPORT: {
2018 bool success = doExport(argument, false, false);
2019 dr.setError(!success);
2021 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2026 case LFUN_BUILD_PROGRAM:
2027 doExport("program", true, false);
2030 case LFUN_BUFFER_CHKTEX:
2034 case LFUN_BUFFER_EXPORT_CUSTOM: {
2036 string command = split(argument, format_name, ' ');
2037 Format const * format = formats.getFormat(format_name);
2039 lyxerr << "Format \"" << format_name
2040 << "\" not recognized!"
2045 // The name of the file created by the conversion process
2048 // Output to filename
2049 if (format->name() == "lyx") {
2050 string const latexname = latexName(false);
2051 filename = changeExtension(latexname,
2052 format->extension());
2053 filename = addName(temppath(), filename);
2055 if (!writeFile(FileName(filename)))
2059 doExport(format_name, true, false, filename);
2062 // Substitute $$FName for filename
2063 if (!contains(command, "$$FName"))
2064 command = "( " + command + " ) < $$FName";
2065 command = subst(command, "$$FName", filename);
2067 // Execute the command in the background
2069 call.startscript(Systemcall::DontWait, command);
2073 // FIXME: There is need for a command-line import.
2075 case LFUN_BUFFER_IMPORT:
2080 case LFUN_BUFFER_AUTO_SAVE:
2082 resetAutosaveTimers();
2085 case LFUN_BRANCH_ADD: {
2086 docstring branch_name = func.argument();
2087 if (branch_name.empty()) {
2091 BranchList & branch_list = params().branchlist();
2092 vector<docstring> const branches =
2093 getVectorFromString(branch_name, branch_list.separator());
2095 for (vector<docstring>::const_iterator it = branches.begin();
2096 it != branches.end(); ++it) {
2098 Branch * branch = branch_list.find(branch_name);
2100 LYXERR0("Branch " << branch_name << " already exists.");
2104 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2106 branch_list.add(branch_name);
2107 branch = branch_list.find(branch_name);
2108 string const x11hexname = X11hexname(branch->color());
2109 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2110 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2112 dr.screenUpdate(Update::Force);
2120 case LFUN_BRANCH_ACTIVATE:
2121 case LFUN_BRANCH_DEACTIVATE: {
2122 BranchList & branchList = params().branchlist();
2123 docstring const branchName = func.argument();
2124 // the case without a branch name is handled elsewhere
2125 if (branchName.empty()) {
2129 Branch * branch = branchList.find(branchName);
2131 LYXERR0("Branch " << branchName << " does not exist.");
2133 docstring const msg =
2134 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2137 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2139 dr.screenUpdate(Update::Force);
2140 dr.forceBufferUpdate();
2145 case LFUN_BRANCHES_RENAME: {
2146 if (func.argument().empty())
2149 docstring const oldname = from_utf8(func.getArg(0));
2150 docstring const newname = from_utf8(func.getArg(1));
2151 InsetIterator it = inset_iterator_begin(inset());
2152 InsetIterator const end = inset_iterator_end(inset());
2153 bool success = false;
2154 for (; it != end; ++it) {
2155 if (it->lyxCode() == BRANCH_CODE) {
2156 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2157 if (ins.branch() == oldname) {
2158 undo().recordUndo(it);
2159 ins.rename(newname);
2164 if (it->lyxCode() == INCLUDE_CODE) {
2165 // get buffer of external file
2166 InsetInclude const & ins =
2167 static_cast<InsetInclude const &>(*it);
2168 Buffer * child = ins.getChildBuffer();
2171 child->dispatch(func, dr);
2176 dr.screenUpdate(Update::Force);
2177 dr.forceBufferUpdate();
2182 case LFUN_BUFFER_PRINT: {
2183 // we'll assume there's a problem until we succeed
2185 string target = func.getArg(0);
2186 string target_name = func.getArg(1);
2187 string command = func.getArg(2);
2190 || target_name.empty()
2191 || command.empty()) {
2192 LYXERR0("Unable to parse " << func.argument());
2193 docstring const msg =
2194 bformat(_("Unable to parse \"%1$s\""), func.argument());
2198 if (target != "printer" && target != "file") {
2199 LYXERR0("Unrecognized target \"" << target << '"');
2200 docstring const msg =
2201 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2206 bool const update_unincluded =
2207 params().maintain_unincluded_children
2208 && !params().getIncludedChildren().empty();
2209 if (!doExport("dvi", true, update_unincluded)) {
2210 showPrintError(absFileName());
2211 dr.setMessage(_("Error exporting to DVI."));
2215 // Push directory path.
2216 string const path = temppath();
2217 // Prevent the compiler from optimizing away p
2221 // there are three cases here:
2222 // 1. we print to a file
2223 // 2. we print directly to a printer
2224 // 3. we print using a spool command (print to file first)
2227 string const dviname = changeExtension(latexName(true), "dvi");
2229 if (target == "printer") {
2230 if (!lyxrc.print_spool_command.empty()) {
2231 // case 3: print using a spool
2232 string const psname = changeExtension(dviname,".ps");
2233 command += ' ' + lyxrc.print_to_file
2236 + quoteName(dviname);
2238 string command2 = lyxrc.print_spool_command + ' ';
2239 if (target_name != "default") {
2240 command2 += lyxrc.print_spool_printerprefix
2244 command2 += quoteName(psname);
2246 // If successful, then spool command
2247 res = one.startscript(Systemcall::Wait, command);
2250 // If there's no GUI, we have to wait on this command. Otherwise,
2251 // LyX deletes the temporary directory, and with it the spooled
2252 // file, before it can be printed!!
2253 Systemcall::Starttype stype = use_gui ?
2254 Systemcall::DontWait : Systemcall::Wait;
2255 res = one.startscript(stype, command2);
2258 // case 2: print directly to a printer
2259 if (target_name != "default")
2260 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2262 Systemcall::Starttype stype = use_gui ?
2263 Systemcall::DontWait : Systemcall::Wait;
2264 res = one.startscript(stype, command + quoteName(dviname));
2268 // case 1: print to a file
2269 FileName const filename(makeAbsPath(target_name, filePath()));
2270 FileName const dvifile(makeAbsPath(dviname, path));
2271 if (filename.exists()) {
2272 docstring text = bformat(
2273 _("The file %1$s already exists.\n\n"
2274 "Do you want to overwrite that file?"),
2275 makeDisplayPath(filename.absFileName()));
2276 if (Alert::prompt(_("Overwrite file?"),
2277 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2280 command += ' ' + lyxrc.print_to_file
2281 + quoteName(filename.toFilesystemEncoding())
2283 + quoteName(dvifile.toFilesystemEncoding());
2285 Systemcall::Starttype stype = use_gui ?
2286 Systemcall::DontWait : Systemcall::Wait;
2287 res = one.startscript(stype, command);
2293 dr.setMessage(_("Error running external commands."));
2294 showPrintError(absFileName());
2299 case LFUN_BUFFER_LANGUAGE: {
2300 Language const * oldL = params().language;
2301 Language const * newL = languages.getLanguage(argument);
2302 if (!newL || oldL == newL)
2304 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2305 changeLanguage(oldL, newL);
2306 dr.forceBufferUpdate();
2315 dr.dispatched(dispatched);
2316 undo().endUndoGroup();
2320 void Buffer::changeLanguage(Language const * from, Language const * to)
2322 LASSERT(from, /**/);
2325 for_each(par_iterator_begin(),
2327 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2331 bool Buffer::isMultiLingual() const
2333 ParConstIterator end = par_iterator_end();
2334 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2335 if (it->isMultiLingual(params()))
2342 std::set<Language const *> Buffer::getLanguages() const
2344 std::set<Language const *> languages;
2345 getLanguages(languages);
2350 void Buffer::getLanguages(std::set<Language const *> & languages) const
2352 ParConstIterator end = par_iterator_end();
2353 // add the buffer language, even if it's not actively used
2354 languages.insert(language());
2355 // iterate over the paragraphs
2356 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2357 it->getLanguages(languages);
2359 ListOfBuffers clist = getDescendents();
2360 ListOfBuffers::const_iterator cit = clist.begin();
2361 ListOfBuffers::const_iterator const cen = clist.end();
2362 for (; cit != cen; ++cit)
2363 (*cit)->getLanguages(languages);
2367 DocIterator Buffer::getParFromID(int const id) const
2369 Buffer * buf = const_cast<Buffer *>(this);
2371 // John says this is called with id == -1 from undo
2372 lyxerr << "getParFromID(), id: " << id << endl;
2373 return doc_iterator_end(buf);
2376 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2377 if (it.paragraph().id() == id)
2380 return doc_iterator_end(buf);
2384 bool Buffer::hasParWithID(int const id) const
2386 return !getParFromID(id).atEnd();
2390 ParIterator Buffer::par_iterator_begin()
2392 return ParIterator(doc_iterator_begin(this));
2396 ParIterator Buffer::par_iterator_end()
2398 return ParIterator(doc_iterator_end(this));
2402 ParConstIterator Buffer::par_iterator_begin() const
2404 return ParConstIterator(doc_iterator_begin(this));
2408 ParConstIterator Buffer::par_iterator_end() const
2410 return ParConstIterator(doc_iterator_end(this));
2414 Language const * Buffer::language() const
2416 return params().language;
2420 docstring const Buffer::B_(string const & l10n) const
2422 return params().B_(l10n);
2426 bool Buffer::isClean() const
2428 return d->lyx_clean;
2432 bool Buffer::isExternallyModified(CheckMethod method) const
2434 LASSERT(d->filename.exists(), /**/);
2435 // if method == timestamp, check timestamp before checksum
2436 return (method == checksum_method
2437 || d->timestamp_ != d->filename.lastModified())
2438 && d->checksum_ != d->filename.checksum();
2442 void Buffer::saveCheckSum() const
2444 FileName const & file = d->filename;
2445 if (file.exists()) {
2446 d->timestamp_ = file.lastModified();
2447 d->checksum_ = file.checksum();
2449 // in the case of save to a new file.
2456 void Buffer::markClean() const
2458 if (!d->lyx_clean) {
2459 d->lyx_clean = true;
2462 // if the .lyx file has been saved, we don't need an
2464 d->bak_clean = true;
2465 d->undo_.markDirty();
2469 void Buffer::setUnnamed(bool flag)
2475 bool Buffer::isUnnamed() const
2482 /// Don't check unnamed, here: isInternal() is used in
2483 /// newBuffer(), where the unnamed flag has not been set by anyone
2484 /// yet. Also, for an internal buffer, there should be no need for
2485 /// retrieving fileName() nor for checking if it is unnamed or not.
2486 bool Buffer::isInternal() const
2488 return fileName().extension() == "internal";
2492 void Buffer::markDirty()
2495 d->lyx_clean = false;
2498 d->bak_clean = false;
2500 DepClean::iterator it = d->dep_clean.begin();
2501 DepClean::const_iterator const end = d->dep_clean.end();
2503 for (; it != end; ++it)
2508 FileName Buffer::fileName() const
2514 string Buffer::absFileName() const
2516 return d->filename.absFileName();
2520 string Buffer::filePath() const
2522 return d->filename.onlyPath().absFileName() + "/";
2526 bool Buffer::isReadonly() const
2528 return d->read_only;
2532 void Buffer::setParent(Buffer const * buffer)
2534 // Avoids recursive include.
2535 d->setParent(buffer == this ? 0 : buffer);
2540 Buffer const * Buffer::parent() const
2546 ListOfBuffers Buffer::allRelatives() const
2548 ListOfBuffers lb = masterBuffer()->getDescendents();
2549 lb.push_front(const_cast<Buffer *>(this));
2554 Buffer const * Buffer::masterBuffer() const
2556 // FIXME Should be make sure we are not in some kind
2557 // of recursive include? A -> B -> A will crash this.
2558 Buffer const * const pbuf = d->parent();
2562 return pbuf->masterBuffer();
2566 bool Buffer::isChild(Buffer * child) const
2568 return d->children_positions.find(child) != d->children_positions.end();
2572 DocIterator Buffer::firstChildPosition(Buffer const * child)
2574 Impl::BufferPositionMap::iterator it;
2575 it = d->children_positions.find(child);
2576 if (it == d->children_positions.end())
2577 return DocIterator(this);
2582 bool Buffer::hasChildren() const
2584 return !d->children_positions.empty();
2588 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2590 // loop over children
2591 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2592 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2593 for (; it != end; ++it) {
2594 Buffer * child = const_cast<Buffer *>(it->first);
2596 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2597 if (bit != clist.end())
2599 clist.push_back(child);
2601 // there might be grandchildren
2602 child->collectChildren(clist, true);
2607 ListOfBuffers Buffer::getChildren() const
2610 collectChildren(v, false);
2615 ListOfBuffers Buffer::getDescendents() const
2618 collectChildren(v, true);
2623 template<typename M>
2624 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2629 typename M::const_iterator it = m.lower_bound(x);
2630 if (it == m.begin())
2638 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2639 DocIterator const & pos) const
2641 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2643 // if paragraphs have no macro context set, pos will be empty
2647 // we haven't found anything yet
2648 DocIterator bestPos = owner_->par_iterator_begin();
2649 MacroData const * bestData = 0;
2651 // find macro definitions for name
2652 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2653 if (nameIt != macros.end()) {
2654 // find last definition in front of pos or at pos itself
2655 PositionScopeMacroMap::const_iterator it
2656 = greatest_below(nameIt->second, pos);
2657 if (it != nameIt->second.end()) {
2659 // scope ends behind pos?
2660 if (pos < it->second.first) {
2661 // Looks good, remember this. If there
2662 // is no external macro behind this,
2663 // we found the right one already.
2664 bestPos = it->first;
2665 bestData = &it->second.second;
2669 // try previous macro if there is one
2670 if (it == nameIt->second.begin())
2677 // find macros in included files
2678 PositionScopeBufferMap::const_iterator it
2679 = greatest_below(position_to_children, pos);
2680 if (it == position_to_children.end())
2681 // no children before
2685 // do we know something better (i.e. later) already?
2686 if (it->first < bestPos )
2689 // scope ends behind pos?
2690 if (pos < it->second.first
2691 && theBufferList().isLoaded(it->second.second)) {
2692 // look for macro in external file
2694 MacroData const * data
2695 = it->second.second->getMacro(name, false);
2698 bestPos = it->first;
2704 // try previous file if there is one
2705 if (it == position_to_children.begin())
2710 // return the best macro we have found
2715 MacroData const * Buffer::getMacro(docstring const & name,
2716 DocIterator const & pos, bool global) const
2721 // query buffer macros
2722 MacroData const * data = d->getBufferMacro(name, pos);
2726 // If there is a master buffer, query that
2727 Buffer const * const pbuf = d->parent();
2729 d->macro_lock = true;
2730 MacroData const * macro = pbuf->getMacro(
2731 name, *this, false);
2732 d->macro_lock = false;
2738 data = MacroTable::globalMacros().get(name);
2747 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2749 // set scope end behind the last paragraph
2750 DocIterator scope = par_iterator_begin();
2751 scope.pit() = scope.lastpit() + 1;
2753 return getMacro(name, scope, global);
2757 MacroData const * Buffer::getMacro(docstring const & name,
2758 Buffer const & child, bool global) const
2760 // look where the child buffer is included first
2761 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2762 if (it == d->children_positions.end())
2765 // check for macros at the inclusion position
2766 return getMacro(name, it->second, global);
2770 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2772 pit_type const lastpit = it.lastpit();
2774 // look for macros in each paragraph
2775 while (it.pit() <= lastpit) {
2776 Paragraph & par = it.paragraph();
2778 // iterate over the insets of the current paragraph
2779 InsetList const & insets = par.insetList();
2780 InsetList::const_iterator iit = insets.begin();
2781 InsetList::const_iterator end = insets.end();
2782 for (; iit != end; ++iit) {
2783 it.pos() = iit->pos;
2785 // is it a nested text inset?
2786 if (iit->inset->asInsetText()) {
2787 // Inset needs its own scope?
2788 InsetText const * itext = iit->inset->asInsetText();
2789 bool newScope = itext->isMacroScope();
2791 // scope which ends just behind the inset
2792 DocIterator insetScope = it;
2795 // collect macros in inset
2796 it.push_back(CursorSlice(*iit->inset));
2797 updateMacros(it, newScope ? insetScope : scope);
2802 if (iit->inset->asInsetTabular()) {
2803 CursorSlice slice(*iit->inset);
2804 size_t const numcells = slice.nargs();
2805 for (; slice.idx() < numcells; slice.forwardIdx()) {
2806 it.push_back(slice);
2807 updateMacros(it, scope);
2813 // is it an external file?
2814 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2815 // get buffer of external file
2816 InsetInclude const & inset =
2817 static_cast<InsetInclude const &>(*iit->inset);
2819 Buffer * child = inset.getChildBuffer();
2824 // register its position, but only when it is
2825 // included first in the buffer
2826 if (children_positions.find(child) ==
2827 children_positions.end())
2828 children_positions[child] = it;
2830 // register child with its scope
2831 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2835 InsetMath * im = iit->inset->asInsetMath();
2836 if (doing_export && im) {
2837 InsetMathHull * hull = im->asHullInset();
2839 hull->recordLocation(it);
2842 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2846 MathMacroTemplate & macroTemplate =
2847 *iit->inset->asInsetMath()->asMacroTemplate();
2848 MacroContext mc(owner_, it);
2849 macroTemplate.updateToContext(mc);
2852 bool valid = macroTemplate.validMacro();
2853 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2854 // then the BufferView's cursor will be invalid in
2855 // some cases which leads to crashes.
2860 // FIXME (Abdel), I don't understandt why we pass 'it' here
2861 // instead of 'macroTemplate' defined above... is this correct?
2862 macros[macroTemplate.name()][it] =
2863 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2873 void Buffer::updateMacros() const
2878 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2880 // start with empty table
2882 d->children_positions.clear();
2883 d->position_to_children.clear();
2885 // Iterate over buffer, starting with first paragraph
2886 // The scope must be bigger than any lookup DocIterator
2887 // later. For the global lookup, lastpit+1 is used, hence
2888 // we use lastpit+2 here.
2889 DocIterator it = par_iterator_begin();
2890 DocIterator outerScope = it;
2891 outerScope.pit() = outerScope.lastpit() + 2;
2892 d->updateMacros(it, outerScope);
2896 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2898 InsetIterator it = inset_iterator_begin(inset());
2899 InsetIterator const end = inset_iterator_end(inset());
2900 for (; it != end; ++it) {
2901 if (it->lyxCode() == BRANCH_CODE) {
2902 InsetBranch & br = static_cast<InsetBranch &>(*it);
2903 docstring const name = br.branch();
2904 if (!from_master && !params().branchlist().find(name))
2905 result.push_back(name);
2906 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2907 result.push_back(name);
2910 if (it->lyxCode() == INCLUDE_CODE) {
2911 // get buffer of external file
2912 InsetInclude const & ins =
2913 static_cast<InsetInclude const &>(*it);
2914 Buffer * child = ins.getChildBuffer();
2917 child->getUsedBranches(result, true);
2920 // remove duplicates
2925 void Buffer::updateMacroInstances() const
2927 LYXERR(Debug::MACROS, "updateMacroInstances for "
2928 << d->filename.onlyFileName());
2929 DocIterator it = doc_iterator_begin(this);
2931 DocIterator const end = doc_iterator_end(this);
2932 for (; it != end; it.forwardInset()) {
2933 // look for MathData cells in InsetMathNest insets
2934 InsetMath * minset = it.nextInset()->asInsetMath();
2938 // update macro in all cells of the InsetMathNest
2939 DocIterator::idx_type n = minset->nargs();
2940 MacroContext mc = MacroContext(this, it);
2941 for (DocIterator::idx_type i = 0; i < n; ++i) {
2942 MathData & data = minset->cell(i);
2943 data.updateMacros(0, mc);
2949 void Buffer::listMacroNames(MacroNameSet & macros) const
2954 d->macro_lock = true;
2956 // loop over macro names
2957 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2958 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2959 for (; nameIt != nameEnd; ++nameIt)
2960 macros.insert(nameIt->first);
2962 // loop over children
2963 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2964 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2965 for (; it != end; ++it)
2966 it->first->listMacroNames(macros);
2969 Buffer const * const pbuf = d->parent();
2971 pbuf->listMacroNames(macros);
2973 d->macro_lock = false;
2977 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2979 Buffer const * const pbuf = d->parent();
2984 pbuf->listMacroNames(names);
2987 MacroNameSet::iterator it = names.begin();
2988 MacroNameSet::iterator end = names.end();
2989 for (; it != end; ++it) {
2991 MacroData const * data =
2992 pbuf->getMacro(*it, *this, false);
2994 macros.insert(data);
2996 // we cannot access the original MathMacroTemplate anymore
2997 // here to calls validate method. So we do its work here manually.
2998 // FIXME: somehow make the template accessible here.
2999 if (data->optionals() > 0)
3000 features.require("xargs");
3006 Buffer::References & Buffer::references(docstring const & label)
3009 return const_cast<Buffer *>(masterBuffer())->references(label);
3011 RefCache::iterator it = d->ref_cache_.find(label);
3012 if (it != d->ref_cache_.end())
3013 return it->second.second;
3015 static InsetLabel const * dummy_il = 0;
3016 static References const dummy_refs;
3017 it = d->ref_cache_.insert(
3018 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3019 return it->second.second;
3023 Buffer::References const & Buffer::references(docstring const & label) const
3025 return const_cast<Buffer *>(this)->references(label);
3029 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3031 masterBuffer()->d->ref_cache_[label].first = il;
3035 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3037 return masterBuffer()->d->ref_cache_[label].first;
3041 void Buffer::clearReferenceCache() const
3044 d->ref_cache_.clear();
3048 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3051 //FIXME: This does not work for child documents yet.
3052 LASSERT(code == CITE_CODE, /**/);
3054 reloadBibInfoCache();
3056 // Check if the label 'from' appears more than once
3057 BiblioInfo const & keys = masterBibInfo();
3058 BiblioInfo::const_iterator bit = keys.begin();
3059 BiblioInfo::const_iterator bend = keys.end();
3060 vector<docstring> labels;
3062 for (; bit != bend; ++bit)
3064 labels.push_back(bit->first);
3066 if (count(labels.begin(), labels.end(), from) > 1)
3069 string const paramName = "key";
3070 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3071 if (it->lyxCode() == code) {
3072 InsetCommand * inset = it->asInsetCommand();
3075 docstring const oldValue = inset->getParam(paramName);
3076 if (oldValue == from)
3077 inset->setParam(paramName, to);
3083 void Buffer::getSourceCode(odocstream & os, string const format,
3084 pit_type par_begin, pit_type par_end,
3085 bool full_source) const
3087 OutputParams runparams(¶ms().encoding());
3088 runparams.nice = true;
3089 runparams.flavor = getOutputFlavor(format);
3090 runparams.linelen = lyxrc.plaintext_linelen;
3091 // No side effect of file copying and image conversion
3092 runparams.dryrun = true;
3095 os << "% " << _("Preview source code") << "\n\n";
3097 d->texrow.newline();
3098 d->texrow.newline();
3100 writeDocBookSource(os, absFileName(), runparams, false);
3101 else if (runparams.flavor == OutputParams::HTML)
3102 writeLyXHTMLSource(os, runparams, false);
3104 // latex or literate
3105 writeLaTeXSource(os, 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 latexParagraphs(*this, text(), os, texrow, runparams);
3137 ErrorList & Buffer::errorList(string const & type) const
3139 static ErrorList emptyErrorList;
3140 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3141 if (it == d->errorLists.end())
3142 return emptyErrorList;
3148 void Buffer::updateTocItem(std::string const & type,
3149 DocIterator const & dit) const
3152 d->gui_->updateTocItem(type, dit);
3156 void Buffer::structureChanged() const
3159 d->gui_->structureChanged();
3163 void Buffer::errors(string const & err, bool from_master) const
3166 d->gui_->errors(err, from_master);
3170 void Buffer::message(docstring const & msg) const
3173 d->gui_->message(msg);
3177 void Buffer::setBusy(bool on) const
3180 d->gui_->setBusy(on);
3184 void Buffer::updateTitles() const
3187 d->wa_->updateTitles();
3191 void Buffer::resetAutosaveTimers() const
3194 d->gui_->resetAutosaveTimers();
3198 bool Buffer::hasGuiDelegate() const
3204 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3213 class AutoSaveBuffer : public ForkedProcess {
3216 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3217 : buffer_(buffer), fname_(fname) {}
3219 virtual shared_ptr<ForkedProcess> clone() const
3221 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3226 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3227 from_utf8(fname_.absFileName())));
3228 return run(DontWait);
3232 virtual int generateChild();
3234 Buffer const & buffer_;
3239 int AutoSaveBuffer::generateChild()
3241 #if defined(__APPLE__)
3242 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3243 * We should use something else like threads.
3245 * Since I do not know how to determine at run time what is the OS X
3246 * version, I just disable forking altogether for now (JMarc)
3248 pid_t const pid = -1;
3250 // tmp_ret will be located (usually) in /tmp
3251 // will that be a problem?
3252 // Note that this calls ForkedCalls::fork(), so it's
3253 // ok cross-platform.
3254 pid_t const pid = fork();
3255 // If you want to debug the autosave
3256 // you should set pid to -1, and comment out the fork.
3257 if (pid != 0 && pid != -1)
3261 // pid = -1 signifies that lyx was unable
3262 // to fork. But we will do the save
3264 bool failed = false;
3265 FileName const tmp_ret = FileName::tempName("lyxauto");
3266 if (!tmp_ret.empty()) {
3267 buffer_.writeFile(tmp_ret);
3268 // assume successful write of tmp_ret
3269 if (!tmp_ret.moveTo(fname_))
3275 // failed to write/rename tmp_ret so try writing direct
3276 if (!buffer_.writeFile(fname_)) {
3277 // It is dangerous to do this in the child,
3278 // but safe in the parent, so...
3279 if (pid == -1) // emit message signal.
3280 buffer_.message(_("Autosave failed!"));
3284 if (pid == 0) // we are the child so...
3293 FileName Buffer::getEmergencyFileName() const
3295 return FileName(d->filename.absFileName() + ".emergency");
3299 FileName Buffer::getAutosaveFileName() const
3301 // if the document is unnamed try to save in the backup dir, else
3302 // in the default document path, and as a last try in the filePath,
3303 // which will most often be the temporary directory
3306 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3307 : lyxrc.backupdir_path;
3308 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3311 string const fname = "#" + d->filename.onlyFileName() + "#";
3313 return makeAbsPath(fname, fpath);
3317 void Buffer::removeAutosaveFile() const
3319 FileName const f = getAutosaveFileName();
3325 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3327 FileName const newauto = getAutosaveFileName();
3329 if (newauto != oldauto && oldauto.exists())
3330 if (!oldauto.moveTo(newauto))
3331 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3335 bool Buffer::autoSave() const
3337 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3338 if (buf->d->bak_clean || isReadonly())
3341 message(_("Autosaving current document..."));
3342 buf->d->bak_clean = true;
3344 FileName const fname = getAutosaveFileName();
3345 if (d->cloned_buffer_) {
3346 // If this buffer is cloned, we assume that
3347 // we are running in a separate thread already.
3348 FileName const tmp_ret = FileName::tempName("lyxauto");
3349 if (!tmp_ret.empty()) {
3351 // assume successful write of tmp_ret
3352 if (tmp_ret.moveTo(fname))
3355 // failed to write/rename tmp_ret so try writing direct
3356 return writeFile(fname);
3358 /// This function is deprecated as the frontend needs to take care
3359 /// of cloning the buffer and autosaving it in another thread. It
3360 /// is still here to allow (QT_VERSION < 0x040400).
3361 AutoSaveBuffer autosave(*this, fname);
3368 string Buffer::bufferFormat() const
3370 string format = params().documentClass().outputFormat();
3371 if (format == "latex") {
3372 if (params().useNonTeXFonts)
3374 if (params().encoding().package() == Encoding::japanese)
3381 string Buffer::getDefaultOutputFormat() const
3383 if (!params().default_output_format.empty()
3384 && params().default_output_format != "default")
3385 return params().default_output_format;
3386 typedef vector<Format const *> Formats;
3387 Formats formats = exportableFormats(true);
3390 || params().useNonTeXFonts
3391 || params().encoding().package() == Encoding::japanese) {
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 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3480 // Get shortest path to format
3481 theConverters().buildGraph();
3482 Graph::EdgePath path;
3483 for (vector<string>::const_iterator it = backs.begin();
3484 it != backs.end(); ++it) {
3485 Graph::EdgePath p = theConverters().getPath(*it, format);
3486 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3487 backend_format = *it;
3492 if (!put_in_tempdir) {
3493 // Only show this alert if this is an export to a non-temporary
3494 // file (not for previewing).
3495 Alert::error(_("Couldn't export file"), bformat(
3496 _("No information for exporting the format %1$s."),
3497 formats.prettyName(format)));
3501 runparams.flavor = theConverters().getFlavor(path);
3504 backend_format = format;
3505 // FIXME: Don't hardcode format names here, but use a flag
3506 if (backend_format == "pdflatex")
3507 runparams.flavor = OutputParams::PDFLATEX;
3508 else if (backend_format == "luatex")
3509 runparams.flavor = OutputParams::LUATEX;
3510 else if (backend_format == "xetex")
3511 runparams.flavor = OutputParams::XETEX;
3514 string filename = latexName(false);
3515 filename = addName(temppath(), filename);
3516 filename = changeExtension(filename,
3517 formats.extension(backend_format));
3520 updateMacroInstances();
3522 // Plain text backend
3523 if (backend_format == "text") {
3524 runparams.flavor = OutputParams::TEXT;
3525 writePlaintextFile(*this, FileName(filename), runparams);
3528 else if (backend_format == "xhtml") {
3529 runparams.flavor = OutputParams::HTML;
3530 switch (params().html_math_output) {
3531 case BufferParams::MathML:
3532 runparams.math_flavor = OutputParams::MathAsMathML;
3534 case BufferParams::HTML:
3535 runparams.math_flavor = OutputParams::MathAsHTML;
3537 case BufferParams::Images:
3538 runparams.math_flavor = OutputParams::MathAsImages;
3540 case BufferParams::LaTeX:
3541 runparams.math_flavor = OutputParams::MathAsLaTeX;
3544 makeLyXHTMLFile(FileName(filename), runparams);
3545 } else if (backend_format == "lyx")
3546 writeFile(FileName(filename));
3548 else if (isDocBook()) {
3549 runparams.nice = !put_in_tempdir;
3550 makeDocBookFile(FileName(filename), runparams);
3553 else if (backend_format == format) {
3554 runparams.nice = true;
3555 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3557 } else if (!lyxrc.tex_allows_spaces
3558 && contains(filePath(), ' ')) {
3559 Alert::error(_("File name error"),
3560 _("The directory path to the document cannot contain spaces."));
3563 runparams.nice = false;
3564 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3568 string const error_type = (format == "program")
3569 ? "Build" : bufferFormat();
3570 ErrorList & error_list = d->errorLists[error_type];
3571 string const ext = formats.extension(format);
3572 FileName const tmp_result_file(changeExtension(filename, ext));
3573 bool const success = theConverters().convert(this, FileName(filename),
3574 tmp_result_file, FileName(absFileName()), backend_format, format,
3577 // Emit the signal to show the error list or copy it back to the
3578 // cloned Buffer so that it cab be emitted afterwards.
3579 if (format != backend_format) {
3580 if (d->cloned_buffer_) {
3581 d->cloned_buffer_->d->errorLists[error_type] =
3582 d->errorLists[error_type];
3585 // also to the children, in case of master-buffer-view
3586 ListOfBuffers clist = getDescendents();
3587 ListOfBuffers::const_iterator cit = clist.begin();
3588 ListOfBuffers::const_iterator const cen = clist.end();
3589 for (; cit != cen; ++cit) {
3590 if (d->cloned_buffer_) {
3591 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3592 (*cit)->d->errorLists[error_type];
3594 (*cit)->errors(error_type, true);
3598 if (d->cloned_buffer_) {
3599 // Enable reverse dvi or pdf to work by copying back the texrow
3600 // object to the cloned buffer.
3601 // FIXME: There is a possibility of concurrent access to texrow
3602 // here from the main GUI thread that should be securized.
3603 d->cloned_buffer_->d->texrow = d->texrow;
3604 string const error_type = bufferFormat();
3605 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3611 if (put_in_tempdir) {
3612 result_file = tmp_result_file.absFileName();
3616 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3617 // We need to copy referenced files (e. g. included graphics
3618 // if format == "dvi") to the result dir.
3619 vector<ExportedFile> const files =
3620 runparams.exportdata->externalFiles(format);
3621 string const dest = onlyPath(result_file);
3622 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3623 : force_overwrite == ALL_FILES;
3624 CopyStatus status = use_force ? FORCE : SUCCESS;
3626 vector<ExportedFile>::const_iterator it = files.begin();
3627 vector<ExportedFile>::const_iterator const en = files.end();
3628 for (; it != en && status != CANCEL; ++it) {
3629 string const fmt = formats.getFormatFromFile(it->sourceName);
3630 status = copyFile(fmt, it->sourceName,
3631 makeAbsPath(it->exportName, dest),
3632 it->exportName, status == FORCE);
3635 if (status == CANCEL) {
3636 message(_("Document export cancelled."));
3637 } else if (tmp_result_file.exists()) {
3638 // Finally copy the main file
3639 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3640 : force_overwrite != NO_FILES;
3641 if (status == SUCCESS && use_force)
3643 status = copyFile(format, tmp_result_file,
3644 FileName(result_file), result_file,
3646 message(bformat(_("Document exported as %1$s "
3648 formats.prettyName(format),
3649 makeDisplayPath(result_file)));
3651 // This must be a dummy converter like fax (bug 1888)
3652 message(bformat(_("Document exported as %1$s"),
3653 formats.prettyName(format)));
3660 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3661 bool includeall) const
3664 // (1) export with all included children (omit \includeonly)
3665 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3667 // (2) export with included children only
3668 return doExport(format, put_in_tempdir, false, result_file);
3672 bool Buffer::preview(string const & format, bool includeall) const
3674 MarkAsExporting exporting(this);
3676 // (1) export with all included children (omit \includeonly)
3677 if (includeall && !doExport(format, true, true))
3679 // (2) export with included children only
3680 if (!doExport(format, true, false, result_file))
3682 return formats.view(*this, FileName(result_file), format);
3686 bool Buffer::isExportable(string const & format) const
3688 vector<string> backs = backends();
3689 for (vector<string>::const_iterator it = backs.begin();
3690 it != backs.end(); ++it)
3691 if (theConverters().isReachable(*it, format))
3697 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3699 vector<string> const backs = backends();
3700 vector<Format const *> result =
3701 theConverters().getReachable(backs[0], only_viewable, true);
3702 for (vector<string>::const_iterator it = backs.begin() + 1;
3703 it != backs.end(); ++it) {
3704 vector<Format const *> r =
3705 theConverters().getReachable(*it, only_viewable, false);
3706 result.insert(result.end(), r.begin(), r.end());
3712 vector<string> Buffer::backends() const
3715 v.push_back(bufferFormat());
3716 // FIXME: Don't hardcode format names here, but use a flag
3717 if (v.back() == "latex") {
3718 v.push_back("pdflatex");
3719 v.push_back("luatex");
3720 v.push_back("xetex");
3721 } else if (v.back() == "xetex")
3722 v.push_back("luatex");
3723 v.push_back("xhtml");
3724 v.push_back("text");
3730 Buffer::ReadStatus Buffer::extractFromVC()
3732 bool const found = LyXVC::file_not_found_hook(d->filename);
3734 return ReadFileNotFound;
3735 if (!d->filename.isReadableFile())
3741 Buffer::ReadStatus Buffer::loadEmergency()
3743 FileName const emergencyFile = getEmergencyFileName();
3744 if (!emergencyFile.exists()
3745 || emergencyFile.lastModified() <= d->filename.lastModified())
3746 return ReadFileNotFound;
3748 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3749 docstring const text = bformat(_("An emergency save of the document "
3750 "%1$s exists.\n\nRecover emergency save?"), file);
3752 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3753 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3759 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3760 bool const success = (ret_llf == ReadSuccess);
3763 Alert::warning(_("File is read-only"),
3764 bformat(_("An emergency file is successfully loaded, "
3765 "but the original file %1$s is marked read-only. "
3766 "Please make sure to save the document as a different "
3767 "file."), from_utf8(d->filename.absFileName())));
3770 str = _("Document was successfully recovered.");
3772 str = _("Document was NOT successfully recovered.");
3773 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3774 makeDisplayPath(emergencyFile.absFileName()));
3776 int const del_emerg =
3777 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3778 _("&Remove"), _("&Keep"));
3779 if (del_emerg == 0) {
3780 emergencyFile.removeFile();
3782 Alert::warning(_("Emergency file deleted"),
3783 _("Do not forget to save your file now!"), true);
3785 return success ? ReadSuccess : ReadEmergencyFailure;
3788 int const del_emerg =
3789 Alert::prompt(_("Delete emergency file?"),
3790 _("Remove emergency file now?"), 1, 1,
3791 _("&Remove"), _("&Keep"));
3793 emergencyFile.removeFile();
3794 return ReadOriginal;
3804 Buffer::ReadStatus Buffer::loadAutosave()
3806 // Now check if autosave file is newer.
3807 FileName const autosaveFile = getAutosaveFileName();
3808 if (!autosaveFile.exists()
3809 || autosaveFile.lastModified() <= d->filename.lastModified())
3810 return ReadFileNotFound;
3812 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3813 docstring const text = bformat(_("The backup of the document %1$s "
3814 "is newer.\n\nLoad the backup instead?"), file);
3815 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3816 _("&Load backup"), _("Load &original"), _("&Cancel"));
3821 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3822 // the file is not saved if we load the autosave file.
3823 if (ret_llf == ReadSuccess) {
3825 Alert::warning(_("File is read-only"),
3826 bformat(_("A backup file is successfully loaded, "
3827 "but the original file %1$s is marked read-only. "
3828 "Please make sure to save the document as a "
3830 from_utf8(d->filename.absFileName())));
3835 return ReadAutosaveFailure;
3838 // Here we delete the autosave
3839 autosaveFile.removeFile();
3840 return ReadOriginal;
3848 Buffer::ReadStatus Buffer::loadLyXFile()
3850 if (!d->filename.isReadableFile()) {
3851 ReadStatus const ret_rvc = extractFromVC();
3852 if (ret_rvc != ReadSuccess)
3856 ReadStatus const ret_re = loadEmergency();
3857 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3860 ReadStatus const ret_ra = loadAutosave();
3861 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3864 return loadThisLyXFile(d->filename);
3868 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3870 return readFile(fn);
3874 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3876 TeXErrors::Errors::const_iterator cit = terr.begin();
3877 TeXErrors::Errors::const_iterator end = terr.end();
3879 for (; cit != end; ++cit) {
3882 int errorRow = cit->error_in_line;
3883 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3889 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3890 } while (found && id_start == id_end && pos_start == pos_end);
3892 errorList.push_back(ErrorItem(cit->error_desc,
3893 cit->error_text, id_start, pos_start, pos_end));
3898 void Buffer::setBuffersForInsets() const
3900 inset().setBuffer(const_cast<Buffer &>(*this));
3904 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3906 // Use the master text class also for child documents
3907 Buffer const * const master = masterBuffer();
3908 DocumentClass const & textclass = master->params().documentClass();
3910 // do this only if we are the top-level Buffer
3912 reloadBibInfoCache();
3914 // keep the buffers to be children in this set. If the call from the
3915 // master comes back we can see which of them were actually seen (i.e.
3916 // via an InsetInclude). The remaining ones in the set need still be updated.
3917 static std::set<Buffer const *> bufToUpdate;
3918 if (scope == UpdateMaster) {
3919 // If this is a child document start with the master
3920 if (master != this) {
3921 bufToUpdate.insert(this);
3922 master->updateBuffer(UpdateMaster, utype);
3923 // Do this here in case the master has no gui associated with it. Then,
3924 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3925 if (!master->d->gui_)
3928 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3929 if (bufToUpdate.find(this) == bufToUpdate.end())
3933 // start over the counters in the master
3934 textclass.counters().reset();
3937 // update will be done below for this buffer
3938 bufToUpdate.erase(this);
3940 // update all caches
3941 clearReferenceCache();
3944 Buffer & cbuf = const_cast<Buffer &>(*this);
3946 LASSERT(!text().paragraphs().empty(), /**/);
3949 ParIterator parit = cbuf.par_iterator_begin();
3950 updateBuffer(parit, utype);
3953 // TocBackend update will be done later.
3956 d->bibinfo_cache_valid_ = true;
3957 cbuf.tocBackend().update();
3958 if (scope == UpdateMaster)
3959 cbuf.structureChanged();
3963 static depth_type getDepth(DocIterator const & it)
3965 depth_type depth = 0;
3966 for (size_t i = 0 ; i < it.depth() ; ++i)
3967 if (!it[i].inset().inMathed())
3968 depth += it[i].paragraph().getDepth() + 1;
3969 // remove 1 since the outer inset does not count
3973 static depth_type getItemDepth(ParIterator const & it)
3975 Paragraph const & par = *it;
3976 LabelType const labeltype = par.layout().labeltype;
3978 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3981 // this will hold the lowest depth encountered up to now.
3982 depth_type min_depth = getDepth(it);
3983 ParIterator prev_it = it;
3986 --prev_it.top().pit();
3988 // start of nested inset: go to outer par
3990 if (prev_it.empty()) {
3991 // start of document: nothing to do
3996 // We search for the first paragraph with same label
3997 // that is not more deeply nested.
3998 Paragraph & prev_par = *prev_it;
3999 depth_type const prev_depth = getDepth(prev_it);
4000 if (labeltype == prev_par.layout().labeltype) {
4001 if (prev_depth < min_depth)
4002 return prev_par.itemdepth + 1;
4003 if (prev_depth == min_depth)
4004 return prev_par.itemdepth;
4006 min_depth = min(min_depth, prev_depth);
4007 // small optimization: if we are at depth 0, we won't
4008 // find anything else
4009 if (prev_depth == 0)
4015 static bool needEnumCounterReset(ParIterator const & it)
4017 Paragraph const & par = *it;
4018 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4019 depth_type const cur_depth = par.getDepth();
4020 ParIterator prev_it = it;
4021 while (prev_it.pit()) {
4022 --prev_it.top().pit();
4023 Paragraph const & prev_par = *prev_it;
4024 if (prev_par.getDepth() <= cur_depth)
4025 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4027 // start of nested inset: reset
4032 // set the label of a paragraph. This includes the counters.
4033 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4035 BufferParams const & bp = owner_->masterBuffer()->params();
4036 DocumentClass const & textclass = bp.documentClass();
4037 Paragraph & par = it.paragraph();
4038 Layout const & layout = par.layout();
4039 Counters & counters = textclass.counters();
4041 if (par.params().startOfAppendix()) {
4042 // FIXME: only the counter corresponding to toplevel
4043 // sectioning should be reset
4045 counters.appendix(true);
4047 par.params().appendix(counters.appendix());
4049 // Compute the item depth of the paragraph
4050 par.itemdepth = getItemDepth(it);
4052 if (layout.margintype == MARGIN_MANUAL
4053 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
4054 if (par.params().labelWidthString().empty())
4055 par.params().labelWidthString(par.expandLabel(layout, bp));
4057 par.params().labelWidthString(docstring());
4060 switch(layout.labeltype) {
4062 if (layout.toclevel <= bp.secnumdepth
4063 && (layout.latextype != LATEX_ENVIRONMENT
4064 || it.text()->isFirstInSequence(it.pit()))) {
4065 if (counters.hasCounter(layout.counter))
4066 counters.step(layout.counter, utype);
4067 par.params().labelString(par.expandLabel(layout, bp));
4069 par.params().labelString(docstring());
4072 case LABEL_ITEMIZE: {
4073 // At some point of time we should do something more
4074 // clever here, like:
4075 // par.params().labelString(
4076 // bp.user_defined_bullet(par.itemdepth).getText());
4077 // for now, use a simple hardcoded label
4078 docstring itemlabel;
4079 switch (par.itemdepth) {
4081 itemlabel = char_type(0x2022);
4084 itemlabel = char_type(0x2013);
4087 itemlabel = char_type(0x2217);
4090 itemlabel = char_type(0x2219); // or 0x00b7
4093 par.params().labelString(itemlabel);
4097 case LABEL_ENUMERATE: {
4098 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4100 switch (par.itemdepth) {
4109 enumcounter += "iv";
4112 // not a valid enumdepth...
4116 // Maybe we have to reset the enumeration counter.
4117 if (needEnumCounterReset(it))
4118 counters.reset(enumcounter);
4119 counters.step(enumcounter, utype);
4121 string const & lang = par.getParLanguage(bp)->code();
4122 par.params().labelString(counters.theCounter(enumcounter, lang));
4127 case LABEL_SENSITIVE: {
4128 string const & type = counters.current_float();
4129 docstring full_label;
4131 full_label = owner_->B_("Senseless!!! ");
4133 docstring name = owner_->B_(textclass.floats().getType(type).name());
4134 if (counters.hasCounter(from_utf8(type))) {
4135 string const & lang = par.getParLanguage(bp)->code();
4136 counters.step(from_utf8(type), utype);
4137 full_label = bformat(from_ascii("%1$s %2$s:"),
4139 counters.theCounter(from_utf8(type), lang));
4141 full_label = bformat(from_ascii("%1$s #:"), name);
4143 par.params().labelString(full_label);
4147 case LABEL_NO_LABEL:
4148 par.params().labelString(docstring());
4152 case LABEL_TOP_ENVIRONMENT:
4153 case LABEL_CENTERED_TOP_ENVIRONMENT:
4156 par.params().labelString(par.expandLabel(layout, bp));
4162 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4164 LASSERT(parit.pit() == 0, /**/);
4166 // Set the position of the text in the buffer to be able
4167 // to resolve macros in it.
4168 parit.text()->setMacrocontextPosition(parit);
4170 depth_type maxdepth = 0;
4171 pit_type const lastpit = parit.lastpit();
4172 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4173 // reduce depth if necessary
4174 parit->params().depth(min(parit->params().depth(), maxdepth));
4175 maxdepth = parit->getMaxDepthAfter();
4177 if (utype == OutputUpdate) {
4178 // track the active counters
4179 // we have to do this for the master buffer, since the local
4180 // buffer isn't tracking anything.
4181 masterBuffer()->params().documentClass().counters().
4182 setActiveLayout(parit->layout());
4185 // set the counter for this paragraph
4186 d->setLabel(parit, utype);
4189 InsetList::const_iterator iit = parit->insetList().begin();
4190 InsetList::const_iterator end = parit->insetList().end();
4191 for (; iit != end; ++iit) {
4192 parit.pos() = iit->pos;
4193 iit->inset->updateBuffer(parit, utype);
4199 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4200 WordLangTuple & word_lang, docstring_list & suggestions) const
4204 suggestions.clear();
4205 word_lang = WordLangTuple();
4206 // OK, we start from here.
4207 DocIterator const end = doc_iterator_end(this);
4208 for (; from != end; from.forwardPos()) {
4209 // We are only interested in text so remove the math CursorSlice.
4210 while (from.inMathed()) {
4214 // If from is at the end of the document (which is possible
4215 // when leaving the mathed) LyX will crash later.
4219 from.paragraph().spellCheck();
4220 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4221 if (SpellChecker::misspelled(res)) {
4226 // Do not increase progress when from == to, otherwise the word
4227 // count will be wrong.
4237 Buffer::ReadStatus Buffer::reload()
4240 // c.f. bug http://www.lyx.org/trac/ticket/6587
4241 removeAutosaveFile();
4242 // e.g., read-only status could have changed due to version control
4243 d->filename.refresh();
4244 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4246 ReadStatus const status = loadLyXFile();
4247 if (status == ReadSuccess) {
4252 message(bformat(_("Document %1$s reloaded."), disp_fn));
4254 message(bformat(_("Could not reload document %1$s."), disp_fn));
4264 bool Buffer::saveAs(FileName const & fn)
4266 FileName const old_name = fileName();
4267 FileName const old_auto = getAutosaveFileName();
4268 bool const old_unnamed = isUnnamed();
4275 // bring the autosave file with us, just in case.
4276 moveAutosaveFile(old_auto);
4277 // validate version control data and
4278 // correct buffer title
4279 lyxvc().file_found_hook(fileName());
4281 // the file has now been saved to the new location.
4282 // we need to check that the locations of child buffers
4284 checkChildBuffers();
4288 // reset the old filename and unnamed state
4289 setFileName(old_name);
4290 setUnnamed(old_unnamed);
4296 // FIXME We could do better here, but it is complicated. What would be
4297 // nice is to offer either (a) to save the child buffer to an appropriate
4298 // location, so that it would "move with the master", or else (b) to update
4299 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4300 // complicated, because the code for this lives in GuiView.
4301 void Buffer::checkChildBuffers()
4303 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4304 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4305 for (; it != en; ++it) {
4306 DocIterator dit = it->second;
4307 Buffer * cbuf = const_cast<Buffer *>(it->first);
4308 if (!cbuf || !theBufferList().isLoaded(cbuf))
4310 Inset * inset = dit.nextInset();
4311 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4312 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4313 docstring const & incfile = inset_inc->getParam("filename");
4314 string oldloc = cbuf->absFileName();
4315 string newloc = makeAbsPath(to_utf8(incfile),
4316 onlyPath(absFileName())).absFileName();
4317 if (oldloc == newloc)
4319 // the location of the child file is incorrect.
4320 Alert::warning(_("Included File Invalid"),
4321 bformat(_("Saving this document to a new location has made the file:\n"
4323 "inaccessible. You will need to update the included filename."),
4324 from_utf8(oldloc)));
4326 inset_inc->setChildBuffer(0);
4328 // invalidate cache of children
4329 d->children_positions.clear();
4330 d->position_to_children.clear();