3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibitem.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetTabular.h"
74 #include "insets/InsetText.h"
76 #include "mathed/InsetMathHull.h"
77 #include "mathed/MacroTable.h"
78 #include "mathed/MathMacroTemplate.h"
79 #include "mathed/MathSupport.h"
81 #include "frontends/alert.h"
82 #include "frontends/Delegates.h"
83 #include "frontends/WorkAreaManager.h"
85 #include "graphics/Previews.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileName.h"
93 #include "support/FileNameList.h"
94 #include "support/filetools.h"
95 #include "support/ForkedCalls.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/lyxalgo.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/Path.h"
103 #include "support/Systemcall.h"
104 #include "support/textutils.h"
105 #include "support/types.h"
107 #include "support/bind.h"
108 #include "support/shared_ptr.h"
120 using namespace lyx::support;
124 namespace Alert = frontend::Alert;
125 namespace os = support::os;
129 // Do not remove the comment below, so we get merge conflict in
130 // independent branches. Instead add your own.
131 int const LYX_FORMAT = 404; // rgh: refstyle
133 typedef map<string, bool> DepClean;
134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
136 void showPrintError(string const & name)
138 docstring str = bformat(_("Could not print the document %1$s.\n"
139 "Check that your printer is set up correctly."),
140 makeDisplayPath(name, 50));
141 Alert::error(_("Print document failed"), str);
150 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
161 /// search for macro in local (buffer) table or in children
162 MacroData const * getBufferMacro(docstring const & name,
163 DocIterator const & pos) const;
165 /// Update macro table starting with position of it \param it in some
167 void updateMacros(DocIterator & it, DocIterator & scope);
169 void setLabel(ParIterator & it, UpdateType utype) const;
171 /** If we have branches that use the file suffix
172 feature, return the file name with suffix appended.
174 support::FileName exportFileName() const;
181 mutable TexRow texrow;
183 /// need to regenerate .tex?
187 mutable bool lyx_clean;
189 /// is autosave needed?
190 mutable bool bak_clean;
192 /// is this a unnamed file (New...)?
198 /// name of the file the buffer is associated with.
201 /** Set to true only when the file is fully loaded.
202 * Used to prevent the premature generation of previews
203 * and by the citation inset.
205 bool file_fully_loaded;
208 mutable TocBackend toc_backend;
211 typedef pair<DocIterator, MacroData> ScopeMacro;
212 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
213 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
214 /// map from the macro name to the position map,
215 /// which maps the macro definition position to the scope and the MacroData.
216 NamePositionScopeMacroMap macros;
217 /// This seem to change the way Buffer::getMacro() works
218 mutable bool macro_lock;
220 /// positions of child buffers in the buffer
221 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
222 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
223 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
224 /// position of children buffers in this buffer
225 BufferPositionMap children_positions;
226 /// map from children inclusion positions to their scope and their buffer
227 PositionScopeBufferMap position_to_children;
229 /// Container for all sort of Buffer dependant errors.
230 map<string, ErrorList> errorLists;
232 /// timestamp and checksum used to test if the file has been externally
233 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
235 unsigned long checksum_;
238 frontend::WorkAreaManager * wa_;
240 frontend::GuiBufferDelegate * gui_;
245 /// A cache for the bibfiles (including bibfiles of loaded child
246 /// documents), needed for appropriate update of natbib labels.
247 mutable support::FileNameList bibfiles_cache_;
249 // FIXME The caching mechanism could be improved. At present, we have a
250 // cache for each Buffer, that caches all the bibliography info for that
251 // Buffer. A more efficient solution would be to have a global cache per
252 // file, and then to construct the Buffer's bibinfo from that.
253 /// A cache for bibliography info
254 mutable BiblioInfo bibinfo_;
255 /// whether the bibinfo cache is valid
256 mutable bool bibinfo_cache_valid_;
257 /// whether the bibfile cache is valid
258 mutable bool bibfile_cache_valid_;
259 /// Cache of timestamps of .bib files
260 map<FileName, time_t> bibfile_status_;
262 mutable RefCache ref_cache_;
264 /// our Text that should be wrapped in an InsetText
267 /// This is here to force the test to be done whenever parent_buffer
269 Buffer const * parent() const {
270 // if parent_buffer is not loaded, then it has been unloaded,
271 // which means that parent_buffer is an invalid pointer. So we
272 // set it to null in that case.
273 // however, the BufferList doesn't know about cloned buffers, so
274 // they will always be regarded as unloaded. in that case, we hope
276 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
278 return parent_buffer;
282 void setParent(Buffer const * pb) {
283 if (parent_buffer == pb)
286 if (!cloned_buffer_ && parent_buffer && pb)
287 LYXERR0("Warning: a buffer should not have two parents!");
289 if (!cloned_buffer_ && parent_buffer) {
290 parent_buffer->invalidateBibfileCache();
291 parent_buffer->invalidateBibinfoCache();
295 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
296 /// This one is useful for preview detached in a thread.
297 Buffer const * cloned_buffer_;
298 /// are we in the process of exporting this buffer?
299 mutable bool doing_export;
302 /// So we can force access via the accessors.
303 mutable Buffer const * parent_buffer;
308 /// Creates the per buffer temporary directory
309 static FileName createBufferTmpDir()
312 // We are in our own directory. Why bother to mangle name?
313 // In fact I wrote this code to circumvent a problematic behaviour
314 // (bug?) of EMX mkstemp().
315 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
316 convert<string>(count++));
318 if (!tmpfl.createDirectory(0777)) {
319 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
320 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
321 from_utf8(tmpfl.absFileName())));
327 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
328 Buffer const * cloned_buffer)
329 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
330 read_only(readonly_), filename(file), file_fully_loaded(false),
331 toc_backend(owner), macro_lock(false), timestamp_(0),
332 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
333 bibfile_cache_valid_(false), cloned_buffer_(cloned_buffer),
334 doing_export(false), parent_buffer(0)
336 if (!cloned_buffer_) {
337 temppath = createBufferTmpDir();
338 lyxvc.setBuffer(owner_);
340 wa_ = new frontend::WorkAreaManager;
343 temppath = cloned_buffer_->d->temppath;
344 file_fully_loaded = true;
345 params = cloned_buffer_->d->params;
346 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
347 bibinfo_ = cloned_buffer_->d->bibinfo_;
348 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
349 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
350 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
354 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
355 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
357 LYXERR(Debug::INFO, "Buffer::Buffer()");
359 d->inset = new InsetText(*cloned_buffer->d->inset);
360 d->inset->setBuffer(*this);
361 // FIXME: optimize this loop somewhat, maybe by creating a new
362 // general recursive Inset::setId().
363 DocIterator it = doc_iterator_begin(this);
364 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
365 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
366 it.paragraph().setId(cloned_it.paragraph().id());
368 d->inset = new InsetText(this);
369 d->inset->setAutoBreakRows(true);
370 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
376 LYXERR(Debug::INFO, "Buffer::~Buffer()");
377 // here the buffer should take care that it is
378 // saved properly, before it goes into the void.
380 // GuiView already destroyed
384 // No need to do additional cleanups for internal buffer.
389 // loop over children
390 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
391 Impl::BufferPositionMap::iterator end = d->children_positions.end();
392 for (; it != end; ++it) {
393 Buffer * child = const_cast<Buffer *>(it->first);
394 if (d->cloned_buffer_)
396 // The child buffer might have been closed already.
397 else if (theBufferList().isLoaded(child))
398 theBufferList().releaseChild(this, child);
402 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
403 msg += emergencyWrite();
404 Alert::warning(_("Attempting to close changed document!"), msg);
407 // clear references to children in macro tables
408 d->children_positions.clear();
409 d->position_to_children.clear();
411 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
412 Alert::warning(_("Could not remove temporary directory"),
413 bformat(_("Could not remove the temporary directory %1$s"),
414 from_utf8(d->temppath.absFileName())));
417 // Remove any previewed LaTeX snippets associated with this buffer.
419 thePreviews().removeLoader(*this);
425 Buffer * Buffer::clone() const
427 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
428 buffer_clone->d->macro_lock = true;
429 buffer_clone->d->children_positions.clear();
430 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
431 // math macro caches need to be rethought and simplified.
432 // I am not sure wether we should handle Buffer cloning here or in BufferList.
433 // Right now BufferList knows nothing about buffer clones.
434 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
435 Impl::BufferPositionMap::iterator end = d->children_positions.end();
436 for (; it != end; ++it) {
437 DocIterator dit = it->second.clone(buffer_clone);
438 dit.setBuffer(buffer_clone);
439 Buffer * child = const_cast<Buffer *>(it->first);
440 Buffer * child_clone = child->clone();
441 Inset * inset = dit.nextInset();
442 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
443 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
444 inset_inc->setChildBuffer(child_clone);
445 child_clone->d->setParent(buffer_clone);
446 buffer_clone->setChild(dit, child_clone);
448 buffer_clone->d->macro_lock = false;
453 bool Buffer::isClone() const
455 return d->cloned_buffer_;
459 void Buffer::changed(bool update_metrics) const
462 d->wa_->redrawAll(update_metrics);
466 frontend::WorkAreaManager & Buffer::workAreaManager() const
468 LASSERT(d->wa_, /**/);
473 Text & Buffer::text() const
475 return d->inset->text();
479 Inset & Buffer::inset() const
485 BufferParams & Buffer::params()
491 BufferParams const & Buffer::params() const
497 ParagraphList & Buffer::paragraphs()
499 return text().paragraphs();
503 ParagraphList const & Buffer::paragraphs() const
505 return text().paragraphs();
509 LyXVC & Buffer::lyxvc()
515 LyXVC const & Buffer::lyxvc() const
521 string const Buffer::temppath() const
523 return d->temppath.absFileName();
527 TexRow & Buffer::texrow()
533 TexRow const & Buffer::texrow() const
539 TocBackend & Buffer::tocBackend() const
541 return d->toc_backend;
545 Undo & Buffer::undo()
551 void Buffer::setChild(DocIterator const & dit, Buffer * child)
553 d->children_positions[child] = dit;
557 string Buffer::latexName(bool const no_path) const
559 FileName latex_name =
560 makeLatexName(d->exportFileName());
561 return no_path ? latex_name.onlyFileName()
562 : latex_name.absFileName();
566 FileName Buffer::Impl::exportFileName() const
568 docstring const branch_suffix =
569 params.branchlist().getFileNameSuffix();
570 if (branch_suffix.empty())
573 string const name = filename.onlyFileNameWithoutExt()
574 + to_utf8(branch_suffix);
575 FileName res(filename.onlyPath().absFileName() + "/" + name);
576 res.changeExtension(filename.extension());
582 string Buffer::logName(LogType * type) const
584 string const filename = latexName(false);
586 if (filename.empty()) {
592 string const path = temppath();
594 FileName const fname(addName(temppath(),
595 onlyFileName(changeExtension(filename,
598 // FIXME: how do we know this is the name of the build log?
599 FileName const bname(
600 addName(path, onlyFileName(
601 changeExtension(filename,
602 formats.extension(bufferFormat()) + ".out"))));
604 // Also consider the master buffer log file
605 FileName masterfname = fname;
607 if (masterBuffer() != this) {
608 string const mlogfile = masterBuffer()->logName(&mtype);
609 masterfname = FileName(mlogfile);
612 // If no Latex log or Build log is newer, show Build log
613 if (bname.exists() &&
614 ((!fname.exists() && !masterfname.exists())
615 || (fname.lastModified() < bname.lastModified()
616 && masterfname.lastModified() < bname.lastModified()))) {
617 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
620 return bname.absFileName();
621 // If we have a newer master file log or only a master log, show this
622 } else if (fname != masterfname
623 && (!fname.exists() && (masterfname.exists()
624 || fname.lastModified() < masterfname.lastModified()))) {
625 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
628 return masterfname.absFileName();
630 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
633 return fname.absFileName();
637 void Buffer::setReadonly(bool const flag)
639 if (d->read_only != flag) {
646 void Buffer::setFileName(string const & newfile)
648 d->filename = makeAbsPath(newfile);
649 setReadonly(d->filename.isReadOnly());
654 int Buffer::readHeader(Lexer & lex)
656 int unknown_tokens = 0;
658 int begin_header_line = -1;
660 // Initialize parameters that may be/go lacking in header:
661 params().branchlist().clear();
662 params().preamble.erase();
663 params().options.erase();
664 params().master.erase();
665 params().float_placement.erase();
666 params().paperwidth.erase();
667 params().paperheight.erase();
668 params().leftmargin.erase();
669 params().rightmargin.erase();
670 params().topmargin.erase();
671 params().bottommargin.erase();
672 params().headheight.erase();
673 params().headsep.erase();
674 params().footskip.erase();
675 params().columnsep.erase();
676 params().fontsCJK.erase();
677 params().listings_params.clear();
678 params().clearLayoutModules();
679 params().clearRemovedModules();
680 params().clearIncludedChildren();
681 params().pdfoptions().clear();
682 params().indiceslist().clear();
683 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
684 params().isbackgroundcolor = false;
685 params().fontcolor = lyx::rgbFromHexName("#000000");
686 params().isfontcolor = false;
687 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
688 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
689 params().html_latex_start.clear();
690 params().html_latex_end.clear();
691 params().html_math_img_scale = 1.0;
692 params().output_sync_macro.erase();
694 for (int i = 0; i < 4; ++i) {
695 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
696 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
699 ErrorList & errorList = d->errorLists["Parse"];
708 if (token == "\\end_header")
712 if (token == "\\begin_header") {
713 begin_header_line = line;
717 LYXERR(Debug::PARSER, "Handling document header token: `"
720 string unknown = params().readToken(lex, token, d->filename.onlyPath());
721 if (!unknown.empty()) {
722 if (unknown[0] != '\\' && token == "\\textclass") {
723 Alert::warning(_("Unknown document class"),
724 bformat(_("Using the default document class, because the "
725 "class %1$s is unknown."), from_utf8(unknown)));
728 docstring const s = bformat(_("Unknown token: "
732 errorList.push_back(ErrorItem(_("Document header error"),
737 if (begin_header_line) {
738 docstring const s = _("\\begin_header is missing");
739 errorList.push_back(ErrorItem(_("Document header error"),
743 params().makeDocumentClass();
745 return unknown_tokens;
750 // changed to be public and have one parameter
751 // Returns true if "\end_document" is not read (Asger)
752 bool Buffer::readDocument(Lexer & lex)
754 ErrorList & errorList = d->errorLists["Parse"];
757 // remove dummy empty par
758 paragraphs().clear();
760 if (!lex.checkFor("\\begin_document")) {
761 docstring const s = _("\\begin_document is missing");
762 errorList.push_back(ErrorItem(_("Document header error"),
768 if (params().outputChanges) {
769 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
770 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
771 LaTeXFeatures::isAvailable("xcolor");
773 if (!dvipost && !xcolorulem) {
774 Alert::warning(_("Changes not shown in LaTeX output"),
775 _("Changes will not be highlighted in LaTeX output, "
776 "because neither dvipost nor xcolor/ulem are installed.\n"
777 "Please install these packages or redefine "
778 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
779 } else if (!xcolorulem) {
780 Alert::warning(_("Changes not shown in LaTeX output"),
781 _("Changes will not be highlighted in LaTeX output "
782 "when using pdflatex, because xcolor and ulem are not installed.\n"
783 "Please install both packages or redefine "
784 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
788 if (!params().master.empty()) {
789 FileName const master_file = makeAbsPath(params().master,
790 onlyPath(absFileName()));
791 if (isLyXFileName(master_file.absFileName())) {
793 checkAndLoadLyXFile(master_file, true);
795 // necessary e.g. after a reload
796 // to re-register the child (bug 5873)
797 // FIXME: clean up updateMacros (here, only
798 // child registering is needed).
799 master->updateMacros();
800 // set master as master buffer, but only
801 // if we are a real child
802 if (master->isChild(this))
804 // if the master is not fully loaded
805 // it is probably just loading this
806 // child. No warning needed then.
807 else if (master->isFullyLoaded())
808 LYXERR0("The master '"
810 << "' assigned to this document ("
812 << ") does not include "
813 "this document. Ignoring the master assignment.");
818 // assure we have a default index
819 params().indiceslist().addDefault(B_("Index"));
822 bool const res = text().read(lex, errorList, d->inset);
826 updateMacroInstances();
831 bool Buffer::readString(string const & s)
833 params().compressed = false;
838 FileName const name = FileName::tempName("Buffer_readString");
839 switch (readFile(lex, name, true)) {
843 case ReadWrongVersion: {
844 // We need to call lyx2lyx, so write the input to a file
845 ofstream os(name.toFilesystemEncoding().c_str());
848 return readFile(name);
858 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
864 ReadStatus const ret_rf = readFile(lex, fname);
865 if (ret_rf != ReadSuccess)
868 // InsetInfo needs to know if file is under VCS
869 lyxvc().file_found_hook(fn);
870 d->read_only = !fname.isWritable();
871 params().compressed = fname.isZippedFile();
876 bool Buffer::isFullyLoaded() const
878 return d->file_fully_loaded;
882 void Buffer::setFullyLoaded(bool value)
884 d->file_fully_loaded = value;
888 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
891 LASSERT(!filename.empty(), /**/);
893 // the first (non-comment) token _must_ be...
894 if (!lex.checkFor("\\lyxformat")) {
895 Alert::error(_("Document format failure"),
896 bformat(_("%1$s is not a readable LyX document."),
897 from_utf8(filename.absFileName())));
903 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
904 // if present remove ".," from string.
905 size_t dot = tmp_format.find_first_of(".,");
906 //lyxerr << " dot found at " << dot << endl;
907 if (dot != string::npos)
908 tmp_format.erase(dot, 1);
909 int const file_format = convert<int>(tmp_format);
910 //lyxerr << "format: " << file_format << endl;
912 // save timestamp and checksum of the original disk file, making sure
913 // to not overwrite them with those of the file created in the tempdir
914 // when it has to be converted to the current format.
916 // Save the timestamp and checksum of disk file. If filename is an
917 // emergency file, save the timestamp and checksum of the original lyx file
918 // because isExternallyModified will check for this file. (BUG4193)
919 string diskfile = filename.absFileName();
920 if (suffixIs(diskfile, ".emergency"))
921 diskfile = diskfile.substr(0, diskfile.size() - 10);
922 saveCheckSum(FileName(diskfile));
925 if (file_format != LYX_FORMAT) {
928 // lyx2lyx would fail
929 return ReadWrongVersion;
931 FileName const tmpfile = FileName::tempName("Buffer_readFile");
932 if (tmpfile.empty()) {
933 Alert::error(_("Conversion failed"),
934 bformat(_("%1$s is from a different"
935 " version of LyX, but a temporary"
936 " file for converting it could"
938 from_utf8(filename.absFileName())));
941 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
942 if (lyx2lyx.empty()) {
943 Alert::error(_("Conversion script not found"),
944 bformat(_("%1$s is from a different"
945 " version of LyX, but the"
946 " conversion script lyx2lyx"
947 " could not be found."),
948 from_utf8(filename.absFileName())));
951 ostringstream command;
952 command << os::python()
953 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
954 << " -t " << convert<string>(LYX_FORMAT)
955 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
956 << ' ' << quoteName(filename.toSafeFilesystemEncoding());
957 string const command_str = command.str();
959 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
961 cmd_ret const ret = runCommand(command_str);
962 if (ret.first != 0) {
963 if (file_format < LYX_FORMAT)
964 Alert::error(_("Conversion script failed"),
965 bformat(_("%1$s is from an older version"
966 " of LyX, but the lyx2lyx script"
967 " failed to convert it."),
968 from_utf8(filename.absFileName())));
970 Alert::error(_("Conversion script failed"),
971 bformat(_("%1$s is from a newer version"
972 " of LyX and cannot be converted by the"
974 from_utf8(filename.absFileName())));
977 // Do stuff with tmpfile name and buffer name here.
978 return readFile(tmpfile);
983 if (readDocument(lex)) {
984 Alert::error(_("Document format failure"),
985 bformat(_("%1$s ended unexpectedly, which means"
986 " that it is probably corrupted."),
987 from_utf8(filename.absFileName())));
991 d->file_fully_loaded = true;
996 // Should probably be moved to somewhere else: BufferView? GuiView?
997 bool Buffer::save() const
999 // ask if the disk file has been externally modified (use checksum method)
1000 if (fileName().exists() && isExternallyModified(checksum_method)) {
1001 docstring const file = makeDisplayPath(absFileName(), 20);
1002 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
1003 "you want to overwrite this file?"), file);
1004 int const ret = Alert::prompt(_("Overwrite modified file?"),
1005 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1010 // We don't need autosaves in the immediate future. (Asger)
1011 resetAutosaveTimers();
1013 FileName backupName;
1014 bool madeBackup = false;
1016 // make a backup if the file already exists
1017 if (lyxrc.make_backup && fileName().exists()) {
1018 backupName = FileName(absFileName() + '~');
1019 if (!lyxrc.backupdir_path.empty()) {
1020 string const mangledName =
1021 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1022 backupName = FileName(addName(lyxrc.backupdir_path,
1025 // do not copy because of #6587
1026 if (fileName().moveTo(backupName)) {
1029 Alert::error(_("Backup failure"),
1030 bformat(_("Cannot create backup file %1$s.\n"
1031 "Please check whether the directory exists and is writeable."),
1032 from_utf8(backupName.absFileName())));
1033 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1037 if (writeFile(d->filename)) {
1041 // Saving failed, so backup is not backup
1043 backupName.moveTo(d->filename);
1049 bool Buffer::writeFile(FileName const & fname) const
1051 if (d->read_only && fname == d->filename)
1054 bool retval = false;
1056 docstring const str = bformat(_("Saving document %1$s..."),
1057 makeDisplayPath(fname.absFileName()));
1060 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1062 if (params().compressed) {
1063 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1064 retval = ofs && write(ofs);
1066 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1067 retval = ofs && write(ofs);
1071 message(str + _(" could not write file!"));
1076 // removeAutosaveFile();
1078 saveCheckSum(d->filename);
1079 message(str + _(" done."));
1085 docstring Buffer::emergencyWrite()
1087 // No need to save if the buffer has not changed.
1091 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1093 docstring user_message = bformat(
1094 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1096 // We try to save three places:
1097 // 1) Same place as document. Unless it is an unnamed doc.
1099 string s = absFileName();
1102 if (writeFile(FileName(s))) {
1104 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1105 return user_message;
1107 user_message += _(" Save failed! Trying again...\n");
1111 // 2) In HOME directory.
1112 string s = addName(package().home_dir().absFileName(), absFileName());
1114 lyxerr << ' ' << s << endl;
1115 if (writeFile(FileName(s))) {
1117 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1118 return user_message;
1121 user_message += _(" Save failed! Trying yet again...\n");
1123 // 3) In "/tmp" directory.
1124 // MakeAbsPath to prepend the current
1125 // drive letter on OS/2
1126 s = addName(package().temp_dir().absFileName(), absFileName());
1128 lyxerr << ' ' << s << endl;
1129 if (writeFile(FileName(s))) {
1131 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1132 return user_message;
1135 user_message += _(" Save failed! Bummer. Document is lost.");
1138 return user_message;
1142 bool Buffer::write(ostream & ofs) const
1145 // Use the standard "C" locale for file output.
1146 ofs.imbue(locale::classic());
1149 // The top of the file should not be written by params().
1151 // write out a comment in the top of the file
1152 ofs << "#LyX " << lyx_version
1153 << " created this file. For more info see http://www.lyx.org/\n"
1154 << "\\lyxformat " << LYX_FORMAT << "\n"
1155 << "\\begin_document\n";
1157 /// For each author, set 'used' to true if there is a change
1158 /// by this author in the document; otherwise set it to 'false'.
1159 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1160 AuthorList::Authors::const_iterator a_end = params().authors().end();
1161 for (; a_it != a_end; ++a_it)
1162 a_it->setUsed(false);
1164 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1165 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1166 for ( ; it != end; ++it)
1167 it->checkAuthors(params().authors());
1169 // now write out the buffer parameters.
1170 ofs << "\\begin_header\n";
1171 params().writeFile(ofs);
1172 ofs << "\\end_header\n";
1175 ofs << "\n\\begin_body\n";
1177 ofs << "\n\\end_body\n";
1179 // Write marker that shows file is complete
1180 ofs << "\\end_document" << endl;
1182 // Shouldn't really be needed....
1185 // how to check if close went ok?
1186 // Following is an attempt... (BE 20001011)
1188 // good() returns false if any error occured, including some
1189 // formatting error.
1190 // bad() returns true if something bad happened in the buffer,
1191 // which should include file system full errors.
1196 lyxerr << "File was not closed properly." << endl;
1203 bool Buffer::makeLaTeXFile(FileName const & fname,
1204 string const & original_path,
1205 OutputParams const & runparams_in,
1206 bool output_preamble, bool output_body) const
1208 OutputParams runparams = runparams_in;
1209 if (params().useXetex)
1210 runparams.flavor = OutputParams::XETEX;
1212 string const encoding = runparams.encoding->iconvName();
1213 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1216 try { ofs.reset(encoding); }
1217 catch (iconv_codecvt_facet_exception & e) {
1218 lyxerr << "Caught iconv exception: " << e.what() << endl;
1219 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1220 "verify that the support software for your encoding (%1$s) is "
1221 "properly installed"), from_ascii(encoding)));
1224 if (!openFileWrite(ofs, fname))
1227 //TexStream ts(ofs.rdbuf(), &texrow());
1228 ErrorList & errorList = d->errorLists["Export"];
1230 bool failed_export = false;
1233 writeLaTeXSource(ofs, original_path,
1234 runparams, output_preamble, output_body);
1236 catch (EncodingException & e) {
1237 odocstringstream ods;
1238 ods.put(e.failed_char);
1240 oss << "0x" << hex << e.failed_char << dec;
1241 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1242 " (code point %2$s)"),
1243 ods.str(), from_utf8(oss.str()));
1244 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1245 "representable in the chosen encoding.\n"
1246 "Changing the document encoding to utf8 could help."),
1247 e.par_id, e.pos, e.pos + 1));
1248 failed_export = true;
1250 catch (iconv_codecvt_facet_exception & e) {
1251 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1252 _(e.what()), -1, 0, 0));
1253 failed_export = true;
1255 catch (exception const & e) {
1256 errorList.push_back(ErrorItem(_("conversion failed"),
1257 _(e.what()), -1, 0, 0));
1258 failed_export = true;
1261 lyxerr << "Caught some really weird exception..." << endl;
1267 failed_export = true;
1268 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1272 return !failed_export;
1276 void Buffer::writeLaTeXSource(odocstream & os,
1277 string const & original_path,
1278 OutputParams const & runparams_in,
1279 bool const output_preamble, bool const output_body) const
1281 // The child documents, if any, shall be already loaded at this point.
1283 OutputParams runparams = runparams_in;
1285 // Classify the unicode characters appearing in math insets
1286 Encodings::initUnicodeMath(*this);
1288 // validate the buffer.
1289 LYXERR(Debug::LATEX, " Validating buffer...");
1290 LaTeXFeatures features(*this, params(), runparams);
1292 LYXERR(Debug::LATEX, " Buffer validation done.");
1294 // The starting paragraph of the coming rows is the
1295 // first paragraph of the document. (Asger)
1296 if (output_preamble && runparams.nice) {
1297 os << "%% LyX " << lyx_version << " created this file. "
1298 "For more info, see http://www.lyx.org/.\n"
1299 "%% Do not edit unless you really know what "
1301 d->texrow.newline();
1302 d->texrow.newline();
1304 LYXERR(Debug::INFO, "lyx document header finished");
1306 // Don't move this behind the parent_buffer=0 code below,
1307 // because then the macros will not get the right "redefinition"
1308 // flag as they don't see the parent macros which are output before.
1311 // fold macros if possible, still with parent buffer as the
1312 // macros will be put in the prefix anyway.
1313 updateMacroInstances();
1315 // There are a few differences between nice LaTeX and usual files:
1316 // usual is \batchmode and has a
1317 // special input@path to allow the including of figures
1318 // with either \input or \includegraphics (what figinsets do).
1319 // input@path is set when the actual parameter
1320 // original_path is set. This is done for usual tex-file, but not
1321 // for nice-latex-file. (Matthias 250696)
1322 // Note that input@path is only needed for something the user does
1323 // in the preamble, included .tex files or ERT, files included by
1324 // LyX work without it.
1325 if (output_preamble) {
1326 if (!runparams.nice) {
1327 // code for usual, NOT nice-latex-file
1328 os << "\\batchmode\n"; // changed
1329 // from \nonstopmode
1330 d->texrow.newline();
1332 if (!original_path.empty()) {
1334 // We don't know the encoding of inputpath
1335 docstring const inputpath = from_utf8(support::latex_path(original_path));
1336 docstring uncodable_glyphs;
1337 Encoding const * const enc = runparams.encoding;
1339 for (size_t n = 0; n < inputpath.size(); ++n) {
1340 docstring const glyph =
1341 docstring(1, inputpath[n]);
1342 if (enc->latexChar(inputpath[n], true) != glyph) {
1343 LYXERR0("Uncodable character '"
1345 << "' in input path!");
1346 uncodable_glyphs += glyph;
1351 // warn user if we found uncodable glyphs.
1352 if (!uncodable_glyphs.empty()) {
1353 frontend::Alert::warning(_("Uncodable character in file path"),
1354 support::bformat(_("The path of your document\n"
1356 "contains glyphs that are unknown in the\n"
1357 "current document encoding (namely %2$s).\n"
1358 "This will likely result in incomplete output.\n\n"
1359 "Choose an appropriate document encoding (such as utf8)\n"
1360 "or change the file path name."), inputpath, uncodable_glyphs));
1362 os << "\\makeatletter\n"
1363 << "\\def\\input@path{{"
1364 << inputpath << "/}}\n"
1365 << "\\makeatother\n";
1366 d->texrow.newline();
1367 d->texrow.newline();
1368 d->texrow.newline();
1372 // get parent macros (if this buffer has a parent) which will be
1373 // written at the document begin further down.
1374 MacroSet parentMacros;
1375 listParentMacros(parentMacros, features);
1377 // Write the preamble
1378 runparams.use_babel = params().writeLaTeX(os, features,
1380 d->filename.onlyPath());
1382 runparams.use_japanese = features.isRequired("japanese");
1388 os << "\\begin{document}\n";
1389 d->texrow.newline();
1391 // output the parent macros
1392 MacroSet::iterator it = parentMacros.begin();
1393 MacroSet::iterator end = parentMacros.end();
1394 for (; it != end; ++it) {
1395 int num_lines = (*it)->write(os, true);
1396 d->texrow.newlines(num_lines);
1399 } // output_preamble
1401 d->texrow.start(paragraphs().begin()->id(), 0);
1403 LYXERR(Debug::INFO, "preamble finished, now the body.");
1405 // if we are doing a real file with body, even if this is the
1406 // child of some other buffer, let's cut the link here.
1407 // This happens for example if only a child document is printed.
1408 Buffer const * save_parent = 0;
1409 if (output_preamble) {
1410 save_parent = d->parent();
1415 latexParagraphs(*this, text(), os, d->texrow, runparams);
1417 // Restore the parenthood if needed
1418 if (output_preamble)
1419 d->setParent(save_parent);
1421 // add this just in case after all the paragraphs
1423 d->texrow.newline();
1425 if (output_preamble) {
1426 os << "\\end{document}\n";
1427 d->texrow.newline();
1428 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1430 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1432 runparams_in.encoding = runparams.encoding;
1434 // Just to be sure. (Asger)
1435 d->texrow.newline();
1437 //for (int i = 0; i<d->texrow.rows(); i++) {
1439 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1440 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1443 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1444 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1448 bool Buffer::isLatex() const
1450 return params().documentClass().outputType() == LATEX;
1454 bool Buffer::isLiterate() const
1456 return params().documentClass().outputType() == LITERATE;
1460 bool Buffer::isDocBook() const
1462 return params().documentClass().outputType() == DOCBOOK;
1466 void Buffer::makeDocBookFile(FileName const & fname,
1467 OutputParams const & runparams,
1468 bool const body_only) const
1470 LYXERR(Debug::LATEX, "makeDocBookFile...");
1473 if (!openFileWrite(ofs, fname))
1476 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1480 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1484 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1485 OutputParams const & runparams,
1486 bool const only_body) const
1488 LaTeXFeatures features(*this, params(), runparams);
1493 DocumentClass const & tclass = params().documentClass();
1494 string const top_element = tclass.latexname();
1497 if (runparams.flavor == OutputParams::XML)
1498 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1501 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1504 if (! tclass.class_header().empty())
1505 os << from_ascii(tclass.class_header());
1506 else if (runparams.flavor == OutputParams::XML)
1507 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1508 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1510 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1512 docstring preamble = from_utf8(params().preamble);
1513 if (runparams.flavor != OutputParams::XML ) {
1514 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1515 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1516 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1517 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1520 string const name = runparams.nice
1521 ? changeExtension(absFileName(), ".sgml") : fname;
1522 preamble += features.getIncludedFiles(name);
1523 preamble += features.getLyXSGMLEntities();
1525 if (!preamble.empty()) {
1526 os << "\n [ " << preamble << " ]";
1531 string top = top_element;
1533 if (runparams.flavor == OutputParams::XML)
1534 top += params().language->code();
1536 top += params().language->code().substr(0, 2);
1539 if (!params().options.empty()) {
1541 top += params().options;
1544 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1545 << " file was created by LyX " << lyx_version
1546 << "\n See http://www.lyx.org/ for more information -->\n";
1548 params().documentClass().counters().reset();
1552 sgml::openTag(os, top);
1554 docbookParagraphs(text(), *this, os, runparams);
1555 sgml::closeTag(os, top_element);
1559 void Buffer::makeLyXHTMLFile(FileName const & fname,
1560 OutputParams const & runparams,
1561 bool const body_only) const
1563 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1566 if (!openFileWrite(ofs, fname))
1569 writeLyXHTMLSource(ofs, runparams, body_only);
1573 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1577 void Buffer::writeLyXHTMLSource(odocstream & os,
1578 OutputParams const & runparams,
1579 bool const only_body) const
1581 LaTeXFeatures features(*this, params(), runparams);
1583 updateBuffer(UpdateMaster, OutputUpdate);
1584 d->bibinfo_.makeCitationLabels(*this);
1586 updateMacroInstances();
1589 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1590 << "<!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"
1591 // FIXME Language should be set properly.
1592 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1594 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1595 // FIXME Presumably need to set this right
1596 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1598 docstring const & doctitle = features.htmlTitle();
1600 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1603 os << "\n<!-- Text Class Preamble -->\n"
1604 << features.getTClassHTMLPreamble()
1605 << "\n<!-- Premable Snippets -->\n"
1606 << from_utf8(features.getPreambleSnippets());
1608 os << "\n<!-- Layout-provided Styles -->\n";
1609 docstring const styleinfo = features.getTClassHTMLStyles();
1610 if (!styleinfo.empty()) {
1611 os << "<style type='text/css'>\n"
1615 os << "</head>\n<body>\n";
1619 params().documentClass().counters().reset();
1620 xhtmlParagraphs(text(), *this, xs, runparams);
1622 os << "</body>\n</html>\n";
1626 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1627 // Other flags: -wall -v0 -x
1628 int Buffer::runChktex()
1632 // get LaTeX-Filename
1633 FileName const path(temppath());
1634 string const name = addName(path.absFileName(), latexName());
1635 string const org_path = filePath();
1637 PathChanger p(path); // path to LaTeX file
1638 message(_("Running chktex..."));
1640 // Generate the LaTeX file if neccessary
1641 OutputParams runparams(¶ms().encoding());
1642 runparams.flavor = OutputParams::LATEX;
1643 runparams.nice = false;
1644 runparams.linelen = lyxrc.plaintext_linelen;
1645 makeLaTeXFile(FileName(name), org_path, runparams);
1648 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1649 int const res = chktex.run(terr); // run chktex
1652 Alert::error(_("chktex failure"),
1653 _("Could not run chktex successfully."));
1654 } else if (res > 0) {
1655 ErrorList & errlist = d->errorLists["ChkTeX"];
1657 bufferErrors(terr, errlist);
1668 void Buffer::validate(LaTeXFeatures & features) const
1670 params().validate(features);
1674 for_each(paragraphs().begin(), paragraphs().end(),
1675 bind(&Paragraph::validate, _1, ref(features)));
1677 if (lyxerr.debugging(Debug::LATEX)) {
1678 features.showStruct();
1683 void Buffer::getLabelList(vector<docstring> & list) const
1685 // If this is a child document, use the master's list instead.
1687 masterBuffer()->getLabelList(list);
1692 Toc & toc = d->toc_backend.toc("label");
1693 TocIterator toc_it = toc.begin();
1694 TocIterator end = toc.end();
1695 for (; toc_it != end; ++toc_it) {
1696 if (toc_it->depth() == 0)
1697 list.push_back(toc_it->str());
1702 void Buffer::updateBibfilesCache(UpdateScope scope) const
1704 // FIXME This is probably unnecssary, given where we call this.
1705 // If this is a child document, use the parent's cache instead.
1706 if (parent() && scope != UpdateChildOnly) {
1707 masterBuffer()->updateBibfilesCache();
1711 d->bibfiles_cache_.clear();
1712 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1713 if (it->lyxCode() == BIBTEX_CODE) {
1714 InsetBibtex const & inset =
1715 static_cast<InsetBibtex const &>(*it);
1716 support::FileNameList const bibfiles = inset.getBibFiles();
1717 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1720 } else if (it->lyxCode() == INCLUDE_CODE) {
1721 InsetInclude & inset =
1722 static_cast<InsetInclude &>(*it);
1723 Buffer const * const incbuf = inset.getChildBuffer();
1726 support::FileNameList const & bibfiles =
1727 incbuf->getBibfilesCache(UpdateChildOnly);
1728 if (!bibfiles.empty()) {
1729 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1735 d->bibfile_cache_valid_ = true;
1736 d->bibinfo_cache_valid_ = false;
1740 void Buffer::invalidateBibinfoCache() const
1742 d->bibinfo_cache_valid_ = false;
1743 // also invalidate the cache for the parent buffer
1744 Buffer const * const pbuf = d->parent();
1746 pbuf->invalidateBibinfoCache();
1750 void Buffer::invalidateBibfileCache() const
1752 d->bibfile_cache_valid_ = false;
1753 d->bibinfo_cache_valid_ = false;
1754 // also invalidate the cache for the parent buffer
1755 Buffer const * const pbuf = d->parent();
1757 pbuf->invalidateBibfileCache();
1761 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1763 // FIXME This is probably unnecessary, given where we call this.
1764 // If this is a child document, use the master's cache instead.
1765 Buffer const * const pbuf = masterBuffer();
1766 if (pbuf != this && scope != UpdateChildOnly)
1767 return pbuf->getBibfilesCache();
1769 if (!d->bibfile_cache_valid_)
1770 this->updateBibfilesCache(scope);
1772 return d->bibfiles_cache_;
1776 BiblioInfo const & Buffer::masterBibInfo() const
1778 Buffer const * const tmp = masterBuffer();
1780 return tmp->masterBibInfo();
1785 void Buffer::checkBibInfoCache() const
1787 // use the master's cache
1788 Buffer const * const tmp = masterBuffer();
1790 tmp->checkBibInfoCache();
1794 // this will also reload the cache if it is invalid
1795 support::FileNameList const & bibfiles_cache = getBibfilesCache();
1797 // compare the cached timestamps with the actual ones.
1798 support::FileNameList::const_iterator ei = bibfiles_cache.begin();
1799 support::FileNameList::const_iterator en = bibfiles_cache.end();
1800 for (; ei != en; ++ ei) {
1801 time_t lastw = ei->lastModified();
1802 time_t prevw = d->bibfile_status_[*ei];
1803 if (lastw != prevw) {
1804 d->bibinfo_cache_valid_ = false;
1805 d->bibfile_status_[*ei] = lastw;
1809 // if not valid, then reload the info
1810 if (!d->bibinfo_cache_valid_) {
1811 d->bibinfo_.clear();
1812 fillWithBibKeys(d->bibinfo_);
1813 d->bibinfo_cache_valid_ = true;
1818 void Buffer::fillWithBibKeys(BiblioInfo & keys) const
1820 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1821 it->fillWithBibKeys(keys, it);
1825 bool Buffer::isDepClean(string const & name) const
1827 DepClean::const_iterator const it = d->dep_clean.find(name);
1828 if (it == d->dep_clean.end())
1834 void Buffer::markDepClean(string const & name)
1836 d->dep_clean[name] = true;
1840 bool Buffer::isExportableFormat(string const & format) const
1842 typedef vector<Format const *> Formats;
1844 formats = exportableFormats(true);
1845 Formats::const_iterator fit = formats.begin();
1846 Formats::const_iterator end = formats.end();
1847 for (; fit != end ; ++fit) {
1848 if ((*fit)->name() == format)
1855 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1858 // FIXME? if there is an Buffer LFUN that can be dispatched even
1859 // if internal, put a switch '(cmd.action)' here.
1865 switch (cmd.action()) {
1867 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1868 flag.setOnOff(isReadonly());
1871 // FIXME: There is need for a command-line import.
1872 //case LFUN_BUFFER_IMPORT:
1874 case LFUN_BUFFER_AUTO_SAVE:
1877 case LFUN_BUFFER_EXPORT_CUSTOM:
1878 // FIXME: Nothing to check here?
1881 case LFUN_BUFFER_EXPORT: {
1882 docstring const arg = cmd.argument();
1883 enable = arg == "custom" || isExportable(to_utf8(arg));
1885 flag.message(bformat(
1886 _("Don't know how to export to format: %1$s"), arg));
1890 case LFUN_BUFFER_CHKTEX:
1891 enable = isLatex() && !lyxrc.chktex_command.empty();
1894 case LFUN_BUILD_PROGRAM:
1895 enable = isExportable("program");
1898 case LFUN_BRANCH_ACTIVATE:
1899 case LFUN_BRANCH_DEACTIVATE: {
1900 BranchList const & branchList = params().branchlist();
1901 docstring const branchName = cmd.argument();
1902 enable = !branchName.empty() && branchList.find(branchName);
1906 case LFUN_BRANCH_ADD:
1907 case LFUN_BRANCHES_RENAME:
1908 case LFUN_BUFFER_PRINT:
1909 // if no Buffer is present, then of course we won't be called!
1912 case LFUN_BUFFER_LANGUAGE:
1913 enable = !isReadonly();
1919 flag.setEnabled(enable);
1924 void Buffer::dispatch(string const & command, DispatchResult & result)
1926 return dispatch(lyxaction.lookupFunc(command), result);
1930 // NOTE We can end up here even if we have no GUI, because we are called
1931 // by LyX::exec to handled command-line requests. So we may need to check
1932 // whether we have a GUI or not. The boolean use_gui holds this information.
1933 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1936 // FIXME? if there is an Buffer LFUN that can be dispatched even
1937 // if internal, put a switch '(cmd.action())' here.
1938 dr.dispatched(false);
1941 string const argument = to_utf8(func.argument());
1942 // We'll set this back to false if need be.
1943 bool dispatched = true;
1944 undo().beginUndoGroup();
1946 switch (func.action()) {
1947 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1948 if (lyxvc().inUse())
1949 lyxvc().toggleReadOnly();
1951 setReadonly(!isReadonly());
1954 case LFUN_BUFFER_EXPORT: {
1955 bool success = doExport(argument, false, false);
1956 dr.setError(!success);
1958 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1963 case LFUN_BUILD_PROGRAM:
1964 doExport("program", true, false);
1967 case LFUN_BUFFER_CHKTEX:
1971 case LFUN_BUFFER_EXPORT_CUSTOM: {
1973 string command = split(argument, format_name, ' ');
1974 Format const * format = formats.getFormat(format_name);
1976 lyxerr << "Format \"" << format_name
1977 << "\" not recognized!"
1982 // The name of the file created by the conversion process
1985 // Output to filename
1986 if (format->name() == "lyx") {
1987 string const latexname = latexName(false);
1988 filename = changeExtension(latexname,
1989 format->extension());
1990 filename = addName(temppath(), filename);
1992 if (!writeFile(FileName(filename)))
1996 doExport(format_name, true, false, filename);
1999 // Substitute $$FName for filename
2000 if (!contains(command, "$$FName"))
2001 command = "( " + command + " ) < $$FName";
2002 command = subst(command, "$$FName", filename);
2004 // Execute the command in the background
2006 call.startscript(Systemcall::DontWait, command);
2010 // FIXME: There is need for a command-line import.
2012 case LFUN_BUFFER_IMPORT:
2017 case LFUN_BUFFER_AUTO_SAVE:
2021 case LFUN_BRANCH_ADD: {
2022 docstring branch_name = func.argument();
2023 if (branch_name.empty()) {
2027 BranchList & branch_list = params().branchlist();
2028 vector<docstring> const branches =
2029 getVectorFromString(branch_name, branch_list.separator());
2031 for (vector<docstring>::const_iterator it = branches.begin();
2032 it != branches.end(); ++it) {
2034 Branch * branch = branch_list.find(branch_name);
2036 LYXERR0("Branch " << branch_name << " already exists.");
2040 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2042 branch_list.add(branch_name);
2043 branch = branch_list.find(branch_name);
2044 string const x11hexname = X11hexname(branch->color());
2045 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2046 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2048 dr.screenUpdate(Update::Force);
2056 case LFUN_BRANCH_ACTIVATE:
2057 case LFUN_BRANCH_DEACTIVATE: {
2058 BranchList & branchList = params().branchlist();
2059 docstring const branchName = func.argument();
2060 // the case without a branch name is handled elsewhere
2061 if (branchName.empty()) {
2065 Branch * branch = branchList.find(branchName);
2067 LYXERR0("Branch " << branchName << " does not exist.");
2069 docstring const msg =
2070 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2073 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2075 dr.screenUpdate(Update::Force);
2076 dr.forceBufferUpdate();
2081 case LFUN_BRANCHES_RENAME: {
2082 if (func.argument().empty())
2085 docstring const oldname = from_utf8(func.getArg(0));
2086 docstring const newname = from_utf8(func.getArg(1));
2087 InsetIterator it = inset_iterator_begin(inset());
2088 InsetIterator const end = inset_iterator_end(inset());
2089 bool success = false;
2090 for (; it != end; ++it) {
2091 if (it->lyxCode() == BRANCH_CODE) {
2092 InsetBranch & ins = dynamic_cast<InsetBranch &>(*it);
2093 if (ins.branch() == oldname) {
2094 undo().recordUndo(it);
2095 ins.rename(newname);
2100 if (it->lyxCode() == INCLUDE_CODE) {
2101 // get buffer of external file
2102 InsetInclude const & ins =
2103 static_cast<InsetInclude const &>(*it);
2104 Buffer * child = ins.getChildBuffer();
2107 child->dispatch(func, dr);
2112 dr.screenUpdate(Update::Force);
2113 dr.forceBufferUpdate();
2118 case LFUN_BUFFER_PRINT: {
2119 // we'll assume there's a problem until we succeed
2121 string target = func.getArg(0);
2122 string target_name = func.getArg(1);
2123 string command = func.getArg(2);
2126 || target_name.empty()
2127 || command.empty()) {
2128 LYXERR0("Unable to parse " << func.argument());
2129 docstring const msg =
2130 bformat(_("Unable to parse \"%1$s\""), func.argument());
2134 if (target != "printer" && target != "file") {
2135 LYXERR0("Unrecognized target \"" << target << '"');
2136 docstring const msg =
2137 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2142 bool const update_unincluded =
2143 params().maintain_unincluded_children
2144 && !params().getIncludedChildren().empty();
2145 if (!doExport("dvi", true, update_unincluded)) {
2146 showPrintError(absFileName());
2147 dr.setMessage(_("Error exporting to DVI."));
2151 // Push directory path.
2152 string const path = temppath();
2153 // Prevent the compiler from optimizing away p
2157 // there are three cases here:
2158 // 1. we print to a file
2159 // 2. we print directly to a printer
2160 // 3. we print using a spool command (print to file first)
2163 string const dviname = changeExtension(latexName(true), "dvi");
2165 if (target == "printer") {
2166 if (!lyxrc.print_spool_command.empty()) {
2167 // case 3: print using a spool
2168 string const psname = changeExtension(dviname,".ps");
2169 command += ' ' + lyxrc.print_to_file
2172 + quoteName(dviname);
2174 string command2 = lyxrc.print_spool_command + ' ';
2175 if (target_name != "default") {
2176 command2 += lyxrc.print_spool_printerprefix
2180 command2 += quoteName(psname);
2182 // If successful, then spool command
2183 res = one.startscript(Systemcall::Wait, command);
2186 // If there's no GUI, we have to wait on this command. Otherwise,
2187 // LyX deletes the temporary directory, and with it the spooled
2188 // file, before it can be printed!!
2189 Systemcall::Starttype stype = use_gui ?
2190 Systemcall::DontWait : Systemcall::Wait;
2191 res = one.startscript(stype, command2);
2194 // case 2: print directly to a printer
2195 if (target_name != "default")
2196 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2198 Systemcall::Starttype stype = use_gui ?
2199 Systemcall::DontWait : Systemcall::Wait;
2200 res = one.startscript(stype, command + quoteName(dviname));
2204 // case 1: print to a file
2205 FileName const filename(makeAbsPath(target_name, filePath()));
2206 FileName const dvifile(makeAbsPath(dviname, path));
2207 if (filename.exists()) {
2208 docstring text = bformat(
2209 _("The file %1$s already exists.\n\n"
2210 "Do you want to overwrite that file?"),
2211 makeDisplayPath(filename.absFileName()));
2212 if (Alert::prompt(_("Overwrite file?"),
2213 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2216 command += ' ' + lyxrc.print_to_file
2217 + quoteName(filename.toFilesystemEncoding())
2219 + quoteName(dvifile.toFilesystemEncoding());
2221 Systemcall::Starttype stype = use_gui ?
2222 Systemcall::DontWait : Systemcall::Wait;
2223 res = one.startscript(stype, command);
2229 dr.setMessage(_("Error running external commands."));
2230 showPrintError(absFileName());
2235 case LFUN_BUFFER_LANGUAGE: {
2236 Language const * oldL = params().language;
2237 Language const * newL = languages.getLanguage(argument);
2238 if (!newL || oldL == newL)
2240 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2241 changeLanguage(oldL, newL);
2242 dr.forceBufferUpdate();
2251 dr.dispatched(dispatched);
2252 undo().endUndoGroup();
2256 void Buffer::changeLanguage(Language const * from, Language const * to)
2258 LASSERT(from, /**/);
2261 for_each(par_iterator_begin(),
2263 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2267 bool Buffer::isMultiLingual() const
2269 ParConstIterator end = par_iterator_end();
2270 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2271 if (it->isMultiLingual(params()))
2278 std::set<Language const *> Buffer::getLanguages() const
2280 std::set<Language const *> languages;
2281 getLanguages(languages);
2286 void Buffer::getLanguages(std::set<Language const *> & languages) const
2288 ParConstIterator end = par_iterator_end();
2289 // add the buffer language, even if it's not actively used
2290 languages.insert(language());
2291 // iterate over the paragraphs
2292 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2293 it->getLanguages(languages);
2295 ListOfBuffers clist = getDescendents();
2296 ListOfBuffers::const_iterator cit = clist.begin();
2297 ListOfBuffers::const_iterator const cen = clist.end();
2298 for (; cit != cen; ++cit)
2299 (*cit)->getLanguages(languages);
2303 DocIterator Buffer::getParFromID(int const id) const
2305 Buffer * buf = const_cast<Buffer *>(this);
2307 // John says this is called with id == -1 from undo
2308 lyxerr << "getParFromID(), id: " << id << endl;
2309 return doc_iterator_end(buf);
2312 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2313 if (it.paragraph().id() == id)
2316 return doc_iterator_end(buf);
2320 bool Buffer::hasParWithID(int const id) const
2322 return !getParFromID(id).atEnd();
2326 ParIterator Buffer::par_iterator_begin()
2328 return ParIterator(doc_iterator_begin(this));
2332 ParIterator Buffer::par_iterator_end()
2334 return ParIterator(doc_iterator_end(this));
2338 ParConstIterator Buffer::par_iterator_begin() const
2340 return ParConstIterator(doc_iterator_begin(this));
2344 ParConstIterator Buffer::par_iterator_end() const
2346 return ParConstIterator(doc_iterator_end(this));
2350 Language const * Buffer::language() const
2352 return params().language;
2356 docstring const Buffer::B_(string const & l10n) const
2358 return params().B_(l10n);
2362 bool Buffer::isClean() const
2364 return d->lyx_clean;
2368 bool Buffer::isExternallyModified(CheckMethod method) const
2370 LASSERT(d->filename.exists(), /**/);
2371 // if method == timestamp, check timestamp before checksum
2372 return (method == checksum_method
2373 || d->timestamp_ != d->filename.lastModified())
2374 && d->checksum_ != d->filename.checksum();
2378 void Buffer::saveCheckSum(FileName const & file) const
2380 if (file.exists()) {
2381 d->timestamp_ = file.lastModified();
2382 d->checksum_ = file.checksum();
2384 // in the case of save to a new file.
2391 void Buffer::markClean() const
2393 if (!d->lyx_clean) {
2394 d->lyx_clean = true;
2397 // if the .lyx file has been saved, we don't need an
2399 d->bak_clean = true;
2400 d->undo_.markDirty();
2404 void Buffer::setUnnamed(bool flag)
2410 bool Buffer::isUnnamed() const
2417 /// Don't check unnamed, here: isInternal() is used in
2418 /// newBuffer(), where the unnamed flag has not been set by anyone
2419 /// yet. Also, for an internal buffer, there should be no need for
2420 /// retrieving fileName() nor for checking if it is unnamed or not.
2421 bool Buffer::isInternal() const
2423 return fileName().extension() == "internal";
2427 void Buffer::markDirty()
2430 d->lyx_clean = false;
2433 d->bak_clean = false;
2435 DepClean::iterator it = d->dep_clean.begin();
2436 DepClean::const_iterator const end = d->dep_clean.end();
2438 for (; it != end; ++it)
2443 FileName Buffer::fileName() const
2449 string Buffer::absFileName() const
2451 return d->filename.absFileName();
2455 string Buffer::filePath() const
2457 return d->filename.onlyPath().absFileName() + "/";
2461 bool Buffer::isReadonly() const
2463 return d->read_only;
2467 void Buffer::setParent(Buffer const * buffer)
2469 // Avoids recursive include.
2470 d->setParent(buffer == this ? 0 : buffer);
2475 Buffer const * Buffer::parent() const
2481 ListOfBuffers Buffer::allRelatives() const
2483 ListOfBuffers lb = masterBuffer()->getDescendents();
2484 lb.push_front(const_cast<Buffer *>(this));
2489 Buffer const * Buffer::masterBuffer() const
2491 // FIXME Should be make sure we are not in some kind
2492 // of recursive include? A -> B -> A will crash this.
2493 Buffer const * const pbuf = d->parent();
2497 return pbuf->masterBuffer();
2501 bool Buffer::isChild(Buffer * child) const
2503 return d->children_positions.find(child) != d->children_positions.end();
2507 DocIterator Buffer::firstChildPosition(Buffer const * child)
2509 Impl::BufferPositionMap::iterator it;
2510 it = d->children_positions.find(child);
2511 if (it == d->children_positions.end())
2512 return DocIterator(this);
2517 bool Buffer::hasChildren() const
2519 return !d->children_positions.empty();
2523 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2525 // loop over children
2526 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2527 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2528 for (; it != end; ++it) {
2529 Buffer * child = const_cast<Buffer *>(it->first);
2531 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2532 if (bit != clist.end())
2534 clist.push_back(child);
2536 // there might be grandchildren
2537 child->collectChildren(clist, true);
2542 ListOfBuffers Buffer::getChildren() const
2545 collectChildren(v, false);
2550 ListOfBuffers Buffer::getDescendents() const
2553 collectChildren(v, true);
2558 template<typename M>
2559 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2564 typename M::const_iterator it = m.lower_bound(x);
2565 if (it == m.begin())
2573 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2574 DocIterator const & pos) const
2576 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2578 // if paragraphs have no macro context set, pos will be empty
2582 // we haven't found anything yet
2583 DocIterator bestPos = owner_->par_iterator_begin();
2584 MacroData const * bestData = 0;
2586 // find macro definitions for name
2587 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2588 if (nameIt != macros.end()) {
2589 // find last definition in front of pos or at pos itself
2590 PositionScopeMacroMap::const_iterator it
2591 = greatest_below(nameIt->second, pos);
2592 if (it != nameIt->second.end()) {
2594 // scope ends behind pos?
2595 if (pos < it->second.first) {
2596 // Looks good, remember this. If there
2597 // is no external macro behind this,
2598 // we found the right one already.
2599 bestPos = it->first;
2600 bestData = &it->second.second;
2604 // try previous macro if there is one
2605 if (it == nameIt->second.begin())
2612 // find macros in included files
2613 PositionScopeBufferMap::const_iterator it
2614 = greatest_below(position_to_children, pos);
2615 if (it == position_to_children.end())
2616 // no children before
2620 // do we know something better (i.e. later) already?
2621 if (it->first < bestPos )
2624 // scope ends behind pos?
2625 if (pos < it->second.first) {
2626 // look for macro in external file
2628 MacroData const * data
2629 = it->second.second->getMacro(name, false);
2632 bestPos = it->first;
2638 // try previous file if there is one
2639 if (it == position_to_children.begin())
2644 // return the best macro we have found
2649 MacroData const * Buffer::getMacro(docstring const & name,
2650 DocIterator const & pos, bool global) const
2655 // query buffer macros
2656 MacroData const * data = d->getBufferMacro(name, pos);
2660 // If there is a master buffer, query that
2661 Buffer const * const pbuf = d->parent();
2663 d->macro_lock = true;
2664 MacroData const * macro = pbuf->getMacro(
2665 name, *this, false);
2666 d->macro_lock = false;
2672 data = MacroTable::globalMacros().get(name);
2681 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2683 // set scope end behind the last paragraph
2684 DocIterator scope = par_iterator_begin();
2685 scope.pit() = scope.lastpit() + 1;
2687 return getMacro(name, scope, global);
2691 MacroData const * Buffer::getMacro(docstring const & name,
2692 Buffer const & child, bool global) const
2694 // look where the child buffer is included first
2695 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2696 if (it == d->children_positions.end())
2699 // check for macros at the inclusion position
2700 return getMacro(name, it->second, global);
2704 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2706 pit_type const lastpit = it.lastpit();
2708 // look for macros in each paragraph
2709 while (it.pit() <= lastpit) {
2710 Paragraph & par = it.paragraph();
2712 // iterate over the insets of the current paragraph
2713 InsetList const & insets = par.insetList();
2714 InsetList::const_iterator iit = insets.begin();
2715 InsetList::const_iterator end = insets.end();
2716 for (; iit != end; ++iit) {
2717 it.pos() = iit->pos;
2719 // is it a nested text inset?
2720 if (iit->inset->asInsetText()) {
2721 // Inset needs its own scope?
2722 InsetText const * itext = iit->inset->asInsetText();
2723 bool newScope = itext->isMacroScope();
2725 // scope which ends just behind the inset
2726 DocIterator insetScope = it;
2729 // collect macros in inset
2730 it.push_back(CursorSlice(*iit->inset));
2731 updateMacros(it, newScope ? insetScope : scope);
2736 if (iit->inset->asInsetTabular()) {
2737 CursorSlice slice(*iit->inset);
2738 size_t const numcells = slice.nargs();
2739 for (; slice.idx() < numcells; slice.forwardIdx()) {
2740 it.push_back(slice);
2741 updateMacros(it, scope);
2747 // is it an external file?
2748 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2749 // get buffer of external file
2750 InsetInclude const & inset =
2751 static_cast<InsetInclude const &>(*iit->inset);
2753 Buffer * child = inset.getChildBuffer();
2758 // register its position, but only when it is
2759 // included first in the buffer
2760 if (children_positions.find(child) ==
2761 children_positions.end())
2762 children_positions[child] = it;
2764 // register child with its scope
2765 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2769 if (doing_export && iit->inset->asInsetMath()) {
2770 InsetMath * im = static_cast<InsetMath *>(iit->inset);
2771 if (im->asHullInset()) {
2772 InsetMathHull * hull = static_cast<InsetMathHull *>(im);
2773 hull->recordLocation(it);
2777 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2781 MathMacroTemplate & macroTemplate =
2782 static_cast<MathMacroTemplate &>(*iit->inset);
2783 MacroContext mc(owner_, it);
2784 macroTemplate.updateToContext(mc);
2787 bool valid = macroTemplate.validMacro();
2788 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2789 // then the BufferView's cursor will be invalid in
2790 // some cases which leads to crashes.
2795 // FIXME (Abdel), I don't understandt why we pass 'it' here
2796 // instead of 'macroTemplate' defined above... is this correct?
2797 macros[macroTemplate.name()][it] =
2798 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2808 void Buffer::updateMacros() const
2813 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2815 // start with empty table
2817 d->children_positions.clear();
2818 d->position_to_children.clear();
2820 // Iterate over buffer, starting with first paragraph
2821 // The scope must be bigger than any lookup DocIterator
2822 // later. For the global lookup, lastpit+1 is used, hence
2823 // we use lastpit+2 here.
2824 DocIterator it = par_iterator_begin();
2825 DocIterator outerScope = it;
2826 outerScope.pit() = outerScope.lastpit() + 2;
2827 d->updateMacros(it, outerScope);
2831 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2833 InsetIterator it = inset_iterator_begin(inset());
2834 InsetIterator const end = inset_iterator_end(inset());
2835 for (; it != end; ++it) {
2836 if (it->lyxCode() == BRANCH_CODE) {
2837 InsetBranch & br = dynamic_cast<InsetBranch &>(*it);
2838 docstring const name = br.branch();
2839 if (!from_master && !params().branchlist().find(name))
2840 result.push_back(name);
2841 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2842 result.push_back(name);
2845 if (it->lyxCode() == INCLUDE_CODE) {
2846 // get buffer of external file
2847 InsetInclude const & ins =
2848 static_cast<InsetInclude const &>(*it);
2849 Buffer * child = ins.getChildBuffer();
2852 child->getUsedBranches(result, true);
2855 // remove duplicates
2860 void Buffer::updateMacroInstances() const
2862 LYXERR(Debug::MACROS, "updateMacroInstances for "
2863 << d->filename.onlyFileName());
2864 DocIterator it = doc_iterator_begin(this);
2866 DocIterator const end = doc_iterator_end(this);
2867 for (; it != end; it.forwardInset()) {
2868 // look for MathData cells in InsetMathNest insets
2869 InsetMath * minset = it.nextInset()->asInsetMath();
2873 // update macro in all cells of the InsetMathNest
2874 DocIterator::idx_type n = minset->nargs();
2875 MacroContext mc = MacroContext(this, it);
2876 for (DocIterator::idx_type i = 0; i < n; ++i) {
2877 MathData & data = minset->cell(i);
2878 data.updateMacros(0, mc);
2884 void Buffer::listMacroNames(MacroNameSet & macros) const
2889 d->macro_lock = true;
2891 // loop over macro names
2892 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2893 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2894 for (; nameIt != nameEnd; ++nameIt)
2895 macros.insert(nameIt->first);
2897 // loop over children
2898 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2899 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2900 for (; it != end; ++it)
2901 it->first->listMacroNames(macros);
2904 Buffer const * const pbuf = d->parent();
2906 pbuf->listMacroNames(macros);
2908 d->macro_lock = false;
2912 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2914 Buffer const * const pbuf = d->parent();
2919 pbuf->listMacroNames(names);
2922 MacroNameSet::iterator it = names.begin();
2923 MacroNameSet::iterator end = names.end();
2924 for (; it != end; ++it) {
2926 MacroData const * data =
2927 pbuf->getMacro(*it, *this, false);
2929 macros.insert(data);
2931 // we cannot access the original MathMacroTemplate anymore
2932 // here to calls validate method. So we do its work here manually.
2933 // FIXME: somehow make the template accessible here.
2934 if (data->optionals() > 0)
2935 features.require("xargs");
2941 Buffer::References & Buffer::references(docstring const & label)
2944 return const_cast<Buffer *>(masterBuffer())->references(label);
2946 RefCache::iterator it = d->ref_cache_.find(label);
2947 if (it != d->ref_cache_.end())
2948 return it->second.second;
2950 static InsetLabel const * dummy_il = 0;
2951 static References const dummy_refs;
2952 it = d->ref_cache_.insert(
2953 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2954 return it->second.second;
2958 Buffer::References const & Buffer::references(docstring const & label) const
2960 return const_cast<Buffer *>(this)->references(label);
2964 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2966 masterBuffer()->d->ref_cache_[label].first = il;
2970 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2972 return masterBuffer()->d->ref_cache_[label].first;
2976 void Buffer::clearReferenceCache() const
2979 d->ref_cache_.clear();
2983 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2986 //FIXME: This does not work for child documents yet.
2987 LASSERT(code == CITE_CODE, /**/);
2988 // Check if the label 'from' appears more than once
2989 vector<docstring> labels;
2991 checkBibInfoCache();
2992 BiblioInfo const & keys = masterBibInfo();
2993 BiblioInfo::const_iterator bit = keys.begin();
2994 BiblioInfo::const_iterator bend = keys.end();
2996 for (; bit != bend; ++bit)
2998 labels.push_back(bit->first);
3001 if (count(labels.begin(), labels.end(), from) > 1)
3004 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3005 if (it->lyxCode() == code) {
3006 InsetCommand & inset = static_cast<InsetCommand &>(*it);
3007 docstring const oldValue = inset.getParam(paramName);
3008 if (oldValue == from)
3009 inset.setParam(paramName, to);
3015 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
3016 pit_type par_end, bool full_source) const
3018 OutputParams runparams(¶ms().encoding());
3019 runparams.nice = true;
3020 runparams.flavor = params().useXetex ?
3021 OutputParams::XETEX : OutputParams::LATEX;
3022 runparams.linelen = lyxrc.plaintext_linelen;
3023 // No side effect of file copying and image conversion
3024 runparams.dryrun = true;
3027 os << "% " << _("Preview source code") << "\n\n";
3029 d->texrow.newline();
3030 d->texrow.newline();
3032 writeDocBookSource(os, absFileName(), runparams, false);
3034 // latex or literate
3035 writeLaTeXSource(os, string(), runparams, true, true);
3037 runparams.par_begin = par_begin;
3038 runparams.par_end = par_end;
3039 if (par_begin + 1 == par_end) {
3041 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3045 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3046 convert<docstring>(par_begin),
3047 convert<docstring>(par_end - 1))
3054 // output paragraphs
3056 docbookParagraphs(text(), *this, os, runparams);
3058 // latex or literate
3059 latexParagraphs(*this, text(), os, texrow, runparams);
3064 ErrorList & Buffer::errorList(string const & type) const
3066 static ErrorList emptyErrorList;
3067 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3068 if (it == d->errorLists.end())
3069 return emptyErrorList;
3075 void Buffer::updateTocItem(std::string const & type,
3076 DocIterator const & dit) const
3079 d->gui_->updateTocItem(type, dit);
3083 void Buffer::structureChanged() const
3086 d->gui_->structureChanged();
3090 void Buffer::errors(string const & err, bool from_master) const
3093 d->gui_->errors(err, from_master);
3097 void Buffer::message(docstring const & msg) const
3100 d->gui_->message(msg);
3104 void Buffer::setBusy(bool on) const
3107 d->gui_->setBusy(on);
3111 void Buffer::updateTitles() const
3114 d->wa_->updateTitles();
3118 void Buffer::resetAutosaveTimers() const
3121 d->gui_->resetAutosaveTimers();
3125 bool Buffer::hasGuiDelegate() const
3131 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3140 class AutoSaveBuffer : public ForkedProcess {
3143 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3144 : buffer_(buffer), fname_(fname) {}
3146 virtual shared_ptr<ForkedProcess> clone() const
3148 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3153 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3154 from_utf8(fname_.absFileName())));
3155 return run(DontWait);
3159 virtual int generateChild();
3161 Buffer const & buffer_;
3166 int AutoSaveBuffer::generateChild()
3168 #if defined(__APPLE__)
3169 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3170 * We should use something else like threads.
3172 * Since I do not know how to determine at run time what is the OS X
3173 * version, I just disable forking altogether for now (JMarc)
3175 pid_t const pid = -1;
3177 // tmp_ret will be located (usually) in /tmp
3178 // will that be a problem?
3179 // Note that this calls ForkedCalls::fork(), so it's
3180 // ok cross-platform.
3181 pid_t const pid = fork();
3182 // If you want to debug the autosave
3183 // you should set pid to -1, and comment out the fork.
3184 if (pid != 0 && pid != -1)
3188 // pid = -1 signifies that lyx was unable
3189 // to fork. But we will do the save
3191 bool failed = false;
3192 FileName const tmp_ret = FileName::tempName("lyxauto");
3193 if (!tmp_ret.empty()) {
3194 buffer_.writeFile(tmp_ret);
3195 // assume successful write of tmp_ret
3196 if (!tmp_ret.moveTo(fname_))
3202 // failed to write/rename tmp_ret so try writing direct
3203 if (!buffer_.writeFile(fname_)) {
3204 // It is dangerous to do this in the child,
3205 // but safe in the parent, so...
3206 if (pid == -1) // emit message signal.
3207 buffer_.message(_("Autosave failed!"));
3211 if (pid == 0) // we are the child so...
3220 FileName Buffer::getEmergencyFileName() const
3222 return getEmergencyFileNameFor(d->filename);
3226 FileName Buffer::getEmergencyFileNameFor(FileName const & fn) const
3228 return FileName(fn.absFileName() + ".emergency");
3232 FileName Buffer::getAutosaveFileName() const
3234 // if the document is unnamed try to save in the backup dir, else
3235 // in the default document path, and as a last try in the filePath,
3236 // which will most often be the temporary directory
3239 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3240 : lyxrc.backupdir_path;
3241 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3244 string const fname = d->filename.onlyFileName();
3245 return getAutosaveFileNameFor(makeAbsPath(fname, fpath));
3249 FileName Buffer::getAutosaveFileNameFor(FileName const & fn) const
3251 string const fname = "#" + onlyFileName(fn.absFileName()) + "#";
3252 return FileName(onlyPath(fn.absFileName()) + fname);
3256 void Buffer::removeAutosaveFile() const
3258 FileName const f = getAutosaveFileName();
3264 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3266 FileName const newauto = getAutosaveFileName();
3268 if (newauto != oldauto && oldauto.exists())
3269 if (!oldauto.moveTo(newauto))
3270 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3274 // Perfect target for a thread...
3275 void Buffer::autoSave() const
3277 if (d->bak_clean || isReadonly()) {
3278 // We don't save now, but we'll try again later
3279 resetAutosaveTimers();
3283 // emit message signal.
3284 message(_("Autosaving current document..."));
3285 AutoSaveBuffer autosave(*this, getAutosaveFileName());
3288 d->bak_clean = true;
3290 resetAutosaveTimers();
3294 string Buffer::bufferFormat() const
3296 string format = params().documentClass().outputFormat();
3297 if (format == "latex") {
3298 if (params().useXetex)
3300 if (params().encoding().package() == Encoding::japanese)
3307 string Buffer::getDefaultOutputFormat() const
3309 if (!params().defaultOutputFormat.empty()
3310 && params().defaultOutputFormat != "default")
3311 return params().defaultOutputFormat;
3312 typedef vector<Format const *> Formats;
3313 Formats formats = exportableFormats(true);
3316 || params().useXetex
3317 || params().encoding().package() == Encoding::japanese) {
3318 if (formats.empty())
3320 // return the first we find
3321 return formats.front()->name();
3323 return lyxrc.default_view_format;
3328 // helper class, to guarantee this gets reset properly
3329 class MarkAsExporting {
3331 MarkAsExporting(Buffer const * buf) : buf_(buf)
3333 LASSERT(buf_, /* */);
3334 buf_->setExportStatus(true);
3338 buf_->setExportStatus(false);
3341 Buffer const * const buf_;
3346 void Buffer::setExportStatus(bool e) const
3348 d->doing_export = e;
3352 bool Buffer::isExporting() const
3354 return d->doing_export;
3358 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3359 bool includeall, string & result_file) const
3361 MarkAsExporting exporting(this);
3362 string backend_format;
3363 OutputParams runparams(¶ms().encoding());
3364 runparams.flavor = OutputParams::LATEX;
3365 runparams.linelen = lyxrc.plaintext_linelen;
3366 runparams.includeall = includeall;
3367 vector<string> backs = backends();
3368 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3369 // Get shortest path to format
3370 Graph::EdgePath path;
3371 for (vector<string>::const_iterator it = backs.begin();
3372 it != backs.end(); ++it) {
3373 Graph::EdgePath p = theConverters().getPath(*it, format);
3374 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3375 backend_format = *it;
3380 if (!put_in_tempdir) {
3381 // Only show this alert if this is an export to a non-temporary
3382 // file (not for previewing).
3383 Alert::error(_("Couldn't export file"), bformat(
3384 _("No information for exporting the format %1$s."),
3385 formats.prettyName(format)));
3389 runparams.flavor = theConverters().getFlavor(path);
3392 backend_format = format;
3393 // FIXME: Don't hardcode format names here, but use a flag
3394 if (backend_format == "pdflatex")
3395 runparams.flavor = OutputParams::PDFLATEX;
3398 string filename = latexName(false);
3399 filename = addName(temppath(), filename);
3400 filename = changeExtension(filename,
3401 formats.extension(backend_format));
3404 updateMacroInstances();
3406 // Plain text backend
3407 if (backend_format == "text") {
3408 runparams.flavor = OutputParams::TEXT;
3409 writePlaintextFile(*this, FileName(filename), runparams);
3412 else if (backend_format == "xhtml") {
3413 runparams.flavor = OutputParams::HTML;
3414 switch (params().html_math_output) {
3415 case BufferParams::MathML:
3416 runparams.math_flavor = OutputParams::MathAsMathML;
3418 case BufferParams::HTML:
3419 runparams.math_flavor = OutputParams::MathAsHTML;
3421 case BufferParams::Images:
3422 runparams.math_flavor = OutputParams::MathAsImages;
3424 case BufferParams::LaTeX:
3425 runparams.math_flavor = OutputParams::MathAsLaTeX;
3429 makeLyXHTMLFile(FileName(filename), runparams);
3430 } else if (backend_format == "lyx")
3431 writeFile(FileName(filename));
3433 else if (isDocBook()) {
3434 runparams.nice = !put_in_tempdir;
3435 makeDocBookFile(FileName(filename), runparams);
3438 else if (backend_format == format) {
3439 runparams.nice = true;
3440 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3442 } else if (!lyxrc.tex_allows_spaces
3443 && contains(filePath(), ' ')) {
3444 Alert::error(_("File name error"),
3445 _("The directory path to the document cannot contain spaces."));
3448 runparams.nice = false;
3449 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3453 string const error_type = (format == "program")
3454 ? "Build" : bufferFormat();
3455 ErrorList & error_list = d->errorLists[error_type];
3456 string const ext = formats.extension(format);
3457 FileName const tmp_result_file(changeExtension(filename, ext));
3458 bool const success = theConverters().convert(this, FileName(filename),
3459 tmp_result_file, FileName(absFileName()), backend_format, format,
3462 // Emit the signal to show the error list or copy it back to the
3463 // cloned Buffer so that it cab be emitted afterwards.
3464 if (format != backend_format) {
3465 if (d->cloned_buffer_) {
3466 d->cloned_buffer_->d->errorLists[error_type] =
3467 d->errorLists[error_type];
3470 // also to the children, in case of master-buffer-view
3471 ListOfBuffers clist = getDescendents();
3472 ListOfBuffers::const_iterator cit = clist.begin();
3473 ListOfBuffers::const_iterator const cen = clist.end();
3474 for (; cit != cen; ++cit) {
3475 if (d->cloned_buffer_) {
3476 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3477 (*cit)->d->errorLists[error_type];
3479 (*cit)->errors(error_type, true);
3483 if (d->cloned_buffer_) {
3484 // Enable reverse dvi or pdf to work by copying back the texrow
3485 // object to the cloned buffer.
3486 // FIXME: There is a possibility of concurrent access to texrow
3487 // here from the main GUI thread that should be securized.
3488 d->cloned_buffer_->d->texrow = d->texrow;
3489 string const error_type = bufferFormat();
3490 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3496 if (put_in_tempdir) {
3497 result_file = tmp_result_file.absFileName();
3501 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3502 // We need to copy referenced files (e. g. included graphics
3503 // if format == "dvi") to the result dir.
3504 vector<ExportedFile> const files =
3505 runparams.exportdata->externalFiles(format);
3506 string const dest = onlyPath(result_file);
3507 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3508 : force_overwrite == ALL_FILES;
3509 CopyStatus status = use_force ? FORCE : SUCCESS;
3511 vector<ExportedFile>::const_iterator it = files.begin();
3512 vector<ExportedFile>::const_iterator const en = files.end();
3513 for (; it != en && status != CANCEL; ++it) {
3514 string const fmt = formats.getFormatFromFile(it->sourceName);
3515 status = copyFile(fmt, it->sourceName,
3516 makeAbsPath(it->exportName, dest),
3517 it->exportName, status == FORCE);
3520 if (status == CANCEL) {
3521 message(_("Document export cancelled."));
3522 } else if (tmp_result_file.exists()) {
3523 // Finally copy the main file
3524 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3525 : force_overwrite != NO_FILES;
3526 if (status == SUCCESS && use_force)
3528 status = copyFile(format, tmp_result_file,
3529 FileName(result_file), result_file,
3531 message(bformat(_("Document exported as %1$s "
3533 formats.prettyName(format),
3534 makeDisplayPath(result_file)));
3536 // This must be a dummy converter like fax (bug 1888)
3537 message(bformat(_("Document exported as %1$s"),
3538 formats.prettyName(format)));
3545 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3546 bool includeall) const
3549 // (1) export with all included children (omit \includeonly)
3550 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3552 // (2) export with included children only
3553 return doExport(format, put_in_tempdir, false, result_file);
3557 bool Buffer::preview(string const & format, bool includeall) const
3559 MarkAsExporting exporting(this);
3561 // (1) export with all included children (omit \includeonly)
3562 if (includeall && !doExport(format, true, true))
3564 // (2) export with included children only
3565 if (!doExport(format, true, false, result_file))
3567 return formats.view(*this, FileName(result_file), format);
3571 bool Buffer::isExportable(string const & format) const
3573 vector<string> backs = backends();
3574 for (vector<string>::const_iterator it = backs.begin();
3575 it != backs.end(); ++it)
3576 if (theConverters().isReachable(*it, format))
3582 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3584 vector<string> const backs = backends();
3585 vector<Format const *> result =
3586 theConverters().getReachable(backs[0], only_viewable, true);
3587 for (vector<string>::const_iterator it = backs.begin() + 1;
3588 it != backs.end(); ++it) {
3589 vector<Format const *> r =
3590 theConverters().getReachable(*it, only_viewable, false);
3591 result.insert(result.end(), r.begin(), r.end());
3597 vector<string> Buffer::backends() const
3600 v.push_back(bufferFormat());
3601 // FIXME: Don't hardcode format names here, but use a flag
3602 if (v.back() == "latex")
3603 v.push_back("pdflatex");
3604 v.push_back("xhtml");
3605 v.push_back("text");
3611 Buffer::ReadStatus Buffer::readFromVC(FileName const & fn)
3613 bool const found = LyXVC::file_not_found_hook(fn);
3615 return ReadFileNotFound;
3616 if (!fn.isReadableFile())
3622 Buffer::ReadStatus Buffer::readEmergency(FileName const & fn)
3624 FileName const emergencyFile = getEmergencyFileNameFor(fn);
3625 if (!emergencyFile.exists()
3626 || emergencyFile.lastModified() <= fn.lastModified())
3627 return ReadFileNotFound;
3629 docstring const file = makeDisplayPath(fn.absFileName(), 20);
3630 docstring const text = bformat(_("An emergency save of the document "
3631 "%1$s exists.\n\nRecover emergency save?"), file);
3632 int const ret = Alert::prompt(_("Load emergency save?"), text,
3633 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3638 // the file is not saved if we load the emergency file.
3642 ReadStatus const ret_rf = readFile(emergencyFile);
3643 if (res = (ret_rf == ReadSuccess))
3644 str = _("Document was successfully recovered.");
3646 str = _("Document was NOT successfully recovered.");
3647 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3648 makeDisplayPath(emergencyFile.absFileName()));
3650 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3651 _("&Remove"), _("&Keep"))) {
3652 emergencyFile.removeFile();
3654 Alert::warning(_("Emergency file deleted"),
3655 _("Do not forget to save your file now!"), true);
3657 return res ? ReadSuccess : ReadEmergencyFailure;
3660 if (!Alert::prompt(_("Delete emergency file?"),
3661 _("Remove emergency file now?"), 1, 1,
3662 _("&Remove"), _("&Keep")))
3663 emergencyFile.removeFile();
3664 return ReadOriginal;
3673 Buffer::ReadStatus Buffer::readAutosave(FileName const & fn)
3675 // Now check if autosave file is newer.
3676 FileName const autosaveFile = getAutosaveFileNameFor(fn);
3677 if (!autosaveFile.exists()
3678 || autosaveFile.lastModified() <= fn.lastModified())
3679 return ReadFileNotFound;
3681 docstring const file = makeDisplayPath(fn.absFileName(), 20);
3682 docstring const text = bformat(_("The backup of the document %1$s "
3683 "is newer.\n\nLoad the backup instead?"), file);
3684 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3685 _("&Load backup"), _("Load &original"), _("&Cancel"));
3690 ReadStatus const ret_rf = readFile(autosaveFile);
3691 // the file is not saved if we load the autosave file.
3692 if (ret_rf == ReadSuccess) {
3696 return ReadAutosaveFailure;
3699 // Here we delete the autosave
3700 autosaveFile.removeFile();
3701 return ReadOriginal;
3709 Buffer::ReadStatus Buffer::loadLyXFile(FileName const & fn)
3711 if (!fn.isReadableFile()) {
3712 ReadStatus const ret_rvc = readFromVC(fn);
3713 if (ret_rvc != ReadSuccess)
3717 ReadStatus const ret_re = readEmergency(fn);
3718 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3721 ReadStatus const ret_ra = readAutosave(fn);
3722 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3725 return readFile(fn);
3729 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3731 TeXErrors::Errors::const_iterator cit = terr.begin();
3732 TeXErrors::Errors::const_iterator end = terr.end();
3734 for (; cit != end; ++cit) {
3737 int errorRow = cit->error_in_line;
3738 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3744 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3745 } while (found && id_start == id_end && pos_start == pos_end);
3747 errorList.push_back(ErrorItem(cit->error_desc,
3748 cit->error_text, id_start, pos_start, pos_end));
3753 void Buffer::setBuffersForInsets() const
3755 inset().setBuffer(const_cast<Buffer &>(*this));
3759 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3761 // Use the master text class also for child documents
3762 Buffer const * const master = masterBuffer();
3763 DocumentClass const & textclass = master->params().documentClass();
3765 // do this only if we are the top-level Buffer
3767 checkBibInfoCache();
3769 // keep the buffers to be children in this set. If the call from the
3770 // master comes back we can see which of them were actually seen (i.e.
3771 // via an InsetInclude). The remaining ones in the set need still be updated.
3772 static std::set<Buffer const *> bufToUpdate;
3773 if (scope == UpdateMaster) {
3774 // If this is a child document start with the master
3775 if (master != this) {
3776 bufToUpdate.insert(this);
3777 master->updateBuffer(UpdateMaster, utype);
3778 // Do this here in case the master has no gui associated with it. Then,
3779 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3780 if (!master->d->gui_)
3783 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3784 if (bufToUpdate.find(this) == bufToUpdate.end())
3788 // start over the counters in the master
3789 textclass.counters().reset();
3792 // update will be done below for this buffer
3793 bufToUpdate.erase(this);
3795 // update all caches
3796 clearReferenceCache();
3799 Buffer & cbuf = const_cast<Buffer &>(*this);
3801 LASSERT(!text().paragraphs().empty(), /**/);
3804 ParIterator parit = cbuf.par_iterator_begin();
3805 updateBuffer(parit, utype);
3808 // TocBackend update will be done later.
3811 cbuf.tocBackend().update();
3812 if (scope == UpdateMaster)
3813 cbuf.structureChanged();
3817 static depth_type getDepth(DocIterator const & it)
3819 depth_type depth = 0;
3820 for (size_t i = 0 ; i < it.depth() ; ++i)
3821 if (!it[i].inset().inMathed())
3822 depth += it[i].paragraph().getDepth() + 1;
3823 // remove 1 since the outer inset does not count
3827 static depth_type getItemDepth(ParIterator const & it)
3829 Paragraph const & par = *it;
3830 LabelType const labeltype = par.layout().labeltype;
3832 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3835 // this will hold the lowest depth encountered up to now.
3836 depth_type min_depth = getDepth(it);
3837 ParIterator prev_it = it;
3840 --prev_it.top().pit();
3842 // start of nested inset: go to outer par
3844 if (prev_it.empty()) {
3845 // start of document: nothing to do
3850 // We search for the first paragraph with same label
3851 // that is not more deeply nested.
3852 Paragraph & prev_par = *prev_it;
3853 depth_type const prev_depth = getDepth(prev_it);
3854 if (labeltype == prev_par.layout().labeltype) {
3855 if (prev_depth < min_depth)
3856 return prev_par.itemdepth + 1;
3857 if (prev_depth == min_depth)
3858 return prev_par.itemdepth;
3860 min_depth = min(min_depth, prev_depth);
3861 // small optimization: if we are at depth 0, we won't
3862 // find anything else
3863 if (prev_depth == 0)
3869 static bool needEnumCounterReset(ParIterator const & it)
3871 Paragraph const & par = *it;
3872 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3873 depth_type const cur_depth = par.getDepth();
3874 ParIterator prev_it = it;
3875 while (prev_it.pit()) {
3876 --prev_it.top().pit();
3877 Paragraph const & prev_par = *prev_it;
3878 if (prev_par.getDepth() <= cur_depth)
3879 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3881 // start of nested inset: reset
3886 // set the label of a paragraph. This includes the counters.
3887 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3889 BufferParams const & bp = owner_->masterBuffer()->params();
3890 DocumentClass const & textclass = bp.documentClass();
3891 Paragraph & par = it.paragraph();
3892 Layout const & layout = par.layout();
3893 Counters & counters = textclass.counters();
3895 if (par.params().startOfAppendix()) {
3896 // FIXME: only the counter corresponding to toplevel
3897 // sectioning should be reset
3899 counters.appendix(true);
3901 par.params().appendix(counters.appendix());
3903 // Compute the item depth of the paragraph
3904 par.itemdepth = getItemDepth(it);
3906 if (layout.margintype == MARGIN_MANUAL
3907 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3908 if (par.params().labelWidthString().empty())
3909 par.params().labelWidthString(par.expandLabel(layout, bp));
3911 par.params().labelWidthString(docstring());
3914 switch(layout.labeltype) {
3916 if (layout.toclevel <= bp.secnumdepth
3917 && (layout.latextype != LATEX_ENVIRONMENT
3918 || it.text()->isFirstInSequence(it.pit()))) {
3919 counters.step(layout.counter, utype);
3920 par.params().labelString(
3921 par.expandLabel(layout, bp));
3923 par.params().labelString(docstring());
3926 case LABEL_ITEMIZE: {
3927 // At some point of time we should do something more
3928 // clever here, like:
3929 // par.params().labelString(
3930 // bp.user_defined_bullet(par.itemdepth).getText());
3931 // for now, use a simple hardcoded label
3932 docstring itemlabel;
3933 switch (par.itemdepth) {
3935 itemlabel = char_type(0x2022);
3938 itemlabel = char_type(0x2013);
3941 itemlabel = char_type(0x2217);
3944 itemlabel = char_type(0x2219); // or 0x00b7
3947 par.params().labelString(itemlabel);
3951 case LABEL_ENUMERATE: {
3952 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3954 switch (par.itemdepth) {
3963 enumcounter += "iv";
3966 // not a valid enumdepth...
3970 // Maybe we have to reset the enumeration counter.
3971 if (needEnumCounterReset(it))
3972 counters.reset(enumcounter);
3973 counters.step(enumcounter, utype);
3975 string const & lang = par.getParLanguage(bp)->code();
3976 par.params().labelString(counters.theCounter(enumcounter, lang));
3981 case LABEL_SENSITIVE: {
3982 string const & type = counters.current_float();
3983 docstring full_label;
3985 full_label = owner_->B_("Senseless!!! ");
3987 docstring name = owner_->B_(textclass.floats().getType(type).name());
3988 if (counters.hasCounter(from_utf8(type))) {
3989 string const & lang = par.getParLanguage(bp)->code();
3990 counters.step(from_utf8(type), utype);
3991 full_label = bformat(from_ascii("%1$s %2$s:"),
3993 counters.theCounter(from_utf8(type), lang));
3995 full_label = bformat(from_ascii("%1$s #:"), name);
3997 par.params().labelString(full_label);
4001 case LABEL_NO_LABEL:
4002 par.params().labelString(docstring());
4006 case LABEL_TOP_ENVIRONMENT:
4007 case LABEL_CENTERED_TOP_ENVIRONMENT:
4010 par.params().labelString(par.expandLabel(layout, bp));
4016 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4018 LASSERT(parit.pit() == 0, /**/);
4020 // Set the position of the text in the buffer to be able
4021 // to resolve macros in it.
4022 parit.text()->setMacrocontextPosition(parit);
4024 depth_type maxdepth = 0;
4025 pit_type const lastpit = parit.lastpit();
4026 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4027 // reduce depth if necessary
4028 parit->params().depth(min(parit->params().depth(), maxdepth));
4029 maxdepth = parit->getMaxDepthAfter();
4031 if (utype == OutputUpdate) {
4032 // track the active counters
4033 // we have to do this for the master buffer, since the local
4034 // buffer isn't tracking anything.
4035 masterBuffer()->params().documentClass().counters().
4036 setActiveLayout(parit->layout());
4039 // set the counter for this paragraph
4040 d->setLabel(parit, utype);
4043 InsetList::const_iterator iit = parit->insetList().begin();
4044 InsetList::const_iterator end = parit->insetList().end();
4045 for (; iit != end; ++iit) {
4046 parit.pos() = iit->pos;
4047 iit->inset->updateBuffer(parit, utype);
4053 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4054 WordLangTuple & word_lang, docstring_list & suggestions) const
4058 suggestions.clear();
4059 word_lang = WordLangTuple();
4060 // OK, we start from here.
4061 DocIterator const end = doc_iterator_end(this);
4062 for (; from != end; from.forwardPos()) {
4063 // We are only interested in text so remove the math CursorSlice.
4064 while (from.inMathed()) {
4068 // If from is at the end of the document (which is possible
4069 // when leaving the mathed) LyX will crash later.
4073 from.paragraph().spellCheck();
4074 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4075 if (SpellChecker::misspelled(res)) {
4080 // Do not increase progress when from == to, otherwise the word
4081 // count will be wrong.
4091 bool Buffer::reload()
4095 removeAutosaveFile();
4096 // e.g., read-only status could have changed due to version control
4097 d->filename.refresh();
4098 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4100 bool const success = (loadLyXFile(d->filename) == ReadSuccess);
4106 saveCheckSum(d->filename);
4107 message(bformat(_("Document %1$s reloaded."), disp_fn));
4109 message(bformat(_("Could not reload document %1$s."), disp_fn));
4112 thePreviews().removeLoader(*this);
4113 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
4114 thePreviews().generateBufferPreviews(*this);
4120 // FIXME We could do better here, but it is complicated. What would be
4121 // nice is to offer either (a) to save the child buffer to an appropriate
4122 // location, so that it would "move with the master", or else (b) to update
4123 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4124 // complicated, because the code for this lives in GuiView.
4125 void Buffer::checkChildBuffers()
4127 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4128 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4129 for (; it != en; ++it) {
4130 DocIterator dit = it->second;
4131 Buffer * cbuf = const_cast<Buffer *>(it->first);
4132 if (!cbuf || !theBufferList().isLoaded(cbuf))
4134 Inset * inset = dit.nextInset();
4135 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4136 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4137 docstring const & incfile = inset_inc->getParam("filename");
4138 string oldloc = cbuf->absFileName();
4139 string newloc = makeAbsPath(to_utf8(incfile),
4140 onlyPath(absFileName())).absFileName();
4141 if (oldloc == newloc)
4143 // the location of the child file is incorrect.
4144 Alert::warning(_("Included File Invalid"),
4145 bformat(_("Saving this document to a new location has made the file:\n"
4147 "inaccessible. You will need to update the included filename."),
4148 from_utf8(oldloc)));
4150 inset_inc->setChildBuffer(0);
4152 // invalidate cache of children
4153 d->children_positions.clear();
4154 d->position_to_children.clear();