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/InsetText.h"
75 #include "mathed/MacroTable.h"
76 #include "mathed/MathMacroTemplate.h"
77 #include "mathed/MathSupport.h"
79 #include "frontends/alert.h"
80 #include "frontends/Delegates.h"
81 #include "frontends/WorkAreaManager.h"
83 #include "graphics/Previews.h"
85 #include "support/lassert.h"
86 #include "support/convert.h"
87 #include "support/debug.h"
88 #include "support/docstring_list.h"
89 #include "support/ExceptionMessage.h"
90 #include "support/FileName.h"
91 #include "support/FileNameList.h"
92 #include "support/filetools.h"
93 #include "support/ForkedCalls.h"
94 #include "support/gettext.h"
95 #include "support/gzstream.h"
96 #include "support/lstrings.h"
97 #include "support/lyxalgo.h"
98 #include "support/os.h"
99 #include "support/Package.h"
100 #include "support/Path.h"
101 #include "support/Systemcall.h"
102 #include "support/textutils.h"
103 #include "support/types.h"
105 #include "support/bind.h"
106 #include "support/shared_ptr.h"
118 using namespace lyx::support;
122 namespace Alert = frontend::Alert;
123 namespace os = support::os;
127 // Do not remove the comment below, so we get merge conflict in
128 // independent branches. Instead add your own.
129 int const LYX_FORMAT = 395; // uwestoehr: support for ISO C paper size series
131 typedef map<string, bool> DepClean;
132 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
134 void showPrintError(string const & name)
136 docstring str = bformat(_("Could not print the document %1$s.\n"
137 "Check that your printer is set up correctly."),
138 makeDisplayPath(name, 50));
139 Alert::error(_("Print document failed"), str);
144 class BufferSet : public std::set<Buffer const *> {};
149 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
160 /// search for macro in local (buffer) table or in children
161 MacroData const * getBufferMacro(docstring const & name,
162 DocIterator const & pos) const;
164 /// Update macro table starting with position of it \param it in some
166 void updateMacros(DocIterator & it, DocIterator & scope);
168 void setLabel(ParIterator & it, UpdateType utype) const;
170 void collectRelatives(BufferSet & bufs) const;
172 /** If we have branches that use the file suffix
173 feature, return the file name with suffix appended.
175 support::FileName exportFileName() const;
182 mutable TexRow texrow;
184 /// need to regenerate .tex?
188 mutable bool lyx_clean;
190 /// is autosave needed?
191 mutable bool bak_clean;
193 /// is this a unnamed file (New...)?
199 /// name of the file the buffer is associated with.
202 /** Set to true only when the file is fully loaded.
203 * Used to prevent the premature generation of previews
204 * and by the citation inset.
206 bool file_fully_loaded;
209 mutable TocBackend toc_backend;
212 typedef pair<DocIterator, MacroData> ScopeMacro;
213 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
214 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
215 /// map from the macro name to the position map,
216 /// which maps the macro definition position to the scope and the MacroData.
217 NamePositionScopeMacroMap macros;
218 /// This seem to change the way Buffer::getMacro() works
219 mutable bool macro_lock;
221 /// positions of child buffers in the buffer
222 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
223 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
224 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
225 /// position of children buffers in this buffer
226 BufferPositionMap children_positions;
227 /// map from children inclusion positions to their scope and their buffer
228 PositionScopeBufferMap position_to_children;
230 /// Container for all sort of Buffer dependant errors.
231 map<string, ErrorList> errorLists;
233 /// timestamp and checksum used to test if the file has been externally
234 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
236 unsigned long checksum_;
239 frontend::WorkAreaManager * wa_;
241 frontend::GuiBufferDelegate * gui_;
246 /// A cache for the bibfiles (including bibfiles of loaded child
247 /// documents), needed for appropriate update of natbib labels.
248 mutable support::FileNameList bibfiles_cache_;
250 // FIXME The caching mechanism could be improved. At present, we have a
251 // cache for each Buffer, that caches all the bibliography info for that
252 // Buffer. A more efficient solution would be to have a global cache per
253 // file, and then to construct the Buffer's bibinfo from that.
254 /// A cache for bibliography info
255 mutable BiblioInfo bibinfo_;
256 /// whether the bibinfo cache is valid
257 bool bibinfo_cache_valid_;
258 /// Cache of timestamps of .bib files
259 map<FileName, time_t> bibfile_status_;
261 mutable RefCache ref_cache_;
263 /// our Text that should be wrapped in an InsetText
266 /// This is here to force the test to be done whenever parent_buffer
268 Buffer const * parent() const {
269 // if parent_buffer is not loaded, then it has been unloaded,
270 // which means that parent_buffer is an invalid pointer. So we
271 // set it to null in that case.
272 // however, the BufferList doesn't know about cloned buffers, so
273 // they will always be regarded as unloaded. in that case, we hope
275 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
277 return parent_buffer;
280 void setParent(Buffer const * pb) {
282 && parent_buffer && pb && parent_buffer != pb)
283 LYXERR0("Warning: a buffer should not have two parents!");
287 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
288 /// This one is useful for preview detached in a thread.
289 Buffer const * cloned_buffer_;
292 /// So we can force access via the accessors.
293 mutable Buffer const * parent_buffer;
298 /// Creates the per buffer temporary directory
299 static FileName createBufferTmpDir()
302 // We are in our own directory. Why bother to mangle name?
303 // In fact I wrote this code to circumvent a problematic behaviour
304 // (bug?) of EMX mkstemp().
305 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
306 convert<string>(count++));
308 if (!tmpfl.createDirectory(0777)) {
309 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
310 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
311 from_utf8(tmpfl.absFileName())));
317 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
318 Buffer const * cloned_buffer)
319 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
320 read_only(readonly_), filename(file), file_fully_loaded(false),
321 toc_backend(owner), macro_lock(false), timestamp_(0),
322 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
323 cloned_buffer_(cloned_buffer), parent_buffer(0)
325 if (!cloned_buffer_) {
326 temppath = createBufferTmpDir();
327 lyxvc.setBuffer(owner_);
329 wa_ = new frontend::WorkAreaManager;
332 temppath = cloned_buffer_->d->temppath;
333 file_fully_loaded = true;
334 params = cloned_buffer_->d->params;
335 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
336 bibinfo_ = cloned_buffer_->d->bibinfo_;
337 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
338 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
342 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
343 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
345 LYXERR(Debug::INFO, "Buffer::Buffer()");
347 d->inset = new InsetText(*cloned_buffer->d->inset);
348 d->inset->setBuffer(*this);
349 // FIXME: optimize this loop somewhat, maybe by creating a new
350 // general recursive Inset::setId().
351 DocIterator it = doc_iterator_begin(this);
352 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
353 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
354 it.paragraph().setId(cloned_it.paragraph().id());
356 d->inset = new InsetText(this);
357 d->inset->setAutoBreakRows(true);
358 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
364 LYXERR(Debug::INFO, "Buffer::~Buffer()");
365 // here the buffer should take care that it is
366 // saved properly, before it goes into the void.
368 // GuiView already destroyed
372 // No need to do additional cleanups for internal buffer.
377 // loop over children
378 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
379 Impl::BufferPositionMap::iterator end = d->children_positions.end();
380 for (; it != end; ++it) {
381 Buffer * child = const_cast<Buffer *>(it->first);
382 if (d->cloned_buffer_)
384 // The child buffer might have been closed already.
385 else if (theBufferList().isLoaded(child))
386 theBufferList().releaseChild(this, child);
390 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
391 msg += emergencyWrite();
392 Alert::warning(_("Attempting to close changed document!"), msg);
395 // clear references to children in macro tables
396 d->children_positions.clear();
397 d->position_to_children.clear();
399 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
400 Alert::warning(_("Could not remove temporary directory"),
401 bformat(_("Could not remove the temporary directory %1$s"),
402 from_utf8(d->temppath.absFileName())));
405 // Remove any previewed LaTeX snippets associated with this buffer.
406 thePreviews().removeLoader(*this);
412 Buffer * Buffer::clone() const
414 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
415 buffer_clone->d->macro_lock = true;
416 buffer_clone->d->children_positions.clear();
417 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
418 // math macro caches need to be rethought and simplified.
419 // I am not sure wether we should handle Buffer cloning here or in BufferList.
420 // Right now BufferList knows nothing about buffer clones.
421 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
422 Impl::BufferPositionMap::iterator end = d->children_positions.end();
423 for (; it != end; ++it) {
424 DocIterator dit = it->second.clone(buffer_clone);
425 dit.setBuffer(buffer_clone);
426 Buffer * child = const_cast<Buffer *>(it->first);
427 Buffer * child_clone = child->clone();
428 Inset * inset = dit.nextInset();
429 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
430 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
431 inset_inc->setChildBuffer(child_clone);
432 child_clone->d->setParent(buffer_clone);
433 buffer_clone->setChild(dit, child_clone);
435 buffer_clone->d->macro_lock = false;
440 bool Buffer::isClone() const
442 return d->cloned_buffer_;
446 void Buffer::changed(bool update_metrics) const
449 d->wa_->redrawAll(update_metrics);
453 frontend::WorkAreaManager & Buffer::workAreaManager() const
455 LASSERT(d->wa_, /**/);
460 Text & Buffer::text() const
462 return d->inset->text();
466 Inset & Buffer::inset() const
472 BufferParams & Buffer::params()
478 BufferParams const & Buffer::params() const
484 ParagraphList & Buffer::paragraphs()
486 return text().paragraphs();
490 ParagraphList const & Buffer::paragraphs() const
492 return text().paragraphs();
496 LyXVC & Buffer::lyxvc()
502 LyXVC const & Buffer::lyxvc() const
508 string const Buffer::temppath() const
510 return d->temppath.absFileName();
514 TexRow & Buffer::texrow()
520 TexRow const & Buffer::texrow() const
526 TocBackend & Buffer::tocBackend() const
528 return d->toc_backend;
532 Undo & Buffer::undo()
538 void Buffer::setChild(DocIterator const & dit, Buffer * child)
540 d->children_positions[child] = dit;
544 string Buffer::latexName(bool const no_path) const
546 FileName latex_name =
547 makeLatexName(d->exportFileName());
548 return no_path ? latex_name.onlyFileName()
549 : latex_name.absFileName();
553 FileName Buffer::Impl::exportFileName() const
555 docstring const branch_suffix =
556 params.branchlist().getFileNameSuffix();
557 if (branch_suffix.empty())
560 string const name = filename.onlyFileNameWithoutExt()
561 + to_utf8(branch_suffix);
562 FileName res(filename.onlyPath().absFileName() + "/" + name);
563 res.changeExtension(filename.extension());
569 string Buffer::logName(LogType * type) const
571 string const filename = latexName(false);
573 if (filename.empty()) {
579 string const path = temppath();
581 FileName const fname(addName(temppath(),
582 onlyFileName(changeExtension(filename,
585 // FIXME: how do we know this is the name of the build log?
586 FileName const bname(
587 addName(path, onlyFileName(
588 changeExtension(filename,
589 formats.extension(bufferFormat()) + ".out"))));
591 // Also consider the master buffer log file
592 FileName masterfname = fname;
594 if (masterBuffer() != this) {
595 string const mlogfile = masterBuffer()->logName(&mtype);
596 masterfname = FileName(mlogfile);
599 // If no Latex log or Build log is newer, show Build log
600 if (bname.exists() &&
601 ((!fname.exists() && !masterfname.exists())
602 || (fname.lastModified() < bname.lastModified()
603 && masterfname.lastModified() < bname.lastModified()))) {
604 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
607 return bname.absFileName();
608 // If we have a newer master file log or only a master log, show this
609 } else if (fname != masterfname
610 && (!fname.exists() && (masterfname.exists()
611 || fname.lastModified() < masterfname.lastModified()))) {
612 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
615 return masterfname.absFileName();
617 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
620 return fname.absFileName();
624 void Buffer::setReadonly(bool const flag)
626 if (d->read_only != flag) {
633 void Buffer::setFileName(string const & newfile)
635 d->filename = makeAbsPath(newfile);
636 setReadonly(d->filename.isReadOnly());
641 int Buffer::readHeader(Lexer & lex)
643 int unknown_tokens = 0;
645 int begin_header_line = -1;
647 // Initialize parameters that may be/go lacking in header:
648 params().branchlist().clear();
649 params().preamble.erase();
650 params().options.erase();
651 params().master.erase();
652 params().float_placement.erase();
653 params().paperwidth.erase();
654 params().paperheight.erase();
655 params().leftmargin.erase();
656 params().rightmargin.erase();
657 params().topmargin.erase();
658 params().bottommargin.erase();
659 params().headheight.erase();
660 params().headsep.erase();
661 params().footskip.erase();
662 params().columnsep.erase();
663 params().fontsCJK.erase();
664 params().listings_params.clear();
665 params().clearLayoutModules();
666 params().clearRemovedModules();
667 params().clearIncludedChildren();
668 params().pdfoptions().clear();
669 params().indiceslist().clear();
670 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
671 params().isbackgroundcolor = false;
672 params().fontcolor = lyx::rgbFromHexName("#000000");
673 params().isfontcolor = false;
674 params().notefontcolor = lyx::rgbFromHexName("#cccccc");
675 params().boxbgcolor = lyx::rgbFromHexName("#ff0000");
676 params().html_latex_start.clear();
677 params().html_latex_end.clear();
678 params().html_math_img_scale = 1.0;
679 params().output_sync_macro.erase();
681 for (int i = 0; i < 4; ++i) {
682 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
683 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
686 ErrorList & errorList = d->errorLists["Parse"];
695 if (token == "\\end_header")
699 if (token == "\\begin_header") {
700 begin_header_line = line;
704 LYXERR(Debug::PARSER, "Handling document header token: `"
707 string unknown = params().readToken(lex, token, d->filename.onlyPath());
708 if (!unknown.empty()) {
709 if (unknown[0] != '\\' && token == "\\textclass") {
710 Alert::warning(_("Unknown document class"),
711 bformat(_("Using the default document class, because the "
712 "class %1$s is unknown."), from_utf8(unknown)));
715 docstring const s = bformat(_("Unknown token: "
719 errorList.push_back(ErrorItem(_("Document header error"),
724 if (begin_header_line) {
725 docstring const s = _("\\begin_header is missing");
726 errorList.push_back(ErrorItem(_("Document header error"),
730 params().makeDocumentClass();
732 return unknown_tokens;
737 // changed to be public and have one parameter
738 // Returns true if "\end_document" is not read (Asger)
739 bool Buffer::readDocument(Lexer & lex)
741 ErrorList & errorList = d->errorLists["Parse"];
744 if (!lex.checkFor("\\begin_document")) {
745 docstring const s = _("\\begin_document is missing");
746 errorList.push_back(ErrorItem(_("Document header error"),
750 // we are reading in a brand new document
751 LASSERT(paragraphs().empty(), /**/);
755 if (params().outputChanges) {
756 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
757 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
758 LaTeXFeatures::isAvailable("xcolor");
760 if (!dvipost && !xcolorulem) {
761 Alert::warning(_("Changes not shown in LaTeX output"),
762 _("Changes will not be highlighted in LaTeX output, "
763 "because neither dvipost nor xcolor/ulem are installed.\n"
764 "Please install these packages or redefine "
765 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
766 } else if (!xcolorulem) {
767 Alert::warning(_("Changes not shown in LaTeX output"),
768 _("Changes will not be highlighted in LaTeX output "
769 "when using pdflatex, because xcolor and ulem are not installed.\n"
770 "Please install both packages or redefine "
771 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
775 if (!params().master.empty()) {
776 FileName const master_file = makeAbsPath(params().master,
777 onlyPath(absFileName()));
778 if (isLyXFileName(master_file.absFileName())) {
780 checkAndLoadLyXFile(master_file, true);
782 // necessary e.g. after a reload
783 // to re-register the child (bug 5873)
784 // FIXME: clean up updateMacros (here, only
785 // child registering is needed).
786 master->updateMacros();
787 // set master as master buffer, but only
788 // if we are a real child
789 if (master->isChild(this))
791 // if the master is not fully loaded
792 // it is probably just loading this
793 // child. No warning needed then.
794 else if (master->isFullyLoaded())
795 LYXERR0("The master '"
797 << "' assigned to this document ("
799 << ") does not include "
800 "this document. Ignoring the master assignment.");
805 // assure we have a default index
806 params().indiceslist().addDefault(B_("Index"));
809 bool const res = text().read(lex, errorList, d->inset);
813 updateMacroInstances();
818 bool Buffer::readString(string const & s)
820 params().compressed = false;
822 // remove dummy empty par
823 paragraphs().clear();
827 FileName const name = FileName::tempName("Buffer_readString");
828 switch (readFile(lex, name, true)) {
832 // We need to call lyx2lyx, so write the input to a file
833 ofstream os(name.toFilesystemEncoding().c_str());
836 return readFile(name);
846 bool Buffer::readFile(FileName const & filename)
848 FileName fname(filename);
850 params().compressed = fname.isZippedFile();
852 // remove dummy empty par
853 paragraphs().clear();
856 if (readFile(lex, fname) != success)
863 bool Buffer::isFullyLoaded() const
865 return d->file_fully_loaded;
869 void Buffer::setFullyLoaded(bool value)
871 d->file_fully_loaded = value;
875 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
878 LASSERT(!filename.empty(), /**/);
880 // the first (non-comment) token _must_ be...
881 if (!lex.checkFor("\\lyxformat")) {
882 Alert::error(_("Document format failure"),
883 bformat(_("%1$s is not a readable LyX document."),
884 from_utf8(filename.absFileName())));
890 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
891 // if present remove ".," from string.
892 size_t dot = tmp_format.find_first_of(".,");
893 //lyxerr << " dot found at " << dot << endl;
894 if (dot != string::npos)
895 tmp_format.erase(dot, 1);
896 int const file_format = convert<int>(tmp_format);
897 //lyxerr << "format: " << file_format << endl;
899 // save timestamp and checksum of the original disk file, making sure
900 // to not overwrite them with those of the file created in the tempdir
901 // when it has to be converted to the current format.
903 // Save the timestamp and checksum of disk file. If filename is an
904 // emergency file, save the timestamp and checksum of the original lyx file
905 // because isExternallyModified will check for this file. (BUG4193)
906 string diskfile = filename.absFileName();
907 if (suffixIs(diskfile, ".emergency"))
908 diskfile = diskfile.substr(0, diskfile.size() - 10);
909 saveCheckSum(FileName(diskfile));
912 if (file_format != LYX_FORMAT) {
915 // lyx2lyx would fail
918 FileName const tmpfile = FileName::tempName("Buffer_readFile");
919 if (tmpfile.empty()) {
920 Alert::error(_("Conversion failed"),
921 bformat(_("%1$s is from a different"
922 " version of LyX, but a temporary"
923 " file for converting it could"
925 from_utf8(filename.absFileName())));
928 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
929 if (lyx2lyx.empty()) {
930 Alert::error(_("Conversion script not found"),
931 bformat(_("%1$s is from a different"
932 " version of LyX, but the"
933 " conversion script lyx2lyx"
934 " could not be found."),
935 from_utf8(filename.absFileName())));
938 ostringstream command;
939 command << os::python()
940 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
941 << " -t " << convert<string>(LYX_FORMAT)
942 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
943 << ' ' << quoteName(filename.toSafeFilesystemEncoding());
944 string const command_str = command.str();
946 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
948 cmd_ret const ret = runCommand(command_str);
949 if (ret.first != 0) {
950 if (file_format < LYX_FORMAT)
951 Alert::error(_("Conversion script failed"),
952 bformat(_("%1$s is from an older version"
953 " of LyX, but the lyx2lyx script"
954 " failed to convert it."),
955 from_utf8(filename.absFileName())));
957 Alert::error(_("Conversion script failed"),
958 bformat(_("%1$s is from a newer version"
959 " of LyX and cannot be converted by the"
961 from_utf8(filename.absFileName())));
964 bool const ret = readFile(tmpfile);
965 // Do stuff with tmpfile name and buffer name here.
966 return ret ? success : failure;
971 if (readDocument(lex)) {
972 Alert::error(_("Document format failure"),
973 bformat(_("%1$s ended unexpectedly, which means"
974 " that it is probably corrupted."),
975 from_utf8(filename.absFileName())));
979 d->file_fully_loaded = true;
984 // Should probably be moved to somewhere else: BufferView? GuiView?
985 bool Buffer::save() const
987 // ask if the disk file has been externally modified (use checksum method)
988 if (fileName().exists() && isExternallyModified(checksum_method)) {
989 docstring const file = makeDisplayPath(absFileName(), 20);
990 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
991 "you want to overwrite this file?"), file);
992 int const ret = Alert::prompt(_("Overwrite modified file?"),
993 text, 1, 1, _("&Overwrite"), _("&Cancel"));
998 // We don't need autosaves in the immediate future. (Asger)
999 resetAutosaveTimers();
1001 FileName backupName;
1002 bool madeBackup = false;
1004 // make a backup if the file already exists
1005 if (lyxrc.make_backup && fileName().exists()) {
1006 backupName = FileName(absFileName() + '~');
1007 if (!lyxrc.backupdir_path.empty()) {
1008 string const mangledName =
1009 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1010 backupName = FileName(addName(lyxrc.backupdir_path,
1013 // do not copy because of #6587
1014 if (fileName().moveTo(backupName)) {
1017 Alert::error(_("Backup failure"),
1018 bformat(_("Cannot create backup file %1$s.\n"
1019 "Please check whether the directory exists and is writeable."),
1020 from_utf8(backupName.absFileName())));
1021 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1025 if (writeFile(d->filename)) {
1029 // Saving failed, so backup is not backup
1031 backupName.moveTo(d->filename);
1037 bool Buffer::writeFile(FileName const & fname) const
1039 if (d->read_only && fname == d->filename)
1042 bool retval = false;
1044 docstring const str = bformat(_("Saving document %1$s..."),
1045 makeDisplayPath(fname.absFileName()));
1048 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1050 if (params().compressed) {
1051 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1052 retval = ofs && write(ofs);
1054 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1055 retval = ofs && write(ofs);
1059 message(str + _(" could not write file!"));
1064 // removeAutosaveFile();
1066 saveCheckSum(d->filename);
1067 message(str + _(" done."));
1073 docstring Buffer::emergencyWrite()
1075 // No need to save if the buffer has not changed.
1079 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1081 docstring user_message = bformat(
1082 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1084 // We try to save three places:
1085 // 1) Same place as document. Unless it is an unnamed doc.
1087 string s = absFileName();
1090 if (writeFile(FileName(s))) {
1092 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1093 return user_message;
1095 user_message += _(" Save failed! Trying again...\n");
1099 // 2) In HOME directory.
1100 string s = addName(package().home_dir().absFileName(), absFileName());
1102 lyxerr << ' ' << s << endl;
1103 if (writeFile(FileName(s))) {
1105 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1106 return user_message;
1109 user_message += _(" Save failed! Trying yet again...\n");
1111 // 3) In "/tmp" directory.
1112 // MakeAbsPath to prepend the current
1113 // drive letter on OS/2
1114 s = addName(package().temp_dir().absFileName(), absFileName());
1116 lyxerr << ' ' << s << endl;
1117 if (writeFile(FileName(s))) {
1119 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1120 return user_message;
1123 user_message += _(" Save failed! Bummer. Document is lost.");
1126 return user_message;
1130 bool Buffer::write(ostream & ofs) const
1133 // Use the standard "C" locale for file output.
1134 ofs.imbue(locale::classic());
1137 // The top of the file should not be written by params().
1139 // write out a comment in the top of the file
1140 ofs << "#LyX " << lyx_version
1141 << " created this file. For more info see http://www.lyx.org/\n"
1142 << "\\lyxformat " << LYX_FORMAT << "\n"
1143 << "\\begin_document\n";
1145 /// For each author, set 'used' to true if there is a change
1146 /// by this author in the document; otherwise set it to 'false'.
1147 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1148 AuthorList::Authors::const_iterator a_end = params().authors().end();
1149 for (; a_it != a_end; ++a_it)
1150 a_it->setUsed(false);
1152 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1153 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1154 for ( ; it != end; ++it)
1155 it->checkAuthors(params().authors());
1157 // now write out the buffer parameters.
1158 ofs << "\\begin_header\n";
1159 params().writeFile(ofs);
1160 ofs << "\\end_header\n";
1163 ofs << "\n\\begin_body\n";
1165 ofs << "\n\\end_body\n";
1167 // Write marker that shows file is complete
1168 ofs << "\\end_document" << endl;
1170 // Shouldn't really be needed....
1173 // how to check if close went ok?
1174 // Following is an attempt... (BE 20001011)
1176 // good() returns false if any error occured, including some
1177 // formatting error.
1178 // bad() returns true if something bad happened in the buffer,
1179 // which should include file system full errors.
1184 lyxerr << "File was not closed properly." << endl;
1191 bool Buffer::makeLaTeXFile(FileName const & fname,
1192 string const & original_path,
1193 OutputParams const & runparams_in,
1194 bool output_preamble, bool output_body) const
1196 OutputParams runparams = runparams_in;
1197 if (params().useXetex)
1198 runparams.flavor = OutputParams::XETEX;
1200 string const encoding = runparams.encoding->iconvName();
1201 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1204 try { ofs.reset(encoding); }
1205 catch (iconv_codecvt_facet_exception & e) {
1206 lyxerr << "Caught iconv exception: " << e.what() << endl;
1207 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1208 "verify that the support software for your encoding (%1$s) is "
1209 "properly installed"), from_ascii(encoding)));
1212 if (!openFileWrite(ofs, fname))
1215 //TexStream ts(ofs.rdbuf(), &texrow());
1216 ErrorList & errorList = d->errorLists["Export"];
1218 bool failed_export = false;
1221 writeLaTeXSource(ofs, original_path,
1222 runparams, output_preamble, output_body);
1224 catch (EncodingException & e) {
1225 odocstringstream ods;
1226 ods.put(e.failed_char);
1228 oss << "0x" << hex << e.failed_char << dec;
1229 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1230 " (code point %2$s)"),
1231 ods.str(), from_utf8(oss.str()));
1232 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1233 "representable in the chosen encoding.\n"
1234 "Changing the document encoding to utf8 could help."),
1235 e.par_id, e.pos, e.pos + 1));
1236 failed_export = true;
1238 catch (iconv_codecvt_facet_exception & e) {
1239 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1240 _(e.what()), -1, 0, 0));
1241 failed_export = true;
1243 catch (exception const & e) {
1244 errorList.push_back(ErrorItem(_("conversion failed"),
1245 _(e.what()), -1, 0, 0));
1246 failed_export = true;
1249 lyxerr << "Caught some really weird exception..." << endl;
1255 failed_export = true;
1256 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1260 return !failed_export;
1264 void Buffer::writeLaTeXSource(odocstream & os,
1265 string const & original_path,
1266 OutputParams const & runparams_in,
1267 bool const output_preamble, bool const output_body) const
1269 // The child documents, if any, shall be already loaded at this point.
1271 OutputParams runparams = runparams_in;
1273 // Classify the unicode characters appearing in math insets
1274 Encodings::initUnicodeMath(*this);
1276 // validate the buffer.
1277 LYXERR(Debug::LATEX, " Validating buffer...");
1278 LaTeXFeatures features(*this, params(), runparams);
1280 LYXERR(Debug::LATEX, " Buffer validation done.");
1282 // The starting paragraph of the coming rows is the
1283 // first paragraph of the document. (Asger)
1284 if (output_preamble && runparams.nice) {
1285 os << "%% LyX " << lyx_version << " created this file. "
1286 "For more info, see http://www.lyx.org/.\n"
1287 "%% Do not edit unless you really know what "
1289 d->texrow.newline();
1290 d->texrow.newline();
1292 LYXERR(Debug::INFO, "lyx document header finished");
1294 // Don't move this behind the parent_buffer=0 code below,
1295 // because then the macros will not get the right "redefinition"
1296 // flag as they don't see the parent macros which are output before.
1299 // fold macros if possible, still with parent buffer as the
1300 // macros will be put in the prefix anyway.
1301 updateMacroInstances();
1303 // There are a few differences between nice LaTeX and usual files:
1304 // usual is \batchmode and has a
1305 // special input@path to allow the including of figures
1306 // with either \input or \includegraphics (what figinsets do).
1307 // input@path is set when the actual parameter
1308 // original_path is set. This is done for usual tex-file, but not
1309 // for nice-latex-file. (Matthias 250696)
1310 // Note that input@path is only needed for something the user does
1311 // in the preamble, included .tex files or ERT, files included by
1312 // LyX work without it.
1313 if (output_preamble) {
1314 if (!runparams.nice) {
1315 // code for usual, NOT nice-latex-file
1316 os << "\\batchmode\n"; // changed
1317 // from \nonstopmode
1318 d->texrow.newline();
1320 if (!original_path.empty()) {
1322 // We don't know the encoding of inputpath
1323 docstring const inputpath = from_utf8(support::latex_path(original_path));
1324 docstring uncodable_glyphs;
1325 Encoding const * const enc = runparams.encoding;
1327 for (size_t n = 0; n < inputpath.size(); ++n) {
1328 docstring const glyph =
1329 docstring(1, inputpath[n]);
1330 if (enc->latexChar(inputpath[n], true) != glyph) {
1331 LYXERR0("Uncodable character '"
1333 << "' in input path!");
1334 uncodable_glyphs += glyph;
1339 // warn user if we found uncodable glyphs.
1340 if (!uncodable_glyphs.empty()) {
1341 frontend::Alert::warning(_("Uncodable character in file path"),
1342 support::bformat(_("The path of your document\n"
1344 "contains glyphs that are unknown in the\n"
1345 "current document encoding (namely %2$s).\n"
1346 "This will likely result in incomplete output.\n\n"
1347 "Choose an appropriate document encoding (such as utf8)\n"
1348 "or change the file path name."), inputpath, uncodable_glyphs));
1350 os << "\\makeatletter\n"
1351 << "\\def\\input@path{{"
1352 << inputpath << "/}}\n"
1353 << "\\makeatother\n";
1354 d->texrow.newline();
1355 d->texrow.newline();
1356 d->texrow.newline();
1360 // get parent macros (if this buffer has a parent) which will be
1361 // written at the document begin further down.
1362 MacroSet parentMacros;
1363 listParentMacros(parentMacros, features);
1365 // Write the preamble
1366 runparams.use_babel = params().writeLaTeX(os, features,
1368 d->filename.onlyPath());
1370 runparams.use_japanese = features.isRequired("japanese");
1376 os << "\\begin{document}\n";
1377 d->texrow.newline();
1379 // output the parent macros
1380 MacroSet::iterator it = parentMacros.begin();
1381 MacroSet::iterator end = parentMacros.end();
1382 for (; it != end; ++it) {
1383 int num_lines = (*it)->write(os, true);
1384 d->texrow.newlines(num_lines);
1387 } // output_preamble
1389 d->texrow.start(paragraphs().begin()->id(), 0);
1391 LYXERR(Debug::INFO, "preamble finished, now the body.");
1393 // if we are doing a real file with body, even if this is the
1394 // child of some other buffer, let's cut the link here.
1395 // This happens for example if only a child document is printed.
1396 Buffer const * save_parent = 0;
1397 if (output_preamble) {
1398 save_parent = d->parent();
1403 latexParagraphs(*this, text(), os, d->texrow, runparams);
1405 // Restore the parenthood if needed
1406 if (output_preamble)
1407 d->setParent(save_parent);
1409 // add this just in case after all the paragraphs
1411 d->texrow.newline();
1413 if (output_preamble) {
1414 os << "\\end{document}\n";
1415 d->texrow.newline();
1416 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1418 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1420 runparams_in.encoding = runparams.encoding;
1422 // Just to be sure. (Asger)
1423 d->texrow.newline();
1425 //for (int i = 0; i<d->texrow.rows(); i++) {
1427 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1428 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1431 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1432 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1436 bool Buffer::isLatex() const
1438 return params().documentClass().outputType() == LATEX;
1442 bool Buffer::isLiterate() const
1444 return params().documentClass().outputType() == LITERATE;
1448 bool Buffer::isDocBook() const
1450 return params().documentClass().outputType() == DOCBOOK;
1454 void Buffer::makeDocBookFile(FileName const & fname,
1455 OutputParams const & runparams,
1456 bool const body_only) const
1458 LYXERR(Debug::LATEX, "makeDocBookFile...");
1461 if (!openFileWrite(ofs, fname))
1464 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1468 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1472 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1473 OutputParams const & runparams,
1474 bool const only_body) const
1476 LaTeXFeatures features(*this, params(), runparams);
1481 DocumentClass const & tclass = params().documentClass();
1482 string const top_element = tclass.latexname();
1485 if (runparams.flavor == OutputParams::XML)
1486 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1489 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1492 if (! tclass.class_header().empty())
1493 os << from_ascii(tclass.class_header());
1494 else if (runparams.flavor == OutputParams::XML)
1495 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1496 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1498 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1500 docstring preamble = from_utf8(params().preamble);
1501 if (runparams.flavor != OutputParams::XML ) {
1502 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1503 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1504 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1505 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1508 string const name = runparams.nice
1509 ? changeExtension(absFileName(), ".sgml") : fname;
1510 preamble += features.getIncludedFiles(name);
1511 preamble += features.getLyXSGMLEntities();
1513 if (!preamble.empty()) {
1514 os << "\n [ " << preamble << " ]";
1519 string top = top_element;
1521 if (runparams.flavor == OutputParams::XML)
1522 top += params().language->code();
1524 top += params().language->code().substr(0, 2);
1527 if (!params().options.empty()) {
1529 top += params().options;
1532 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1533 << " file was created by LyX " << lyx_version
1534 << "\n See http://www.lyx.org/ for more information -->\n";
1536 params().documentClass().counters().reset();
1540 sgml::openTag(os, top);
1542 docbookParagraphs(text(), *this, os, runparams);
1543 sgml::closeTag(os, top_element);
1547 void Buffer::makeLyXHTMLFile(FileName const & fname,
1548 OutputParams const & runparams,
1549 bool const body_only) const
1551 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1554 if (!openFileWrite(ofs, fname))
1557 writeLyXHTMLSource(ofs, runparams, body_only);
1561 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1565 void Buffer::writeLyXHTMLSource(odocstream & os,
1566 OutputParams const & runparams,
1567 bool const only_body) const
1569 LaTeXFeatures features(*this, params(), runparams);
1571 updateBuffer(UpdateMaster, OutputUpdate);
1572 checkBibInfoCache();
1573 d->bibinfo_.makeCitationLabels(*this);
1575 updateMacroInstances();
1578 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1579 << "<!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"
1580 // FIXME Language should be set properly.
1581 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1583 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1584 // FIXME Presumably need to set this right
1585 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1587 docstring const & doctitle = features.htmlTitle();
1589 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1592 os << "\n<!-- Text Class Preamble -->\n"
1593 << features.getTClassHTMLPreamble()
1594 << "\n<!-- Premable Snippets -->\n"
1595 << from_utf8(features.getPreambleSnippets());
1597 os << "\n<!-- Layout-provided Styles -->\n";
1598 docstring const styleinfo = features.getTClassHTMLStyles();
1599 if (!styleinfo.empty()) {
1600 os << "<style type='text/css'>\n"
1604 os << "</head>\n<body>\n";
1608 params().documentClass().counters().reset();
1609 xhtmlParagraphs(text(), *this, xs, runparams);
1611 os << "</body>\n</html>\n";
1615 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1616 // Other flags: -wall -v0 -x
1617 int Buffer::runChktex()
1621 // get LaTeX-Filename
1622 FileName const path(temppath());
1623 string const name = addName(path.absFileName(), latexName());
1624 string const org_path = filePath();
1626 PathChanger p(path); // path to LaTeX file
1627 message(_("Running chktex..."));
1629 // Generate the LaTeX file if neccessary
1630 OutputParams runparams(¶ms().encoding());
1631 runparams.flavor = OutputParams::LATEX;
1632 runparams.nice = false;
1633 runparams.linelen = lyxrc.plaintext_linelen;
1634 makeLaTeXFile(FileName(name), org_path, runparams);
1637 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1638 int const res = chktex.run(terr); // run chktex
1641 Alert::error(_("chktex failure"),
1642 _("Could not run chktex successfully."));
1643 } else if (res > 0) {
1644 ErrorList & errlist = d->errorLists["ChkTeX"];
1646 bufferErrors(terr, errlist);
1657 void Buffer::validate(LaTeXFeatures & features) const
1659 params().validate(features);
1663 for_each(paragraphs().begin(), paragraphs().end(),
1664 bind(&Paragraph::validate, _1, ref(features)));
1666 if (lyxerr.debugging(Debug::LATEX)) {
1667 features.showStruct();
1672 void Buffer::getLabelList(vector<docstring> & list) const
1674 // If this is a child document, use the parent's list instead.
1675 Buffer const * const pbuf = d->parent();
1677 pbuf->getLabelList(list);
1682 Toc & toc = d->toc_backend.toc("label");
1683 TocIterator toc_it = toc.begin();
1684 TocIterator end = toc.end();
1685 for (; toc_it != end; ++toc_it) {
1686 if (toc_it->depth() == 0)
1687 list.push_back(toc_it->str());
1692 void Buffer::updateBibfilesCache(UpdateScope scope) const
1694 // If this is a child document, use the parent's cache instead.
1695 Buffer const * const pbuf = d->parent();
1696 if (pbuf && scope != UpdateChildOnly) {
1697 pbuf->updateBibfilesCache();
1701 d->bibfiles_cache_.clear();
1702 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1703 if (it->lyxCode() == BIBTEX_CODE) {
1704 InsetBibtex const & inset =
1705 static_cast<InsetBibtex const &>(*it);
1706 support::FileNameList const bibfiles = inset.getBibFiles();
1707 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1710 } else if (it->lyxCode() == INCLUDE_CODE) {
1711 InsetInclude & inset =
1712 static_cast<InsetInclude &>(*it);
1713 inset.updateBibfilesCache();
1714 support::FileNameList const & bibfiles =
1715 inset.getBibfilesCache();
1716 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1721 // the bibinfo cache is now invalid
1722 d->bibinfo_cache_valid_ = false;
1726 void Buffer::invalidateBibinfoCache()
1728 d->bibinfo_cache_valid_ = false;
1732 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1734 // If this is a child document, use the parent's cache instead.
1735 Buffer const * const pbuf = d->parent();
1736 if (pbuf && scope != UpdateChildOnly)
1737 return pbuf->getBibfilesCache();
1739 // We update the cache when first used instead of at loading time.
1740 if (d->bibfiles_cache_.empty())
1741 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1743 return d->bibfiles_cache_;
1747 BiblioInfo const & Buffer::masterBibInfo() const
1749 // if this is a child document and the parent is already loaded
1750 // use the parent's list instead [ale990412]
1751 Buffer const * const tmp = masterBuffer();
1754 return tmp->masterBibInfo();
1755 return localBibInfo();
1759 BiblioInfo const & Buffer::localBibInfo() const
1765 void Buffer::checkBibInfoCache() const
1767 support::FileNameList const & bibfilesCache = getBibfilesCache();
1768 // compare the cached timestamps with the actual ones.
1769 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1770 support::FileNameList::const_iterator en = bibfilesCache.end();
1771 for (; ei != en; ++ ei) {
1772 time_t lastw = ei->lastModified();
1773 time_t prevw = d->bibfile_status_[*ei];
1774 if (lastw != prevw) {
1775 d->bibinfo_cache_valid_ = false;
1776 d->bibfile_status_[*ei] = lastw;
1780 if (!d->bibinfo_cache_valid_) {
1781 d->bibinfo_.clear();
1782 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1783 it->fillWithBibKeys(d->bibinfo_, it);
1784 d->bibinfo_cache_valid_ = true;
1789 bool Buffer::isDepClean(string const & name) const
1791 DepClean::const_iterator const it = d->dep_clean.find(name);
1792 if (it == d->dep_clean.end())
1798 void Buffer::markDepClean(string const & name)
1800 d->dep_clean[name] = true;
1804 bool Buffer::isExportableFormat(string const & format) const
1806 typedef vector<Format const *> Formats;
1808 formats = exportableFormats(true);
1809 Formats::const_iterator fit = formats.begin();
1810 Formats::const_iterator end = formats.end();
1811 for (; fit != end ; ++fit) {
1812 if ((*fit)->name() == format)
1819 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1822 // FIXME? if there is an Buffer LFUN that can be dispatched even
1823 // if internal, put a switch '(cmd.action)' here.
1829 switch (cmd.action()) {
1831 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1832 flag.setOnOff(isReadonly());
1835 // FIXME: There is need for a command-line import.
1836 //case LFUN_BUFFER_IMPORT:
1838 case LFUN_BUFFER_AUTO_SAVE:
1841 case LFUN_BUFFER_EXPORT_CUSTOM:
1842 // FIXME: Nothing to check here?
1845 case LFUN_BUFFER_EXPORT: {
1846 docstring const arg = cmd.argument();
1847 enable = arg == "custom" || isExportable(to_utf8(arg));
1849 flag.message(bformat(
1850 _("Don't know how to export to format: %1$s"), arg));
1854 case LFUN_BUFFER_CHKTEX:
1855 enable = isLatex() && !lyxrc.chktex_command.empty();
1858 case LFUN_BUILD_PROGRAM:
1859 enable = isExportable("program");
1862 case LFUN_BRANCH_ACTIVATE:
1863 case LFUN_BRANCH_DEACTIVATE: {
1864 BranchList const & branchList = params().branchlist();
1865 docstring const branchName = cmd.argument();
1866 enable = !branchName.empty() && branchList.find(branchName);
1870 case LFUN_BRANCH_ADD:
1871 case LFUN_BRANCHES_RENAME:
1872 case LFUN_BUFFER_PRINT:
1873 // if no Buffer is present, then of course we won't be called!
1876 case LFUN_BUFFER_LANGUAGE:
1877 enable = !isReadonly();
1883 flag.setEnabled(enable);
1888 void Buffer::dispatch(string const & command, DispatchResult & result)
1890 return dispatch(lyxaction.lookupFunc(command), result);
1894 // NOTE We can end up here even if we have no GUI, because we are called
1895 // by LyX::exec to handled command-line requests. So we may need to check
1896 // whether we have a GUI or not. The boolean use_gui holds this information.
1897 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1900 // FIXME? if there is an Buffer LFUN that can be dispatched even
1901 // if internal, put a switch '(cmd.action())' here.
1902 dr.dispatched(false);
1905 string const argument = to_utf8(func.argument());
1906 // We'll set this back to false if need be.
1907 bool dispatched = true;
1908 undo().beginUndoGroup();
1910 switch (func.action()) {
1911 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1912 if (lyxvc().inUse())
1913 lyxvc().toggleReadOnly();
1915 setReadonly(!isReadonly());
1918 case LFUN_BUFFER_EXPORT: {
1919 bool success = doExport(argument, false, false);
1920 dr.setError(!success);
1922 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1927 case LFUN_BUILD_PROGRAM:
1928 doExport("program", true, false);
1931 case LFUN_BUFFER_CHKTEX:
1935 case LFUN_BUFFER_EXPORT_CUSTOM: {
1937 string command = split(argument, format_name, ' ');
1938 Format const * format = formats.getFormat(format_name);
1940 lyxerr << "Format \"" << format_name
1941 << "\" not recognized!"
1946 // The name of the file created by the conversion process
1949 // Output to filename
1950 if (format->name() == "lyx") {
1951 string const latexname = latexName(false);
1952 filename = changeExtension(latexname,
1953 format->extension());
1954 filename = addName(temppath(), filename);
1956 if (!writeFile(FileName(filename)))
1960 doExport(format_name, true, false, filename);
1963 // Substitute $$FName for filename
1964 if (!contains(command, "$$FName"))
1965 command = "( " + command + " ) < $$FName";
1966 command = subst(command, "$$FName", filename);
1968 // Execute the command in the background
1970 call.startscript(Systemcall::DontWait, command);
1974 // FIXME: There is need for a command-line import.
1976 case LFUN_BUFFER_IMPORT:
1981 case LFUN_BUFFER_AUTO_SAVE:
1985 case LFUN_BRANCH_ADD: {
1986 docstring branch_name = func.argument();
1987 if (branch_name.empty()) {
1991 BranchList & branch_list = params().branchlist();
1992 vector<docstring> const branches =
1993 getVectorFromString(branch_name, branch_list.separator());
1995 for (vector<docstring>::const_iterator it = branches.begin();
1996 it != branches.end(); ++it) {
1998 Branch * branch = branch_list.find(branch_name);
2000 LYXERR0("Branch " << branch_name << " already exists.");
2004 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2006 branch_list.add(branch_name);
2007 branch = branch_list.find(branch_name);
2008 string const x11hexname = X11hexname(branch->color());
2009 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2010 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2012 dr.update(Update::Force);
2020 case LFUN_BRANCH_ACTIVATE:
2021 case LFUN_BRANCH_DEACTIVATE: {
2022 BranchList & branchList = params().branchlist();
2023 docstring const branchName = func.argument();
2024 // the case without a branch name is handled elsewhere
2025 if (branchName.empty()) {
2029 Branch * branch = branchList.find(branchName);
2031 LYXERR0("Branch " << branchName << " does not exist.");
2033 docstring const msg =
2034 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2037 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2039 dr.update(Update::Force);
2040 dr.forceBufferUpdate();
2045 case LFUN_BRANCHES_RENAME: {
2046 if (func.argument().empty())
2049 docstring const oldname = from_utf8(func.getArg(0));
2050 docstring const newname = from_utf8(func.getArg(1));
2051 InsetIterator it = inset_iterator_begin(inset());
2052 InsetIterator const end = inset_iterator_end(inset());
2053 bool success = false;
2054 for (; it != end; ++it) {
2055 if (it->lyxCode() == BRANCH_CODE) {
2056 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2057 if (ins.branch() == oldname) {
2058 undo().recordUndo(it);
2059 ins.rename(newname);
2064 if (it->lyxCode() == INCLUDE_CODE) {
2065 // get buffer of external file
2066 InsetInclude const & ins =
2067 static_cast<InsetInclude const &>(*it);
2068 Buffer * child = ins.getChildBuffer();
2071 child->dispatch(func, dr);
2076 dr.update(Update::Force);
2077 dr.forceBufferUpdate();
2082 case LFUN_BUFFER_PRINT: {
2083 // we'll assume there's a problem until we succeed
2085 string target = func.getArg(0);
2086 string target_name = func.getArg(1);
2087 string command = func.getArg(2);
2090 || target_name.empty()
2091 || command.empty()) {
2092 LYXERR0("Unable to parse " << func.argument());
2093 docstring const msg =
2094 bformat(_("Unable to parse \"%1$s\""), func.argument());
2098 if (target != "printer" && target != "file") {
2099 LYXERR0("Unrecognized target \"" << target << '"');
2100 docstring const msg =
2101 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2106 bool const update_unincluded =
2107 params().maintain_unincluded_children
2108 && !params().getIncludedChildren().empty();
2109 if (!doExport("dvi", true, update_unincluded)) {
2110 showPrintError(absFileName());
2111 dr.setMessage(_("Error exporting to DVI."));
2115 // Push directory path.
2116 string const path = temppath();
2117 // Prevent the compiler from optimizing away p
2121 // there are three cases here:
2122 // 1. we print to a file
2123 // 2. we print directly to a printer
2124 // 3. we print using a spool command (print to file first)
2127 string const dviname = changeExtension(latexName(true), "dvi");
2129 if (target == "printer") {
2130 if (!lyxrc.print_spool_command.empty()) {
2131 // case 3: print using a spool
2132 string const psname = changeExtension(dviname,".ps");
2133 command += ' ' + lyxrc.print_to_file
2136 + quoteName(dviname);
2138 string command2 = lyxrc.print_spool_command + ' ';
2139 if (target_name != "default") {
2140 command2 += lyxrc.print_spool_printerprefix
2144 command2 += quoteName(psname);
2146 // If successful, then spool command
2147 res = one.startscript(Systemcall::Wait, command);
2150 // If there's no GUI, we have to wait on this command. Otherwise,
2151 // LyX deletes the temporary directory, and with it the spooled
2152 // file, before it can be printed!!
2153 Systemcall::Starttype stype = use_gui ?
2154 Systemcall::DontWait : Systemcall::Wait;
2155 res = one.startscript(stype, command2);
2158 // case 2: print directly to a printer
2159 if (target_name != "default")
2160 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2162 Systemcall::Starttype stype = use_gui ?
2163 Systemcall::DontWait : Systemcall::Wait;
2164 res = one.startscript(stype, command + quoteName(dviname));
2168 // case 1: print to a file
2169 FileName const filename(makeAbsPath(target_name, filePath()));
2170 FileName const dvifile(makeAbsPath(dviname, path));
2171 if (filename.exists()) {
2172 docstring text = bformat(
2173 _("The file %1$s already exists.\n\n"
2174 "Do you want to overwrite that file?"),
2175 makeDisplayPath(filename.absFileName()));
2176 if (Alert::prompt(_("Overwrite file?"),
2177 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2180 command += ' ' + lyxrc.print_to_file
2181 + quoteName(filename.toFilesystemEncoding())
2183 + quoteName(dvifile.toFilesystemEncoding());
2185 Systemcall::Starttype stype = use_gui ?
2186 Systemcall::DontWait : Systemcall::Wait;
2187 res = one.startscript(stype, command);
2193 dr.setMessage(_("Error running external commands."));
2194 showPrintError(absFileName());
2199 case LFUN_BUFFER_LANGUAGE: {
2200 Language const * oldL = params().language;
2201 Language const * newL = languages.getLanguage(argument);
2202 if (!newL || oldL == newL)
2204 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual()) {
2205 changeLanguage(oldL, newL);
2206 dr.forceBufferUpdate();
2215 dr.dispatched(dispatched);
2216 undo().endUndoGroup();
2220 void Buffer::changeLanguage(Language const * from, Language const * to)
2222 LASSERT(from, /**/);
2225 for_each(par_iterator_begin(),
2227 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2231 bool Buffer::isMultiLingual() const
2233 ParConstIterator end = par_iterator_end();
2234 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2235 if (it->isMultiLingual(params()))
2242 std::set<Language const *> Buffer::getLanguages() const
2244 std::set<Language const *> languages;
2245 getLanguages(languages);
2250 void Buffer::getLanguages(std::set<Language const *> & languages) const
2252 ParConstIterator end = par_iterator_end();
2253 // add the buffer language, even if it's not actively used
2254 languages.insert(language());
2255 // iterate over the paragraphs
2256 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2257 it->getLanguages(languages);
2259 std::vector<Buffer *> clist = getChildren();
2260 for (vector<Buffer *>::const_iterator cit = clist.begin();
2261 cit != clist.end(); ++cit)
2262 (*cit)->getLanguages(languages);
2266 DocIterator Buffer::getParFromID(int const id) const
2268 Buffer * buf = const_cast<Buffer *>(this);
2270 // John says this is called with id == -1 from undo
2271 lyxerr << "getParFromID(), id: " << id << endl;
2272 return doc_iterator_end(buf);
2275 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2276 if (it.paragraph().id() == id)
2279 return doc_iterator_end(buf);
2283 bool Buffer::hasParWithID(int const id) const
2285 return !getParFromID(id).atEnd();
2289 ParIterator Buffer::par_iterator_begin()
2291 return ParIterator(doc_iterator_begin(this));
2295 ParIterator Buffer::par_iterator_end()
2297 return ParIterator(doc_iterator_end(this));
2301 ParConstIterator Buffer::par_iterator_begin() const
2303 return ParConstIterator(doc_iterator_begin(this));
2307 ParConstIterator Buffer::par_iterator_end() const
2309 return ParConstIterator(doc_iterator_end(this));
2313 Language const * Buffer::language() const
2315 return params().language;
2319 docstring const Buffer::B_(string const & l10n) const
2321 return params().B_(l10n);
2325 bool Buffer::isClean() const
2327 return d->lyx_clean;
2331 bool Buffer::isExternallyModified(CheckMethod method) const
2333 LASSERT(d->filename.exists(), /**/);
2334 // if method == timestamp, check timestamp before checksum
2335 return (method == checksum_method
2336 || d->timestamp_ != d->filename.lastModified())
2337 && d->checksum_ != d->filename.checksum();
2341 void Buffer::saveCheckSum(FileName const & file) const
2343 if (file.exists()) {
2344 d->timestamp_ = file.lastModified();
2345 d->checksum_ = file.checksum();
2347 // in the case of save to a new file.
2354 void Buffer::markClean() const
2356 if (!d->lyx_clean) {
2357 d->lyx_clean = true;
2360 // if the .lyx file has been saved, we don't need an
2362 d->bak_clean = true;
2366 void Buffer::setUnnamed(bool flag)
2372 bool Buffer::isUnnamed() const
2379 /// Don't check unnamed, here: isInternal() is used in
2380 /// newBuffer(), where the unnamed flag has not been set by anyone
2381 /// yet. Also, for an internal buffer, there should be no need for
2382 /// retrieving fileName() nor for checking if it is unnamed or not.
2383 bool Buffer::isInternal() const
2385 return fileName().extension() == "internal";
2389 void Buffer::markDirty()
2392 d->lyx_clean = false;
2395 d->bak_clean = false;
2397 DepClean::iterator it = d->dep_clean.begin();
2398 DepClean::const_iterator const end = d->dep_clean.end();
2400 for (; it != end; ++it)
2405 FileName Buffer::fileName() const
2411 string Buffer::absFileName() const
2413 return d->filename.absFileName();
2417 string Buffer::filePath() const
2419 return d->filename.onlyPath().absFileName() + "/";
2423 bool Buffer::isReadonly() const
2425 return d->read_only;
2429 void Buffer::setParent(Buffer const * buffer)
2431 // Avoids recursive include.
2432 d->setParent(buffer == this ? 0 : buffer);
2437 Buffer const * Buffer::parent() const
2443 void Buffer::Impl::collectRelatives(BufferSet & bufs) const
2445 bufs.insert(owner_);
2447 parent()->d->collectRelatives(bufs);
2449 // loop over children
2450 BufferPositionMap::const_iterator it = children_positions.begin();
2451 BufferPositionMap::const_iterator end = children_positions.end();
2452 for (; it != end; ++it)
2453 bufs.insert(const_cast<Buffer *>(it->first));
2457 std::vector<Buffer const *> Buffer::allRelatives() const
2460 d->collectRelatives(bufs);
2461 BufferSet::iterator it = bufs.begin();
2462 std::vector<Buffer const *> ret;
2463 for (; it != bufs.end(); ++it)
2469 Buffer const * Buffer::masterBuffer() const
2471 Buffer const * const pbuf = d->parent();
2475 return pbuf->masterBuffer();
2479 bool Buffer::isChild(Buffer * child) const
2481 return d->children_positions.find(child) != d->children_positions.end();
2485 DocIterator Buffer::firstChildPosition(Buffer const * child)
2487 Impl::BufferPositionMap::iterator it;
2488 it = d->children_positions.find(child);
2489 if (it == d->children_positions.end())
2490 return DocIterator(this);
2495 void Buffer::getChildren(std::vector<Buffer *> & clist, bool grand_children) const
2497 // loop over children
2498 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2499 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2500 for (; it != end; ++it) {
2501 Buffer * child = const_cast<Buffer *>(it->first);
2502 clist.push_back(child);
2503 if (grand_children) {
2504 // there might be grandchildren
2505 vector<Buffer *> glist = child->getChildren();
2506 clist.insert(clist.end(), glist.begin(), glist.end());
2512 vector<Buffer *> Buffer::getChildren(bool grand_children) const
2515 getChildren(v, grand_children);
2520 template<typename M>
2521 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2526 typename M::const_iterator it = m.lower_bound(x);
2527 if (it == m.begin())
2535 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2536 DocIterator const & pos) const
2538 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2540 // if paragraphs have no macro context set, pos will be empty
2544 // we haven't found anything yet
2545 DocIterator bestPos = owner_->par_iterator_begin();
2546 MacroData const * bestData = 0;
2548 // find macro definitions for name
2549 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2550 if (nameIt != macros.end()) {
2551 // find last definition in front of pos or at pos itself
2552 PositionScopeMacroMap::const_iterator it
2553 = greatest_below(nameIt->second, pos);
2554 if (it != nameIt->second.end()) {
2556 // scope ends behind pos?
2557 if (pos < it->second.first) {
2558 // Looks good, remember this. If there
2559 // is no external macro behind this,
2560 // we found the right one already.
2561 bestPos = it->first;
2562 bestData = &it->second.second;
2566 // try previous macro if there is one
2567 if (it == nameIt->second.begin())
2574 // find macros in included files
2575 PositionScopeBufferMap::const_iterator it
2576 = greatest_below(position_to_children, pos);
2577 if (it == position_to_children.end())
2578 // no children before
2582 // do we know something better (i.e. later) already?
2583 if (it->first < bestPos )
2586 // scope ends behind pos?
2587 if (pos < it->second.first) {
2588 // look for macro in external file
2590 MacroData const * data
2591 = it->second.second->getMacro(name, false);
2594 bestPos = it->first;
2600 // try previous file if there is one
2601 if (it == position_to_children.begin())
2606 // return the best macro we have found
2611 MacroData const * Buffer::getMacro(docstring const & name,
2612 DocIterator const & pos, bool global) const
2617 // query buffer macros
2618 MacroData const * data = d->getBufferMacro(name, pos);
2622 // If there is a master buffer, query that
2623 Buffer const * const pbuf = d->parent();
2625 d->macro_lock = true;
2626 MacroData const * macro = pbuf->getMacro(
2627 name, *this, false);
2628 d->macro_lock = false;
2634 data = MacroTable::globalMacros().get(name);
2643 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2645 // set scope end behind the last paragraph
2646 DocIterator scope = par_iterator_begin();
2647 scope.pit() = scope.lastpit() + 1;
2649 return getMacro(name, scope, global);
2653 MacroData const * Buffer::getMacro(docstring const & name,
2654 Buffer const & child, bool global) const
2656 // look where the child buffer is included first
2657 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2658 if (it == d->children_positions.end())
2661 // check for macros at the inclusion position
2662 return getMacro(name, it->second, global);
2666 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2668 pit_type const lastpit = it.lastpit();
2670 // look for macros in each paragraph
2671 while (it.pit() <= lastpit) {
2672 Paragraph & par = it.paragraph();
2674 // iterate over the insets of the current paragraph
2675 InsetList const & insets = par.insetList();
2676 InsetList::const_iterator iit = insets.begin();
2677 InsetList::const_iterator end = insets.end();
2678 for (; iit != end; ++iit) {
2679 it.pos() = iit->pos;
2681 // is it a nested text inset?
2682 if (iit->inset->asInsetText()) {
2683 // Inset needs its own scope?
2684 InsetText const * itext = iit->inset->asInsetText();
2685 bool newScope = itext->isMacroScope();
2687 // scope which ends just behind the inset
2688 DocIterator insetScope = it;
2691 // collect macros in inset
2692 it.push_back(CursorSlice(*iit->inset));
2693 updateMacros(it, newScope ? insetScope : scope);
2698 // is it an external file?
2699 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2700 // get buffer of external file
2701 InsetInclude const & inset =
2702 static_cast<InsetInclude const &>(*iit->inset);
2704 Buffer * child = inset.getChildBuffer();
2709 // register its position, but only when it is
2710 // included first in the buffer
2711 if (children_positions.find(child) ==
2712 children_positions.end())
2713 children_positions[child] = it;
2715 // register child with its scope
2716 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2720 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2724 MathMacroTemplate & macroTemplate =
2725 static_cast<MathMacroTemplate &>(*iit->inset);
2726 MacroContext mc(owner_, it);
2727 macroTemplate.updateToContext(mc);
2730 bool valid = macroTemplate.validMacro();
2731 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2732 // then the BufferView's cursor will be invalid in
2733 // some cases which leads to crashes.
2738 // FIXME (Abdel), I don't understandt why we pass 'it' here
2739 // instead of 'macroTemplate' defined above... is this correct?
2740 macros[macroTemplate.name()][it] =
2741 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2751 void Buffer::updateMacros() const
2756 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2758 // start with empty table
2760 d->children_positions.clear();
2761 d->position_to_children.clear();
2763 // Iterate over buffer, starting with first paragraph
2764 // The scope must be bigger than any lookup DocIterator
2765 // later. For the global lookup, lastpit+1 is used, hence
2766 // we use lastpit+2 here.
2767 DocIterator it = par_iterator_begin();
2768 DocIterator outerScope = it;
2769 outerScope.pit() = outerScope.lastpit() + 2;
2770 d->updateMacros(it, outerScope);
2774 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2776 InsetIterator it = inset_iterator_begin(inset());
2777 InsetIterator const end = inset_iterator_end(inset());
2778 for (; it != end; ++it) {
2779 if (it->lyxCode() == BRANCH_CODE) {
2780 InsetBranch & br = static_cast<InsetBranch &>(*it);
2781 docstring const name = br.branch();
2782 if (!from_master && !params().branchlist().find(name))
2783 result.push_back(name);
2784 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2785 result.push_back(name);
2788 if (it->lyxCode() == INCLUDE_CODE) {
2789 // get buffer of external file
2790 InsetInclude const & ins =
2791 static_cast<InsetInclude const &>(*it);
2792 Buffer * child = ins.getChildBuffer();
2795 child->getUsedBranches(result, true);
2798 // remove duplicates
2803 void Buffer::updateMacroInstances() const
2805 LYXERR(Debug::MACROS, "updateMacroInstances for "
2806 << d->filename.onlyFileName());
2807 DocIterator it = doc_iterator_begin(this);
2809 DocIterator const end = doc_iterator_end(this);
2810 for (; it != end; it.forwardInset()) {
2811 // look for MathData cells in InsetMathNest insets
2812 InsetMath * minset = it.nextInset()->asInsetMath();
2816 // update macro in all cells of the InsetMathNest
2817 DocIterator::idx_type n = minset->nargs();
2818 MacroContext mc = MacroContext(this, it);
2819 for (DocIterator::idx_type i = 0; i < n; ++i) {
2820 MathData & data = minset->cell(i);
2821 data.updateMacros(0, mc);
2827 void Buffer::listMacroNames(MacroNameSet & macros) const
2832 d->macro_lock = true;
2834 // loop over macro names
2835 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2836 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2837 for (; nameIt != nameEnd; ++nameIt)
2838 macros.insert(nameIt->first);
2840 // loop over children
2841 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2842 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2843 for (; it != end; ++it)
2844 it->first->listMacroNames(macros);
2847 Buffer const * const pbuf = d->parent();
2849 pbuf->listMacroNames(macros);
2851 d->macro_lock = false;
2855 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2857 Buffer const * const pbuf = d->parent();
2862 pbuf->listMacroNames(names);
2865 MacroNameSet::iterator it = names.begin();
2866 MacroNameSet::iterator end = names.end();
2867 for (; it != end; ++it) {
2869 MacroData const * data =
2870 pbuf->getMacro(*it, *this, false);
2872 macros.insert(data);
2874 // we cannot access the original MathMacroTemplate anymore
2875 // here to calls validate method. So we do its work here manually.
2876 // FIXME: somehow make the template accessible here.
2877 if (data->optionals() > 0)
2878 features.require("xargs");
2884 Buffer::References & Buffer::references(docstring const & label)
2887 return const_cast<Buffer *>(masterBuffer())->references(label);
2889 RefCache::iterator it = d->ref_cache_.find(label);
2890 if (it != d->ref_cache_.end())
2891 return it->second.second;
2893 static InsetLabel const * dummy_il = 0;
2894 static References const dummy_refs;
2895 it = d->ref_cache_.insert(
2896 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2897 return it->second.second;
2901 Buffer::References const & Buffer::references(docstring const & label) const
2903 return const_cast<Buffer *>(this)->references(label);
2907 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2909 masterBuffer()->d->ref_cache_[label].first = il;
2913 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2915 return masterBuffer()->d->ref_cache_[label].first;
2919 void Buffer::clearReferenceCache() const
2922 d->ref_cache_.clear();
2926 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2929 //FIXME: This does not work for child documents yet.
2930 LASSERT(code == CITE_CODE, /**/);
2931 // Check if the label 'from' appears more than once
2932 vector<docstring> labels;
2934 checkBibInfoCache();
2935 BiblioInfo const & keys = masterBibInfo();
2936 BiblioInfo::const_iterator bit = keys.begin();
2937 BiblioInfo::const_iterator bend = keys.end();
2939 for (; bit != bend; ++bit)
2941 labels.push_back(bit->first);
2944 if (count(labels.begin(), labels.end(), from) > 1)
2947 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2948 if (it->lyxCode() == code) {
2949 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2950 docstring const oldValue = inset.getParam(paramName);
2951 if (oldValue == from)
2952 inset.setParam(paramName, to);
2958 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2959 pit_type par_end, bool full_source) const
2961 OutputParams runparams(¶ms().encoding());
2962 runparams.nice = true;
2963 runparams.flavor = params().useXetex ?
2964 OutputParams::XETEX : OutputParams::LATEX;
2965 runparams.linelen = lyxrc.plaintext_linelen;
2966 // No side effect of file copying and image conversion
2967 runparams.dryrun = true;
2970 os << "% " << _("Preview source code") << "\n\n";
2972 d->texrow.newline();
2973 d->texrow.newline();
2975 writeDocBookSource(os, absFileName(), runparams, false);
2977 // latex or literate
2978 writeLaTeXSource(os, string(), runparams, true, true);
2980 runparams.par_begin = par_begin;
2981 runparams.par_end = par_end;
2982 if (par_begin + 1 == par_end) {
2984 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2988 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2989 convert<docstring>(par_begin),
2990 convert<docstring>(par_end - 1))
2997 // output paragraphs
2999 docbookParagraphs(text(), *this, os, runparams);
3001 // latex or literate
3002 latexParagraphs(*this, text(), os, texrow, runparams);
3007 ErrorList & Buffer::errorList(string const & type) const
3009 static ErrorList emptyErrorList;
3010 map<string, ErrorList>::iterator it = d->errorLists.find(type);
3011 if (it == d->errorLists.end())
3012 return emptyErrorList;
3018 void Buffer::updateTocItem(std::string const & type,
3019 DocIterator const & dit) const
3022 d->gui_->updateTocItem(type, dit);
3026 void Buffer::structureChanged() const
3029 d->gui_->structureChanged();
3033 void Buffer::errors(string const & err, bool from_master) const
3036 d->gui_->errors(err, from_master);
3040 void Buffer::message(docstring const & msg) const
3043 d->gui_->message(msg);
3047 void Buffer::setBusy(bool on) const
3050 d->gui_->setBusy(on);
3054 void Buffer::updateTitles() const
3057 d->wa_->updateTitles();
3061 void Buffer::resetAutosaveTimers() const
3064 d->gui_->resetAutosaveTimers();
3068 bool Buffer::hasGuiDelegate() const
3074 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3083 class AutoSaveBuffer : public ForkedProcess {
3086 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3087 : buffer_(buffer), fname_(fname) {}
3089 virtual shared_ptr<ForkedProcess> clone() const
3091 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3096 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3097 from_utf8(fname_.absFileName())));
3098 return run(DontWait);
3102 virtual int generateChild();
3104 Buffer const & buffer_;
3109 int AutoSaveBuffer::generateChild()
3111 #if defined(__APPLE__)
3112 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3113 * We should use something else like threads.
3115 * Since I do not know how to determine at run time what is the OS X
3116 * version, I just disable forking altogether for now (JMarc)
3118 pid_t const pid = -1;
3120 // tmp_ret will be located (usually) in /tmp
3121 // will that be a problem?
3122 // Note that this calls ForkedCalls::fork(), so it's
3123 // ok cross-platform.
3124 pid_t const pid = fork();
3125 // If you want to debug the autosave
3126 // you should set pid to -1, and comment out the fork.
3127 if (pid != 0 && pid != -1)
3131 // pid = -1 signifies that lyx was unable
3132 // to fork. But we will do the save
3134 bool failed = false;
3135 FileName const tmp_ret = FileName::tempName("lyxauto");
3136 if (!tmp_ret.empty()) {
3137 buffer_.writeFile(tmp_ret);
3138 // assume successful write of tmp_ret
3139 if (!tmp_ret.moveTo(fname_))
3145 // failed to write/rename tmp_ret so try writing direct
3146 if (!buffer_.writeFile(fname_)) {
3147 // It is dangerous to do this in the child,
3148 // but safe in the parent, so...
3149 if (pid == -1) // emit message signal.
3150 buffer_.message(_("Autosave failed!"));
3154 if (pid == 0) // we are the child so...
3163 FileName Buffer::getAutosaveFileName() const
3165 // if the document is unnamed try to save in the backup dir, else
3166 // in the default document path, and as a last try in the filePath,
3167 // which will most often be the temporary directory
3170 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3171 : lyxrc.backupdir_path;
3172 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3175 string const fname = "#" + d->filename.onlyFileName() + "#";
3176 return makeAbsPath(fname, fpath);
3180 void Buffer::removeAutosaveFile() const
3182 FileName const f = getAutosaveFileName();
3188 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3190 FileName const newauto = getAutosaveFileName();
3192 if (newauto != oldauto && oldauto.exists())
3193 if (!oldauto.moveTo(newauto))
3194 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3198 // Perfect target for a thread...
3199 void Buffer::autoSave() const
3201 if (d->bak_clean || isReadonly()) {
3202 // We don't save now, but we'll try again later
3203 resetAutosaveTimers();
3207 // emit message signal.
3208 message(_("Autosaving current document..."));
3209 AutoSaveBuffer autosave(*this, getAutosaveFileName());
3212 d->bak_clean = true;
3214 resetAutosaveTimers();
3218 string Buffer::bufferFormat() const
3220 string format = params().documentClass().outputFormat();
3221 if (format == "latex") {
3222 if (params().useXetex)
3224 if (params().encoding().package() == Encoding::japanese)
3231 string Buffer::getDefaultOutputFormat() const
3233 if (!params().defaultOutputFormat.empty()
3234 && params().defaultOutputFormat != "default")
3235 return params().defaultOutputFormat;
3236 typedef vector<Format const *> Formats;
3237 Formats formats = exportableFormats(true);
3240 || params().useXetex
3241 || params().encoding().package() == Encoding::japanese) {
3242 if (formats.empty())
3244 // return the first we find
3245 return formats.front()->name();
3247 return lyxrc.default_view_format;
3252 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3253 bool includeall, string & result_file) const
3255 string backend_format;
3256 OutputParams runparams(¶ms().encoding());
3257 runparams.flavor = OutputParams::LATEX;
3258 runparams.linelen = lyxrc.plaintext_linelen;
3259 runparams.includeall = includeall;
3260 vector<string> backs = backends();
3261 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3262 // Get shortest path to format
3263 Graph::EdgePath path;
3264 for (vector<string>::const_iterator it = backs.begin();
3265 it != backs.end(); ++it) {
3266 Graph::EdgePath p = theConverters().getPath(*it, format);
3267 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3268 backend_format = *it;
3273 if (!put_in_tempdir) {
3274 // Only show this alert if this is an export to a non-temporary
3275 // file (not for previewing).
3276 Alert::error(_("Couldn't export file"), bformat(
3277 _("No information for exporting the format %1$s."),
3278 formats.prettyName(format)));
3282 runparams.flavor = theConverters().getFlavor(path);
3285 backend_format = format;
3286 // FIXME: Don't hardcode format names here, but use a flag
3287 if (backend_format == "pdflatex")
3288 runparams.flavor = OutputParams::PDFLATEX;
3291 string filename = latexName(false);
3292 filename = addName(temppath(), filename);
3293 filename = changeExtension(filename,
3294 formats.extension(backend_format));
3297 updateMacroInstances();
3299 // Plain text backend
3300 if (backend_format == "text") {
3301 runparams.flavor = OutputParams::TEXT;
3302 writePlaintextFile(*this, FileName(filename), runparams);
3305 else if (backend_format == "xhtml") {
3306 runparams.flavor = OutputParams::HTML;
3307 switch (params().html_math_output) {
3308 case BufferParams::MathML:
3309 runparams.math_flavor = OutputParams::MathAsMathML;
3311 case BufferParams::HTML:
3312 runparams.math_flavor = OutputParams::MathAsHTML;
3314 case BufferParams::Images:
3315 runparams.math_flavor = OutputParams::MathAsImages;
3317 case BufferParams::LaTeX:
3318 runparams.math_flavor = OutputParams::MathAsLaTeX;
3322 makeLyXHTMLFile(FileName(filename), runparams);
3323 } else if (backend_format == "lyx")
3324 writeFile(FileName(filename));
3326 else if (isDocBook()) {
3327 runparams.nice = !put_in_tempdir;
3328 makeDocBookFile(FileName(filename), runparams);
3331 else if (backend_format == format) {
3332 runparams.nice = true;
3333 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3335 } else if (!lyxrc.tex_allows_spaces
3336 && contains(filePath(), ' ')) {
3337 Alert::error(_("File name error"),
3338 _("The directory path to the document cannot contain spaces."));
3341 runparams.nice = false;
3342 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3346 string const error_type = (format == "program")
3347 ? "Build" : bufferFormat();
3348 ErrorList & error_list = d->errorLists[error_type];
3349 string const ext = formats.extension(format);
3350 FileName const tmp_result_file(changeExtension(filename, ext));
3351 bool const success = theConverters().convert(this, FileName(filename),
3352 tmp_result_file, FileName(absFileName()), backend_format, format,
3355 // Emit the signal to show the error list or copy it back to the
3356 // cloned Buffer so that it cab be emitted afterwards.
3357 if (format != backend_format) {
3358 if (d->cloned_buffer_) {
3359 d->cloned_buffer_->d->errorLists[error_type] =
3360 d->errorLists[error_type];
3363 // also to the children, in case of master-buffer-view
3364 std::vector<Buffer *> clist = getChildren();
3365 for (vector<Buffer *>::const_iterator cit = clist.begin();
3366 cit != clist.end(); ++cit) {
3367 if (d->cloned_buffer_) {
3368 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3369 (*cit)->d->errorLists[error_type];
3371 (*cit)->errors(error_type, true);
3375 if (d->cloned_buffer_) {
3376 // Enable reverse dvi or pdf to work by copying back the texrow
3377 // object to the cloned buffer.
3378 // FIXME: There is a possibility of concurrent access to texrow
3379 // here from the main GUI thread that should be securized.
3380 d->cloned_buffer_->d->texrow = d->texrow;
3381 string const error_type = bufferFormat();
3382 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3388 if (put_in_tempdir) {
3389 result_file = tmp_result_file.absFileName();
3393 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3394 // We need to copy referenced files (e. g. included graphics
3395 // if format == "dvi") to the result dir.
3396 vector<ExportedFile> const files =
3397 runparams.exportdata->externalFiles(format);
3398 string const dest = onlyPath(result_file);
3399 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3400 : force_overwrite == ALL_FILES;
3401 CopyStatus status = use_force ? FORCE : SUCCESS;
3403 vector<ExportedFile>::const_iterator it = files.begin();
3404 vector<ExportedFile>::const_iterator const en = files.end();
3405 for (; it != en && status != CANCEL; ++it) {
3406 string const fmt = formats.getFormatFromFile(it->sourceName);
3407 status = copyFile(fmt, it->sourceName,
3408 makeAbsPath(it->exportName, dest),
3409 it->exportName, status == FORCE);
3412 if (status == CANCEL) {
3413 message(_("Document export cancelled."));
3414 } else if (tmp_result_file.exists()) {
3415 // Finally copy the main file
3416 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3417 : force_overwrite != NO_FILES;
3418 if (status == SUCCESS && use_force)
3420 status = copyFile(format, tmp_result_file,
3421 FileName(result_file), result_file,
3423 message(bformat(_("Document exported as %1$s "
3425 formats.prettyName(format),
3426 makeDisplayPath(result_file)));
3428 // This must be a dummy converter like fax (bug 1888)
3429 message(bformat(_("Document exported as %1$s"),
3430 formats.prettyName(format)));
3437 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3438 bool includeall) const
3441 // (1) export with all included children (omit \includeonly)
3442 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3444 // (2) export with included children only
3445 return doExport(format, put_in_tempdir, false, result_file);
3449 bool Buffer::preview(string const & format, bool includeall) const
3452 // (1) export with all included children (omit \includeonly)
3453 if (includeall && !doExport(format, true, true))
3455 // (2) export with included children only
3456 if (!doExport(format, true, false, result_file))
3458 return formats.view(*this, FileName(result_file), format);
3462 bool Buffer::isExportable(string const & format) const
3464 vector<string> backs = backends();
3465 for (vector<string>::const_iterator it = backs.begin();
3466 it != backs.end(); ++it)
3467 if (theConverters().isReachable(*it, format))
3473 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3475 vector<string> const backs = backends();
3476 vector<Format const *> result =
3477 theConverters().getReachable(backs[0], only_viewable, true);
3478 for (vector<string>::const_iterator it = backs.begin() + 1;
3479 it != backs.end(); ++it) {
3480 vector<Format const *> r =
3481 theConverters().getReachable(*it, only_viewable, false);
3482 result.insert(result.end(), r.begin(), r.end());
3488 vector<string> Buffer::backends() const
3491 v.push_back(bufferFormat());
3492 // FIXME: Don't hardcode format names here, but use a flag
3493 if (v.back() == "latex")
3494 v.push_back("pdflatex");
3495 v.push_back("xhtml");
3496 v.push_back("text");
3502 bool Buffer::readFileHelper(FileName const & s)
3504 // File information about normal file
3506 docstring const file = makeDisplayPath(s.absFileName(), 50);
3507 docstring text = bformat(_("The specified document\n%1$s"
3508 "\ncould not be read."), file);
3509 Alert::error(_("Could not read document"), text);
3513 // Check if emergency save file exists and is newer.
3514 FileName const e(s.absFileName() + ".emergency");
3516 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3517 docstring const file = makeDisplayPath(s.absFileName(), 20);
3518 docstring const text =
3519 bformat(_("An emergency save of the document "
3521 "Recover emergency save?"), file);
3522 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3523 _("&Recover"), _("&Load Original"),
3527 // the file is not saved if we load the emergency file.
3532 if ((res = readFile(e)) == success)
3533 str = _("Document was successfully recovered.");
3535 str = _("Document was NOT successfully recovered.");
3536 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3537 makeDisplayPath(e.absFileName()));
3539 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3540 _("&Remove"), _("&Keep it"))) {
3543 Alert::warning(_("Emergency file deleted"),
3544 _("Do not forget to save your file now!"), true);
3549 if (!Alert::prompt(_("Delete emergency file?"),
3550 _("Remove emergency file now?"), 1, 1,
3551 _("&Remove"), _("&Keep it")))
3559 // Now check if autosave file is newer.
3560 FileName const a(onlyPath(s.absFileName()) + '#' + onlyFileName(s.absFileName()) + '#');
3562 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3563 docstring const file = makeDisplayPath(s.absFileName(), 20);
3564 docstring const text =
3565 bformat(_("The backup of the document "
3566 "%1$s is newer.\n\nLoad the "
3567 "backup instead?"), file);
3568 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3569 _("&Load backup"), _("Load &original"),
3573 // the file is not saved if we load the autosave file.
3577 // Here we delete the autosave
3588 bool Buffer::loadLyXFile(FileName const & s)
3590 // If the file is not readable, we try to
3591 // retrieve the file from version control.
3592 if (!s.isReadableFile()
3593 && !LyXVC::file_not_found_hook(s))
3596 if (s.isReadableFile()){
3597 // InsetInfo needs to know if file is under VCS
3598 lyxvc().file_found_hook(s);
3599 if (readFileHelper(s)) {
3600 d->read_only = !s.isWritable();
3608 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3610 TeXErrors::Errors::const_iterator cit = terr.begin();
3611 TeXErrors::Errors::const_iterator end = terr.end();
3613 for (; cit != end; ++cit) {
3616 int errorRow = cit->error_in_line;
3617 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3623 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3624 } while (found && id_start == id_end && pos_start == pos_end);
3626 errorList.push_back(ErrorItem(cit->error_desc,
3627 cit->error_text, id_start, pos_start, pos_end));
3632 void Buffer::setBuffersForInsets() const
3634 inset().setBuffer(const_cast<Buffer &>(*this));
3638 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3640 // Use the master text class also for child documents
3641 Buffer const * const master = masterBuffer();
3642 DocumentClass const & textclass = master->params().documentClass();
3644 // do this only if we are the top-level Buffer
3645 if (scope != UpdateMaster || master == this)
3646 checkBibInfoCache();
3648 // keep the buffers to be children in this set. If the call from the
3649 // master comes back we can see which of them were actually seen (i.e.
3650 // via an InsetInclude). The remaining ones in the set need still be updated.
3651 static std::set<Buffer const *> bufToUpdate;
3652 if (scope == UpdateMaster) {
3653 // If this is a child document start with the master
3654 if (master != this) {
3655 bufToUpdate.insert(this);
3656 master->updateBuffer(UpdateMaster, utype);
3657 // Do this here in case the master has no gui associated with it. Then,
3658 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3659 if (!master->d->gui_)
3662 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3663 if (bufToUpdate.find(this) == bufToUpdate.end())
3667 // start over the counters in the master
3668 textclass.counters().reset();
3671 // update will be done below for this buffer
3672 bufToUpdate.erase(this);
3674 // update all caches
3675 clearReferenceCache();
3678 Buffer & cbuf = const_cast<Buffer &>(*this);
3680 LASSERT(!text().paragraphs().empty(), /**/);
3683 ParIterator parit = cbuf.par_iterator_begin();
3684 updateBuffer(parit, utype);
3687 // TocBackend update will be done later.
3690 cbuf.tocBackend().update();
3691 if (scope == UpdateMaster)
3692 cbuf.structureChanged();
3696 static depth_type getDepth(DocIterator const & it)
3698 depth_type depth = 0;
3699 for (size_t i = 0 ; i < it.depth() ; ++i)
3700 if (!it[i].inset().inMathed())
3701 depth += it[i].paragraph().getDepth() + 1;
3702 // remove 1 since the outer inset does not count
3706 static depth_type getItemDepth(ParIterator const & it)
3708 Paragraph const & par = *it;
3709 LabelType const labeltype = par.layout().labeltype;
3711 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3714 // this will hold the lowest depth encountered up to now.
3715 depth_type min_depth = getDepth(it);
3716 ParIterator prev_it = it;
3719 --prev_it.top().pit();
3721 // start of nested inset: go to outer par
3723 if (prev_it.empty()) {
3724 // start of document: nothing to do
3729 // We search for the first paragraph with same label
3730 // that is not more deeply nested.
3731 Paragraph & prev_par = *prev_it;
3732 depth_type const prev_depth = getDepth(prev_it);
3733 if (labeltype == prev_par.layout().labeltype) {
3734 if (prev_depth < min_depth)
3735 return prev_par.itemdepth + 1;
3736 if (prev_depth == min_depth)
3737 return prev_par.itemdepth;
3739 min_depth = min(min_depth, prev_depth);
3740 // small optimization: if we are at depth 0, we won't
3741 // find anything else
3742 if (prev_depth == 0)
3748 static bool needEnumCounterReset(ParIterator const & it)
3750 Paragraph const & par = *it;
3751 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3752 depth_type const cur_depth = par.getDepth();
3753 ParIterator prev_it = it;
3754 while (prev_it.pit()) {
3755 --prev_it.top().pit();
3756 Paragraph const & prev_par = *prev_it;
3757 if (prev_par.getDepth() <= cur_depth)
3758 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3760 // start of nested inset: reset
3765 // set the label of a paragraph. This includes the counters.
3766 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3768 BufferParams const & bp = owner_->masterBuffer()->params();
3769 DocumentClass const & textclass = bp.documentClass();
3770 Paragraph & par = it.paragraph();
3771 Layout const & layout = par.layout();
3772 Counters & counters = textclass.counters();
3774 if (par.params().startOfAppendix()) {
3775 // FIXME: only the counter corresponding to toplevel
3776 // sectioning should be reset
3778 counters.appendix(true);
3780 par.params().appendix(counters.appendix());
3782 // Compute the item depth of the paragraph
3783 par.itemdepth = getItemDepth(it);
3785 if (layout.margintype == MARGIN_MANUAL
3786 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3787 if (par.params().labelWidthString().empty())
3788 par.params().labelWidthString(par.expandLabel(layout, bp));
3790 par.params().labelWidthString(docstring());
3793 switch(layout.labeltype) {
3795 if (layout.toclevel <= bp.secnumdepth
3796 && (layout.latextype != LATEX_ENVIRONMENT
3797 || it.text()->isFirstInSequence(it.pit()))) {
3798 counters.step(layout.counter, utype);
3799 par.params().labelString(
3800 par.expandLabel(layout, bp));
3802 par.params().labelString(docstring());
3805 case LABEL_ITEMIZE: {
3806 // At some point of time we should do something more
3807 // clever here, like:
3808 // par.params().labelString(
3809 // bp.user_defined_bullet(par.itemdepth).getText());
3810 // for now, use a simple hardcoded label
3811 docstring itemlabel;
3812 switch (par.itemdepth) {
3814 itemlabel = char_type(0x2022);
3817 itemlabel = char_type(0x2013);
3820 itemlabel = char_type(0x2217);
3823 itemlabel = char_type(0x2219); // or 0x00b7
3826 par.params().labelString(itemlabel);
3830 case LABEL_ENUMERATE: {
3831 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3833 switch (par.itemdepth) {
3842 enumcounter += "iv";
3845 // not a valid enumdepth...
3849 // Maybe we have to reset the enumeration counter.
3850 if (needEnumCounterReset(it))
3851 counters.reset(enumcounter);
3852 counters.step(enumcounter, utype);
3854 string const & lang = par.getParLanguage(bp)->code();
3855 par.params().labelString(counters.theCounter(enumcounter, lang));
3860 case LABEL_SENSITIVE: {
3861 string const & type = counters.current_float();
3862 docstring full_label;
3864 full_label = owner_->B_("Senseless!!! ");
3866 docstring name = owner_->B_(textclass.floats().getType(type).name());
3867 if (counters.hasCounter(from_utf8(type))) {
3868 string const & lang = par.getParLanguage(bp)->code();
3869 counters.step(from_utf8(type), utype);
3870 full_label = bformat(from_ascii("%1$s %2$s:"),
3872 counters.theCounter(from_utf8(type), lang));
3874 full_label = bformat(from_ascii("%1$s #:"), name);
3876 par.params().labelString(full_label);
3880 case LABEL_NO_LABEL:
3881 par.params().labelString(docstring());
3885 case LABEL_TOP_ENVIRONMENT:
3886 case LABEL_CENTERED_TOP_ENVIRONMENT:
3889 par.params().labelString(par.expandLabel(layout, bp));
3895 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
3897 LASSERT(parit.pit() == 0, /**/);
3899 // set the position of the text in the buffer to be able
3900 // to resolve macros in it. This has nothing to do with
3901 // labels, but by putting it here we avoid implementing
3902 // a whole bunch of traversal routines just for this call.
3903 parit.text()->setMacrocontextPosition(parit);
3905 depth_type maxdepth = 0;
3906 pit_type const lastpit = parit.lastpit();
3907 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3908 // reduce depth if necessary
3909 parit->params().depth(min(parit->params().depth(), maxdepth));
3910 maxdepth = parit->getMaxDepthAfter();
3912 if (utype == OutputUpdate) {
3913 // track the active counters
3914 // we have to do this for the master buffer, since the local
3915 // buffer isn't tracking anything.
3916 masterBuffer()->params().documentClass().counters().
3917 setActiveLayout(parit->layout());
3920 // set the counter for this paragraph
3921 d->setLabel(parit, utype);
3924 InsetList::const_iterator iit = parit->insetList().begin();
3925 InsetList::const_iterator end = parit->insetList().end();
3926 for (; iit != end; ++iit) {
3927 parit.pos() = iit->pos;
3928 iit->inset->updateBuffer(parit, utype);
3934 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3935 WordLangTuple & word_lang, docstring_list & suggestions) const
3939 suggestions.clear();
3940 word_lang = WordLangTuple();
3941 // OK, we start from here.
3942 DocIterator const end = doc_iterator_end(this);
3943 for (; from != end; from.forwardPos()) {
3944 // We are only interested in text so remove the math CursorSlice.
3945 while (from.inMathed()) {
3949 // If from is at the end of the document (which is possible
3950 // when leaving the mathed) LyX will crash later.
3954 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {
3959 // Do not increase progress when from == to, otherwise the word
3960 // count will be wrong.
3970 bool Buffer::reload()
3974 removeAutosaveFile();
3975 // e.g., read-only status could have changed due to version control
3976 d->filename.refresh();
3977 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
3979 bool const success = loadLyXFile(d->filename);
3985 message(bformat(_("Document %1$s reloaded."), disp_fn));
3987 message(bformat(_("Could not reload document %1$s."), disp_fn));
3990 thePreviews().removeLoader(*this);
3991 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
3992 thePreviews().generateBufferPreviews(*this);
3998 // FIXME We could do better here, but it is complicated. What would be
3999 // nice is to offer either (a) to save the child buffer to an appropriate
4000 // location, so that it would "move with the master", or else (b) to update
4001 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4002 // complicated, because the code for this lives in GuiView.
4003 void Buffer::checkChildBuffers()
4005 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4006 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4007 for (; it != en; ++it) {
4008 DocIterator dit = it->second;
4009 Buffer * cbuf = const_cast<Buffer *>(it->first);
4010 if (!cbuf || !theBufferList().isLoaded(cbuf))
4012 Inset * inset = dit.nextInset();
4013 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4014 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4015 docstring const & incfile = inset_inc->getParam("filename");
4016 string oldloc = cbuf->absFileName();
4017 string newloc = makeAbsPath(to_utf8(incfile),
4018 onlyPath(absFileName())).absFileName();
4019 if (oldloc == newloc)
4021 // the location of the child file is incorrect.
4022 Alert::warning(_("Included File Invalid"),
4023 bformat(_("Saving this document to a new location has made the file:\n"
4025 "inaccessible. You will need to update the included filename."),
4026 from_utf8(oldloc)));
4028 inset_inc->setChildBuffer(0);
4030 // invalidate cache of children
4031 d->children_positions.clear();
4032 d->position_to_children.clear();