3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibtex.h"
70 #include "insets/InsetBranch.h"
71 #include "insets/InsetInclude.h"
72 #include "insets/InsetTabular.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "frontends/alert.h"
81 #include "frontends/Delegates.h"
82 #include "frontends/WorkAreaManager.h"
84 #include "graphics/Previews.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include "support/bind.h"
107 #include "support/shared_ptr.h"
119 using namespace lyx::support;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 // Do not remove the comment below, so we get merge conflict in
129 // independent branches. Instead add your own.
130 int const LYX_FORMAT = 413; // rgh: html_css_as_file
132 typedef map<string, bool> DepClean;
133 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
135 void showPrintError(string const & name)
137 docstring str = bformat(_("Could not print the document %1$s.\n"
138 "Check that your printer is set up correctly."),
139 makeDisplayPath(name, 50));
140 Alert::error(_("Print document failed"), str);
149 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
160 /// search for macro in local (buffer) table or in children
161 MacroData const * getBufferMacro(docstring const & name,
162 DocIterator const & pos) const;
164 /// Update macro table starting with position of it \param it in some
166 void updateMacros(DocIterator & it, DocIterator & scope);
168 void setLabel(ParIterator & it, UpdateType utype) const;
170 /** If we have branches that use the file suffix
171 feature, return the file name with suffix appended.
173 support::FileName exportFileName() const;
180 mutable TexRow texrow;
182 /// need to regenerate .tex?
186 mutable bool lyx_clean;
188 /// is autosave needed?
189 mutable bool bak_clean;
191 /// is this an unnamed file (New...)?
197 /// name of the file the buffer is associated with.
200 /** Set to true only when the file is fully loaded.
201 * Used to prevent the premature generation of previews
202 * and by the citation inset.
204 bool file_fully_loaded;
207 mutable TocBackend toc_backend;
210 typedef pair<DocIterator, MacroData> ScopeMacro;
211 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
212 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
213 /// map from the macro name to the position map,
214 /// which maps the macro definition position to the scope and the MacroData.
215 NamePositionScopeMacroMap macros;
216 /// This seem to change the way Buffer::getMacro() works
217 mutable bool macro_lock;
219 /// positions of child buffers in the buffer
220 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
221 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
222 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
223 /// position of children buffers in this buffer
224 BufferPositionMap children_positions;
225 /// map from children inclusion positions to their scope and their buffer
226 PositionScopeBufferMap position_to_children;
228 /// Container for all sort of Buffer dependant errors.
229 map<string, ErrorList> errorLists;
231 /// timestamp and checksum used to test if the file has been externally
232 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
234 unsigned long checksum_;
237 frontend::WorkAreaManager * wa_;
239 frontend::GuiBufferDelegate * gui_;
244 /// A cache for the bibfiles (including bibfiles of loaded child
245 /// documents), needed for appropriate update of natbib labels.
246 mutable support::FileNameList bibfiles_cache_;
248 // FIXME The caching mechanism could be improved. At present, we have a
249 // cache for each Buffer, that caches all the bibliography info for that
250 // Buffer. A more efficient solution would be to have a global cache per
251 // file, and then to construct the Buffer's bibinfo from that.
252 /// A cache for bibliography info
253 mutable BiblioInfo bibinfo_;
254 /// whether the bibinfo cache is valid
255 mutable bool bibinfo_cache_valid_;
256 /// whether the bibfile cache is valid
257 mutable bool bibfile_cache_valid_;
258 /// Cache of timestamps of .bib files
259 map<FileName, time_t> bibfile_status_;
260 /// Indicates whether the bibinfo has changed since the last time
261 /// we ran updateBuffer(), i.e., whether citation labels may need
263 mutable bool cite_labels_valid_;
265 mutable RefCache ref_cache_;
267 /// our Text that should be wrapped in an InsetText
270 /// This is here to force the test to be done whenever parent_buffer
272 Buffer const * parent() const {
273 // if parent_buffer is not loaded, then it has been unloaded,
274 // which means that parent_buffer is an invalid pointer. So we
275 // set it to null in that case.
276 // however, the BufferList doesn't know about cloned buffers, so
277 // they will always be regarded as unloaded. in that case, we hope
279 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
281 return parent_buffer;
285 void setParent(Buffer const * pb) {
286 if (parent_buffer == pb)
289 if (!cloned_buffer_ && parent_buffer && pb)
290 LYXERR0("Warning: a buffer should not have two parents!");
292 if (!cloned_buffer_ && parent_buffer) {
293 parent_buffer->invalidateBibfileCache();
294 parent_buffer->invalidateBibinfoCache();
298 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
299 /// This one is useful for preview detached in a thread.
300 Buffer const * cloned_buffer_;
301 /// are we in the process of exporting this buffer?
302 mutable bool doing_export;
305 /// So we can force access via the accessors.
306 mutable Buffer const * parent_buffer;
311 /// Creates the per buffer temporary directory
312 static FileName createBufferTmpDir()
315 // We are in our own directory. Why bother to mangle name?
316 // In fact I wrote this code to circumvent a problematic behaviour
317 // (bug?) of EMX mkstemp().
318 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
319 convert<string>(count++));
321 if (!tmpfl.createDirectory(0777)) {
322 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
323 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
324 from_utf8(tmpfl.absFileName())));
330 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
331 Buffer const * cloned_buffer)
332 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
333 read_only(readonly_), filename(file), file_fully_loaded(false),
334 toc_backend(owner), macro_lock(false), timestamp_(0),
335 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
336 bibfile_cache_valid_(false), cite_labels_valid_(false),
337 cloned_buffer_(cloned_buffer), doing_export(false), parent_buffer(0)
339 if (!cloned_buffer_) {
340 temppath = createBufferTmpDir();
341 lyxvc.setBuffer(owner_);
343 wa_ = new frontend::WorkAreaManager;
346 temppath = cloned_buffer_->d->temppath;
347 file_fully_loaded = true;
348 params = cloned_buffer_->d->params;
349 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
350 bibinfo_ = cloned_buffer_->d->bibinfo_;
351 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
352 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
353 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
354 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
358 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
359 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
361 LYXERR(Debug::INFO, "Buffer::Buffer()");
363 d->inset = new InsetText(*cloned_buffer->d->inset);
364 d->inset->setBuffer(*this);
365 // FIXME: optimize this loop somewhat, maybe by creating a new
366 // general recursive Inset::setId().
367 DocIterator it = doc_iterator_begin(this);
368 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
369 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
370 it.paragraph().setId(cloned_it.paragraph().id());
372 d->inset = new InsetText(this);
373 d->inset->setAutoBreakRows(true);
374 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
380 LYXERR(Debug::INFO, "Buffer::~Buffer()");
381 // here the buffer should take care that it is
382 // saved properly, before it goes into the void.
384 // GuiView already destroyed
388 // No need to do additional cleanups for internal buffer.
393 // loop over children
394 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
395 Impl::BufferPositionMap::iterator end = d->children_positions.end();
396 for (; it != end; ++it) {
397 Buffer * child = const_cast<Buffer *>(it->first);
398 if (d->cloned_buffer_)
400 // The child buffer might have been closed already.
401 else if (theBufferList().isLoaded(child))
402 theBufferList().releaseChild(this, child);
406 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
407 msg += emergencyWrite();
408 Alert::warning(_("Attempting to close changed document!"), msg);
411 // clear references to children in macro tables
412 d->children_positions.clear();
413 d->position_to_children.clear();
415 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
416 Alert::warning(_("Could not remove temporary directory"),
417 bformat(_("Could not remove the temporary directory %1$s"),
418 from_utf8(d->temppath.absFileName())));
428 Buffer * Buffer::clone() const
430 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
431 buffer_clone->d->macro_lock = true;
432 buffer_clone->d->children_positions.clear();
433 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
434 // math macro caches need to be rethought and simplified.
435 // I am not sure wether we should handle Buffer cloning here or in BufferList.
436 // Right now BufferList knows nothing about buffer clones.
437 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
438 Impl::BufferPositionMap::iterator end = d->children_positions.end();
439 for (; it != end; ++it) {
440 DocIterator dit = it->second.clone(buffer_clone);
441 dit.setBuffer(buffer_clone);
442 Buffer * child = const_cast<Buffer *>(it->first);
443 Buffer * child_clone = child->clone();
444 Inset * inset = dit.nextInset();
445 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
446 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
447 inset_inc->setChildBuffer(child_clone);
448 child_clone->d->setParent(buffer_clone);
449 buffer_clone->setChild(dit, child_clone);
451 buffer_clone->d->macro_lock = false;
456 bool Buffer::isClone() const
458 return d->cloned_buffer_;
462 void Buffer::changed(bool update_metrics) const
465 d->wa_->redrawAll(update_metrics);
469 frontend::WorkAreaManager & Buffer::workAreaManager() const
471 LASSERT(d->wa_, /**/);
476 Text & Buffer::text() const
478 return d->inset->text();
482 Inset & Buffer::inset() const
488 BufferParams & Buffer::params()
494 BufferParams const & Buffer::params() const
500 ParagraphList & Buffer::paragraphs()
502 return text().paragraphs();
506 ParagraphList const & Buffer::paragraphs() const
508 return text().paragraphs();
512 LyXVC & Buffer::lyxvc()
518 LyXVC const & Buffer::lyxvc() const
524 string const Buffer::temppath() const
526 return d->temppath.absFileName();
530 TexRow & Buffer::texrow()
536 TexRow const & Buffer::texrow() const
542 TocBackend & Buffer::tocBackend() const
544 return d->toc_backend;
548 Undo & Buffer::undo()
554 void Buffer::setChild(DocIterator const & dit, Buffer * child)
556 d->children_positions[child] = dit;
560 string Buffer::latexName(bool const no_path) const
562 FileName latex_name =
563 makeLatexName(d->exportFileName());
564 return no_path ? latex_name.onlyFileName()
565 : latex_name.absFileName();
569 FileName Buffer::Impl::exportFileName() const
571 docstring const branch_suffix =
572 params.branchlist().getFileNameSuffix();
573 if (branch_suffix.empty())
576 string const name = filename.onlyFileNameWithoutExt()
577 + to_utf8(branch_suffix);
578 FileName res(filename.onlyPath().absFileName() + "/" + name);
579 res.changeExtension(filename.extension());
585 string Buffer::logName(LogType * type) const
587 string const filename = latexName(false);
589 if (filename.empty()) {
595 string const path = temppath();
597 FileName const fname(addName(temppath(),
598 onlyFileName(changeExtension(filename,
601 // FIXME: how do we know this is the name of the build log?
602 FileName const bname(
603 addName(path, onlyFileName(
604 changeExtension(filename,
605 formats.extension(bufferFormat()) + ".out"))));
607 // Also consider the master buffer log file
608 FileName masterfname = fname;
610 if (masterBuffer() != this) {
611 string const mlogfile = masterBuffer()->logName(&mtype);
612 masterfname = FileName(mlogfile);
615 // If no Latex log or Build log is newer, show Build log
616 if (bname.exists() &&
617 ((!fname.exists() && !masterfname.exists())
618 || (fname.lastModified() < bname.lastModified()
619 && masterfname.lastModified() < bname.lastModified()))) {
620 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
623 return bname.absFileName();
624 // If we have a newer master file log or only a master log, show this
625 } else if (fname != masterfname
626 && (!fname.exists() && (masterfname.exists()
627 || fname.lastModified() < masterfname.lastModified()))) {
628 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
631 return masterfname.absFileName();
633 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
636 return fname.absFileName();
640 void Buffer::setReadonly(bool const flag)
642 if (d->read_only != flag) {
649 void Buffer::setFileName(FileName const & fname)
652 setReadonly(d->filename.isReadOnly());
658 int Buffer::readHeader(Lexer & lex)
660 int unknown_tokens = 0;
662 int begin_header_line = -1;
664 // Initialize parameters that may be/go lacking in header:
665 params().branchlist().clear();
666 params().preamble.erase();
667 params().options.erase();
668 params().master.erase();
669 params().float_placement.erase();
670 params().paperwidth.erase();
671 params().paperheight.erase();
672 params().leftmargin.erase();
673 params().rightmargin.erase();
674 params().topmargin.erase();
675 params().bottommargin.erase();
676 params().headheight.erase();
677 params().headsep.erase();
678 params().footskip.erase();
679 params().columnsep.erase();
680 params().fonts_cjk.erase();
681 params().listings_params.clear();
682 params().clearLayoutModules();
683 params().clearRemovedModules();
684 params().clearIncludedChildren();
685 params().pdfoptions().clear();
686 params().indiceslist().clear();
687 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
688 params().isbackgroundcolor = false;
689 params().fontcolor = lyx::rgbFromHexName("#000000");
690 params().isfontcolor = false;
691 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
692 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
693 params().html_latex_start.clear();
694 params().html_latex_end.clear();
695 params().html_math_img_scale = 1.0;
696 params().output_sync_macro.erase();
698 for (int i = 0; i < 4; ++i) {
699 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
700 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
703 ErrorList & errorList = d->errorLists["Parse"];
712 if (token == "\\end_header")
716 if (token == "\\begin_header") {
717 begin_header_line = line;
721 LYXERR(Debug::PARSER, "Handling document header token: `"
724 string unknown = params().readToken(lex, token, d->filename.onlyPath());
725 if (!unknown.empty()) {
726 if (unknown[0] != '\\' && token == "\\textclass") {
727 Alert::warning(_("Unknown document class"),
728 bformat(_("Using the default document class, because the "
729 "class %1$s is unknown."), from_utf8(unknown)));
732 docstring const s = bformat(_("Unknown token: "
736 errorList.push_back(ErrorItem(_("Document header error"),
741 if (begin_header_line) {
742 docstring const s = _("\\begin_header is missing");
743 errorList.push_back(ErrorItem(_("Document header error"),
747 params().makeDocumentClass();
749 return unknown_tokens;
754 // changed to be public and have one parameter
755 // Returns true if "\end_document" is not read (Asger)
756 bool Buffer::readDocument(Lexer & lex)
758 ErrorList & errorList = d->errorLists["Parse"];
761 // remove dummy empty par
762 paragraphs().clear();
764 if (!lex.checkFor("\\begin_document")) {
765 docstring const s = _("\\begin_document is missing");
766 errorList.push_back(ErrorItem(_("Document header error"),
772 if (params().outputChanges) {
773 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
774 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
775 LaTeXFeatures::isAvailable("xcolor");
777 if (!dvipost && !xcolorulem) {
778 Alert::warning(_("Changes not shown in LaTeX output"),
779 _("Changes will not be highlighted in LaTeX output, "
780 "because neither dvipost nor xcolor/ulem are installed.\n"
781 "Please install these packages or redefine "
782 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
783 } else if (!xcolorulem) {
784 Alert::warning(_("Changes not shown in LaTeX output"),
785 _("Changes will not be highlighted in LaTeX output "
786 "when using pdflatex, because xcolor and ulem are not installed.\n"
787 "Please install both packages or redefine "
788 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
792 if (!params().master.empty()) {
793 FileName const master_file = makeAbsPath(params().master,
794 onlyPath(absFileName()));
795 if (isLyXFileName(master_file.absFileName())) {
797 checkAndLoadLyXFile(master_file, true);
799 // necessary e.g. after a reload
800 // to re-register the child (bug 5873)
801 // FIXME: clean up updateMacros (here, only
802 // child registering is needed).
803 master->updateMacros();
804 // set master as master buffer, but only
805 // if we are a real child
806 if (master->isChild(this))
808 // if the master is not fully loaded
809 // it is probably just loading this
810 // child. No warning needed then.
811 else if (master->isFullyLoaded())
812 LYXERR0("The master '"
814 << "' assigned to this document ("
816 << ") does not include "
817 "this document. Ignoring the master assignment.");
822 // assure we have a default index
823 params().indiceslist().addDefault(B_("Index"));
826 bool const res = text().read(lex, errorList, d->inset);
828 // inform parent buffer about local macros
830 Buffer const * pbuf = parent();
831 UserMacroSet::const_iterator cit = usermacros.begin();
832 UserMacroSet::const_iterator end = usermacros.end();
833 for (; cit != end; ++cit)
834 pbuf->usermacros.insert(*cit);
838 updateMacroInstances(InternalUpdate);
843 bool Buffer::readString(string const & s)
845 params().compressed = false;
850 FileName const fn = FileName::tempName("Buffer_readString");
853 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
854 if (ret_plf != ReadSuccess)
857 if (file_format != LYX_FORMAT) {
858 // We need to call lyx2lyx, so write the input to a file
859 ofstream os(fn.toFilesystemEncoding().c_str());
863 return readFile(fn) == ReadSuccess;
866 if (readDocument(lex))
872 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
879 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
880 if (ret_plf != ReadSuccess)
883 if (file_format != LYX_FORMAT) {
885 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
886 if (ret_clf != ReadSuccess)
888 return readFile(tmpFile);
891 // FIXME: InsetInfo needs to know whether the file is under VCS
892 // during the parse process, so this has to be done before.
893 lyxvc().file_found_hook(d->filename);
895 if (readDocument(lex)) {
896 Alert::error(_("Document format failure"),
897 bformat(_("%1$s ended unexpectedly, which means"
898 " that it is probably corrupted."),
899 from_utf8(fn.absFileName())));
900 return ReadDocumentFailure;
903 d->file_fully_loaded = true;
904 d->read_only = !d->filename.isWritable();
905 params().compressed = d->filename.isZippedFile();
911 bool Buffer::isFullyLoaded() const
913 return d->file_fully_loaded;
917 void Buffer::setFullyLoaded(bool value)
919 d->file_fully_loaded = value;
923 void Buffer::updatePreviews() const
925 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
926 thePreviews().generateBufferPreviews(*this);
930 void Buffer::removePreviews() const
932 thePreviews().removeLoader(*this);
936 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
937 FileName const & fn, int & file_format) const
939 if(!lex.checkFor("\\lyxformat")) {
940 Alert::error(_("Document format failure"),
941 bformat(_("%1$s is not a readable LyX document."),
942 from_utf8(fn.absFileName())));
943 return ReadNoLyXFormat;
949 // LyX formats 217 and earlier were written as 2.17. This corresponds
950 // to files from LyX versions < 1.1.6.3. We just remove the dot in
951 // these cases. See also: www.lyx.org/trac/changeset/1313.
952 size_t dot = tmp_format.find_first_of(".,");
953 if (dot != string::npos)
954 tmp_format.erase(dot, 1);
956 file_format = convert<int>(tmp_format);
961 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
962 FileName & tmpfile, int from_format)
964 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
965 if(tmpfile.empty()) {
966 Alert::error(_("Conversion failed"),
967 bformat(_("%1$s is from a different"
968 " version of LyX, but a temporary"
969 " file for converting it could"
971 from_utf8(fn.absFileName())));
972 return LyX2LyXNoTempFile;
975 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
976 if (lyx2lyx.empty()) {
977 Alert::error(_("Conversion script not found"),
978 bformat(_("%1$s is from a different"
979 " version of LyX, but the"
980 " conversion script lyx2lyx"
981 " could not be found."),
982 from_utf8(fn.absFileName())));
983 return LyX2LyXNotFound;
987 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
988 ostringstream command;
989 command << os::python()
990 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
991 << " -t " << convert<string>(LYX_FORMAT)
992 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
993 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
994 string const command_str = command.str();
996 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
998 cmd_ret const ret = runCommand(command_str);
999 if (ret.first != 0) {
1000 if (from_format < LYX_FORMAT) {
1001 Alert::error(_("Conversion script failed"),
1002 bformat(_("%1$s is from an older version"
1003 " of LyX and the lyx2lyx script"
1004 " failed to convert it."),
1005 from_utf8(fn.absFileName())));
1006 return LyX2LyXOlderFormat;
1008 Alert::error(_("Conversion script failed"),
1009 bformat(_("%1$s is from a newer version"
1010 " of LyX and the lyx2lyx script"
1011 " failed to convert it."),
1012 from_utf8(fn.absFileName())));
1013 return LyX2LyXNewerFormat;
1020 // Should probably be moved to somewhere else: BufferView? GuiView?
1021 bool Buffer::save() const
1023 docstring const file = makeDisplayPath(absFileName(), 20);
1024 d->filename.refresh();
1026 // check the read-only status before moving the file as a backup
1027 if (d->filename.exists()) {
1028 bool const read_only = !d->filename.isWritable();
1030 Alert::warning(_("File is read-only"),
1031 bformat(_("The file %1$s cannot be written because it "
1032 "is marked as read-only."), file));
1037 // ask if the disk file has been externally modified (use checksum method)
1038 if (fileName().exists() && isExternallyModified(checksum_method)) {
1040 bformat(_("Document %1$s has been externally modified. "
1041 "Are you sure you want to overwrite this file?"), file);
1042 int const ret = Alert::prompt(_("Overwrite modified file?"),
1043 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1048 // We don't need autosaves in the immediate future. (Asger)
1049 resetAutosaveTimers();
1051 FileName backupName;
1052 bool madeBackup = false;
1054 // make a backup if the file already exists
1055 if (lyxrc.make_backup && fileName().exists()) {
1056 backupName = FileName(absFileName() + '~');
1057 if (!lyxrc.backupdir_path.empty()) {
1058 string const mangledName =
1059 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1060 backupName = FileName(addName(lyxrc.backupdir_path,
1064 // Except file is symlink do not copy because of #6587.
1065 // Hard links have bad luck.
1066 if (fileName().isSymLink())
1067 madeBackup = fileName().copyTo(backupName);
1069 madeBackup = fileName().moveTo(backupName);
1072 Alert::error(_("Backup failure"),
1073 bformat(_("Cannot create backup file %1$s.\n"
1074 "Please check whether the directory exists and is writable."),
1075 from_utf8(backupName.absFileName())));
1076 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1080 if (writeFile(d->filename)) {
1084 // Saving failed, so backup is not backup
1086 backupName.moveTo(d->filename);
1092 bool Buffer::writeFile(FileName const & fname) const
1094 // FIXME Do we need to do these here? I don't think writing
1095 // the LyX file depends upon it. (RGH)
1097 // updateMacroInstances();
1099 if (d->read_only && fname == d->filename)
1102 bool retval = false;
1104 docstring const str = bformat(_("Saving document %1$s..."),
1105 makeDisplayPath(fname.absFileName()));
1108 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1110 if (params().compressed) {
1111 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1112 retval = ofs && write(ofs);
1114 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1115 retval = ofs && write(ofs);
1119 message(str + _(" could not write file!"));
1124 // removeAutosaveFile();
1127 message(str + _(" done."));
1133 docstring Buffer::emergencyWrite()
1135 // No need to save if the buffer has not changed.
1139 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1141 docstring user_message = bformat(
1142 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1144 // We try to save three places:
1145 // 1) Same place as document. Unless it is an unnamed doc.
1147 string s = absFileName();
1150 if (writeFile(FileName(s))) {
1152 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1153 return user_message;
1155 user_message += " " + _("Save failed! Trying again...\n");
1159 // 2) In HOME directory.
1160 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1162 lyxerr << ' ' << s << endl;
1163 if (writeFile(FileName(s))) {
1165 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1166 return user_message;
1169 user_message += " " + _("Save failed! Trying yet again...\n");
1171 // 3) In "/tmp" directory.
1172 // MakeAbsPath to prepend the current
1173 // drive letter on OS/2
1174 s = addName(package().temp_dir().absFileName(), absFileName());
1176 lyxerr << ' ' << s << endl;
1177 if (writeFile(FileName(s))) {
1179 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1180 return user_message;
1183 user_message += " " + _("Save failed! Bummer. Document is lost.");
1186 return user_message;
1190 bool Buffer::write(ostream & ofs) const
1193 // Use the standard "C" locale for file output.
1194 ofs.imbue(locale::classic());
1197 // The top of the file should not be written by params().
1199 // write out a comment in the top of the file
1200 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1201 << " created this file. For more info see http://www.lyx.org/\n"
1202 << "\\lyxformat " << LYX_FORMAT << "\n"
1203 << "\\begin_document\n";
1205 /// For each author, set 'used' to true if there is a change
1206 /// by this author in the document; otherwise set it to 'false'.
1207 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1208 AuthorList::Authors::const_iterator a_end = params().authors().end();
1209 for (; a_it != a_end; ++a_it)
1210 a_it->setUsed(false);
1212 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1213 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1214 for ( ; it != end; ++it)
1215 it->checkAuthors(params().authors());
1217 // now write out the buffer parameters.
1218 ofs << "\\begin_header\n";
1219 params().writeFile(ofs);
1220 ofs << "\\end_header\n";
1223 ofs << "\n\\begin_body\n";
1225 ofs << "\n\\end_body\n";
1227 // Write marker that shows file is complete
1228 ofs << "\\end_document" << endl;
1230 // Shouldn't really be needed....
1233 // how to check if close went ok?
1234 // Following is an attempt... (BE 20001011)
1236 // good() returns false if any error occured, including some
1237 // formatting error.
1238 // bad() returns true if something bad happened in the buffer,
1239 // which should include file system full errors.
1244 lyxerr << "File was not closed properly." << endl;
1251 bool Buffer::makeLaTeXFile(FileName const & fname,
1252 string const & original_path,
1253 OutputParams const & runparams_in,
1254 bool output_preamble, bool output_body) const
1256 OutputParams runparams = runparams_in;
1258 // This is necessary for LuaTeX/XeTeX with tex fonts.
1259 // See FIXME in BufferParams::encoding()
1260 if (runparams.isFullUnicode())
1261 runparams.encoding = encodings.fromLyXName("utf8-plain");
1263 string const encoding = runparams.encoding->iconvName();
1264 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1267 try { ofs.reset(encoding); }
1268 catch (iconv_codecvt_facet_exception & e) {
1269 lyxerr << "Caught iconv exception: " << e.what() << endl;
1270 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1271 "verify that the support software for your encoding (%1$s) is "
1272 "properly installed"), from_ascii(encoding)));
1275 if (!openFileWrite(ofs, fname))
1278 //TexStream ts(ofs.rdbuf(), &texrow());
1279 ErrorList & errorList = d->errorLists["Export"];
1281 bool failed_export = false;
1282 otexstream os(ofs, d->texrow);
1284 // make sure we are ready to export
1285 // this needs to be done before we validate
1286 // FIXME Do we need to do this all the time? I.e., in children
1287 // of a master we are exporting?
1289 updateMacroInstances(OutputUpdate);
1292 os.texrow().reset();
1293 writeLaTeXSource(os, original_path,
1294 runparams, output_preamble, output_body);
1296 catch (EncodingException & e) {
1297 odocstringstream ods;
1298 ods.put(e.failed_char);
1300 oss << "0x" << hex << e.failed_char << dec;
1301 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1302 " (code point %2$s)"),
1303 ods.str(), from_utf8(oss.str()));
1304 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1305 "representable in the chosen encoding.\n"
1306 "Changing the document encoding to utf8 could help."),
1307 e.par_id, e.pos, e.pos + 1));
1308 failed_export = true;
1310 catch (iconv_codecvt_facet_exception & e) {
1311 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1312 _(e.what()), -1, 0, 0));
1313 failed_export = true;
1315 catch (exception const & e) {
1316 errorList.push_back(ErrorItem(_("conversion failed"),
1317 _(e.what()), -1, 0, 0));
1318 failed_export = true;
1321 lyxerr << "Caught some really weird exception..." << endl;
1327 failed_export = true;
1328 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1332 return !failed_export;
1336 void Buffer::writeLaTeXSource(otexstream & os,
1337 string const & original_path,
1338 OutputParams const & runparams_in,
1339 bool const output_preamble, bool const output_body) const
1341 // The child documents, if any, shall be already loaded at this point.
1343 OutputParams runparams = runparams_in;
1345 // Classify the unicode characters appearing in math insets
1346 Encodings::initUnicodeMath(*this);
1348 // validate the buffer.
1349 LYXERR(Debug::LATEX, " Validating buffer...");
1350 LaTeXFeatures features(*this, params(), runparams);
1352 LYXERR(Debug::LATEX, " Buffer validation done.");
1354 // The starting paragraph of the coming rows is the
1355 // first paragraph of the document. (Asger)
1356 if (output_preamble && runparams.nice) {
1357 os << "%% LyX " << lyx_version << " created this file. "
1358 "For more info, see http://www.lyx.org/.\n"
1359 "%% Do not edit unless you really know what "
1362 LYXERR(Debug::INFO, "lyx document header finished");
1364 // There are a few differences between nice LaTeX and usual files:
1365 // usual is \batchmode and has a
1366 // special input@path to allow the including of figures
1367 // with either \input or \includegraphics (what figinsets do).
1368 // input@path is set when the actual parameter
1369 // original_path is set. This is done for usual tex-file, but not
1370 // for nice-latex-file. (Matthias 250696)
1371 // Note that input@path is only needed for something the user does
1372 // in the preamble, included .tex files or ERT, files included by
1373 // LyX work without it.
1374 if (output_preamble) {
1375 if (!runparams.nice) {
1376 // code for usual, NOT nice-latex-file
1377 os << "\\batchmode\n"; // changed from \nonstopmode
1379 if (!original_path.empty()) {
1381 // We don't know the encoding of inputpath
1382 docstring const inputpath = from_utf8(support::latex_path(original_path));
1383 docstring uncodable_glyphs;
1384 Encoding const * const enc = runparams.encoding;
1386 for (size_t n = 0; n < inputpath.size(); ++n) {
1387 docstring const glyph =
1388 docstring(1, inputpath[n]);
1389 if (enc->latexChar(inputpath[n], true) != glyph) {
1390 LYXERR0("Uncodable character '"
1392 << "' in input path!");
1393 uncodable_glyphs += glyph;
1398 // warn user if we found uncodable glyphs.
1399 if (!uncodable_glyphs.empty()) {
1400 frontend::Alert::warning(_("Uncodable character in file path"),
1401 support::bformat(_("The path of your document\n"
1403 "contains glyphs that are unknown in the\n"
1404 "current document encoding (namely %2$s).\n"
1405 "This will likely result in incomplete output.\n\n"
1406 "Choose an appropriate document encoding (such as utf8)\n"
1407 "or change the file path name."), inputpath, uncodable_glyphs));
1409 os << "\\makeatletter\n"
1410 << "\\def\\input@path{{"
1411 << inputpath << "/}}\n"
1412 << "\\makeatother\n";
1416 // get parent macros (if this buffer has a parent) which will be
1417 // written at the document begin further down.
1418 MacroSet parentMacros;
1419 listParentMacros(parentMacros, features);
1421 runparams.use_polyglossia = features.usePolyglossia();
1422 // Write the preamble
1423 runparams.use_babel = params().writeLaTeX(os, features,
1424 d->filename.onlyPath());
1426 runparams.use_japanese = features.isRequired("japanese");
1432 os << "\\begin{document}\n";
1434 // output the parent macros
1435 MacroSet::iterator it = parentMacros.begin();
1436 MacroSet::iterator end = parentMacros.end();
1437 for (; it != end; ++it) {
1438 int num_lines = (*it)->write(os.os(), true);
1439 os.texrow().newlines(num_lines);
1442 } // output_preamble
1444 os.texrow().start(paragraphs().begin()->id(), 0);
1446 LYXERR(Debug::INFO, "preamble finished, now the body.");
1448 // if we are doing a real file with body, even if this is the
1449 // child of some other buffer, let's cut the link here.
1450 // This happens for example if only a child document is printed.
1451 Buffer const * save_parent = 0;
1452 if (output_preamble) {
1453 save_parent = d->parent();
1458 latexParagraphs(*this, text(), os, runparams);
1460 // Restore the parenthood if needed
1461 if (output_preamble)
1462 d->setParent(save_parent);
1464 // add this just in case after all the paragraphs
1467 if (output_preamble) {
1468 os << "\\end{document}\n";
1469 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1471 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1473 runparams_in.encoding = runparams.encoding;
1475 // Just to be sure. (Asger)
1476 os.texrow().newline();
1478 //for (int i = 0; i<d->texrow.rows(); i++) {
1480 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1481 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1484 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1485 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1489 bool Buffer::isLatex() const
1491 return params().documentClass().outputType() == LATEX;
1495 bool Buffer::isLiterate() const
1497 return params().documentClass().outputType() == LITERATE;
1501 bool Buffer::isDocBook() const
1503 return params().documentClass().outputType() == DOCBOOK;
1507 void Buffer::makeDocBookFile(FileName const & fname,
1508 OutputParams const & runparams,
1509 bool const body_only) const
1511 LYXERR(Debug::LATEX, "makeDocBookFile...");
1514 if (!openFileWrite(ofs, fname))
1517 // make sure we are ready to export
1518 // this needs to be done before we validate
1520 updateMacroInstances(OutputUpdate);
1522 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1526 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1530 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1531 OutputParams const & runparams,
1532 bool const only_body) const
1534 LaTeXFeatures features(*this, params(), runparams);
1539 DocumentClass const & tclass = params().documentClass();
1540 string const top_element = tclass.latexname();
1543 if (runparams.flavor == OutputParams::XML)
1544 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1547 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1550 if (! tclass.class_header().empty())
1551 os << from_ascii(tclass.class_header());
1552 else if (runparams.flavor == OutputParams::XML)
1553 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1554 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1556 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1558 docstring preamble = from_utf8(params().preamble);
1559 if (runparams.flavor != OutputParams::XML ) {
1560 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1561 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1562 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1563 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1566 string const name = runparams.nice
1567 ? changeExtension(absFileName(), ".sgml") : fname;
1568 preamble += features.getIncludedFiles(name);
1569 preamble += features.getLyXSGMLEntities();
1571 if (!preamble.empty()) {
1572 os << "\n [ " << preamble << " ]";
1577 string top = top_element;
1579 if (runparams.flavor == OutputParams::XML)
1580 top += params().language->code();
1582 top += params().language->code().substr(0, 2);
1585 if (!params().options.empty()) {
1587 top += params().options;
1590 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1591 << " file was created by LyX " << lyx_version
1592 << "\n See http://www.lyx.org/ for more information -->\n";
1594 params().documentClass().counters().reset();
1596 sgml::openTag(os, top);
1598 docbookParagraphs(text(), *this, os, runparams);
1599 sgml::closeTag(os, top_element);
1603 void Buffer::makeLyXHTMLFile(FileName const & fname,
1604 OutputParams const & runparams,
1605 bool const body_only) const
1607 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1610 if (!openFileWrite(ofs, fname))
1613 // make sure we are ready to export
1614 // this has to be done before we validate
1615 updateBuffer(UpdateMaster, OutputUpdate);
1616 updateMacroInstances(OutputUpdate);
1618 writeLyXHTMLSource(ofs, runparams, body_only);
1622 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1626 void Buffer::writeLyXHTMLSource(odocstream & os,
1627 OutputParams const & runparams,
1628 bool const only_body) const
1630 LaTeXFeatures features(*this, params(), runparams);
1632 d->bibinfo_.makeCitationLabels(*this);
1635 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1636 << "<!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"
1637 // FIXME Language should be set properly.
1638 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1640 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1641 // FIXME Presumably need to set this right
1642 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1644 docstring const & doctitle = features.htmlTitle();
1646 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1649 os << "\n<!-- Text Class Preamble -->\n"
1650 << features.getTClassHTMLPreamble()
1651 << "\n<!-- Preamble Snippets -->\n"
1652 << from_utf8(features.getPreambleSnippets());
1654 os << "\n<!-- Layout-provided Styles -->\n";
1655 docstring const styleinfo = features.getTClassHTMLStyles();
1656 if (!styleinfo.empty()) {
1657 os << "<style type='text/css'>\n"
1661 os << "</head>\n<body>\n";
1665 params().documentClass().counters().reset();
1666 xhtmlParagraphs(text(), *this, xs, runparams);
1668 os << "</body>\n</html>\n";
1672 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1673 // Other flags: -wall -v0 -x
1674 int Buffer::runChktex()
1678 // get LaTeX-Filename
1679 FileName const path(temppath());
1680 string const name = addName(path.absFileName(), latexName());
1681 string const org_path = filePath();
1683 PathChanger p(path); // path to LaTeX file
1684 message(_("Running chktex..."));
1686 // Generate the LaTeX file if neccessary
1687 OutputParams runparams(¶ms().encoding());
1688 runparams.flavor = OutputParams::LATEX;
1689 runparams.nice = false;
1690 runparams.linelen = lyxrc.plaintext_linelen;
1691 makeLaTeXFile(FileName(name), org_path, runparams);
1694 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1695 int const res = chktex.run(terr); // run chktex
1698 Alert::error(_("chktex failure"),
1699 _("Could not run chktex successfully."));
1700 } else if (res > 0) {
1701 ErrorList & errlist = d->errorLists["ChkTeX"];
1703 bufferErrors(terr, errlist);
1714 void Buffer::validate(LaTeXFeatures & features) const
1716 params().validate(features);
1718 for_each(paragraphs().begin(), paragraphs().end(),
1719 bind(&Paragraph::validate, _1, ref(features)));
1721 if (lyxerr.debugging(Debug::LATEX)) {
1722 features.showStruct();
1727 void Buffer::getLabelList(vector<docstring> & list) const
1729 // If this is a child document, use the master's list instead.
1731 masterBuffer()->getLabelList(list);
1736 Toc & toc = d->toc_backend.toc("label");
1737 TocIterator toc_it = toc.begin();
1738 TocIterator end = toc.end();
1739 for (; toc_it != end; ++toc_it) {
1740 if (toc_it->depth() == 0)
1741 list.push_back(toc_it->str());
1746 void Buffer::updateBibfilesCache(UpdateScope scope) const
1748 // FIXME This is probably unnecssary, given where we call this.
1749 // If this is a child document, use the parent's cache instead.
1750 if (parent() && scope != UpdateChildOnly) {
1751 masterBuffer()->updateBibfilesCache();
1755 d->bibfiles_cache_.clear();
1756 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1757 if (it->lyxCode() == BIBTEX_CODE) {
1758 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1759 support::FileNameList const bibfiles = inset.getBibFiles();
1760 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1763 } else if (it->lyxCode() == INCLUDE_CODE) {
1764 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1765 Buffer const * const incbuf = inset.getChildBuffer();
1768 support::FileNameList const & bibfiles =
1769 incbuf->getBibfilesCache(UpdateChildOnly);
1770 if (!bibfiles.empty()) {
1771 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1777 d->bibfile_cache_valid_ = true;
1778 d->bibinfo_cache_valid_ = false;
1779 d->cite_labels_valid_ = false;
1783 void Buffer::invalidateBibinfoCache() const
1785 d->bibinfo_cache_valid_ = false;
1786 d->cite_labels_valid_ = false;
1787 // also invalidate the cache for the parent buffer
1788 Buffer const * const pbuf = d->parent();
1790 pbuf->invalidateBibinfoCache();
1794 void Buffer::invalidateBibfileCache() const
1796 d->bibfile_cache_valid_ = false;
1797 d->bibinfo_cache_valid_ = false;
1798 d->cite_labels_valid_ = false;
1799 // also invalidate the cache for the parent buffer
1800 Buffer const * const pbuf = d->parent();
1802 pbuf->invalidateBibfileCache();
1806 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1808 // FIXME This is probably unnecessary, given where we call this.
1809 // If this is a child document, use the master's cache instead.
1810 Buffer const * const pbuf = masterBuffer();
1811 if (pbuf != this && scope != UpdateChildOnly)
1812 return pbuf->getBibfilesCache();
1814 if (!d->bibfile_cache_valid_)
1815 this->updateBibfilesCache(scope);
1817 return d->bibfiles_cache_;
1821 BiblioInfo const & Buffer::masterBibInfo() const
1823 Buffer const * const tmp = masterBuffer();
1825 return tmp->masterBibInfo();
1830 void Buffer::checkIfBibInfoCacheIsValid() const
1832 // use the master's cache
1833 Buffer const * const tmp = masterBuffer();
1835 tmp->checkIfBibInfoCacheIsValid();
1839 // compare the cached timestamps with the actual ones.
1840 FileNameList const & bibfiles_cache = getBibfilesCache();
1841 FileNameList::const_iterator ei = bibfiles_cache.begin();
1842 FileNameList::const_iterator en = bibfiles_cache.end();
1843 for (; ei != en; ++ ei) {
1844 time_t lastw = ei->lastModified();
1845 time_t prevw = d->bibfile_status_[*ei];
1846 if (lastw != prevw) {
1847 d->bibinfo_cache_valid_ = false;
1848 d->cite_labels_valid_ = false;
1849 d->bibfile_status_[*ei] = lastw;
1855 void Buffer::reloadBibInfoCache() const
1857 // use the master's cache
1858 Buffer const * const tmp = masterBuffer();
1860 tmp->reloadBibInfoCache();
1864 checkIfBibInfoCacheIsValid();
1865 if (d->bibinfo_cache_valid_)
1868 d->bibinfo_.clear();
1870 d->bibinfo_cache_valid_ = true;
1874 void Buffer::collectBibKeys() const
1876 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1877 it->collectBibKeys(it);
1881 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1883 Buffer const * tmp = masterBuffer();
1884 BiblioInfo & masterbi = (tmp == this) ?
1885 d->bibinfo_ : tmp->d->bibinfo_;
1886 masterbi.mergeBiblioInfo(bi);
1890 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1892 Buffer const * tmp = masterBuffer();
1893 BiblioInfo & masterbi = (tmp == this) ?
1894 d->bibinfo_ : tmp->d->bibinfo_;
1899 bool Buffer::citeLabelsValid() const
1901 return masterBuffer()->d->cite_labels_valid_;
1905 bool Buffer::isDepClean(string const & name) const
1907 DepClean::const_iterator const it = d->dep_clean.find(name);
1908 if (it == d->dep_clean.end())
1914 void Buffer::markDepClean(string const & name)
1916 d->dep_clean[name] = true;
1920 bool Buffer::isExportableFormat(string const & format) const
1922 typedef vector<Format const *> Formats;
1924 formats = exportableFormats(true);
1925 Formats::const_iterator fit = formats.begin();
1926 Formats::const_iterator end = formats.end();
1927 for (; fit != end ; ++fit) {
1928 if ((*fit)->name() == format)
1935 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1938 // FIXME? if there is an Buffer LFUN that can be dispatched even
1939 // if internal, put a switch '(cmd.action)' here.
1945 switch (cmd.action()) {
1947 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1948 flag.setOnOff(isReadonly());
1951 // FIXME: There is need for a command-line import.
1952 //case LFUN_BUFFER_IMPORT:
1954 case LFUN_BUFFER_AUTO_SAVE:
1957 case LFUN_BUFFER_EXPORT_CUSTOM:
1958 // FIXME: Nothing to check here?
1961 case LFUN_BUFFER_EXPORT: {
1962 docstring const arg = cmd.argument();
1963 enable = arg == "custom" || isExportable(to_utf8(arg));
1965 flag.message(bformat(
1966 _("Don't know how to export to format: %1$s"), arg));
1970 case LFUN_BUFFER_CHKTEX:
1971 enable = isLatex() && !lyxrc.chktex_command.empty();
1974 case LFUN_BUILD_PROGRAM:
1975 enable = isExportable("program");
1978 case LFUN_BRANCH_ACTIVATE:
1979 case LFUN_BRANCH_DEACTIVATE: {
1980 BranchList const & branchList = params().branchlist();
1981 docstring const branchName = cmd.argument();
1982 enable = !branchName.empty() && branchList.find(branchName);
1986 case LFUN_BRANCH_ADD:
1987 case LFUN_BRANCHES_RENAME:
1988 case LFUN_BUFFER_PRINT:
1989 // if no Buffer is present, then of course we won't be called!
1992 case LFUN_BUFFER_LANGUAGE:
1993 enable = !isReadonly();
1999 flag.setEnabled(enable);
2004 void Buffer::dispatch(string const & command, DispatchResult & result)
2006 return dispatch(lyxaction.lookupFunc(command), result);
2010 // NOTE We can end up here even if we have no GUI, because we are called
2011 // by LyX::exec to handled command-line requests. So we may need to check
2012 // whether we have a GUI or not. The boolean use_gui holds this information.
2013 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2016 // FIXME? if there is an Buffer LFUN that can be dispatched even
2017 // if internal, put a switch '(cmd.action())' here.
2018 dr.dispatched(false);
2021 string const argument = to_utf8(func.argument());
2022 // We'll set this back to false if need be.
2023 bool dispatched = true;
2024 undo().beginUndoGroup();
2026 switch (func.action()) {
2027 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2028 if (lyxvc().inUse())
2029 lyxvc().toggleReadOnly();
2031 setReadonly(!isReadonly());
2034 case LFUN_BUFFER_EXPORT: {
2035 bool success = doExport(argument, false, false);
2036 dr.setError(!success);
2038 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2043 case LFUN_BUILD_PROGRAM:
2044 doExport("program", true, false);
2047 case LFUN_BUFFER_CHKTEX:
2051 case LFUN_BUFFER_EXPORT_CUSTOM: {
2053 string command = split(argument, format_name, ' ');
2054 Format const * format = formats.getFormat(format_name);
2056 lyxerr << "Format \"" << format_name
2057 << "\" not recognized!"
2062 // The name of the file created by the conversion process
2065 // Output to filename
2066 if (format->name() == "lyx") {
2067 string const latexname = latexName(false);
2068 filename = changeExtension(latexname,
2069 format->extension());
2070 filename = addName(temppath(), filename);
2072 if (!writeFile(FileName(filename)))
2076 doExport(format_name, true, false, filename);
2079 // Substitute $$FName for filename
2080 if (!contains(command, "$$FName"))
2081 command = "( " + command + " ) < $$FName";
2082 command = subst(command, "$$FName", filename);
2084 // Execute the command in the background
2086 call.startscript(Systemcall::DontWait, command, filePath());
2090 // FIXME: There is need for a command-line import.
2092 case LFUN_BUFFER_IMPORT:
2097 case LFUN_BUFFER_AUTO_SAVE:
2099 resetAutosaveTimers();
2102 case LFUN_BRANCH_ADD: {
2103 docstring branch_name = func.argument();
2104 if (branch_name.empty()) {
2108 BranchList & branch_list = params().branchlist();
2109 vector<docstring> const branches =
2110 getVectorFromString(branch_name, branch_list.separator());
2112 for (vector<docstring>::const_iterator it = branches.begin();
2113 it != branches.end(); ++it) {
2115 Branch * branch = branch_list.find(branch_name);
2117 LYXERR0("Branch " << branch_name << " already exists.");
2121 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2123 branch_list.add(branch_name);
2124 branch = branch_list.find(branch_name);
2125 string const x11hexname = X11hexname(branch->color());
2126 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2127 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2129 dr.screenUpdate(Update::Force);
2137 case LFUN_BRANCH_ACTIVATE:
2138 case LFUN_BRANCH_DEACTIVATE: {
2139 BranchList & branchList = params().branchlist();
2140 docstring const branchName = func.argument();
2141 // the case without a branch name is handled elsewhere
2142 if (branchName.empty()) {
2146 Branch * branch = branchList.find(branchName);
2148 LYXERR0("Branch " << branchName << " does not exist.");
2150 docstring const msg =
2151 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2154 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2156 dr.screenUpdate(Update::Force);
2157 dr.forceBufferUpdate();
2162 case LFUN_BRANCHES_RENAME: {
2163 if (func.argument().empty())
2166 docstring const oldname = from_utf8(func.getArg(0));
2167 docstring const newname = from_utf8(func.getArg(1));
2168 InsetIterator it = inset_iterator_begin(inset());
2169 InsetIterator const end = inset_iterator_end(inset());
2170 bool success = false;
2171 for (; it != end; ++it) {
2172 if (it->lyxCode() == BRANCH_CODE) {
2173 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2174 if (ins.branch() == oldname) {
2175 undo().recordUndo(it);
2176 ins.rename(newname);
2181 if (it->lyxCode() == INCLUDE_CODE) {
2182 // get buffer of external file
2183 InsetInclude const & ins =
2184 static_cast<InsetInclude const &>(*it);
2185 Buffer * child = ins.getChildBuffer();
2188 child->dispatch(func, dr);
2193 dr.screenUpdate(Update::Force);
2194 dr.forceBufferUpdate();
2199 case LFUN_BUFFER_PRINT: {
2200 // we'll assume there's a problem until we succeed
2202 string target = func.getArg(0);
2203 string target_name = func.getArg(1);
2204 string command = func.getArg(2);
2207 || target_name.empty()
2208 || command.empty()) {
2209 LYXERR0("Unable to parse " << func.argument());
2210 docstring const msg =
2211 bformat(_("Unable to parse \"%1$s\""), func.argument());
2215 if (target != "printer" && target != "file") {
2216 LYXERR0("Unrecognized target \"" << target << '"');
2217 docstring const msg =
2218 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2223 bool const update_unincluded =
2224 params().maintain_unincluded_children
2225 && !params().getIncludedChildren().empty();
2226 if (!doExport("dvi", true, update_unincluded)) {
2227 showPrintError(absFileName());
2228 dr.setMessage(_("Error exporting to DVI."));
2232 // Push directory path.
2233 string const path = temppath();
2234 // Prevent the compiler from optimizing away p
2238 // there are three cases here:
2239 // 1. we print to a file
2240 // 2. we print directly to a printer
2241 // 3. we print using a spool command (print to file first)
2244 string const dviname = changeExtension(latexName(true), "dvi");
2246 if (target == "printer") {
2247 if (!lyxrc.print_spool_command.empty()) {
2248 // case 3: print using a spool
2249 string const psname = changeExtension(dviname,".ps");
2250 command += ' ' + lyxrc.print_to_file
2253 + quoteName(dviname);
2255 string command2 = lyxrc.print_spool_command + ' ';
2256 if (target_name != "default") {
2257 command2 += lyxrc.print_spool_printerprefix
2261 command2 += quoteName(psname);
2263 // If successful, then spool command
2264 res = one.startscript(Systemcall::Wait, command,
2268 // If there's no GUI, we have to wait on this command. Otherwise,
2269 // LyX deletes the temporary directory, and with it the spooled
2270 // file, before it can be printed!!
2271 Systemcall::Starttype stype = use_gui ?
2272 Systemcall::DontWait : Systemcall::Wait;
2273 res = one.startscript(stype, command2,
2277 // case 2: print directly to a printer
2278 if (target_name != "default")
2279 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2281 Systemcall::Starttype stype = use_gui ?
2282 Systemcall::DontWait : Systemcall::Wait;
2283 res = one.startscript(stype, command +
2284 quoteName(dviname), filePath());
2288 // case 1: print to a file
2289 FileName const filename(makeAbsPath(target_name, filePath()));
2290 FileName const dvifile(makeAbsPath(dviname, path));
2291 if (filename.exists()) {
2292 docstring text = bformat(
2293 _("The file %1$s already exists.\n\n"
2294 "Do you want to overwrite that file?"),
2295 makeDisplayPath(filename.absFileName()));
2296 if (Alert::prompt(_("Overwrite file?"),
2297 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2300 command += ' ' + lyxrc.print_to_file
2301 + quoteName(filename.toFilesystemEncoding())
2303 + quoteName(dvifile.toFilesystemEncoding());
2305 Systemcall::Starttype stype = use_gui ?
2306 Systemcall::DontWait : Systemcall::Wait;
2307 res = one.startscript(stype, command, filePath());
2313 dr.setMessage(_("Error running external commands."));
2314 showPrintError(absFileName());
2319 case LFUN_BUFFER_LANGUAGE: {
2320 Language const * oldL = params().language;
2321 Language const * newL = languages.getLanguage(argument);
2322 if (!newL || oldL == newL)
2324 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2325 changeLanguage(oldL, newL);
2326 dr.forceBufferUpdate();
2335 dr.dispatched(dispatched);
2336 undo().endUndoGroup();
2340 void Buffer::changeLanguage(Language const * from, Language const * to)
2342 LASSERT(from, /**/);
2345 for_each(par_iterator_begin(),
2347 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2351 bool Buffer::isMultiLingual() const
2353 ParConstIterator end = par_iterator_end();
2354 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2355 if (it->isMultiLingual(params()))
2362 std::set<Language const *> Buffer::getLanguages() const
2364 std::set<Language const *> languages;
2365 getLanguages(languages);
2370 void Buffer::getLanguages(std::set<Language const *> & languages) const
2372 ParConstIterator end = par_iterator_end();
2373 // add the buffer language, even if it's not actively used
2374 languages.insert(language());
2375 // iterate over the paragraphs
2376 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2377 it->getLanguages(languages);
2379 ListOfBuffers clist = getDescendents();
2380 ListOfBuffers::const_iterator cit = clist.begin();
2381 ListOfBuffers::const_iterator const cen = clist.end();
2382 for (; cit != cen; ++cit)
2383 (*cit)->getLanguages(languages);
2387 DocIterator Buffer::getParFromID(int const id) const
2389 Buffer * buf = const_cast<Buffer *>(this);
2391 // John says this is called with id == -1 from undo
2392 lyxerr << "getParFromID(), id: " << id << endl;
2393 return doc_iterator_end(buf);
2396 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2397 if (it.paragraph().id() == id)
2400 return doc_iterator_end(buf);
2404 bool Buffer::hasParWithID(int const id) const
2406 return !getParFromID(id).atEnd();
2410 ParIterator Buffer::par_iterator_begin()
2412 return ParIterator(doc_iterator_begin(this));
2416 ParIterator Buffer::par_iterator_end()
2418 return ParIterator(doc_iterator_end(this));
2422 ParConstIterator Buffer::par_iterator_begin() const
2424 return ParConstIterator(doc_iterator_begin(this));
2428 ParConstIterator Buffer::par_iterator_end() const
2430 return ParConstIterator(doc_iterator_end(this));
2434 Language const * Buffer::language() const
2436 return params().language;
2440 docstring const Buffer::B_(string const & l10n) const
2442 return params().B_(l10n);
2446 bool Buffer::isClean() const
2448 return d->lyx_clean;
2452 bool Buffer::isExternallyModified(CheckMethod method) const
2454 LASSERT(d->filename.exists(), /**/);
2455 // if method == timestamp, check timestamp before checksum
2456 return (method == checksum_method
2457 || d->timestamp_ != d->filename.lastModified())
2458 && d->checksum_ != d->filename.checksum();
2462 void Buffer::saveCheckSum() const
2464 FileName const & file = d->filename;
2467 if (file.exists()) {
2468 d->timestamp_ = file.lastModified();
2469 d->checksum_ = file.checksum();
2471 // in the case of save to a new file.
2478 void Buffer::markClean() const
2480 if (!d->lyx_clean) {
2481 d->lyx_clean = true;
2484 // if the .lyx file has been saved, we don't need an
2486 d->bak_clean = true;
2487 d->undo_.markDirty();
2491 void Buffer::setUnnamed(bool flag)
2497 bool Buffer::isUnnamed() const
2504 /// Don't check unnamed, here: isInternal() is used in
2505 /// newBuffer(), where the unnamed flag has not been set by anyone
2506 /// yet. Also, for an internal buffer, there should be no need for
2507 /// retrieving fileName() nor for checking if it is unnamed or not.
2508 bool Buffer::isInternal() const
2510 return fileName().extension() == "internal";
2514 void Buffer::markDirty()
2517 d->lyx_clean = false;
2520 d->bak_clean = false;
2522 DepClean::iterator it = d->dep_clean.begin();
2523 DepClean::const_iterator const end = d->dep_clean.end();
2525 for (; it != end; ++it)
2530 FileName Buffer::fileName() const
2536 string Buffer::absFileName() const
2538 return d->filename.absFileName();
2542 string Buffer::filePath() const
2544 return d->filename.onlyPath().absFileName() + "/";
2548 bool Buffer::isReadonly() const
2550 return d->read_only;
2554 void Buffer::setParent(Buffer const * buffer)
2556 // Avoids recursive include.
2557 d->setParent(buffer == this ? 0 : buffer);
2562 Buffer const * Buffer::parent() const
2568 ListOfBuffers Buffer::allRelatives() const
2570 ListOfBuffers lb = masterBuffer()->getDescendents();
2571 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2576 Buffer const * Buffer::masterBuffer() const
2578 // FIXME Should be make sure we are not in some kind
2579 // of recursive include? A -> B -> A will crash this.
2580 Buffer const * const pbuf = d->parent();
2584 return pbuf->masterBuffer();
2588 bool Buffer::isChild(Buffer * child) const
2590 return d->children_positions.find(child) != d->children_positions.end();
2594 DocIterator Buffer::firstChildPosition(Buffer const * child)
2596 Impl::BufferPositionMap::iterator it;
2597 it = d->children_positions.find(child);
2598 if (it == d->children_positions.end())
2599 return DocIterator(this);
2604 bool Buffer::hasChildren() const
2606 return !d->children_positions.empty();
2610 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2612 // loop over children
2613 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2614 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2615 for (; it != end; ++it) {
2616 Buffer * child = const_cast<Buffer *>(it->first);
2618 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2619 if (bit != clist.end())
2621 clist.push_back(child);
2623 // there might be grandchildren
2624 child->collectChildren(clist, true);
2629 ListOfBuffers Buffer::getChildren() const
2632 collectChildren(v, false);
2637 ListOfBuffers Buffer::getDescendents() const
2640 collectChildren(v, true);
2645 template<typename M>
2646 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2651 typename M::const_iterator it = m.lower_bound(x);
2652 if (it == m.begin())
2660 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2661 DocIterator const & pos) const
2663 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2665 // if paragraphs have no macro context set, pos will be empty
2669 // we haven't found anything yet
2670 DocIterator bestPos = owner_->par_iterator_begin();
2671 MacroData const * bestData = 0;
2673 // find macro definitions for name
2674 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2675 if (nameIt != macros.end()) {
2676 // find last definition in front of pos or at pos itself
2677 PositionScopeMacroMap::const_iterator it
2678 = greatest_below(nameIt->second, pos);
2679 if (it != nameIt->second.end()) {
2681 // scope ends behind pos?
2682 if (pos < it->second.first) {
2683 // Looks good, remember this. If there
2684 // is no external macro behind this,
2685 // we found the right one already.
2686 bestPos = it->first;
2687 bestData = &it->second.second;
2691 // try previous macro if there is one
2692 if (it == nameIt->second.begin())
2699 // find macros in included files
2700 PositionScopeBufferMap::const_iterator it
2701 = greatest_below(position_to_children, pos);
2702 if (it == position_to_children.end())
2703 // no children before
2707 // do we know something better (i.e. later) already?
2708 if (it->first < bestPos )
2711 // scope ends behind pos?
2712 if (pos < it->second.first
2713 && (cloned_buffer_ ||
2714 theBufferList().isLoaded(it->second.second))) {
2715 // look for macro in external file
2717 MacroData const * data
2718 = it->second.second->getMacro(name, false);
2721 bestPos = it->first;
2727 // try previous file if there is one
2728 if (it == position_to_children.begin())
2733 // return the best macro we have found
2738 MacroData const * Buffer::getMacro(docstring const & name,
2739 DocIterator const & pos, bool global) const
2744 // query buffer macros
2745 MacroData const * data = d->getBufferMacro(name, pos);
2749 // If there is a master buffer, query that
2750 Buffer const * const pbuf = d->parent();
2752 d->macro_lock = true;
2753 MacroData const * macro = pbuf->getMacro(
2754 name, *this, false);
2755 d->macro_lock = false;
2761 data = MacroTable::globalMacros().get(name);
2770 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2772 // set scope end behind the last paragraph
2773 DocIterator scope = par_iterator_begin();
2774 scope.pit() = scope.lastpit() + 1;
2776 return getMacro(name, scope, global);
2780 MacroData const * Buffer::getMacro(docstring const & name,
2781 Buffer const & child, bool global) const
2783 // look where the child buffer is included first
2784 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2785 if (it == d->children_positions.end())
2788 // check for macros at the inclusion position
2789 return getMacro(name, it->second, global);
2793 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2795 pit_type const lastpit = it.lastpit();
2797 // look for macros in each paragraph
2798 while (it.pit() <= lastpit) {
2799 Paragraph & par = it.paragraph();
2801 // iterate over the insets of the current paragraph
2802 InsetList const & insets = par.insetList();
2803 InsetList::const_iterator iit = insets.begin();
2804 InsetList::const_iterator end = insets.end();
2805 for (; iit != end; ++iit) {
2806 it.pos() = iit->pos;
2808 // is it a nested text inset?
2809 if (iit->inset->asInsetText()) {
2810 // Inset needs its own scope?
2811 InsetText const * itext = iit->inset->asInsetText();
2812 bool newScope = itext->isMacroScope();
2814 // scope which ends just behind the inset
2815 DocIterator insetScope = it;
2818 // collect macros in inset
2819 it.push_back(CursorSlice(*iit->inset));
2820 updateMacros(it, newScope ? insetScope : scope);
2825 if (iit->inset->asInsetTabular()) {
2826 CursorSlice slice(*iit->inset);
2827 size_t const numcells = slice.nargs();
2828 for (; slice.idx() < numcells; slice.forwardIdx()) {
2829 it.push_back(slice);
2830 updateMacros(it, scope);
2836 // is it an external file?
2837 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2838 // get buffer of external file
2839 InsetInclude const & inset =
2840 static_cast<InsetInclude const &>(*iit->inset);
2842 Buffer * child = inset.getChildBuffer();
2847 // register its position, but only when it is
2848 // included first in the buffer
2849 if (children_positions.find(child) ==
2850 children_positions.end())
2851 children_positions[child] = it;
2853 // register child with its scope
2854 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2858 InsetMath * im = iit->inset->asInsetMath();
2859 if (doing_export && im) {
2860 InsetMathHull * hull = im->asHullInset();
2862 hull->recordLocation(it);
2865 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2869 MathMacroTemplate & macroTemplate =
2870 *iit->inset->asInsetMath()->asMacroTemplate();
2871 MacroContext mc(owner_, it);
2872 macroTemplate.updateToContext(mc);
2875 bool valid = macroTemplate.validMacro();
2876 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2877 // then the BufferView's cursor will be invalid in
2878 // some cases which leads to crashes.
2883 // FIXME (Abdel), I don't understandt why we pass 'it' here
2884 // instead of 'macroTemplate' defined above... is this correct?
2885 macros[macroTemplate.name()][it] =
2886 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2896 void Buffer::updateMacros() const
2901 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2903 // start with empty table
2905 d->children_positions.clear();
2906 d->position_to_children.clear();
2908 // Iterate over buffer, starting with first paragraph
2909 // The scope must be bigger than any lookup DocIterator
2910 // later. For the global lookup, lastpit+1 is used, hence
2911 // we use lastpit+2 here.
2912 DocIterator it = par_iterator_begin();
2913 DocIterator outerScope = it;
2914 outerScope.pit() = outerScope.lastpit() + 2;
2915 d->updateMacros(it, outerScope);
2919 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2921 InsetIterator it = inset_iterator_begin(inset());
2922 InsetIterator const end = inset_iterator_end(inset());
2923 for (; it != end; ++it) {
2924 if (it->lyxCode() == BRANCH_CODE) {
2925 InsetBranch & br = static_cast<InsetBranch &>(*it);
2926 docstring const name = br.branch();
2927 if (!from_master && !params().branchlist().find(name))
2928 result.push_back(name);
2929 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2930 result.push_back(name);
2933 if (it->lyxCode() == INCLUDE_CODE) {
2934 // get buffer of external file
2935 InsetInclude const & ins =
2936 static_cast<InsetInclude const &>(*it);
2937 Buffer * child = ins.getChildBuffer();
2940 child->getUsedBranches(result, true);
2943 // remove duplicates
2948 void Buffer::updateMacroInstances(UpdateType utype) const
2950 LYXERR(Debug::MACROS, "updateMacroInstances for "
2951 << d->filename.onlyFileName());
2952 DocIterator it = doc_iterator_begin(this);
2954 DocIterator const end = doc_iterator_end(this);
2955 for (; it != end; it.forwardInset()) {
2956 // look for MathData cells in InsetMathNest insets
2957 InsetMath * minset = it.nextInset()->asInsetMath();
2961 // update macro in all cells of the InsetMathNest
2962 DocIterator::idx_type n = minset->nargs();
2963 MacroContext mc = MacroContext(this, it);
2964 for (DocIterator::idx_type i = 0; i < n; ++i) {
2965 MathData & data = minset->cell(i);
2966 data.updateMacros(0, mc, utype);
2972 void Buffer::listMacroNames(MacroNameSet & macros) const
2977 d->macro_lock = true;
2979 // loop over macro names
2980 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2981 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2982 for (; nameIt != nameEnd; ++nameIt)
2983 macros.insert(nameIt->first);
2985 // loop over children
2986 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2987 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2988 for (; it != end; ++it)
2989 it->first->listMacroNames(macros);
2992 Buffer const * const pbuf = d->parent();
2994 pbuf->listMacroNames(macros);
2996 d->macro_lock = false;
3000 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3002 Buffer const * const pbuf = d->parent();
3007 pbuf->listMacroNames(names);
3010 MacroNameSet::iterator it = names.begin();
3011 MacroNameSet::iterator end = names.end();
3012 for (; it != end; ++it) {
3014 MacroData const * data =
3015 pbuf->getMacro(*it, *this, false);
3017 macros.insert(data);
3019 // we cannot access the original MathMacroTemplate anymore
3020 // here to calls validate method. So we do its work here manually.
3021 // FIXME: somehow make the template accessible here.
3022 if (data->optionals() > 0)
3023 features.require("xargs");
3029 Buffer::References & Buffer::references(docstring const & label)
3032 return const_cast<Buffer *>(masterBuffer())->references(label);
3034 RefCache::iterator it = d->ref_cache_.find(label);
3035 if (it != d->ref_cache_.end())
3036 return it->second.second;
3038 static InsetLabel const * dummy_il = 0;
3039 static References const dummy_refs;
3040 it = d->ref_cache_.insert(
3041 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3042 return it->second.second;
3046 Buffer::References const & Buffer::references(docstring const & label) const
3048 return const_cast<Buffer *>(this)->references(label);
3052 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3054 masterBuffer()->d->ref_cache_[label].first = il;
3058 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3060 return masterBuffer()->d->ref_cache_[label].first;
3064 void Buffer::clearReferenceCache() const
3067 d->ref_cache_.clear();
3071 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3074 //FIXME: This does not work for child documents yet.
3075 LASSERT(code == CITE_CODE, /**/);
3077 reloadBibInfoCache();
3079 // Check if the label 'from' appears more than once
3080 BiblioInfo const & keys = masterBibInfo();
3081 BiblioInfo::const_iterator bit = keys.begin();
3082 BiblioInfo::const_iterator bend = keys.end();
3083 vector<docstring> labels;
3085 for (; bit != bend; ++bit)
3087 labels.push_back(bit->first);
3089 if (count(labels.begin(), labels.end(), from) > 1)
3092 string const paramName = "key";
3093 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3094 if (it->lyxCode() == code) {
3095 InsetCommand * inset = it->asInsetCommand();
3098 docstring const oldValue = inset->getParam(paramName);
3099 if (oldValue == from)
3100 inset->setParam(paramName, to);
3106 void Buffer::getSourceCode(odocstream & os, string const format,
3107 pit_type par_begin, pit_type par_end,
3108 bool full_source) const
3110 OutputParams runparams(¶ms().encoding());
3111 runparams.nice = true;
3112 runparams.flavor = getOutputFlavor(format);
3113 runparams.linelen = lyxrc.plaintext_linelen;
3114 // No side effect of file copying and image conversion
3115 runparams.dryrun = true;
3118 os << "% " << _("Preview source code") << "\n\n";
3120 d->texrow.newline();
3121 d->texrow.newline();
3123 writeDocBookSource(os, absFileName(), runparams, false);
3124 else if (runparams.flavor == OutputParams::HTML)
3125 writeLyXHTMLSource(os, runparams, false);
3127 // latex or literate
3128 otexstream ots(os, d->texrow);
3129 writeLaTeXSource(ots, string(), runparams, true, true);
3132 runparams.par_begin = par_begin;
3133 runparams.par_end = par_end;
3134 if (par_begin + 1 == par_end) {
3136 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3140 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3141 convert<docstring>(par_begin),
3142 convert<docstring>(par_end - 1))
3149 // output paragraphs
3151 docbookParagraphs(text(), *this, os, runparams);
3152 else if (runparams.flavor == OutputParams::HTML) {
3154 xhtmlParagraphs(text(), *this, xs, runparams);
3156 // latex or literate
3157 otexstream ots(os, texrow);
3158 latexParagraphs(*this, text(), ots, runparams);
3164 ErrorList & Buffer::errorList(string const & type) const
3166 static ErrorList emptyErrorList;
3167 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3168 if (it == d->errorLists.end())
3169 return emptyErrorList;
3175 void Buffer::updateTocItem(std::string const & type,
3176 DocIterator const & dit) const
3179 d->gui_->updateTocItem(type, dit);
3183 void Buffer::structureChanged() const
3186 d->gui_->structureChanged();
3190 void Buffer::errors(string const & err, bool from_master) const
3193 d->gui_->errors(err, from_master);
3197 void Buffer::message(docstring const & msg) const
3200 d->gui_->message(msg);
3204 void Buffer::setBusy(bool on) const
3207 d->gui_->setBusy(on);
3211 void Buffer::updateTitles() const
3214 d->wa_->updateTitles();
3218 void Buffer::resetAutosaveTimers() const
3221 d->gui_->resetAutosaveTimers();
3225 bool Buffer::hasGuiDelegate() const
3231 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3240 class AutoSaveBuffer : public ForkedProcess {
3243 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3244 : buffer_(buffer), fname_(fname) {}
3246 virtual shared_ptr<ForkedProcess> clone() const
3248 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3253 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3254 from_utf8(fname_.absFileName())));
3255 return run(DontWait);
3259 virtual int generateChild();
3261 Buffer const & buffer_;
3266 int AutoSaveBuffer::generateChild()
3268 #if defined(__APPLE__)
3269 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3270 * We should use something else like threads.
3272 * Since I do not know how to determine at run time what is the OS X
3273 * version, I just disable forking altogether for now (JMarc)
3275 pid_t const pid = -1;
3277 // tmp_ret will be located (usually) in /tmp
3278 // will that be a problem?
3279 // Note that this calls ForkedCalls::fork(), so it's
3280 // ok cross-platform.
3281 pid_t const pid = fork();
3282 // If you want to debug the autosave
3283 // you should set pid to -1, and comment out the fork.
3284 if (pid != 0 && pid != -1)
3288 // pid = -1 signifies that lyx was unable
3289 // to fork. But we will do the save
3291 bool failed = false;
3292 FileName const tmp_ret = FileName::tempName("lyxauto");
3293 if (!tmp_ret.empty()) {
3294 buffer_.writeFile(tmp_ret);
3295 // assume successful write of tmp_ret
3296 if (!tmp_ret.moveTo(fname_))
3302 // failed to write/rename tmp_ret so try writing direct
3303 if (!buffer_.writeFile(fname_)) {
3304 // It is dangerous to do this in the child,
3305 // but safe in the parent, so...
3306 if (pid == -1) // emit message signal.
3307 buffer_.message(_("Autosave failed!"));
3311 if (pid == 0) // we are the child so...
3320 FileName Buffer::getEmergencyFileName() const
3322 return FileName(d->filename.absFileName() + ".emergency");
3326 FileName Buffer::getAutosaveFileName() const
3328 // if the document is unnamed try to save in the backup dir, else
3329 // in the default document path, and as a last try in the filePath,
3330 // which will most often be the temporary directory
3333 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3334 : lyxrc.backupdir_path;
3335 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3338 string const fname = "#" + d->filename.onlyFileName() + "#";
3340 return makeAbsPath(fname, fpath);
3344 void Buffer::removeAutosaveFile() const
3346 FileName const f = getAutosaveFileName();
3352 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3354 FileName const newauto = getAutosaveFileName();
3356 if (newauto != oldauto && oldauto.exists())
3357 if (!oldauto.moveTo(newauto))
3358 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3362 bool Buffer::autoSave() const
3364 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3365 if (buf->d->bak_clean || isReadonly())
3368 message(_("Autosaving current document..."));
3369 buf->d->bak_clean = true;
3371 FileName const fname = getAutosaveFileName();
3372 if (d->cloned_buffer_) {
3373 // If this buffer is cloned, we assume that
3374 // we are running in a separate thread already.
3375 FileName const tmp_ret = FileName::tempName("lyxauto");
3376 if (!tmp_ret.empty()) {
3378 // assume successful write of tmp_ret
3379 if (tmp_ret.moveTo(fname))
3382 // failed to write/rename tmp_ret so try writing direct
3383 return writeFile(fname);
3385 /// This function is deprecated as the frontend needs to take care
3386 /// of cloning the buffer and autosaving it in another thread. It
3387 /// is still here to allow (QT_VERSION < 0x040400).
3388 AutoSaveBuffer autosave(*this, fname);
3395 string Buffer::bufferFormat() const
3397 string format = params().documentClass().outputFormat();
3398 if (format == "latex") {
3399 if (params().useNonTeXFonts)
3401 if (params().encoding().package() == Encoding::japanese)
3408 string Buffer::getDefaultOutputFormat() const
3410 if (!params().default_output_format.empty()
3411 && params().default_output_format != "default")
3412 return params().default_output_format;
3414 || params().useNonTeXFonts
3415 || params().encoding().package() == Encoding::japanese) {
3416 vector<Format const *> const formats = exportableFormats(true);
3417 if (formats.empty())
3419 // return the first we find
3420 return formats.front()->name();
3422 return lyxrc.default_view_format;
3426 OutputParams::FLAVOR Buffer::getOutputFlavor(string const format) const
3428 string const dformat = (format.empty() || format == "default") ?
3429 getDefaultOutputFormat() : format;
3430 DefaultFlavorCache::const_iterator it =
3431 default_flavors_.find(dformat);
3433 if (it != default_flavors_.end())
3436 OutputParams::FLAVOR result = OutputParams::LATEX;
3438 if (dformat == "xhtml")
3439 result = OutputParams::HTML;
3441 // Try to determine flavor of default output format
3442 vector<string> backs = backends();
3443 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
3444 // Get shortest path to format
3445 Graph::EdgePath path;
3446 for (vector<string>::const_iterator it = backs.begin();
3447 it != backs.end(); ++it) {
3448 Graph::EdgePath p = theConverters().getPath(*it, dformat);
3449 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3454 result = theConverters().getFlavor(path);
3457 // cache this flavor
3458 default_flavors_[dformat] = result;
3464 // helper class, to guarantee this gets reset properly
3465 class MarkAsExporting {
3467 MarkAsExporting(Buffer const * buf) : buf_(buf)
3469 LASSERT(buf_, /* */);
3470 buf_->setExportStatus(true);
3474 buf_->setExportStatus(false);
3477 Buffer const * const buf_;
3482 void Buffer::setExportStatus(bool e) const
3484 d->doing_export = e;
3485 ListOfBuffers clist = getDescendents();
3486 ListOfBuffers::const_iterator cit = clist.begin();
3487 ListOfBuffers::const_iterator const cen = clist.end();
3488 for (; cit != cen; ++cit)
3489 (*cit)->d->doing_export = e;
3493 bool Buffer::isExporting() const
3495 return d->doing_export;
3499 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3500 bool includeall, string & result_file) const
3502 MarkAsExporting exporting(this);
3503 string backend_format;
3504 OutputParams runparams(¶ms().encoding());
3505 runparams.flavor = OutputParams::LATEX;
3506 runparams.linelen = lyxrc.plaintext_linelen;
3507 runparams.includeall = includeall;
3508 vector<string> backs = backends();
3509 Converters converters = theConverters();
3510 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3511 // Get shortest path to format
3512 converters.buildGraph();
3513 Graph::EdgePath path;
3514 for (vector<string>::const_iterator it = backs.begin();
3515 it != backs.end(); ++it) {
3516 Graph::EdgePath p = converters.getPath(*it, format);
3517 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3518 backend_format = *it;
3523 if (!put_in_tempdir) {
3524 // Only show this alert if this is an export to a non-temporary
3525 // file (not for previewing).
3526 Alert::error(_("Couldn't export file"), bformat(
3527 _("No information for exporting the format %1$s."),
3528 formats.prettyName(format)));
3532 runparams.flavor = converters.getFlavor(path);
3535 backend_format = format;
3536 // FIXME: Don't hardcode format names here, but use a flag
3537 if (backend_format == "pdflatex")
3538 runparams.flavor = OutputParams::PDFLATEX;
3539 else if (backend_format == "luatex")
3540 runparams.flavor = OutputParams::LUATEX;
3541 else if (backend_format == "xetex")
3542 runparams.flavor = OutputParams::XETEX;
3545 string filename = latexName(false);
3546 filename = addName(temppath(), filename);
3547 filename = changeExtension(filename,
3548 formats.extension(backend_format));
3550 // Plain text backend
3551 if (backend_format == "text") {
3552 runparams.flavor = OutputParams::TEXT;
3553 writePlaintextFile(*this, FileName(filename), runparams);
3556 else if (backend_format == "xhtml") {
3557 runparams.flavor = OutputParams::HTML;
3558 switch (params().html_math_output) {
3559 case BufferParams::MathML:
3560 runparams.math_flavor = OutputParams::MathAsMathML;
3562 case BufferParams::HTML:
3563 runparams.math_flavor = OutputParams::MathAsHTML;
3565 case BufferParams::Images:
3566 runparams.math_flavor = OutputParams::MathAsImages;
3568 case BufferParams::LaTeX:
3569 runparams.math_flavor = OutputParams::MathAsLaTeX;
3572 makeLyXHTMLFile(FileName(filename), runparams);
3573 } else if (backend_format == "lyx")
3574 writeFile(FileName(filename));
3576 else if (isDocBook()) {
3577 runparams.nice = !put_in_tempdir;
3578 makeDocBookFile(FileName(filename), runparams);
3581 else if (backend_format == format) {
3582 runparams.nice = true;
3583 if (!makeLaTeXFile(FileName(filename), string(), runparams)) {
3584 if (d->cloned_buffer_) {
3585 d->cloned_buffer_->d->errorLists["Export"] =
3586 d->errorLists["Export"];
3590 } else if (!lyxrc.tex_allows_spaces
3591 && contains(filePath(), ' ')) {
3592 Alert::error(_("File name error"),
3593 _("The directory path to the document cannot contain spaces."));
3596 runparams.nice = false;
3597 if (!makeLaTeXFile(FileName(filename), filePath(), runparams)) {
3598 if (d->cloned_buffer_) {
3599 d->cloned_buffer_->d->errorLists["Export"] =
3600 d->errorLists["Export"];
3606 string const error_type = (format == "program")
3607 ? "Build" : bufferFormat();
3608 ErrorList & error_list = d->errorLists[error_type];
3609 string const ext = formats.extension(format);
3610 FileName const tmp_result_file(changeExtension(filename, ext));
3611 bool const success = converters.convert(this, FileName(filename),
3612 tmp_result_file, FileName(absFileName()), backend_format, format,
3615 // Emit the signal to show the error list or copy it back to the
3616 // cloned Buffer so that it can be emitted afterwards.
3617 if (format != backend_format) {
3618 if (d->cloned_buffer_) {
3619 d->cloned_buffer_->d->errorLists[error_type] =
3620 d->errorLists[error_type];
3623 // also to the children, in case of master-buffer-view
3624 ListOfBuffers clist = getDescendents();
3625 ListOfBuffers::const_iterator cit = clist.begin();
3626 ListOfBuffers::const_iterator const cen = clist.end();
3627 for (; cit != cen; ++cit) {
3628 if (d->cloned_buffer_) {
3629 // Enable reverse search by copying back the
3630 // texrow object to the cloned buffer.
3631 // FIXME: this is not thread safe.
3632 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3633 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3634 (*cit)->d->errorLists[error_type];
3636 (*cit)->errors(error_type, true);
3640 if (d->cloned_buffer_) {
3641 // Enable reverse dvi or pdf to work by copying back the texrow
3642 // object to the cloned buffer.
3643 // FIXME: There is a possibility of concurrent access to texrow
3644 // here from the main GUI thread that should be securized.
3645 d->cloned_buffer_->d->texrow = d->texrow;
3646 string const error_type = bufferFormat();
3647 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3653 if (put_in_tempdir) {
3654 result_file = tmp_result_file.absFileName();
3658 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3659 // We need to copy referenced files (e. g. included graphics
3660 // if format == "dvi") to the result dir.
3661 vector<ExportedFile> const files =
3662 runparams.exportdata->externalFiles(format);
3663 string const dest = onlyPath(result_file);
3664 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3665 : force_overwrite == ALL_FILES;
3666 CopyStatus status = use_force ? FORCE : SUCCESS;
3668 vector<ExportedFile>::const_iterator it = files.begin();
3669 vector<ExportedFile>::const_iterator const en = files.end();
3670 for (; it != en && status != CANCEL; ++it) {
3671 string const fmt = formats.getFormatFromFile(it->sourceName);
3672 status = copyFile(fmt, it->sourceName,
3673 makeAbsPath(it->exportName, dest),
3674 it->exportName, status == FORCE);
3677 if (status == CANCEL) {
3678 message(_("Document export cancelled."));
3679 } else if (tmp_result_file.exists()) {
3680 // Finally copy the main file
3681 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3682 : force_overwrite != NO_FILES;
3683 if (status == SUCCESS && use_force)
3685 status = copyFile(format, tmp_result_file,
3686 FileName(result_file), result_file,
3688 message(bformat(_("Document exported as %1$s "
3690 formats.prettyName(format),
3691 makeDisplayPath(result_file)));
3693 // This must be a dummy converter like fax (bug 1888)
3694 message(bformat(_("Document exported as %1$s"),
3695 formats.prettyName(format)));
3702 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3703 bool includeall) const
3706 // (1) export with all included children (omit \includeonly)
3707 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3709 // (2) export with included children only
3710 return doExport(format, put_in_tempdir, false, result_file);
3714 bool Buffer::preview(string const & format, bool includeall) const
3716 MarkAsExporting exporting(this);
3718 // (1) export with all included children (omit \includeonly)
3719 if (includeall && !doExport(format, true, true))
3721 // (2) export with included children only
3722 if (!doExport(format, true, false, result_file))
3724 return formats.view(*this, FileName(result_file), format);
3728 bool Buffer::isExportable(string const & format) const
3730 vector<string> backs = backends();
3731 for (vector<string>::const_iterator it = backs.begin();
3732 it != backs.end(); ++it)
3733 if (theConverters().isReachable(*it, format))
3739 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3741 vector<string> const backs = backends();
3742 set<string> excludes;
3743 if (params().useNonTeXFonts) {
3744 excludes.insert("latex");
3745 excludes.insert("pdflatex");
3747 vector<Format const *> result =
3748 theConverters().getReachable(backs[0], only_viewable, true, excludes);
3749 for (vector<string>::const_iterator it = backs.begin() + 1;
3750 it != backs.end(); ++it) {
3751 vector<Format const *> r =
3752 theConverters().getReachable(*it, only_viewable, false, excludes);
3753 result.insert(result.end(), r.begin(), r.end());
3759 vector<string> Buffer::backends() const
3762 v.push_back(bufferFormat());
3763 // FIXME: Don't hardcode format names here, but use a flag
3764 if (v.back() == "latex") {
3765 v.push_back("pdflatex");
3766 v.push_back("luatex");
3767 v.push_back("xetex");
3768 } else if (v.back() == "xetex")
3769 v.push_back("luatex");
3770 v.push_back("xhtml");
3771 v.push_back("text");
3777 Buffer::ReadStatus Buffer::extractFromVC()
3779 bool const found = LyXVC::file_not_found_hook(d->filename);
3781 return ReadFileNotFound;
3782 if (!d->filename.isReadableFile())
3788 Buffer::ReadStatus Buffer::loadEmergency()
3790 FileName const emergencyFile = getEmergencyFileName();
3791 if (!emergencyFile.exists()
3792 || emergencyFile.lastModified() <= d->filename.lastModified())
3793 return ReadFileNotFound;
3795 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3796 docstring const text = bformat(_("An emergency save of the document "
3797 "%1$s exists.\n\nRecover emergency save?"), file);
3799 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3800 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3806 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3807 bool const success = (ret_llf == ReadSuccess);
3810 Alert::warning(_("File is read-only"),
3811 bformat(_("An emergency file is successfully loaded, "
3812 "but the original file %1$s is marked read-only. "
3813 "Please make sure to save the document as a different "
3814 "file."), from_utf8(d->filename.absFileName())));
3817 str = _("Document was successfully recovered.");
3819 str = _("Document was NOT successfully recovered.");
3820 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3821 makeDisplayPath(emergencyFile.absFileName()));
3823 int const del_emerg =
3824 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3825 _("&Remove"), _("&Keep"));
3826 if (del_emerg == 0) {
3827 emergencyFile.removeFile();
3829 Alert::warning(_("Emergency file deleted"),
3830 _("Do not forget to save your file now!"), true);
3832 return success ? ReadSuccess : ReadEmergencyFailure;
3835 int const del_emerg =
3836 Alert::prompt(_("Delete emergency file?"),
3837 _("Remove emergency file now?"), 1, 1,
3838 _("&Remove"), _("&Keep"));
3840 emergencyFile.removeFile();
3841 return ReadOriginal;
3851 Buffer::ReadStatus Buffer::loadAutosave()
3853 // Now check if autosave file is newer.
3854 FileName const autosaveFile = getAutosaveFileName();
3855 if (!autosaveFile.exists()
3856 || autosaveFile.lastModified() <= d->filename.lastModified())
3857 return ReadFileNotFound;
3859 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3860 docstring const text = bformat(_("The backup of the document %1$s "
3861 "is newer.\n\nLoad the backup instead?"), file);
3862 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3863 _("&Load backup"), _("Load &original"), _("&Cancel"));
3868 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3869 // the file is not saved if we load the autosave file.
3870 if (ret_llf == ReadSuccess) {
3872 Alert::warning(_("File is read-only"),
3873 bformat(_("A backup file is successfully loaded, "
3874 "but the original file %1$s is marked read-only. "
3875 "Please make sure to save the document as a "
3877 from_utf8(d->filename.absFileName())));
3882 return ReadAutosaveFailure;
3885 // Here we delete the autosave
3886 autosaveFile.removeFile();
3887 return ReadOriginal;
3895 Buffer::ReadStatus Buffer::loadLyXFile()
3897 if (!d->filename.isReadableFile()) {
3898 ReadStatus const ret_rvc = extractFromVC();
3899 if (ret_rvc != ReadSuccess)
3903 ReadStatus const ret_re = loadEmergency();
3904 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3907 ReadStatus const ret_ra = loadAutosave();
3908 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3911 return loadThisLyXFile(d->filename);
3915 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3917 return readFile(fn);
3921 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3923 TeXErrors::Errors::const_iterator it = terr.begin();
3924 TeXErrors::Errors::const_iterator end = terr.end();
3925 ListOfBuffers clist = getDescendents();
3926 ListOfBuffers::const_iterator cen = clist.end();
3928 for (; it != end; ++it) {
3931 int errorRow = it->error_in_line;
3932 Buffer const * buf = 0;
3934 if (it->child_name.empty())
3935 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
3937 // The error occurred in a child
3938 ListOfBuffers::const_iterator cit = clist.begin();
3939 for (; cit != cen; ++cit) {
3940 string const child_name =
3941 DocFileName(changeExtension(
3942 (*cit)->absFileName(), "tex")).
3944 if (it->child_name != child_name)
3946 (*cit)->d->texrow.getIdFromRow(errorRow,
3947 id_start, pos_start);
3948 if (id_start != -1) {
3949 buf = d->cloned_buffer_
3950 ? (*cit)->d->cloned_buffer_->d->owner_
3951 : (*cit)->d->owner_;
3962 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
3963 } while (found && id_start == id_end && pos_start == pos_end);
3965 if (id_start != id_end) {
3966 // Next registered position is outside the inset where
3967 // the error occurred, so signal end-of-paragraph
3971 errorList.push_back(ErrorItem(it->error_desc,
3972 it->error_text, id_start, pos_start, pos_end, buf));
3977 void Buffer::setBuffersForInsets() const
3979 inset().setBuffer(const_cast<Buffer &>(*this));
3983 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3985 // Use the master text class also for child documents
3986 Buffer const * const master = masterBuffer();
3987 DocumentClass const & textclass = master->params().documentClass();
3989 // do this only if we are the top-level Buffer
3991 reloadBibInfoCache();
3993 // keep the buffers to be children in this set. If the call from the
3994 // master comes back we can see which of them were actually seen (i.e.
3995 // via an InsetInclude). The remaining ones in the set need still be updated.
3996 static std::set<Buffer const *> bufToUpdate;
3997 if (scope == UpdateMaster) {
3998 // If this is a child document start with the master
3999 if (master != this) {
4000 bufToUpdate.insert(this);
4001 master->updateBuffer(UpdateMaster, utype);
4002 // Do this here in case the master has no gui associated with it. Then,
4003 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4004 if (!master->d->gui_)
4007 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4008 if (bufToUpdate.find(this) == bufToUpdate.end())
4012 // start over the counters in the master
4013 textclass.counters().reset();
4016 // update will be done below for this buffer
4017 bufToUpdate.erase(this);
4019 // update all caches
4020 clearReferenceCache();
4023 Buffer & cbuf = const_cast<Buffer &>(*this);
4025 LASSERT(!text().paragraphs().empty(), /**/);
4028 ParIterator parit = cbuf.par_iterator_begin();
4029 updateBuffer(parit, utype);
4032 // TocBackend update will be done later.
4035 d->bibinfo_cache_valid_ = true;
4036 d->cite_labels_valid_ = true;
4037 cbuf.tocBackend().update();
4038 if (scope == UpdateMaster)
4039 cbuf.structureChanged();
4043 static depth_type getDepth(DocIterator const & it)
4045 depth_type depth = 0;
4046 for (size_t i = 0 ; i < it.depth() ; ++i)
4047 if (!it[i].inset().inMathed())
4048 depth += it[i].paragraph().getDepth() + 1;
4049 // remove 1 since the outer inset does not count
4053 static depth_type getItemDepth(ParIterator const & it)
4055 Paragraph const & par = *it;
4056 LabelType const labeltype = par.layout().labeltype;
4058 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4061 // this will hold the lowest depth encountered up to now.
4062 depth_type min_depth = getDepth(it);
4063 ParIterator prev_it = it;
4066 --prev_it.top().pit();
4068 // start of nested inset: go to outer par
4070 if (prev_it.empty()) {
4071 // start of document: nothing to do
4076 // We search for the first paragraph with same label
4077 // that is not more deeply nested.
4078 Paragraph & prev_par = *prev_it;
4079 depth_type const prev_depth = getDepth(prev_it);
4080 if (labeltype == prev_par.layout().labeltype) {
4081 if (prev_depth < min_depth)
4082 return prev_par.itemdepth + 1;
4083 if (prev_depth == min_depth)
4084 return prev_par.itemdepth;
4086 min_depth = min(min_depth, prev_depth);
4087 // small optimization: if we are at depth 0, we won't
4088 // find anything else
4089 if (prev_depth == 0)
4095 static bool needEnumCounterReset(ParIterator const & it)
4097 Paragraph const & par = *it;
4098 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4099 depth_type const cur_depth = par.getDepth();
4100 ParIterator prev_it = it;
4101 while (prev_it.pit()) {
4102 --prev_it.top().pit();
4103 Paragraph const & prev_par = *prev_it;
4104 if (prev_par.getDepth() <= cur_depth)
4105 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4107 // start of nested inset: reset
4112 // set the label of a paragraph. This includes the counters.
4113 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4115 BufferParams const & bp = owner_->masterBuffer()->params();
4116 DocumentClass const & textclass = bp.documentClass();
4117 Paragraph & par = it.paragraph();
4118 Layout const & layout = par.layout();
4119 Counters & counters = textclass.counters();
4121 if (par.params().startOfAppendix()) {
4122 // FIXME: only the counter corresponding to toplevel
4123 // sectioning should be reset
4125 counters.appendix(true);
4127 par.params().appendix(counters.appendix());
4129 // Compute the item depth of the paragraph
4130 par.itemdepth = getItemDepth(it);
4132 if (layout.margintype == MARGIN_MANUAL
4133 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
4134 if (par.params().labelWidthString().empty())
4135 par.params().labelWidthString(par.expandLabel(layout, bp));
4137 par.params().labelWidthString(docstring());
4140 switch(layout.labeltype) {
4142 if (layout.toclevel <= bp.secnumdepth
4143 && (layout.latextype != LATEX_ENVIRONMENT
4144 || it.text()->isFirstInSequence(it.pit()))) {
4145 if (counters.hasCounter(layout.counter))
4146 counters.step(layout.counter, utype);
4147 par.params().labelString(par.expandLabel(layout, bp));
4149 par.params().labelString(docstring());
4152 case LABEL_ITEMIZE: {
4153 // At some point of time we should do something more
4154 // clever here, like:
4155 // par.params().labelString(
4156 // bp.user_defined_bullet(par.itemdepth).getText());
4157 // for now, use a simple hardcoded label
4158 docstring itemlabel;
4159 switch (par.itemdepth) {
4161 itemlabel = char_type(0x2022);
4164 itemlabel = char_type(0x2013);
4167 itemlabel = char_type(0x2217);
4170 itemlabel = char_type(0x2219); // or 0x00b7
4173 par.params().labelString(itemlabel);
4177 case LABEL_ENUMERATE: {
4178 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4180 switch (par.itemdepth) {
4189 enumcounter += "iv";
4192 // not a valid enumdepth...
4196 // Maybe we have to reset the enumeration counter.
4197 if (needEnumCounterReset(it))
4198 counters.reset(enumcounter);
4199 counters.step(enumcounter, utype);
4201 string const & lang = par.getParLanguage(bp)->code();
4202 par.params().labelString(counters.theCounter(enumcounter, lang));
4207 case LABEL_SENSITIVE: {
4208 string const & type = counters.current_float();
4209 docstring full_label;
4211 full_label = owner_->B_("Senseless!!! ");
4213 docstring name = owner_->B_(textclass.floats().getType(type).name());
4214 if (counters.hasCounter(from_utf8(type))) {
4215 string const & lang = par.getParLanguage(bp)->code();
4216 counters.step(from_utf8(type), utype);
4217 full_label = bformat(from_ascii("%1$s %2$s:"),
4219 counters.theCounter(from_utf8(type), lang));
4221 full_label = bformat(from_ascii("%1$s #:"), name);
4223 par.params().labelString(full_label);
4227 case LABEL_NO_LABEL:
4228 par.params().labelString(docstring());
4232 case LABEL_TOP_ENVIRONMENT:
4233 case LABEL_CENTERED_TOP_ENVIRONMENT:
4236 par.params().labelString(par.expandLabel(layout, bp));
4242 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4244 LASSERT(parit.pit() == 0, /**/);
4246 // Set the position of the text in the buffer to be able
4247 // to resolve macros in it.
4248 parit.text()->setMacrocontextPosition(parit);
4250 depth_type maxdepth = 0;
4251 pit_type const lastpit = parit.lastpit();
4252 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4253 // reduce depth if necessary
4254 parit->params().depth(min(parit->params().depth(), maxdepth));
4255 maxdepth = parit->getMaxDepthAfter();
4257 if (utype == OutputUpdate) {
4258 // track the active counters
4259 // we have to do this for the master buffer, since the local
4260 // buffer isn't tracking anything.
4261 masterBuffer()->params().documentClass().counters().
4262 setActiveLayout(parit->layout());
4265 // set the counter for this paragraph
4266 d->setLabel(parit, utype);
4269 InsetList::const_iterator iit = parit->insetList().begin();
4270 InsetList::const_iterator end = parit->insetList().end();
4271 for (; iit != end; ++iit) {
4272 parit.pos() = iit->pos;
4273 iit->inset->updateBuffer(parit, utype);
4279 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4280 WordLangTuple & word_lang, docstring_list & suggestions) const
4284 suggestions.clear();
4285 word_lang = WordLangTuple();
4286 // OK, we start from here.
4287 DocIterator const end = doc_iterator_end(this);
4288 for (; from != end; from.forwardPos()) {
4289 // We are only interested in text so remove the math CursorSlice.
4290 while (from.inMathed()) {
4294 // If from is at the end of the document (which is possible
4295 // when leaving the mathed) LyX will crash later.
4299 from.paragraph().spellCheck();
4300 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4301 if (SpellChecker::misspelled(res)) {
4306 // Do not increase progress when from == to, otherwise the word
4307 // count will be wrong.
4317 Buffer::ReadStatus Buffer::reload()
4320 // c.f. bug http://www.lyx.org/trac/ticket/6587
4321 removeAutosaveFile();
4322 // e.g., read-only status could have changed due to version control
4323 d->filename.refresh();
4324 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4326 ReadStatus const status = loadLyXFile();
4327 if (status == ReadSuccess) {
4332 message(bformat(_("Document %1$s reloaded."), disp_fn));
4335 message(bformat(_("Could not reload document %1$s."), disp_fn));
4345 bool Buffer::saveAs(FileName const & fn)
4347 FileName const old_name = fileName();
4348 FileName const old_auto = getAutosaveFileName();
4349 bool const old_unnamed = isUnnamed();
4356 // bring the autosave file with us, just in case.
4357 moveAutosaveFile(old_auto);
4358 // validate version control data and
4359 // correct buffer title
4360 lyxvc().file_found_hook(fileName());
4362 // the file has now been saved to the new location.
4363 // we need to check that the locations of child buffers
4365 checkChildBuffers();
4369 // reset the old filename and unnamed state
4370 setFileName(old_name);
4371 setUnnamed(old_unnamed);
4377 // FIXME We could do better here, but it is complicated. What would be
4378 // nice is to offer either (a) to save the child buffer to an appropriate
4379 // location, so that it would "move with the master", or else (b) to update
4380 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4381 // complicated, because the code for this lives in GuiView.
4382 void Buffer::checkChildBuffers()
4384 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4385 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4386 for (; it != en; ++it) {
4387 DocIterator dit = it->second;
4388 Buffer * cbuf = const_cast<Buffer *>(it->first);
4389 if (!cbuf || !theBufferList().isLoaded(cbuf))
4391 Inset * inset = dit.nextInset();
4392 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4393 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4394 docstring const & incfile = inset_inc->getParam("filename");
4395 string oldloc = cbuf->absFileName();
4396 string newloc = makeAbsPath(to_utf8(incfile),
4397 onlyPath(absFileName())).absFileName();
4398 if (oldloc == newloc)
4400 // the location of the child file is incorrect.
4401 Alert::warning(_("Included File Invalid"),
4402 bformat(_("Saving this document to a new location has made the file:\n"
4404 "inaccessible. You will need to update the included filename."),
4405 from_utf8(oldloc)));
4407 inset_inc->setChildBuffer(0);
4409 // invalidate cache of children
4410 d->children_positions.clear();
4411 d->position_to_children.clear();