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 = 408; // gb add script inset
133 typedef map<string, bool> DepClean;
134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
136 void showPrintError(string const & name)
138 docstring str = bformat(_("Could not print the document %1$s.\n"
139 "Check that your printer is set up correctly."),
140 makeDisplayPath(name, 50));
141 Alert::error(_("Print document failed"), str);
150 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
161 /// search for macro in local (buffer) table or in children
162 MacroData const * getBufferMacro(docstring const & name,
163 DocIterator const & pos) const;
165 /// Update macro table starting with position of it \param it in some
167 void updateMacros(DocIterator & it, DocIterator & scope);
169 void setLabel(ParIterator & it, UpdateType utype) const;
171 /** If we have branches that use the file suffix
172 feature, return the file name with suffix appended.
174 support::FileName exportFileName() const;
181 mutable TexRow texrow;
183 /// need to regenerate .tex?
187 mutable bool lyx_clean;
189 /// is autosave needed?
190 mutable bool bak_clean;
192 /// is this an unnamed file (New...)?
198 /// name of the file the buffer is associated with.
201 /** Set to true only when the file is fully loaded.
202 * Used to prevent the premature generation of previews
203 * and by the citation inset.
205 bool file_fully_loaded;
208 mutable TocBackend toc_backend;
211 typedef pair<DocIterator, MacroData> ScopeMacro;
212 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
213 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
214 /// map from the macro name to the position map,
215 /// which maps the macro definition position to the scope and the MacroData.
216 NamePositionScopeMacroMap macros;
217 /// This seem to change the way Buffer::getMacro() works
218 mutable bool macro_lock;
220 /// positions of child buffers in the buffer
221 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
222 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
223 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
224 /// position of children buffers in this buffer
225 BufferPositionMap children_positions;
226 /// map from children inclusion positions to their scope and their buffer
227 PositionScopeBufferMap position_to_children;
229 /// Container for all sort of Buffer dependant errors.
230 map<string, ErrorList> errorLists;
232 /// timestamp and checksum used to test if the file has been externally
233 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
235 unsigned long checksum_;
238 frontend::WorkAreaManager * wa_;
240 frontend::GuiBufferDelegate * gui_;
245 /// A cache for the bibfiles (including bibfiles of loaded child
246 /// documents), needed for appropriate update of natbib labels.
247 mutable support::FileNameList bibfiles_cache_;
249 // FIXME The caching mechanism could be improved. At present, we have a
250 // cache for each Buffer, that caches all the bibliography info for that
251 // Buffer. A more efficient solution would be to have a global cache per
252 // file, and then to construct the Buffer's bibinfo from that.
253 /// A cache for bibliography info
254 mutable BiblioInfo bibinfo_;
255 /// whether the bibinfo cache is valid
256 mutable bool bibinfo_cache_valid_;
257 /// whether the bibfile cache is valid
258 mutable bool bibfile_cache_valid_;
259 /// Cache of timestamps of .bib files
260 map<FileName, time_t> bibfile_status_;
262 mutable RefCache ref_cache_;
264 /// our Text that should be wrapped in an InsetText
267 /// This is here to force the test to be done whenever parent_buffer
269 Buffer const * parent() const {
270 // if parent_buffer is not loaded, then it has been unloaded,
271 // which means that parent_buffer is an invalid pointer. So we
272 // set it to null in that case.
273 // however, the BufferList doesn't know about cloned buffers, so
274 // they will always be regarded as unloaded. in that case, we hope
276 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
278 return parent_buffer;
282 void setParent(Buffer const * pb) {
283 if (parent_buffer == pb)
286 if (!cloned_buffer_ && parent_buffer && pb)
287 LYXERR0("Warning: a buffer should not have two parents!");
289 if (!cloned_buffer_ && parent_buffer) {
290 parent_buffer->invalidateBibfileCache();
291 parent_buffer->invalidateBibinfoCache();
295 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
296 /// This one is useful for preview detached in a thread.
297 Buffer const * cloned_buffer_;
298 /// are we in the process of exporting this buffer?
299 mutable bool doing_export;
302 /// So we can force access via the accessors.
303 mutable Buffer const * parent_buffer;
308 /// Creates the per buffer temporary directory
309 static FileName createBufferTmpDir()
312 // We are in our own directory. Why bother to mangle name?
313 // In fact I wrote this code to circumvent a problematic behaviour
314 // (bug?) of EMX mkstemp().
315 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
316 convert<string>(count++));
318 if (!tmpfl.createDirectory(0777)) {
319 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
320 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
321 from_utf8(tmpfl.absFileName())));
327 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
328 Buffer const * cloned_buffer)
329 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
330 read_only(readonly_), filename(file), file_fully_loaded(false),
331 toc_backend(owner), macro_lock(false), timestamp_(0),
332 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
333 bibfile_cache_valid_(false), cloned_buffer_(cloned_buffer),
334 doing_export(false), parent_buffer(0)
336 if (!cloned_buffer_) {
337 temppath = createBufferTmpDir();
338 lyxvc.setBuffer(owner_);
340 wa_ = new frontend::WorkAreaManager;
343 temppath = cloned_buffer_->d->temppath;
344 file_fully_loaded = true;
345 params = cloned_buffer_->d->params;
346 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
347 bibinfo_ = cloned_buffer_->d->bibinfo_;
348 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
349 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
350 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
354 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
355 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
357 LYXERR(Debug::INFO, "Buffer::Buffer()");
359 d->inset = new InsetText(*cloned_buffer->d->inset);
360 d->inset->setBuffer(*this);
361 // FIXME: optimize this loop somewhat, maybe by creating a new
362 // general recursive Inset::setId().
363 DocIterator it = doc_iterator_begin(this);
364 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
365 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
366 it.paragraph().setId(cloned_it.paragraph().id());
368 d->inset = new InsetText(this);
369 d->inset->setAutoBreakRows(true);
370 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
376 LYXERR(Debug::INFO, "Buffer::~Buffer()");
377 // here the buffer should take care that it is
378 // saved properly, before it goes into the void.
380 // GuiView already destroyed
384 // No need to do additional cleanups for internal buffer.
389 // loop over children
390 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
391 Impl::BufferPositionMap::iterator end = d->children_positions.end();
392 for (; it != end; ++it) {
393 Buffer * child = const_cast<Buffer *>(it->first);
394 if (d->cloned_buffer_)
396 // The child buffer might have been closed already.
397 else if (theBufferList().isLoaded(child))
398 theBufferList().releaseChild(this, child);
402 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
403 msg += emergencyWrite();
404 Alert::warning(_("Attempting to close changed document!"), msg);
407 // clear references to children in macro tables
408 d->children_positions.clear();
409 d->position_to_children.clear();
411 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
412 Alert::warning(_("Could not remove temporary directory"),
413 bformat(_("Could not remove the temporary directory %1$s"),
414 from_utf8(d->temppath.absFileName())));
424 Buffer * Buffer::clone() const
426 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
427 buffer_clone->d->macro_lock = true;
428 buffer_clone->d->children_positions.clear();
429 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
430 // math macro caches need to be rethought and simplified.
431 // I am not sure wether we should handle Buffer cloning here or in BufferList.
432 // Right now BufferList knows nothing about buffer clones.
433 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
434 Impl::BufferPositionMap::iterator end = d->children_positions.end();
435 for (; it != end; ++it) {
436 DocIterator dit = it->second.clone(buffer_clone);
437 dit.setBuffer(buffer_clone);
438 Buffer * child = const_cast<Buffer *>(it->first);
439 Buffer * child_clone = child->clone();
440 Inset * inset = dit.nextInset();
441 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
442 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
443 inset_inc->setChildBuffer(child_clone);
444 child_clone->d->setParent(buffer_clone);
445 buffer_clone->setChild(dit, child_clone);
447 buffer_clone->d->macro_lock = false;
452 bool Buffer::isClone() const
454 return d->cloned_buffer_;
458 void Buffer::changed(bool update_metrics) const
461 d->wa_->redrawAll(update_metrics);
465 frontend::WorkAreaManager & Buffer::workAreaManager() const
467 LASSERT(d->wa_, /**/);
472 Text & Buffer::text() const
474 return d->inset->text();
478 Inset & Buffer::inset() const
484 BufferParams & Buffer::params()
490 BufferParams const & Buffer::params() const
496 ParagraphList & Buffer::paragraphs()
498 return text().paragraphs();
502 ParagraphList const & Buffer::paragraphs() const
504 return text().paragraphs();
508 LyXVC & Buffer::lyxvc()
514 LyXVC const & Buffer::lyxvc() const
520 string const Buffer::temppath() const
522 return d->temppath.absFileName();
526 TexRow & Buffer::texrow()
532 TexRow const & Buffer::texrow() const
538 TocBackend & Buffer::tocBackend() const
540 return d->toc_backend;
544 Undo & Buffer::undo()
550 void Buffer::setChild(DocIterator const & dit, Buffer * child)
552 d->children_positions[child] = dit;
556 string Buffer::latexName(bool const no_path) const
558 FileName latex_name =
559 makeLatexName(d->exportFileName());
560 return no_path ? latex_name.onlyFileName()
561 : latex_name.absFileName();
565 FileName Buffer::Impl::exportFileName() const
567 docstring const branch_suffix =
568 params.branchlist().getFileNameSuffix();
569 if (branch_suffix.empty())
572 string const name = filename.onlyFileNameWithoutExt()
573 + to_utf8(branch_suffix);
574 FileName res(filename.onlyPath().absFileName() + "/" + name);
575 res.changeExtension(filename.extension());
581 string Buffer::logName(LogType * type) const
583 string const filename = latexName(false);
585 if (filename.empty()) {
591 string const path = temppath();
593 FileName const fname(addName(temppath(),
594 onlyFileName(changeExtension(filename,
597 // FIXME: how do we know this is the name of the build log?
598 FileName const bname(
599 addName(path, onlyFileName(
600 changeExtension(filename,
601 formats.extension(bufferFormat()) + ".out"))));
603 // Also consider the master buffer log file
604 FileName masterfname = fname;
606 if (masterBuffer() != this) {
607 string const mlogfile = masterBuffer()->logName(&mtype);
608 masterfname = FileName(mlogfile);
611 // If no Latex log or Build log is newer, show Build log
612 if (bname.exists() &&
613 ((!fname.exists() && !masterfname.exists())
614 || (fname.lastModified() < bname.lastModified()
615 && masterfname.lastModified() < bname.lastModified()))) {
616 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
619 return bname.absFileName();
620 // If we have a newer master file log or only a master log, show this
621 } else if (fname != masterfname
622 && (!fname.exists() && (masterfname.exists()
623 || fname.lastModified() < masterfname.lastModified()))) {
624 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
627 return masterfname.absFileName();
629 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
632 return fname.absFileName();
636 void Buffer::setReadonly(bool const flag)
638 if (d->read_only != flag) {
645 void Buffer::setFileName(FileName const & fname)
648 setReadonly(d->filename.isReadOnly());
654 int Buffer::readHeader(Lexer & lex)
656 int unknown_tokens = 0;
658 int begin_header_line = -1;
660 // Initialize parameters that may be/go lacking in header:
661 params().branchlist().clear();
662 params().preamble.erase();
663 params().options.erase();
664 params().master.erase();
665 params().float_placement.erase();
666 params().paperwidth.erase();
667 params().paperheight.erase();
668 params().leftmargin.erase();
669 params().rightmargin.erase();
670 params().topmargin.erase();
671 params().bottommargin.erase();
672 params().headheight.erase();
673 params().headsep.erase();
674 params().footskip.erase();
675 params().columnsep.erase();
676 params().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 fn = FileName::tempName("Buffer_readString");
841 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
842 if (ret_plf != ReadSuccess)
845 if (file_format != LYX_FORMAT) {
846 // We need to call lyx2lyx, so write the input to a file
847 ofstream os(fn.toFilesystemEncoding().c_str());
851 return readFile(fn) == ReadSuccess;
854 if (readDocument(lex))
860 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
867 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
868 if (ret_plf != ReadSuccess)
871 if (file_format != LYX_FORMAT) {
873 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
874 if (ret_clf != ReadSuccess)
876 return readFile(tmpFile);
879 // FIXME: InsetInfo needs to know whether the file is under VCS
880 // during the parse process, so this has to be done before.
881 lyxvc().file_found_hook(d->filename);
883 if (readDocument(lex)) {
884 Alert::error(_("Document format failure"),
885 bformat(_("%1$s ended unexpectedly, which means"
886 " that it is probably corrupted."),
887 from_utf8(fn.absFileName())));
888 return ReadDocumentFailure;
891 d->file_fully_loaded = true;
892 d->read_only = !d->filename.isWritable();
893 params().compressed = d->filename.isZippedFile();
899 bool Buffer::isFullyLoaded() const
901 return d->file_fully_loaded;
905 void Buffer::setFullyLoaded(bool value)
907 d->file_fully_loaded = value;
911 void Buffer::updatePreviews() const
913 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
914 thePreviews().generateBufferPreviews(*this);
918 void Buffer::removePreviews() const
920 thePreviews().removeLoader(*this);
924 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
925 FileName const & fn, int & file_format) const
927 if(!lex.checkFor("\\lyxformat")) {
928 Alert::error(_("Document format failure"),
929 bformat(_("%1$s is not a readable LyX document."),
930 from_utf8(fn.absFileName())));
931 return ReadNoLyXFormat;
937 // LyX formats 217 and earlier were written as 2.17. This corresponds
938 // to files from LyX versions < 1.1.6.3. We just remove the dot in
939 // these cases. See also: www.lyx.org/trac/changeset/1313.
940 size_t dot = tmp_format.find_first_of(".,");
941 if (dot != string::npos)
942 tmp_format.erase(dot, 1);
944 file_format = convert<int>(tmp_format);
949 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
950 FileName & tmpfile, int from_format)
952 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
953 if(tmpfile.empty()) {
954 Alert::error(_("Conversion failed"),
955 bformat(_("%1$s is from a different"
956 " version of LyX, but a temporary"
957 " file for converting it could"
959 from_utf8(fn.absFileName())));
960 return LyX2LyXNoTempFile;
963 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
964 if (lyx2lyx.empty()) {
965 Alert::error(_("Conversion script not found"),
966 bformat(_("%1$s is from a different"
967 " version of LyX, but the"
968 " conversion script lyx2lyx"
969 " could not be found."),
970 from_utf8(fn.absFileName())));
971 return LyX2LyXNotFound;
975 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
976 ostringstream command;
977 command << os::python()
978 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
979 << " -t " << convert<string>(LYX_FORMAT)
980 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
981 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
982 string const command_str = command.str();
984 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
986 cmd_ret const ret = runCommand(command_str);
987 if (ret.first != 0) {
988 if (from_format < LYX_FORMAT) {
989 Alert::error(_("Conversion script failed"),
990 bformat(_("%1$s is from an older version"
991 " of LyX and the lyx2lyx script"
992 " failed to convert it."),
993 from_utf8(fn.absFileName())));
994 return LyX2LyXOlderFormat;
996 Alert::error(_("Conversion script failed"),
997 bformat(_("%1$s is from a newer version"
998 " of LyX and the lyx2lyx script"
999 " failed to convert it."),
1000 from_utf8(fn.absFileName())));
1001 return LyX2LyXNewerFormat;
1008 // Should probably be moved to somewhere else: BufferView? GuiView?
1009 bool Buffer::save() const
1011 // ask if the disk file has been externally modified (use checksum method)
1012 if (fileName().exists() && isExternallyModified(checksum_method)) {
1013 docstring const file = makeDisplayPath(absFileName(), 20);
1014 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
1015 "you want to overwrite this file?"), file);
1016 int const ret = Alert::prompt(_("Overwrite modified file?"),
1017 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1022 // We don't need autosaves in the immediate future. (Asger)
1023 resetAutosaveTimers();
1025 FileName backupName;
1026 bool madeBackup = false;
1028 // make a backup if the file already exists
1029 if (lyxrc.make_backup && fileName().exists()) {
1030 backupName = FileName(absFileName() + '~');
1031 if (!lyxrc.backupdir_path.empty()) {
1032 string const mangledName =
1033 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1034 backupName = FileName(addName(lyxrc.backupdir_path,
1037 // do not copy because of #6587
1038 if (fileName().moveTo(backupName)) {
1041 Alert::error(_("Backup failure"),
1042 bformat(_("Cannot create backup file %1$s.\n"
1043 "Please check whether the directory exists and is writeable."),
1044 from_utf8(backupName.absFileName())));
1045 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1049 if (writeFile(d->filename)) {
1053 // Saving failed, so backup is not backup
1055 backupName.moveTo(d->filename);
1061 bool Buffer::writeFile(FileName const & fname) const
1063 if (d->read_only && fname == d->filename)
1066 bool retval = false;
1068 docstring const str = bformat(_("Saving document %1$s..."),
1069 makeDisplayPath(fname.absFileName()));
1072 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1074 if (params().compressed) {
1075 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1076 retval = ofs && write(ofs);
1078 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1079 retval = ofs && write(ofs);
1083 message(str + _(" could not write file!"));
1088 // removeAutosaveFile();
1091 message(str + _(" done."));
1097 docstring Buffer::emergencyWrite()
1099 // No need to save if the buffer has not changed.
1103 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1105 docstring user_message = bformat(
1106 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1108 // We try to save three places:
1109 // 1) Same place as document. Unless it is an unnamed doc.
1111 string s = absFileName();
1114 if (writeFile(FileName(s))) {
1116 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1117 return user_message;
1119 user_message += _(" Save failed! Trying again...\n");
1123 // 2) In HOME directory.
1124 string s = addName(package().home_dir().absFileName(), absFileName());
1126 lyxerr << ' ' << s << endl;
1127 if (writeFile(FileName(s))) {
1129 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1130 return user_message;
1133 user_message += _(" Save failed! Trying yet again...\n");
1135 // 3) In "/tmp" directory.
1136 // MakeAbsPath to prepend the current
1137 // drive letter on OS/2
1138 s = addName(package().temp_dir().absFileName(), absFileName());
1140 lyxerr << ' ' << s << endl;
1141 if (writeFile(FileName(s))) {
1143 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1144 return user_message;
1147 user_message += _(" Save failed! Bummer. Document is lost.");
1150 return user_message;
1154 bool Buffer::write(ostream & ofs) const
1157 // Use the standard "C" locale for file output.
1158 ofs.imbue(locale::classic());
1161 // The top of the file should not be written by params().
1163 // write out a comment in the top of the file
1164 ofs << "#LyX " << lyx_version
1165 << " created this file. For more info see http://www.lyx.org/\n"
1166 << "\\lyxformat " << LYX_FORMAT << "\n"
1167 << "\\begin_document\n";
1169 /// For each author, set 'used' to true if there is a change
1170 /// by this author in the document; otherwise set it to 'false'.
1171 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1172 AuthorList::Authors::const_iterator a_end = params().authors().end();
1173 for (; a_it != a_end; ++a_it)
1174 a_it->setUsed(false);
1176 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1177 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1178 for ( ; it != end; ++it)
1179 it->checkAuthors(params().authors());
1181 // now write out the buffer parameters.
1182 ofs << "\\begin_header\n";
1183 params().writeFile(ofs);
1184 ofs << "\\end_header\n";
1187 ofs << "\n\\begin_body\n";
1189 ofs << "\n\\end_body\n";
1191 // Write marker that shows file is complete
1192 ofs << "\\end_document" << endl;
1194 // Shouldn't really be needed....
1197 // how to check if close went ok?
1198 // Following is an attempt... (BE 20001011)
1200 // good() returns false if any error occured, including some
1201 // formatting error.
1202 // bad() returns true if something bad happened in the buffer,
1203 // which should include file system full errors.
1208 lyxerr << "File was not closed properly." << endl;
1215 bool Buffer::makeLaTeXFile(FileName const & fname,
1216 string const & original_path,
1217 OutputParams const & runparams_in,
1218 bool output_preamble, bool output_body) const
1220 OutputParams runparams = runparams_in;
1222 string const encoding = runparams.encoding->iconvName();
1223 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1226 try { ofs.reset(encoding); }
1227 catch (iconv_codecvt_facet_exception & e) {
1228 lyxerr << "Caught iconv exception: " << e.what() << endl;
1229 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1230 "verify that the support software for your encoding (%1$s) is "
1231 "properly installed"), from_ascii(encoding)));
1234 if (!openFileWrite(ofs, fname))
1237 //TexStream ts(ofs.rdbuf(), &texrow());
1238 ErrorList & errorList = d->errorLists["Export"];
1240 bool failed_export = false;
1243 writeLaTeXSource(ofs, original_path,
1244 runparams, output_preamble, output_body);
1246 catch (EncodingException & e) {
1247 odocstringstream ods;
1248 ods.put(e.failed_char);
1250 oss << "0x" << hex << e.failed_char << dec;
1251 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1252 " (code point %2$s)"),
1253 ods.str(), from_utf8(oss.str()));
1254 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1255 "representable in the chosen encoding.\n"
1256 "Changing the document encoding to utf8 could help."),
1257 e.par_id, e.pos, e.pos + 1));
1258 failed_export = true;
1260 catch (iconv_codecvt_facet_exception & e) {
1261 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1262 _(e.what()), -1, 0, 0));
1263 failed_export = true;
1265 catch (exception const & e) {
1266 errorList.push_back(ErrorItem(_("conversion failed"),
1267 _(e.what()), -1, 0, 0));
1268 failed_export = true;
1271 lyxerr << "Caught some really weird exception..." << endl;
1277 failed_export = true;
1278 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1282 return !failed_export;
1286 void Buffer::writeLaTeXSource(odocstream & os,
1287 string const & original_path,
1288 OutputParams const & runparams_in,
1289 bool const output_preamble, bool const output_body) const
1291 // The child documents, if any, shall be already loaded at this point.
1293 OutputParams runparams = runparams_in;
1295 // Classify the unicode characters appearing in math insets
1296 Encodings::initUnicodeMath(*this);
1298 // validate the buffer.
1299 LYXERR(Debug::LATEX, " Validating buffer...");
1300 LaTeXFeatures features(*this, params(), runparams);
1302 LYXERR(Debug::LATEX, " Buffer validation done.");
1304 // The starting paragraph of the coming rows is the
1305 // first paragraph of the document. (Asger)
1306 if (output_preamble && runparams.nice) {
1307 os << "%% LyX " << lyx_version << " created this file. "
1308 "For more info, see http://www.lyx.org/.\n"
1309 "%% Do not edit unless you really know what "
1311 d->texrow.newline();
1312 d->texrow.newline();
1314 LYXERR(Debug::INFO, "lyx document header finished");
1316 // Don't move this behind the parent_buffer=0 code below,
1317 // because then the macros will not get the right "redefinition"
1318 // flag as they don't see the parent macros which are output before.
1321 // fold macros if possible, still with parent buffer as the
1322 // macros will be put in the prefix anyway.
1323 updateMacroInstances();
1325 // There are a few differences between nice LaTeX and usual files:
1326 // usual is \batchmode and has a
1327 // special input@path to allow the including of figures
1328 // with either \input or \includegraphics (what figinsets do).
1329 // input@path is set when the actual parameter
1330 // original_path is set. This is done for usual tex-file, but not
1331 // for nice-latex-file. (Matthias 250696)
1332 // Note that input@path is only needed for something the user does
1333 // in the preamble, included .tex files or ERT, files included by
1334 // LyX work without it.
1335 if (output_preamble) {
1336 if (!runparams.nice) {
1337 // code for usual, NOT nice-latex-file
1338 os << "\\batchmode\n"; // changed
1339 // from \nonstopmode
1340 d->texrow.newline();
1342 if (!original_path.empty()) {
1344 // We don't know the encoding of inputpath
1345 docstring const inputpath = from_utf8(support::latex_path(original_path));
1346 docstring uncodable_glyphs;
1347 Encoding const * const enc = runparams.encoding;
1349 for (size_t n = 0; n < inputpath.size(); ++n) {
1350 docstring const glyph =
1351 docstring(1, inputpath[n]);
1352 if (enc->latexChar(inputpath[n], true) != glyph) {
1353 LYXERR0("Uncodable character '"
1355 << "' in input path!");
1356 uncodable_glyphs += glyph;
1361 // warn user if we found uncodable glyphs.
1362 if (!uncodable_glyphs.empty()) {
1363 frontend::Alert::warning(_("Uncodable character in file path"),
1364 support::bformat(_("The path of your document\n"
1366 "contains glyphs that are unknown in the\n"
1367 "current document encoding (namely %2$s).\n"
1368 "This will likely result in incomplete output.\n\n"
1369 "Choose an appropriate document encoding (such as utf8)\n"
1370 "or change the file path name."), inputpath, uncodable_glyphs));
1372 os << "\\makeatletter\n"
1373 << "\\def\\input@path{{"
1374 << inputpath << "/}}\n"
1375 << "\\makeatother\n";
1376 d->texrow.newline();
1377 d->texrow.newline();
1378 d->texrow.newline();
1382 // get parent macros (if this buffer has a parent) which will be
1383 // written at the document begin further down.
1384 MacroSet parentMacros;
1385 listParentMacros(parentMacros, features);
1387 runparams.use_polyglossia = features.usePolyglossia();
1388 // Write the preamble
1389 runparams.use_babel = params().writeLaTeX(os, features,
1391 d->filename.onlyPath());
1393 runparams.use_japanese = features.isRequired("japanese");
1399 os << "\\begin{document}\n";
1400 d->texrow.newline();
1402 // output the parent macros
1403 MacroSet::iterator it = parentMacros.begin();
1404 MacroSet::iterator end = parentMacros.end();
1405 for (; it != end; ++it) {
1406 int num_lines = (*it)->write(os, true);
1407 d->texrow.newlines(num_lines);
1410 } // output_preamble
1412 d->texrow.start(paragraphs().begin()->id(), 0);
1414 LYXERR(Debug::INFO, "preamble finished, now the body.");
1416 // if we are doing a real file with body, even if this is the
1417 // child of some other buffer, let's cut the link here.
1418 // This happens for example if only a child document is printed.
1419 Buffer const * save_parent = 0;
1420 if (output_preamble) {
1421 save_parent = d->parent();
1426 latexParagraphs(*this, text(), os, d->texrow, runparams);
1428 // Restore the parenthood if needed
1429 if (output_preamble)
1430 d->setParent(save_parent);
1432 // add this just in case after all the paragraphs
1434 d->texrow.newline();
1436 if (output_preamble) {
1437 os << "\\end{document}\n";
1438 d->texrow.newline();
1439 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1441 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1443 runparams_in.encoding = runparams.encoding;
1445 // Just to be sure. (Asger)
1446 d->texrow.newline();
1448 //for (int i = 0; i<d->texrow.rows(); i++) {
1450 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1451 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1454 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1455 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1459 bool Buffer::isLatex() const
1461 return params().documentClass().outputType() == LATEX;
1465 bool Buffer::isLiterate() const
1467 return params().documentClass().outputType() == LITERATE;
1471 bool Buffer::isDocBook() const
1473 return params().documentClass().outputType() == DOCBOOK;
1477 void Buffer::makeDocBookFile(FileName const & fname,
1478 OutputParams const & runparams,
1479 bool const body_only) const
1481 LYXERR(Debug::LATEX, "makeDocBookFile...");
1484 if (!openFileWrite(ofs, fname))
1487 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1491 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1495 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1496 OutputParams const & runparams,
1497 bool const only_body) const
1499 LaTeXFeatures features(*this, params(), runparams);
1504 DocumentClass const & tclass = params().documentClass();
1505 string const top_element = tclass.latexname();
1508 if (runparams.flavor == OutputParams::XML)
1509 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1512 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1515 if (! tclass.class_header().empty())
1516 os << from_ascii(tclass.class_header());
1517 else if (runparams.flavor == OutputParams::XML)
1518 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1519 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1521 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1523 docstring preamble = from_utf8(params().preamble);
1524 if (runparams.flavor != OutputParams::XML ) {
1525 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1526 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1527 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1528 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1531 string const name = runparams.nice
1532 ? changeExtension(absFileName(), ".sgml") : fname;
1533 preamble += features.getIncludedFiles(name);
1534 preamble += features.getLyXSGMLEntities();
1536 if (!preamble.empty()) {
1537 os << "\n [ " << preamble << " ]";
1542 string top = top_element;
1544 if (runparams.flavor == OutputParams::XML)
1545 top += params().language->code();
1547 top += params().language->code().substr(0, 2);
1550 if (!params().options.empty()) {
1552 top += params().options;
1555 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1556 << " file was created by LyX " << lyx_version
1557 << "\n See http://www.lyx.org/ for more information -->\n";
1559 params().documentClass().counters().reset();
1563 sgml::openTag(os, top);
1565 docbookParagraphs(text(), *this, os, runparams);
1566 sgml::closeTag(os, top_element);
1570 void Buffer::makeLyXHTMLFile(FileName const & fname,
1571 OutputParams const & runparams,
1572 bool const body_only) const
1574 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1577 if (!openFileWrite(ofs, fname))
1580 writeLyXHTMLSource(ofs, runparams, body_only);
1584 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1588 void Buffer::writeLyXHTMLSource(odocstream & os,
1589 OutputParams const & runparams,
1590 bool const only_body) const
1592 LaTeXFeatures features(*this, params(), runparams);
1594 updateBuffer(UpdateMaster, OutputUpdate);
1595 d->bibinfo_.makeCitationLabels(*this);
1597 updateMacroInstances();
1600 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1601 << "<!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"
1602 // FIXME Language should be set properly.
1603 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1605 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1606 // FIXME Presumably need to set this right
1607 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1609 docstring const & doctitle = features.htmlTitle();
1611 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1614 os << "\n<!-- Text Class Preamble -->\n"
1615 << features.getTClassHTMLPreamble()
1616 << "\n<!-- Preamble Snippets -->\n"
1617 << from_utf8(features.getPreambleSnippets());
1619 os << "\n<!-- Layout-provided Styles -->\n";
1620 docstring const styleinfo = features.getTClassHTMLStyles();
1621 if (!styleinfo.empty()) {
1622 os << "<style type='text/css'>\n"
1626 os << "</head>\n<body>\n";
1630 params().documentClass().counters().reset();
1631 xhtmlParagraphs(text(), *this, xs, runparams);
1633 os << "</body>\n</html>\n";
1637 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1638 // Other flags: -wall -v0 -x
1639 int Buffer::runChktex()
1643 // get LaTeX-Filename
1644 FileName const path(temppath());
1645 string const name = addName(path.absFileName(), latexName());
1646 string const org_path = filePath();
1648 PathChanger p(path); // path to LaTeX file
1649 message(_("Running chktex..."));
1651 // Generate the LaTeX file if neccessary
1652 OutputParams runparams(¶ms().encoding());
1653 runparams.flavor = OutputParams::LATEX;
1654 runparams.nice = false;
1655 runparams.linelen = lyxrc.plaintext_linelen;
1656 makeLaTeXFile(FileName(name), org_path, runparams);
1659 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1660 int const res = chktex.run(terr); // run chktex
1663 Alert::error(_("chktex failure"),
1664 _("Could not run chktex successfully."));
1665 } else if (res > 0) {
1666 ErrorList & errlist = d->errorLists["ChkTeX"];
1668 bufferErrors(terr, errlist);
1679 void Buffer::validate(LaTeXFeatures & features) const
1681 params().validate(features);
1685 for_each(paragraphs().begin(), paragraphs().end(),
1686 bind(&Paragraph::validate, _1, ref(features)));
1688 if (lyxerr.debugging(Debug::LATEX)) {
1689 features.showStruct();
1694 void Buffer::getLabelList(vector<docstring> & list) const
1696 // If this is a child document, use the master's list instead.
1698 masterBuffer()->getLabelList(list);
1703 Toc & toc = d->toc_backend.toc("label");
1704 TocIterator toc_it = toc.begin();
1705 TocIterator end = toc.end();
1706 for (; toc_it != end; ++toc_it) {
1707 if (toc_it->depth() == 0)
1708 list.push_back(toc_it->str());
1713 void Buffer::updateBibfilesCache(UpdateScope scope) const
1715 // FIXME This is probably unnecssary, given where we call this.
1716 // If this is a child document, use the parent's cache instead.
1717 if (parent() && scope != UpdateChildOnly) {
1718 masterBuffer()->updateBibfilesCache();
1722 d->bibfiles_cache_.clear();
1723 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1724 if (it->lyxCode() == BIBTEX_CODE) {
1725 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1726 support::FileNameList const bibfiles = inset.getBibFiles();
1727 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1730 } else if (it->lyxCode() == INCLUDE_CODE) {
1731 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1732 Buffer const * const incbuf = inset.getChildBuffer();
1735 support::FileNameList const & bibfiles =
1736 incbuf->getBibfilesCache(UpdateChildOnly);
1737 if (!bibfiles.empty()) {
1738 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1744 d->bibfile_cache_valid_ = true;
1745 d->bibinfo_cache_valid_ = false;
1749 void Buffer::invalidateBibinfoCache() const
1751 d->bibinfo_cache_valid_ = false;
1752 // also invalidate the cache for the parent buffer
1753 Buffer const * const pbuf = d->parent();
1755 pbuf->invalidateBibinfoCache();
1759 void Buffer::invalidateBibfileCache() const
1761 d->bibfile_cache_valid_ = false;
1762 d->bibinfo_cache_valid_ = false;
1763 // also invalidate the cache for the parent buffer
1764 Buffer const * const pbuf = d->parent();
1766 pbuf->invalidateBibfileCache();
1770 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1772 // FIXME This is probably unnecessary, given where we call this.
1773 // If this is a child document, use the master's cache instead.
1774 Buffer const * const pbuf = masterBuffer();
1775 if (pbuf != this && scope != UpdateChildOnly)
1776 return pbuf->getBibfilesCache();
1778 if (!d->bibfile_cache_valid_)
1779 this->updateBibfilesCache(scope);
1781 return d->bibfiles_cache_;
1785 BiblioInfo const & Buffer::masterBibInfo() const
1787 Buffer const * const tmp = masterBuffer();
1789 return tmp->masterBibInfo();
1794 void Buffer::checkBibInfoCache() const
1796 // use the master's cache
1797 Buffer const * const tmp = masterBuffer();
1799 tmp->checkBibInfoCache();
1803 // this will also reload the cache if it is invalid
1804 support::FileNameList const & bibfiles_cache = getBibfilesCache();
1806 // compare the cached timestamps with the actual ones.
1807 support::FileNameList::const_iterator ei = bibfiles_cache.begin();
1808 support::FileNameList::const_iterator en = bibfiles_cache.end();
1809 for (; ei != en; ++ ei) {
1810 time_t lastw = ei->lastModified();
1811 time_t prevw = d->bibfile_status_[*ei];
1812 if (lastw != prevw) {
1813 d->bibinfo_cache_valid_ = false;
1814 d->bibfile_status_[*ei] = lastw;
1818 // if not valid, then reload the info
1819 if (!d->bibinfo_cache_valid_) {
1820 d->bibinfo_.clear();
1821 fillWithBibKeys(d->bibinfo_);
1822 d->bibinfo_cache_valid_ = true;
1827 void Buffer::fillWithBibKeys(BiblioInfo & keys) const
1829 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1830 it->fillWithBibKeys(keys, it);
1834 bool Buffer::isDepClean(string const & name) const
1836 DepClean::const_iterator const it = d->dep_clean.find(name);
1837 if (it == d->dep_clean.end())
1843 void Buffer::markDepClean(string const & name)
1845 d->dep_clean[name] = true;
1849 bool Buffer::isExportableFormat(string const & format) const
1851 typedef vector<Format const *> Formats;
1853 formats = exportableFormats(true);
1854 Formats::const_iterator fit = formats.begin();
1855 Formats::const_iterator end = formats.end();
1856 for (; fit != end ; ++fit) {
1857 if ((*fit)->name() == format)
1864 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1867 // FIXME? if there is an Buffer LFUN that can be dispatched even
1868 // if internal, put a switch '(cmd.action)' here.
1874 switch (cmd.action()) {
1876 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1877 flag.setOnOff(isReadonly());
1880 // FIXME: There is need for a command-line import.
1881 //case LFUN_BUFFER_IMPORT:
1883 case LFUN_BUFFER_AUTO_SAVE:
1886 case LFUN_BUFFER_EXPORT_CUSTOM:
1887 // FIXME: Nothing to check here?
1890 case LFUN_BUFFER_EXPORT: {
1891 docstring const arg = cmd.argument();
1892 enable = arg == "custom" || isExportable(to_utf8(arg));
1894 flag.message(bformat(
1895 _("Don't know how to export to format: %1$s"), arg));
1899 case LFUN_BUFFER_CHKTEX:
1900 enable = isLatex() && !lyxrc.chktex_command.empty();
1903 case LFUN_BUILD_PROGRAM:
1904 enable = isExportable("program");
1907 case LFUN_BRANCH_ACTIVATE:
1908 case LFUN_BRANCH_DEACTIVATE: {
1909 BranchList const & branchList = params().branchlist();
1910 docstring const branchName = cmd.argument();
1911 enable = !branchName.empty() && branchList.find(branchName);
1915 case LFUN_BRANCH_ADD:
1916 case LFUN_BRANCHES_RENAME:
1917 case LFUN_BUFFER_PRINT:
1918 // if no Buffer is present, then of course we won't be called!
1921 case LFUN_BUFFER_LANGUAGE:
1922 enable = !isReadonly();
1928 flag.setEnabled(enable);
1933 void Buffer::dispatch(string const & command, DispatchResult & result)
1935 return dispatch(lyxaction.lookupFunc(command), result);
1939 // NOTE We can end up here even if we have no GUI, because we are called
1940 // by LyX::exec to handled command-line requests. So we may need to check
1941 // whether we have a GUI or not. The boolean use_gui holds this information.
1942 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1945 // FIXME? if there is an Buffer LFUN that can be dispatched even
1946 // if internal, put a switch '(cmd.action())' here.
1947 dr.dispatched(false);
1950 string const argument = to_utf8(func.argument());
1951 // We'll set this back to false if need be.
1952 bool dispatched = true;
1953 undo().beginUndoGroup();
1955 switch (func.action()) {
1956 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1957 if (lyxvc().inUse())
1958 lyxvc().toggleReadOnly();
1960 setReadonly(!isReadonly());
1963 case LFUN_BUFFER_EXPORT: {
1964 bool success = doExport(argument, false, false);
1965 dr.setError(!success);
1967 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1972 case LFUN_BUILD_PROGRAM:
1973 doExport("program", true, false);
1976 case LFUN_BUFFER_CHKTEX:
1980 case LFUN_BUFFER_EXPORT_CUSTOM: {
1982 string command = split(argument, format_name, ' ');
1983 Format const * format = formats.getFormat(format_name);
1985 lyxerr << "Format \"" << format_name
1986 << "\" not recognized!"
1991 // The name of the file created by the conversion process
1994 // Output to filename
1995 if (format->name() == "lyx") {
1996 string const latexname = latexName(false);
1997 filename = changeExtension(latexname,
1998 format->extension());
1999 filename = addName(temppath(), filename);
2001 if (!writeFile(FileName(filename)))
2005 doExport(format_name, true, false, filename);
2008 // Substitute $$FName for filename
2009 if (!contains(command, "$$FName"))
2010 command = "( " + command + " ) < $$FName";
2011 command = subst(command, "$$FName", filename);
2013 // Execute the command in the background
2015 call.startscript(Systemcall::DontWait, command);
2019 // FIXME: There is need for a command-line import.
2021 case LFUN_BUFFER_IMPORT:
2026 case LFUN_BUFFER_AUTO_SAVE:
2028 resetAutosaveTimers();
2031 case LFUN_BRANCH_ADD: {
2032 docstring branch_name = func.argument();
2033 if (branch_name.empty()) {
2037 BranchList & branch_list = params().branchlist();
2038 vector<docstring> const branches =
2039 getVectorFromString(branch_name, branch_list.separator());
2041 for (vector<docstring>::const_iterator it = branches.begin();
2042 it != branches.end(); ++it) {
2044 Branch * branch = branch_list.find(branch_name);
2046 LYXERR0("Branch " << branch_name << " already exists.");
2050 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2052 branch_list.add(branch_name);
2053 branch = branch_list.find(branch_name);
2054 string const x11hexname = X11hexname(branch->color());
2055 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2056 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2058 dr.screenUpdate(Update::Force);
2066 case LFUN_BRANCH_ACTIVATE:
2067 case LFUN_BRANCH_DEACTIVATE: {
2068 BranchList & branchList = params().branchlist();
2069 docstring const branchName = func.argument();
2070 // the case without a branch name is handled elsewhere
2071 if (branchName.empty()) {
2075 Branch * branch = branchList.find(branchName);
2077 LYXERR0("Branch " << branchName << " does not exist.");
2079 docstring const msg =
2080 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2083 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2085 dr.screenUpdate(Update::Force);
2086 dr.forceBufferUpdate();
2091 case LFUN_BRANCHES_RENAME: {
2092 if (func.argument().empty())
2095 docstring const oldname = from_utf8(func.getArg(0));
2096 docstring const newname = from_utf8(func.getArg(1));
2097 InsetIterator it = inset_iterator_begin(inset());
2098 InsetIterator const end = inset_iterator_end(inset());
2099 bool success = false;
2100 for (; it != end; ++it) {
2101 if (it->lyxCode() == BRANCH_CODE) {
2102 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2103 if (ins.branch() == oldname) {
2104 undo().recordUndo(it);
2105 ins.rename(newname);
2110 if (it->lyxCode() == INCLUDE_CODE) {
2111 // get buffer of external file
2112 InsetInclude const & ins =
2113 static_cast<InsetInclude const &>(*it);
2114 Buffer * child = ins.getChildBuffer();
2117 child->dispatch(func, dr);
2122 dr.screenUpdate(Update::Force);
2123 dr.forceBufferUpdate();
2128 case LFUN_BUFFER_PRINT: {
2129 // we'll assume there's a problem until we succeed
2131 string target = func.getArg(0);
2132 string target_name = func.getArg(1);
2133 string command = func.getArg(2);
2136 || target_name.empty()
2137 || command.empty()) {
2138 LYXERR0("Unable to parse " << func.argument());
2139 docstring const msg =
2140 bformat(_("Unable to parse \"%1$s\""), func.argument());
2144 if (target != "printer" && target != "file") {
2145 LYXERR0("Unrecognized target \"" << target << '"');
2146 docstring const msg =
2147 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2152 bool const update_unincluded =
2153 params().maintain_unincluded_children
2154 && !params().getIncludedChildren().empty();
2155 if (!doExport("dvi", true, update_unincluded)) {
2156 showPrintError(absFileName());
2157 dr.setMessage(_("Error exporting to DVI."));
2161 // Push directory path.
2162 string const path = temppath();
2163 // Prevent the compiler from optimizing away p
2167 // there are three cases here:
2168 // 1. we print to a file
2169 // 2. we print directly to a printer
2170 // 3. we print using a spool command (print to file first)
2173 string const dviname = changeExtension(latexName(true), "dvi");
2175 if (target == "printer") {
2176 if (!lyxrc.print_spool_command.empty()) {
2177 // case 3: print using a spool
2178 string const psname = changeExtension(dviname,".ps");
2179 command += ' ' + lyxrc.print_to_file
2182 + quoteName(dviname);
2184 string command2 = lyxrc.print_spool_command + ' ';
2185 if (target_name != "default") {
2186 command2 += lyxrc.print_spool_printerprefix
2190 command2 += quoteName(psname);
2192 // If successful, then spool command
2193 res = one.startscript(Systemcall::Wait, command);
2196 // If there's no GUI, we have to wait on this command. Otherwise,
2197 // LyX deletes the temporary directory, and with it the spooled
2198 // file, before it can be printed!!
2199 Systemcall::Starttype stype = use_gui ?
2200 Systemcall::DontWait : Systemcall::Wait;
2201 res = one.startscript(stype, command2);
2204 // case 2: print directly to a printer
2205 if (target_name != "default")
2206 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2208 Systemcall::Starttype stype = use_gui ?
2209 Systemcall::DontWait : Systemcall::Wait;
2210 res = one.startscript(stype, command + quoteName(dviname));
2214 // case 1: print to a file
2215 FileName const filename(makeAbsPath(target_name, filePath()));
2216 FileName const dvifile(makeAbsPath(dviname, path));
2217 if (filename.exists()) {
2218 docstring text = bformat(
2219 _("The file %1$s already exists.\n\n"
2220 "Do you want to overwrite that file?"),
2221 makeDisplayPath(filename.absFileName()));
2222 if (Alert::prompt(_("Overwrite file?"),
2223 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2226 command += ' ' + lyxrc.print_to_file
2227 + quoteName(filename.toFilesystemEncoding())
2229 + quoteName(dvifile.toFilesystemEncoding());
2231 Systemcall::Starttype stype = use_gui ?
2232 Systemcall::DontWait : Systemcall::Wait;
2233 res = one.startscript(stype, command);
2239 dr.setMessage(_("Error running external commands."));
2240 showPrintError(absFileName());
2245 case LFUN_BUFFER_LANGUAGE: {
2246 Language const * oldL = params().language;
2247 Language const * newL = languages.getLanguage(argument);
2248 if (!newL || oldL == newL)
2250 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2251 changeLanguage(oldL, newL);
2252 dr.forceBufferUpdate();
2261 dr.dispatched(dispatched);
2262 undo().endUndoGroup();
2266 void Buffer::changeLanguage(Language const * from, Language const * to)
2268 LASSERT(from, /**/);
2271 for_each(par_iterator_begin(),
2273 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2277 bool Buffer::isMultiLingual() const
2279 ParConstIterator end = par_iterator_end();
2280 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2281 if (it->isMultiLingual(params()))
2288 std::set<Language const *> Buffer::getLanguages() const
2290 std::set<Language const *> languages;
2291 getLanguages(languages);
2296 void Buffer::getLanguages(std::set<Language const *> & languages) const
2298 ParConstIterator end = par_iterator_end();
2299 // add the buffer language, even if it's not actively used
2300 languages.insert(language());
2301 // iterate over the paragraphs
2302 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2303 it->getLanguages(languages);
2305 ListOfBuffers clist = getDescendents();
2306 ListOfBuffers::const_iterator cit = clist.begin();
2307 ListOfBuffers::const_iterator const cen = clist.end();
2308 for (; cit != cen; ++cit)
2309 (*cit)->getLanguages(languages);
2313 DocIterator Buffer::getParFromID(int const id) const
2315 Buffer * buf = const_cast<Buffer *>(this);
2317 // John says this is called with id == -1 from undo
2318 lyxerr << "getParFromID(), id: " << id << endl;
2319 return doc_iterator_end(buf);
2322 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2323 if (it.paragraph().id() == id)
2326 return doc_iterator_end(buf);
2330 bool Buffer::hasParWithID(int const id) const
2332 return !getParFromID(id).atEnd();
2336 ParIterator Buffer::par_iterator_begin()
2338 return ParIterator(doc_iterator_begin(this));
2342 ParIterator Buffer::par_iterator_end()
2344 return ParIterator(doc_iterator_end(this));
2348 ParConstIterator Buffer::par_iterator_begin() const
2350 return ParConstIterator(doc_iterator_begin(this));
2354 ParConstIterator Buffer::par_iterator_end() const
2356 return ParConstIterator(doc_iterator_end(this));
2360 Language const * Buffer::language() const
2362 return params().language;
2366 docstring const Buffer::B_(string const & l10n) const
2368 return params().B_(l10n);
2372 bool Buffer::isClean() const
2374 return d->lyx_clean;
2378 bool Buffer::isExternallyModified(CheckMethod method) const
2380 LASSERT(d->filename.exists(), /**/);
2381 // if method == timestamp, check timestamp before checksum
2382 return (method == checksum_method
2383 || d->timestamp_ != d->filename.lastModified())
2384 && d->checksum_ != d->filename.checksum();
2388 void Buffer::saveCheckSum() const
2390 FileName const & file = d->filename;
2391 if (file.exists()) {
2392 d->timestamp_ = file.lastModified();
2393 d->checksum_ = file.checksum();
2395 // in the case of save to a new file.
2402 void Buffer::markClean() const
2404 if (!d->lyx_clean) {
2405 d->lyx_clean = true;
2408 // if the .lyx file has been saved, we don't need an
2410 d->bak_clean = true;
2411 d->undo_.markDirty();
2415 void Buffer::setUnnamed(bool flag)
2421 bool Buffer::isUnnamed() const
2428 /// Don't check unnamed, here: isInternal() is used in
2429 /// newBuffer(), where the unnamed flag has not been set by anyone
2430 /// yet. Also, for an internal buffer, there should be no need for
2431 /// retrieving fileName() nor for checking if it is unnamed or not.
2432 bool Buffer::isInternal() const
2434 return fileName().extension() == "internal";
2438 void Buffer::markDirty()
2441 d->lyx_clean = false;
2444 d->bak_clean = false;
2446 DepClean::iterator it = d->dep_clean.begin();
2447 DepClean::const_iterator const end = d->dep_clean.end();
2449 for (; it != end; ++it)
2454 FileName Buffer::fileName() const
2460 string Buffer::absFileName() const
2462 return d->filename.absFileName();
2466 string Buffer::filePath() const
2468 return d->filename.onlyPath().absFileName() + "/";
2472 bool Buffer::isReadonly() const
2474 return d->read_only;
2478 void Buffer::setParent(Buffer const * buffer)
2480 // Avoids recursive include.
2481 d->setParent(buffer == this ? 0 : buffer);
2486 Buffer const * Buffer::parent() const
2492 ListOfBuffers Buffer::allRelatives() const
2494 ListOfBuffers lb = masterBuffer()->getDescendents();
2495 lb.push_front(const_cast<Buffer *>(this));
2500 Buffer const * Buffer::masterBuffer() const
2502 // FIXME Should be make sure we are not in some kind
2503 // of recursive include? A -> B -> A will crash this.
2504 Buffer const * const pbuf = d->parent();
2508 return pbuf->masterBuffer();
2512 bool Buffer::isChild(Buffer * child) const
2514 return d->children_positions.find(child) != d->children_positions.end();
2518 DocIterator Buffer::firstChildPosition(Buffer const * child)
2520 Impl::BufferPositionMap::iterator it;
2521 it = d->children_positions.find(child);
2522 if (it == d->children_positions.end())
2523 return DocIterator(this);
2528 bool Buffer::hasChildren() const
2530 return !d->children_positions.empty();
2534 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2536 // loop over children
2537 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2538 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2539 for (; it != end; ++it) {
2540 Buffer * child = const_cast<Buffer *>(it->first);
2542 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2543 if (bit != clist.end())
2545 clist.push_back(child);
2547 // there might be grandchildren
2548 child->collectChildren(clist, true);
2553 ListOfBuffers Buffer::getChildren() const
2556 collectChildren(v, false);
2561 ListOfBuffers Buffer::getDescendents() const
2564 collectChildren(v, true);
2569 template<typename M>
2570 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2575 typename M::const_iterator it = m.lower_bound(x);
2576 if (it == m.begin())
2584 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2585 DocIterator const & pos) const
2587 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2589 // if paragraphs have no macro context set, pos will be empty
2593 // we haven't found anything yet
2594 DocIterator bestPos = owner_->par_iterator_begin();
2595 MacroData const * bestData = 0;
2597 // find macro definitions for name
2598 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2599 if (nameIt != macros.end()) {
2600 // find last definition in front of pos or at pos itself
2601 PositionScopeMacroMap::const_iterator it
2602 = greatest_below(nameIt->second, pos);
2603 if (it != nameIt->second.end()) {
2605 // scope ends behind pos?
2606 if (pos < it->second.first) {
2607 // Looks good, remember this. If there
2608 // is no external macro behind this,
2609 // we found the right one already.
2610 bestPos = it->first;
2611 bestData = &it->second.second;
2615 // try previous macro if there is one
2616 if (it == nameIt->second.begin())
2623 // find macros in included files
2624 PositionScopeBufferMap::const_iterator it
2625 = greatest_below(position_to_children, pos);
2626 if (it == position_to_children.end())
2627 // no children before
2631 // do we know something better (i.e. later) already?
2632 if (it->first < bestPos )
2635 // scope ends behind pos?
2636 if (pos < it->second.first) {
2637 // look for macro in external file
2639 MacroData const * data
2640 = it->second.second->getMacro(name, false);
2643 bestPos = it->first;
2649 // try previous file if there is one
2650 if (it == position_to_children.begin())
2655 // return the best macro we have found
2660 MacroData const * Buffer::getMacro(docstring const & name,
2661 DocIterator const & pos, bool global) const
2666 // query buffer macros
2667 MacroData const * data = d->getBufferMacro(name, pos);
2671 // If there is a master buffer, query that
2672 Buffer const * const pbuf = d->parent();
2674 d->macro_lock = true;
2675 MacroData const * macro = pbuf->getMacro(
2676 name, *this, false);
2677 d->macro_lock = false;
2683 data = MacroTable::globalMacros().get(name);
2692 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2694 // set scope end behind the last paragraph
2695 DocIterator scope = par_iterator_begin();
2696 scope.pit() = scope.lastpit() + 1;
2698 return getMacro(name, scope, global);
2702 MacroData const * Buffer::getMacro(docstring const & name,
2703 Buffer const & child, bool global) const
2705 // look where the child buffer is included first
2706 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2707 if (it == d->children_positions.end())
2710 // check for macros at the inclusion position
2711 return getMacro(name, it->second, global);
2715 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2717 pit_type const lastpit = it.lastpit();
2719 // look for macros in each paragraph
2720 while (it.pit() <= lastpit) {
2721 Paragraph & par = it.paragraph();
2723 // iterate over the insets of the current paragraph
2724 InsetList const & insets = par.insetList();
2725 InsetList::const_iterator iit = insets.begin();
2726 InsetList::const_iterator end = insets.end();
2727 for (; iit != end; ++iit) {
2728 it.pos() = iit->pos;
2730 // is it a nested text inset?
2731 if (iit->inset->asInsetText()) {
2732 // Inset needs its own scope?
2733 InsetText const * itext = iit->inset->asInsetText();
2734 bool newScope = itext->isMacroScope();
2736 // scope which ends just behind the inset
2737 DocIterator insetScope = it;
2740 // collect macros in inset
2741 it.push_back(CursorSlice(*iit->inset));
2742 updateMacros(it, newScope ? insetScope : scope);
2747 if (iit->inset->asInsetTabular()) {
2748 CursorSlice slice(*iit->inset);
2749 size_t const numcells = slice.nargs();
2750 for (; slice.idx() < numcells; slice.forwardIdx()) {
2751 it.push_back(slice);
2752 updateMacros(it, scope);
2758 // is it an external file?
2759 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2760 // get buffer of external file
2761 InsetInclude const & inset =
2762 static_cast<InsetInclude const &>(*iit->inset);
2764 Buffer * child = inset.getChildBuffer();
2769 // register its position, but only when it is
2770 // included first in the buffer
2771 if (children_positions.find(child) ==
2772 children_positions.end())
2773 children_positions[child] = it;
2775 // register child with its scope
2776 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2780 InsetMath * im = iit->inset->asInsetMath();
2781 if (doing_export && im) {
2782 InsetMathHull * hull = im->asHullInset();
2784 hull->recordLocation(it);
2787 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2791 MathMacroTemplate & macroTemplate =
2792 *iit->inset->asInsetMath()->asMacroTemplate();
2793 MacroContext mc(owner_, it);
2794 macroTemplate.updateToContext(mc);
2797 bool valid = macroTemplate.validMacro();
2798 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2799 // then the BufferView's cursor will be invalid in
2800 // some cases which leads to crashes.
2805 // FIXME (Abdel), I don't understandt why we pass 'it' here
2806 // instead of 'macroTemplate' defined above... is this correct?
2807 macros[macroTemplate.name()][it] =
2808 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2818 void Buffer::updateMacros() const
2823 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2825 // start with empty table
2827 d->children_positions.clear();
2828 d->position_to_children.clear();
2830 // Iterate over buffer, starting with first paragraph
2831 // The scope must be bigger than any lookup DocIterator
2832 // later. For the global lookup, lastpit+1 is used, hence
2833 // we use lastpit+2 here.
2834 DocIterator it = par_iterator_begin();
2835 DocIterator outerScope = it;
2836 outerScope.pit() = outerScope.lastpit() + 2;
2837 d->updateMacros(it, outerScope);
2841 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2843 InsetIterator it = inset_iterator_begin(inset());
2844 InsetIterator const end = inset_iterator_end(inset());
2845 for (; it != end; ++it) {
2846 if (it->lyxCode() == BRANCH_CODE) {
2847 InsetBranch & br = static_cast<InsetBranch &>(*it);
2848 docstring const name = br.branch();
2849 if (!from_master && !params().branchlist().find(name))
2850 result.push_back(name);
2851 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2852 result.push_back(name);
2855 if (it->lyxCode() == INCLUDE_CODE) {
2856 // get buffer of external file
2857 InsetInclude const & ins =
2858 static_cast<InsetInclude const &>(*it);
2859 Buffer * child = ins.getChildBuffer();
2862 child->getUsedBranches(result, true);
2865 // remove duplicates
2870 void Buffer::updateMacroInstances() const
2872 LYXERR(Debug::MACROS, "updateMacroInstances for "
2873 << d->filename.onlyFileName());
2874 DocIterator it = doc_iterator_begin(this);
2876 DocIterator const end = doc_iterator_end(this);
2877 for (; it != end; it.forwardInset()) {
2878 // look for MathData cells in InsetMathNest insets
2879 InsetMath * minset = it.nextInset()->asInsetMath();
2883 // update macro in all cells of the InsetMathNest
2884 DocIterator::idx_type n = minset->nargs();
2885 MacroContext mc = MacroContext(this, it);
2886 for (DocIterator::idx_type i = 0; i < n; ++i) {
2887 MathData & data = minset->cell(i);
2888 data.updateMacros(0, mc);
2894 void Buffer::listMacroNames(MacroNameSet & macros) const
2899 d->macro_lock = true;
2901 // loop over macro names
2902 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2903 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2904 for (; nameIt != nameEnd; ++nameIt)
2905 macros.insert(nameIt->first);
2907 // loop over children
2908 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2909 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2910 for (; it != end; ++it)
2911 it->first->listMacroNames(macros);
2914 Buffer const * const pbuf = d->parent();
2916 pbuf->listMacroNames(macros);
2918 d->macro_lock = false;
2922 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2924 Buffer const * const pbuf = d->parent();
2929 pbuf->listMacroNames(names);
2932 MacroNameSet::iterator it = names.begin();
2933 MacroNameSet::iterator end = names.end();
2934 for (; it != end; ++it) {
2936 MacroData const * data =
2937 pbuf->getMacro(*it, *this, false);
2939 macros.insert(data);
2941 // we cannot access the original MathMacroTemplate anymore
2942 // here to calls validate method. So we do its work here manually.
2943 // FIXME: somehow make the template accessible here.
2944 if (data->optionals() > 0)
2945 features.require("xargs");
2951 Buffer::References & Buffer::references(docstring const & label)
2954 return const_cast<Buffer *>(masterBuffer())->references(label);
2956 RefCache::iterator it = d->ref_cache_.find(label);
2957 if (it != d->ref_cache_.end())
2958 return it->second.second;
2960 static InsetLabel const * dummy_il = 0;
2961 static References const dummy_refs;
2962 it = d->ref_cache_.insert(
2963 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2964 return it->second.second;
2968 Buffer::References const & Buffer::references(docstring const & label) const
2970 return const_cast<Buffer *>(this)->references(label);
2974 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2976 masterBuffer()->d->ref_cache_[label].first = il;
2980 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2982 return masterBuffer()->d->ref_cache_[label].first;
2986 void Buffer::clearReferenceCache() const
2989 d->ref_cache_.clear();
2993 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2996 //FIXME: This does not work for child documents yet.
2997 LASSERT(code == CITE_CODE, /**/);
2998 // Check if the label 'from' appears more than once
2999 vector<docstring> labels;
3001 checkBibInfoCache();
3002 BiblioInfo const & keys = masterBibInfo();
3003 BiblioInfo::const_iterator bit = keys.begin();
3004 BiblioInfo::const_iterator bend = keys.end();
3006 for (; bit != bend; ++bit)
3008 labels.push_back(bit->first);
3011 if (count(labels.begin(), labels.end(), from) > 1)
3014 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3015 if (it->lyxCode() == code) {
3016 InsetCommand * inset = it->asInsetCommand();
3019 docstring const oldValue = inset->getParam(paramName);
3020 if (oldValue == from)
3021 inset->setParam(paramName, to);
3027 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
3028 pit_type par_end, bool full_source) const
3030 OutputParams runparams(¶ms().encoding());
3031 runparams.nice = true;
3032 runparams.flavor = params().useXetex ?
3033 OutputParams::XETEX : OutputParams::LATEX;
3034 runparams.linelen = lyxrc.plaintext_linelen;
3035 // No side effect of file copying and image conversion
3036 runparams.dryrun = true;
3039 os << "% " << _("Preview source code") << "\n\n";
3041 d->texrow.newline();
3042 d->texrow.newline();
3044 writeDocBookSource(os, absFileName(), runparams, false);
3046 // latex or literate
3047 writeLaTeXSource(os, string(), runparams, true, true);
3049 runparams.par_begin = par_begin;
3050 runparams.par_end = par_end;
3051 if (par_begin + 1 == par_end) {
3053 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3057 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3058 convert<docstring>(par_begin),
3059 convert<docstring>(par_end - 1))
3066 // output paragraphs
3068 docbookParagraphs(text(), *this, os, runparams);
3070 // latex or literate
3071 latexParagraphs(*this, text(), os, texrow, runparams);
3076 ErrorList & Buffer::errorList(string const & type) const
3078 static ErrorList emptyErrorList;
3079 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3080 if (it == d->errorLists.end())
3081 return emptyErrorList;
3087 void Buffer::updateTocItem(std::string const & type,
3088 DocIterator const & dit) const
3091 d->gui_->updateTocItem(type, dit);
3095 void Buffer::structureChanged() const
3098 d->gui_->structureChanged();
3102 void Buffer::errors(string const & err, bool from_master) const
3105 d->gui_->errors(err, from_master);
3109 void Buffer::message(docstring const & msg) const
3112 d->gui_->message(msg);
3116 void Buffer::setBusy(bool on) const
3119 d->gui_->setBusy(on);
3123 void Buffer::updateTitles() const
3126 d->wa_->updateTitles();
3130 void Buffer::resetAutosaveTimers() const
3133 d->gui_->resetAutosaveTimers();
3137 bool Buffer::hasGuiDelegate() const
3143 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3152 class AutoSaveBuffer : public ForkedProcess {
3155 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3156 : buffer_(buffer), fname_(fname) {}
3158 virtual shared_ptr<ForkedProcess> clone() const
3160 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3165 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3166 from_utf8(fname_.absFileName())));
3167 return run(DontWait);
3171 virtual int generateChild();
3173 Buffer const & buffer_;
3178 int AutoSaveBuffer::generateChild()
3180 #if defined(__APPLE__)
3181 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3182 * We should use something else like threads.
3184 * Since I do not know how to determine at run time what is the OS X
3185 * version, I just disable forking altogether for now (JMarc)
3187 pid_t const pid = -1;
3189 // tmp_ret will be located (usually) in /tmp
3190 // will that be a problem?
3191 // Note that this calls ForkedCalls::fork(), so it's
3192 // ok cross-platform.
3193 pid_t const pid = fork();
3194 // If you want to debug the autosave
3195 // you should set pid to -1, and comment out the fork.
3196 if (pid != 0 && pid != -1)
3200 // pid = -1 signifies that lyx was unable
3201 // to fork. But we will do the save
3203 bool failed = false;
3204 FileName const tmp_ret = FileName::tempName("lyxauto");
3205 if (!tmp_ret.empty()) {
3206 buffer_.writeFile(tmp_ret);
3207 // assume successful write of tmp_ret
3208 if (!tmp_ret.moveTo(fname_))
3214 // failed to write/rename tmp_ret so try writing direct
3215 if (!buffer_.writeFile(fname_)) {
3216 // It is dangerous to do this in the child,
3217 // but safe in the parent, so...
3218 if (pid == -1) // emit message signal.
3219 buffer_.message(_("Autosave failed!"));
3223 if (pid == 0) // we are the child so...
3232 FileName Buffer::getEmergencyFileName() const
3234 return FileName(d->filename.absFileName() + ".emergency");
3238 FileName Buffer::getAutosaveFileName() const
3240 // if the document is unnamed try to save in the backup dir, else
3241 // in the default document path, and as a last try in the filePath,
3242 // which will most often be the temporary directory
3245 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3246 : lyxrc.backupdir_path;
3247 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3250 string const fname = "#" + d->filename.onlyFileName() + "#";
3252 return makeAbsPath(fname, fpath);
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 bool Buffer::autoSave() const
3276 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3277 if (buf->d->bak_clean || isReadonly())
3280 message(_("Autosaving current document..."));
3281 buf->d->bak_clean = true;
3283 FileName const fname = getAutosaveFileName();
3284 if (d->cloned_buffer_) {
3285 // If this buffer is cloned, we assume that
3286 // we are running in a separate thread already.
3287 FileName const tmp_ret = FileName::tempName("lyxauto");
3288 if (!tmp_ret.empty()) {
3290 // assume successful write of tmp_ret
3291 if (tmp_ret.moveTo(fname))
3294 // failed to write/rename tmp_ret so try writing direct
3295 return writeFile(fname);
3297 /// This function is deprecated as the frontend needs to take care
3298 /// of cloning the buffer and autosaving it in another thread. It
3299 /// is still here to allow (QT_VERSION < 0x040400).
3300 AutoSaveBuffer autosave(*this, fname);
3307 string Buffer::bufferFormat() const
3309 string format = params().documentClass().outputFormat();
3310 if (format == "latex") {
3311 if (params().useXetex)
3313 if (params().encoding().package() == Encoding::japanese)
3320 string Buffer::getDefaultOutputFormat() const
3322 if (!params().defaultOutputFormat.empty()
3323 && params().defaultOutputFormat != "default")
3324 return params().defaultOutputFormat;
3325 typedef vector<Format const *> Formats;
3326 Formats formats = exportableFormats(true);
3329 || params().useXetex
3330 || params().encoding().package() == Encoding::japanese) {
3331 if (formats.empty())
3333 // return the first we find
3334 return formats.front()->name();
3336 return lyxrc.default_view_format;
3341 // helper class, to guarantee this gets reset properly
3342 class MarkAsExporting {
3344 MarkAsExporting(Buffer const * buf) : buf_(buf)
3346 LASSERT(buf_, /* */);
3347 buf_->setExportStatus(true);
3351 buf_->setExportStatus(false);
3354 Buffer const * const buf_;
3359 void Buffer::setExportStatus(bool e) const
3361 d->doing_export = e;
3365 bool Buffer::isExporting() const
3367 return d->doing_export;
3371 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3372 bool includeall, string & result_file) const
3374 MarkAsExporting exporting(this);
3375 string backend_format;
3376 OutputParams runparams(¶ms().encoding());
3377 runparams.flavor = OutputParams::LATEX;
3378 runparams.linelen = lyxrc.plaintext_linelen;
3379 runparams.includeall = includeall;
3380 vector<string> backs = backends();
3381 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3382 // Get shortest path to format
3383 Graph::EdgePath path;
3384 for (vector<string>::const_iterator it = backs.begin();
3385 it != backs.end(); ++it) {
3386 Graph::EdgePath p = theConverters().getPath(*it, format);
3387 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3388 backend_format = *it;
3393 if (!put_in_tempdir) {
3394 // Only show this alert if this is an export to a non-temporary
3395 // file (not for previewing).
3396 Alert::error(_("Couldn't export file"), bformat(
3397 _("No information for exporting the format %1$s."),
3398 formats.prettyName(format)));
3402 runparams.flavor = theConverters().getFlavor(path);
3405 backend_format = format;
3406 // FIXME: Don't hardcode format names here, but use a flag
3407 if (backend_format == "pdflatex")
3408 runparams.flavor = OutputParams::PDFLATEX;
3409 else if (backend_format == "luatex")
3410 runparams.flavor = OutputParams::LUATEX;
3411 else if (backend_format == "xetex")
3412 runparams.flavor = OutputParams::XETEX;
3415 string filename = latexName(false);
3416 filename = addName(temppath(), filename);
3417 filename = changeExtension(filename,
3418 formats.extension(backend_format));
3421 updateMacroInstances();
3423 // Plain text backend
3424 if (backend_format == "text") {
3425 runparams.flavor = OutputParams::TEXT;
3426 writePlaintextFile(*this, FileName(filename), runparams);
3429 else if (backend_format == "xhtml") {
3430 runparams.flavor = OutputParams::HTML;
3431 switch (params().html_math_output) {
3432 case BufferParams::MathML:
3433 runparams.math_flavor = OutputParams::MathAsMathML;
3435 case BufferParams::HTML:
3436 runparams.math_flavor = OutputParams::MathAsHTML;
3438 case BufferParams::Images:
3439 runparams.math_flavor = OutputParams::MathAsImages;
3441 case BufferParams::LaTeX:
3442 runparams.math_flavor = OutputParams::MathAsLaTeX;
3446 makeLyXHTMLFile(FileName(filename), runparams);
3447 } else if (backend_format == "lyx")
3448 writeFile(FileName(filename));
3450 else if (isDocBook()) {
3451 runparams.nice = !put_in_tempdir;
3452 makeDocBookFile(FileName(filename), runparams);
3455 else if (backend_format == format) {
3456 runparams.nice = true;
3457 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3459 } else if (!lyxrc.tex_allows_spaces
3460 && contains(filePath(), ' ')) {
3461 Alert::error(_("File name error"),
3462 _("The directory path to the document cannot contain spaces."));
3465 runparams.nice = false;
3466 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3470 string const error_type = (format == "program")
3471 ? "Build" : bufferFormat();
3472 ErrorList & error_list = d->errorLists[error_type];
3473 string const ext = formats.extension(format);
3474 FileName const tmp_result_file(changeExtension(filename, ext));
3475 bool const success = theConverters().convert(this, FileName(filename),
3476 tmp_result_file, FileName(absFileName()), backend_format, format,
3479 // Emit the signal to show the error list or copy it back to the
3480 // cloned Buffer so that it cab be emitted afterwards.
3481 if (format != backend_format) {
3482 if (d->cloned_buffer_) {
3483 d->cloned_buffer_->d->errorLists[error_type] =
3484 d->errorLists[error_type];
3487 // also to the children, in case of master-buffer-view
3488 ListOfBuffers clist = getDescendents();
3489 ListOfBuffers::const_iterator cit = clist.begin();
3490 ListOfBuffers::const_iterator const cen = clist.end();
3491 for (; cit != cen; ++cit) {
3492 if (d->cloned_buffer_) {
3493 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3494 (*cit)->d->errorLists[error_type];
3496 (*cit)->errors(error_type, true);
3500 if (d->cloned_buffer_) {
3501 // Enable reverse dvi or pdf to work by copying back the texrow
3502 // object to the cloned buffer.
3503 // FIXME: There is a possibility of concurrent access to texrow
3504 // here from the main GUI thread that should be securized.
3505 d->cloned_buffer_->d->texrow = d->texrow;
3506 string const error_type = bufferFormat();
3507 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3513 if (put_in_tempdir) {
3514 result_file = tmp_result_file.absFileName();
3518 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3519 // We need to copy referenced files (e. g. included graphics
3520 // if format == "dvi") to the result dir.
3521 vector<ExportedFile> const files =
3522 runparams.exportdata->externalFiles(format);
3523 string const dest = onlyPath(result_file);
3524 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3525 : force_overwrite == ALL_FILES;
3526 CopyStatus status = use_force ? FORCE : SUCCESS;
3528 vector<ExportedFile>::const_iterator it = files.begin();
3529 vector<ExportedFile>::const_iterator const en = files.end();
3530 for (; it != en && status != CANCEL; ++it) {
3531 string const fmt = formats.getFormatFromFile(it->sourceName);
3532 status = copyFile(fmt, it->sourceName,
3533 makeAbsPath(it->exportName, dest),
3534 it->exportName, status == FORCE);
3537 if (status == CANCEL) {
3538 message(_("Document export cancelled."));
3539 } else if (tmp_result_file.exists()) {
3540 // Finally copy the main file
3541 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3542 : force_overwrite != NO_FILES;
3543 if (status == SUCCESS && use_force)
3545 status = copyFile(format, tmp_result_file,
3546 FileName(result_file), result_file,
3548 message(bformat(_("Document exported as %1$s "
3550 formats.prettyName(format),
3551 makeDisplayPath(result_file)));
3553 // This must be a dummy converter like fax (bug 1888)
3554 message(bformat(_("Document exported as %1$s"),
3555 formats.prettyName(format)));
3562 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3563 bool includeall) const
3566 // (1) export with all included children (omit \includeonly)
3567 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3569 // (2) export with included children only
3570 return doExport(format, put_in_tempdir, false, result_file);
3574 bool Buffer::preview(string const & format, bool includeall) const
3576 MarkAsExporting exporting(this);
3578 // (1) export with all included children (omit \includeonly)
3579 if (includeall && !doExport(format, true, true))
3581 // (2) export with included children only
3582 if (!doExport(format, true, false, result_file))
3584 return formats.view(*this, FileName(result_file), format);
3588 bool Buffer::isExportable(string const & format) const
3590 vector<string> backs = backends();
3591 for (vector<string>::const_iterator it = backs.begin();
3592 it != backs.end(); ++it)
3593 if (theConverters().isReachable(*it, format))
3599 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3601 vector<string> const backs = backends();
3602 vector<Format const *> result =
3603 theConverters().getReachable(backs[0], only_viewable, true);
3604 for (vector<string>::const_iterator it = backs.begin() + 1;
3605 it != backs.end(); ++it) {
3606 vector<Format const *> r =
3607 theConverters().getReachable(*it, only_viewable, false);
3608 result.insert(result.end(), r.begin(), r.end());
3614 vector<string> Buffer::backends() const
3617 v.push_back(bufferFormat());
3618 // FIXME: Don't hardcode format names here, but use a flag
3619 if (v.back() == "latex")
3620 v.push_back("pdflatex");
3621 else if (v.back() == "xetex")
3622 v.push_back("luatex");
3623 v.push_back("xhtml");
3624 v.push_back("text");
3630 Buffer::ReadStatus Buffer::extractFromVC()
3632 bool const found = LyXVC::file_not_found_hook(d->filename);
3634 return ReadFileNotFound;
3635 if (!d->filename.isReadableFile())
3641 Buffer::ReadStatus Buffer::loadEmergency()
3643 FileName const emergencyFile = getEmergencyFileName();
3644 if (!emergencyFile.exists()
3645 || emergencyFile.lastModified() <= d->filename.lastModified())
3646 return ReadFileNotFound;
3648 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3649 docstring const text = bformat(_("An emergency save of the document "
3650 "%1$s exists.\n\nRecover emergency save?"), file);
3652 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3653 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3659 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3660 bool const success = (ret_llf == ReadSuccess);
3663 Alert::warning(_("File is read-only"),
3664 bformat(_("An emergency file is succesfully loaded, "
3665 "but the original file %1$s is marked read-only. "
3666 "Please make sure to save the document as a different "
3667 "file."), from_utf8(d->filename.absFileName())));
3670 str = _("Document was successfully recovered.");
3672 str = _("Document was NOT successfully recovered.");
3673 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3674 makeDisplayPath(emergencyFile.absFileName()));
3676 int const del_emerg =
3677 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3678 _("&Remove"), _("&Keep"));
3679 if (del_emerg == 0) {
3680 emergencyFile.removeFile();
3682 Alert::warning(_("Emergency file deleted"),
3683 _("Do not forget to save your file now!"), true);
3685 return success ? ReadSuccess : ReadEmergencyFailure;
3688 int const del_emerg =
3689 Alert::prompt(_("Delete emergency file?"),
3690 _("Remove emergency file now?"), 1, 1,
3691 _("&Remove"), _("&Keep"));
3693 emergencyFile.removeFile();
3694 return ReadOriginal;
3704 Buffer::ReadStatus Buffer::loadAutosave()
3706 // Now check if autosave file is newer.
3707 FileName const autosaveFile = getAutosaveFileName();
3708 if (!autosaveFile.exists()
3709 || autosaveFile.lastModified() <= d->filename.lastModified())
3710 return ReadFileNotFound;
3712 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3713 docstring const text = bformat(_("The backup of the document %1$s "
3714 "is newer.\n\nLoad the backup instead?"), file);
3715 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3716 _("&Load backup"), _("Load &original"), _("&Cancel"));
3721 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3722 // the file is not saved if we load the autosave file.
3723 if (ret_llf == ReadSuccess) {
3725 Alert::warning(_("File is read-only"),
3726 bformat(_("A backup file is succesfully loaded, "
3727 "but the original file %1$s is marked read-only. "
3728 "Please make sure to save the document as a "
3730 from_utf8(d->filename.absFileName())));
3735 return ReadAutosaveFailure;
3738 // Here we delete the autosave
3739 autosaveFile.removeFile();
3740 return ReadOriginal;
3748 Buffer::ReadStatus Buffer::loadLyXFile()
3750 if (!d->filename.isReadableFile()) {
3751 ReadStatus const ret_rvc = extractFromVC();
3752 if (ret_rvc != ReadSuccess)
3756 ReadStatus const ret_re = loadEmergency();
3757 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3760 ReadStatus const ret_ra = loadAutosave();
3761 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3764 return loadThisLyXFile(d->filename);
3768 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3770 return readFile(fn);
3774 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3776 TeXErrors::Errors::const_iterator cit = terr.begin();
3777 TeXErrors::Errors::const_iterator end = terr.end();
3779 for (; cit != end; ++cit) {
3782 int errorRow = cit->error_in_line;
3783 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3789 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3790 } while (found && id_start == id_end && pos_start == pos_end);
3792 errorList.push_back(ErrorItem(cit->error_desc,
3793 cit->error_text, id_start, pos_start, pos_end));
3798 void Buffer::setBuffersForInsets() const
3800 inset().setBuffer(const_cast<Buffer &>(*this));
3804 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3806 // Use the master text class also for child documents
3807 Buffer const * const master = masterBuffer();
3808 DocumentClass const & textclass = master->params().documentClass();
3810 // do this only if we are the top-level Buffer
3812 checkBibInfoCache();
3814 // keep the buffers to be children in this set. If the call from the
3815 // master comes back we can see which of them were actually seen (i.e.
3816 // via an InsetInclude). The remaining ones in the set need still be updated.
3817 static std::set<Buffer const *> bufToUpdate;
3818 if (scope == UpdateMaster) {
3819 // If this is a child document start with the master
3820 if (master != this) {
3821 bufToUpdate.insert(this);
3822 master->updateBuffer(UpdateMaster, utype);
3823 // Do this here in case the master has no gui associated with it. Then,
3824 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3825 if (!master->d->gui_)
3828 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3829 if (bufToUpdate.find(this) == bufToUpdate.end())
3833 // start over the counters in the master
3834 textclass.counters().reset();
3837 // update will be done below for this buffer
3838 bufToUpdate.erase(this);
3840 // update all caches
3841 clearReferenceCache();
3844 Buffer & cbuf = const_cast<Buffer &>(*this);
3846 LASSERT(!text().paragraphs().empty(), /**/);
3849 ParIterator parit = cbuf.par_iterator_begin();
3850 updateBuffer(parit, utype);
3853 // TocBackend update will be done later.
3856 cbuf.tocBackend().update();
3857 if (scope == UpdateMaster)
3858 cbuf.structureChanged();
3862 static depth_type getDepth(DocIterator const & it)
3864 depth_type depth = 0;
3865 for (size_t i = 0 ; i < it.depth() ; ++i)
3866 if (!it[i].inset().inMathed())
3867 depth += it[i].paragraph().getDepth() + 1;
3868 // remove 1 since the outer inset does not count
3872 static depth_type getItemDepth(ParIterator const & it)
3874 Paragraph const & par = *it;
3875 LabelType const labeltype = par.layout().labeltype;
3877 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3880 // this will hold the lowest depth encountered up to now.
3881 depth_type min_depth = getDepth(it);
3882 ParIterator prev_it = it;
3885 --prev_it.top().pit();
3887 // start of nested inset: go to outer par
3889 if (prev_it.empty()) {
3890 // start of document: nothing to do
3895 // We search for the first paragraph with same label
3896 // that is not more deeply nested.
3897 Paragraph & prev_par = *prev_it;
3898 depth_type const prev_depth = getDepth(prev_it);
3899 if (labeltype == prev_par.layout().labeltype) {
3900 if (prev_depth < min_depth)
3901 return prev_par.itemdepth + 1;
3902 if (prev_depth == min_depth)
3903 return prev_par.itemdepth;
3905 min_depth = min(min_depth, prev_depth);
3906 // small optimization: if we are at depth 0, we won't
3907 // find anything else
3908 if (prev_depth == 0)
3914 static bool needEnumCounterReset(ParIterator const & it)
3916 Paragraph const & par = *it;
3917 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3918 depth_type const cur_depth = par.getDepth();
3919 ParIterator prev_it = it;
3920 while (prev_it.pit()) {
3921 --prev_it.top().pit();
3922 Paragraph const & prev_par = *prev_it;
3923 if (prev_par.getDepth() <= cur_depth)
3924 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3926 // start of nested inset: reset
3931 // set the label of a paragraph. This includes the counters.
3932 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3934 BufferParams const & bp = owner_->masterBuffer()->params();
3935 DocumentClass const & textclass = bp.documentClass();
3936 Paragraph & par = it.paragraph();
3937 Layout const & layout = par.layout();
3938 Counters & counters = textclass.counters();
3940 if (par.params().startOfAppendix()) {
3941 // FIXME: only the counter corresponding to toplevel
3942 // sectioning should be reset
3944 counters.appendix(true);
3946 par.params().appendix(counters.appendix());
3948 // Compute the item depth of the paragraph
3949 par.itemdepth = getItemDepth(it);
3951 if (layout.margintype == MARGIN_MANUAL
3952 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3953 if (par.params().labelWidthString().empty())
3954 par.params().labelWidthString(par.expandLabel(layout, bp));
3956 par.params().labelWidthString(docstring());
3959 switch(layout.labeltype) {
3961 if (layout.toclevel <= bp.secnumdepth
3962 && (layout.latextype != LATEX_ENVIRONMENT
3963 || it.text()->isFirstInSequence(it.pit()))) {
3964 counters.step(layout.counter, utype);
3965 par.params().labelString(
3966 par.expandLabel(layout, bp));
3968 par.params().labelString(docstring());
3971 case LABEL_ITEMIZE: {
3972 // At some point of time we should do something more
3973 // clever here, like:
3974 // par.params().labelString(
3975 // bp.user_defined_bullet(par.itemdepth).getText());
3976 // for now, use a simple hardcoded label
3977 docstring itemlabel;
3978 switch (par.itemdepth) {
3980 itemlabel = char_type(0x2022);
3983 itemlabel = char_type(0x2013);
3986 itemlabel = char_type(0x2217);
3989 itemlabel = char_type(0x2219); // or 0x00b7
3992 par.params().labelString(itemlabel);
3996 case LABEL_ENUMERATE: {
3997 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3999 switch (par.itemdepth) {
4008 enumcounter += "iv";
4011 // not a valid enumdepth...
4015 // Maybe we have to reset the enumeration counter.
4016 if (needEnumCounterReset(it))
4017 counters.reset(enumcounter);
4018 counters.step(enumcounter, utype);
4020 string const & lang = par.getParLanguage(bp)->code();
4021 par.params().labelString(counters.theCounter(enumcounter, lang));
4026 case LABEL_SENSITIVE: {
4027 string const & type = counters.current_float();
4028 docstring full_label;
4030 full_label = owner_->B_("Senseless!!! ");
4032 docstring name = owner_->B_(textclass.floats().getType(type).name());
4033 if (counters.hasCounter(from_utf8(type))) {
4034 string const & lang = par.getParLanguage(bp)->code();
4035 counters.step(from_utf8(type), utype);
4036 full_label = bformat(from_ascii("%1$s %2$s:"),
4038 counters.theCounter(from_utf8(type), lang));
4040 full_label = bformat(from_ascii("%1$s #:"), name);
4042 par.params().labelString(full_label);
4046 case LABEL_NO_LABEL:
4047 par.params().labelString(docstring());
4051 case LABEL_TOP_ENVIRONMENT:
4052 case LABEL_CENTERED_TOP_ENVIRONMENT:
4055 par.params().labelString(par.expandLabel(layout, bp));
4061 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4063 LASSERT(parit.pit() == 0, /**/);
4065 // Set the position of the text in the buffer to be able
4066 // to resolve macros in it.
4067 parit.text()->setMacrocontextPosition(parit);
4069 depth_type maxdepth = 0;
4070 pit_type const lastpit = parit.lastpit();
4071 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4072 // reduce depth if necessary
4073 parit->params().depth(min(parit->params().depth(), maxdepth));
4074 maxdepth = parit->getMaxDepthAfter();
4076 if (utype == OutputUpdate) {
4077 // track the active counters
4078 // we have to do this for the master buffer, since the local
4079 // buffer isn't tracking anything.
4080 masterBuffer()->params().documentClass().counters().
4081 setActiveLayout(parit->layout());
4084 // set the counter for this paragraph
4085 d->setLabel(parit, utype);
4088 InsetList::const_iterator iit = parit->insetList().begin();
4089 InsetList::const_iterator end = parit->insetList().end();
4090 for (; iit != end; ++iit) {
4091 parit.pos() = iit->pos;
4092 iit->inset->updateBuffer(parit, utype);
4098 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4099 WordLangTuple & word_lang, docstring_list & suggestions) const
4103 suggestions.clear();
4104 word_lang = WordLangTuple();
4105 // OK, we start from here.
4106 DocIterator const end = doc_iterator_end(this);
4107 for (; from != end; from.forwardPos()) {
4108 // We are only interested in text so remove the math CursorSlice.
4109 while (from.inMathed()) {
4113 // If from is at the end of the document (which is possible
4114 // when leaving the mathed) LyX will crash later.
4118 from.paragraph().spellCheck();
4119 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4120 if (SpellChecker::misspelled(res)) {
4125 // Do not increase progress when from == to, otherwise the word
4126 // count will be wrong.
4136 Buffer::ReadStatus Buffer::reload()
4139 // c.f. bug http://www.lyx.org/trac/ticket/6587
4140 removeAutosaveFile();
4141 // e.g., read-only status could have changed due to version control
4142 d->filename.refresh();
4143 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4145 ReadStatus const status = loadLyXFile();
4146 if (status == ReadSuccess) {
4151 message(bformat(_("Document %1$s reloaded."), disp_fn));
4153 message(bformat(_("Could not reload document %1$s."), disp_fn));
4163 bool Buffer::saveAs(FileName const & fn)
4165 FileName const old_name = fileName();
4166 FileName const old_auto = getAutosaveFileName();
4167 bool const old_unnamed = isUnnamed();
4174 // bring the autosave file with us, just in case.
4175 moveAutosaveFile(old_auto);
4176 // validate version control data and
4177 // correct buffer title
4178 lyxvc().file_found_hook(fileName());
4180 // the file has now been saved to the new location.
4181 // we need to check that the locations of child buffers
4183 checkChildBuffers();
4187 // reset the old filename and unnamed state
4188 setFileName(old_name);
4189 setUnnamed(old_unnamed);
4195 // FIXME We could do better here, but it is complicated. What would be
4196 // nice is to offer either (a) to save the child buffer to an appropriate
4197 // location, so that it would "move with the master", or else (b) to update
4198 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4199 // complicated, because the code for this lives in GuiView.
4200 void Buffer::checkChildBuffers()
4202 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4203 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4204 for (; it != en; ++it) {
4205 DocIterator dit = it->second;
4206 Buffer * cbuf = const_cast<Buffer *>(it->first);
4207 if (!cbuf || !theBufferList().isLoaded(cbuf))
4209 Inset * inset = dit.nextInset();
4210 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4211 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4212 docstring const & incfile = inset_inc->getParam("filename");
4213 string oldloc = cbuf->absFileName();
4214 string newloc = makeAbsPath(to_utf8(incfile),
4215 onlyPath(absFileName())).absFileName();
4216 if (oldloc == newloc)
4218 // the location of the child file is incorrect.
4219 Alert::warning(_("Included File Invalid"),
4220 bformat(_("Saving this document to a new location has made the file:\n"
4222 "inaccessible. You will need to update the included filename."),
4223 from_utf8(oldloc)));
4225 inset_inc->setChildBuffer(0);
4227 // invalidate cache of children
4228 d->children_positions.clear();
4229 d->position_to_children.clear();