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 <boost/bind.hpp>
106 #include <boost/shared_ptr.hpp>
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 = 385; // uwestoehr: support to change the shaded box color
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");
677 for (int i = 0; i < 4; ++i) {
678 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
679 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
682 ErrorList & errorList = d->errorLists["Parse"];
691 if (token == "\\end_header")
695 if (token == "\\begin_header") {
696 begin_header_line = line;
700 LYXERR(Debug::PARSER, "Handling document header token: `"
703 string unknown = params().readToken(lex, token, d->filename.onlyPath());
704 if (!unknown.empty()) {
705 if (unknown[0] != '\\' && token == "\\textclass") {
706 Alert::warning(_("Unknown document class"),
707 bformat(_("Using the default document class, because the "
708 "class %1$s is unknown."), from_utf8(unknown)));
711 docstring const s = bformat(_("Unknown token: "
715 errorList.push_back(ErrorItem(_("Document header error"),
720 if (begin_header_line) {
721 docstring const s = _("\\begin_header is missing");
722 errorList.push_back(ErrorItem(_("Document header error"),
726 params().makeDocumentClass();
728 return unknown_tokens;
733 // changed to be public and have one parameter
734 // Returns true if "\end_document" is not read (Asger)
735 bool Buffer::readDocument(Lexer & lex)
737 ErrorList & errorList = d->errorLists["Parse"];
740 if (!lex.checkFor("\\begin_document")) {
741 docstring const s = _("\\begin_document is missing");
742 errorList.push_back(ErrorItem(_("Document header error"),
746 // we are reading in a brand new document
747 LASSERT(paragraphs().empty(), /**/);
751 if (params().outputChanges) {
752 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
753 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
754 LaTeXFeatures::isAvailable("xcolor");
756 if (!dvipost && !xcolorulem) {
757 Alert::warning(_("Changes not shown in LaTeX output"),
758 _("Changes will not be highlighted in LaTeX output, "
759 "because neither dvipost nor xcolor/ulem are installed.\n"
760 "Please install these packages or redefine "
761 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
762 } else if (!xcolorulem) {
763 Alert::warning(_("Changes not shown in LaTeX output"),
764 _("Changes will not be highlighted in LaTeX output "
765 "when using pdflatex, because xcolor and ulem are not installed.\n"
766 "Please install both packages or redefine "
767 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
771 if (!params().master.empty()) {
772 FileName const master_file = makeAbsPath(params().master,
773 onlyPath(absFileName()));
774 if (isLyXFilename(master_file.absFilename())) {
776 checkAndLoadLyXFile(master_file, true);
778 // necessary e.g. after a reload
779 // to re-register the child (bug 5873)
780 // FIXME: clean up updateMacros (here, only
781 // child registering is needed).
782 master->updateMacros();
783 // set master as master buffer, but only
784 // if we are a real child
785 if (master->isChild(this))
787 // if the master is not fully loaded
788 // it is probably just loading this
789 // child. No warning needed then.
790 else if (master->isFullyLoaded())
791 LYXERR0("The master '"
793 << "' assigned to this document ("
795 << ") does not include "
796 "this document. Ignoring the master assignment.");
801 // assure we have a default index
802 params().indiceslist().addDefault(B_("Index"));
805 bool const res = text().read(lex, errorList, d->inset);
809 updateMacroInstances();
814 bool Buffer::readString(string const & s)
816 params().compressed = false;
818 // remove dummy empty par
819 paragraphs().clear();
823 FileName const name = FileName::tempName("Buffer_readString");
824 switch (readFile(lex, name, true)) {
828 // We need to call lyx2lyx, so write the input to a file
829 ofstream os(name.toFilesystemEncoding().c_str());
832 return readFile(name);
842 bool Buffer::readFile(FileName const & filename)
844 FileName fname(filename);
846 params().compressed = fname.isZippedFile();
848 // remove dummy empty par
849 paragraphs().clear();
852 if (readFile(lex, fname) != success)
859 bool Buffer::isFullyLoaded() const
861 return d->file_fully_loaded;
865 void Buffer::setFullyLoaded(bool value)
867 d->file_fully_loaded = value;
871 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
874 LASSERT(!filename.empty(), /**/);
876 // the first (non-comment) token _must_ be...
877 if (!lex.checkFor("\\lyxformat")) {
878 Alert::error(_("Document format failure"),
879 bformat(_("%1$s is not a readable LyX document."),
880 from_utf8(filename.absFilename())));
886 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
887 // if present remove ".," from string.
888 size_t dot = tmp_format.find_first_of(".,");
889 //lyxerr << " dot found at " << dot << endl;
890 if (dot != string::npos)
891 tmp_format.erase(dot, 1);
892 int const file_format = convert<int>(tmp_format);
893 //lyxerr << "format: " << file_format << endl;
895 // save timestamp and checksum of the original disk file, making sure
896 // to not overwrite them with those of the file created in the tempdir
897 // when it has to be converted to the current format.
899 // Save the timestamp and checksum of disk file. If filename is an
900 // emergency file, save the timestamp and checksum of the original lyx file
901 // because isExternallyModified will check for this file. (BUG4193)
902 string diskfile = filename.absFilename();
903 if (suffixIs(diskfile, ".emergency"))
904 diskfile = diskfile.substr(0, diskfile.size() - 10);
905 saveCheckSum(FileName(diskfile));
908 if (file_format != LYX_FORMAT) {
911 // lyx2lyx would fail
914 FileName const tmpfile = FileName::tempName("Buffer_readFile");
915 if (tmpfile.empty()) {
916 Alert::error(_("Conversion failed"),
917 bformat(_("%1$s is from a different"
918 " version of LyX, but a temporary"
919 " file for converting it could"
921 from_utf8(filename.absFilename())));
924 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
925 if (lyx2lyx.empty()) {
926 Alert::error(_("Conversion script not found"),
927 bformat(_("%1$s is from a different"
928 " version of LyX, but the"
929 " conversion script lyx2lyx"
930 " could not be found."),
931 from_utf8(filename.absFilename())));
934 ostringstream command;
935 command << os::python()
936 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
937 << " -t " << convert<string>(LYX_FORMAT)
938 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
939 << ' ' << quoteName(filename.toSafeFilesystemEncoding());
940 string const command_str = command.str();
942 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
944 cmd_ret const ret = runCommand(command_str);
945 if (ret.first != 0) {
946 if (file_format < LYX_FORMAT)
947 Alert::error(_("Conversion script failed"),
948 bformat(_("%1$s is from an older version"
949 " of LyX, but the lyx2lyx script"
950 " failed to convert it."),
951 from_utf8(filename.absFilename())));
953 Alert::error(_("Conversion script failed"),
954 bformat(_("%1$s is from a newer version"
955 " of LyX and cannot be converted by the"
957 from_utf8(filename.absFilename())));
960 bool const ret = readFile(tmpfile);
961 // Do stuff with tmpfile name and buffer name here.
962 return ret ? success : failure;
967 if (readDocument(lex)) {
968 Alert::error(_("Document format failure"),
969 bformat(_("%1$s ended unexpectedly, which means"
970 " that it is probably corrupted."),
971 from_utf8(filename.absFilename())));
975 d->file_fully_loaded = true;
980 // Should probably be moved to somewhere else: BufferView? GuiView?
981 bool Buffer::save() const
983 // ask if the disk file has been externally modified (use checksum method)
984 if (fileName().exists() && isExternallyModified(checksum_method)) {
985 docstring const file = makeDisplayPath(absFileName(), 20);
986 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
987 "you want to overwrite this file?"), file);
988 int const ret = Alert::prompt(_("Overwrite modified file?"),
989 text, 1, 1, _("&Overwrite"), _("&Cancel"));
994 // We don't need autosaves in the immediate future. (Asger)
995 resetAutosaveTimers();
998 bool madeBackup = false;
1000 // make a backup if the file already exists
1001 if (lyxrc.make_backup && fileName().exists()) {
1002 backupName = FileName(absFileName() + '~');
1003 if (!lyxrc.backupdir_path.empty()) {
1004 string const mangledName =
1005 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
1006 backupName = FileName(addName(lyxrc.backupdir_path,
1009 if (fileName().moveTo(backupName)) {
1012 Alert::error(_("Backup failure"),
1013 bformat(_("Cannot create backup file %1$s.\n"
1014 "Please check whether the directory exists and is writeable."),
1015 from_utf8(backupName.absFilename())));
1016 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1020 if (writeFile(d->filename)) {
1024 // Saving failed, so backup is not backup
1026 backupName.moveTo(d->filename);
1032 bool Buffer::writeFile(FileName const & fname) const
1034 if (d->read_only && fname == d->filename)
1037 bool retval = false;
1039 docstring const str = bformat(_("Saving document %1$s..."),
1040 makeDisplayPath(fname.absFilename()));
1043 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1045 if (params().compressed) {
1046 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1047 retval = ofs && write(ofs);
1049 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1050 retval = ofs && write(ofs);
1054 message(str + _(" could not write file!"));
1059 // removeAutosaveFile();
1061 saveCheckSum(d->filename);
1062 message(str + _(" done."));
1068 docstring Buffer::emergencyWrite()
1070 // No need to save if the buffer has not changed.
1074 string const doc = isUnnamed() ? onlyFilename(absFileName()) : absFileName();
1076 docstring user_message = bformat(
1077 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1079 // We try to save three places:
1080 // 1) Same place as document. Unless it is an unnamed doc.
1082 string s = absFileName();
1085 if (writeFile(FileName(s))) {
1087 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1088 return user_message;
1090 user_message += _(" Save failed! Trying again...\n");
1094 // 2) In HOME directory.
1095 string s = addName(package().home_dir().absFilename(), absFileName());
1097 lyxerr << ' ' << s << endl;
1098 if (writeFile(FileName(s))) {
1100 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1101 return user_message;
1104 user_message += _(" Save failed! Trying yet again...\n");
1106 // 3) In "/tmp" directory.
1107 // MakeAbsPath to prepend the current
1108 // drive letter on OS/2
1109 s = addName(package().temp_dir().absFilename(), absFileName());
1111 lyxerr << ' ' << s << endl;
1112 if (writeFile(FileName(s))) {
1114 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1115 return user_message;
1118 user_message += _(" Save failed! Bummer. Document is lost.");
1121 return user_message;
1125 bool Buffer::write(ostream & ofs) const
1128 // Use the standard "C" locale for file output.
1129 ofs.imbue(locale::classic());
1132 // The top of the file should not be written by params().
1134 // write out a comment in the top of the file
1135 ofs << "#LyX " << lyx_version
1136 << " created this file. For more info see http://www.lyx.org/\n"
1137 << "\\lyxformat " << LYX_FORMAT << "\n"
1138 << "\\begin_document\n";
1140 /// For each author, set 'used' to true if there is a change
1141 /// by this author in the document; otherwise set it to 'false'.
1142 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1143 AuthorList::Authors::const_iterator a_end = params().authors().end();
1144 for (; a_it != a_end; ++a_it)
1145 a_it->setUsed(false);
1147 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1148 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1149 for ( ; it != end; ++it)
1150 it->checkAuthors(params().authors());
1152 // now write out the buffer parameters.
1153 ofs << "\\begin_header\n";
1154 params().writeFile(ofs);
1155 ofs << "\\end_header\n";
1158 ofs << "\n\\begin_body\n";
1160 ofs << "\n\\end_body\n";
1162 // Write marker that shows file is complete
1163 ofs << "\\end_document" << endl;
1165 // Shouldn't really be needed....
1168 // how to check if close went ok?
1169 // Following is an attempt... (BE 20001011)
1171 // good() returns false if any error occured, including some
1172 // formatting error.
1173 // bad() returns true if something bad happened in the buffer,
1174 // which should include file system full errors.
1179 lyxerr << "File was not closed properly." << endl;
1186 bool Buffer::makeLaTeXFile(FileName const & fname,
1187 string const & original_path,
1188 OutputParams const & runparams_in,
1189 bool output_preamble, bool output_body) const
1191 OutputParams runparams = runparams_in;
1192 if (params().useXetex)
1193 runparams.flavor = OutputParams::XETEX;
1195 string const encoding = runparams.encoding->iconvName();
1196 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1199 try { ofs.reset(encoding); }
1200 catch (iconv_codecvt_facet_exception & e) {
1201 lyxerr << "Caught iconv exception: " << e.what() << endl;
1202 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1203 "verify that the support software for your encoding (%1$s) is "
1204 "properly installed"), from_ascii(encoding)));
1207 if (!openFileWrite(ofs, fname))
1210 //TexStream ts(ofs.rdbuf(), &texrow());
1211 ErrorList & errorList = d->errorLists["Export"];
1213 bool failed_export = false;
1216 writeLaTeXSource(ofs, original_path,
1217 runparams, output_preamble, output_body);
1219 catch (EncodingException & e) {
1220 odocstringstream ods;
1221 ods.put(e.failed_char);
1223 oss << "0x" << hex << e.failed_char << dec;
1224 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1225 " (code point %2$s)"),
1226 ods.str(), from_utf8(oss.str()));
1227 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1228 "representable in the chosen encoding.\n"
1229 "Changing the document encoding to utf8 could help."),
1230 e.par_id, e.pos, e.pos + 1));
1231 failed_export = true;
1233 catch (iconv_codecvt_facet_exception & e) {
1234 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1235 _(e.what()), -1, 0, 0));
1236 failed_export = true;
1238 catch (exception const & e) {
1239 errorList.push_back(ErrorItem(_("conversion failed"),
1240 _(e.what()), -1, 0, 0));
1241 failed_export = true;
1244 lyxerr << "Caught some really weird exception..." << endl;
1250 failed_export = true;
1251 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1255 return !failed_export;
1259 void Buffer::writeLaTeXSource(odocstream & os,
1260 string const & original_path,
1261 OutputParams const & runparams_in,
1262 bool const output_preamble, bool const output_body) const
1264 // The child documents, if any, shall be already loaded at this point.
1266 OutputParams runparams = runparams_in;
1268 // Classify the unicode characters appearing in math insets
1269 Encodings::initUnicodeMath(*this);
1271 // validate the buffer.
1272 LYXERR(Debug::LATEX, " Validating buffer...");
1273 LaTeXFeatures features(*this, params(), runparams);
1275 LYXERR(Debug::LATEX, " Buffer validation done.");
1277 // The starting paragraph of the coming rows is the
1278 // first paragraph of the document. (Asger)
1279 if (output_preamble && runparams.nice) {
1280 os << "%% LyX " << lyx_version << " created this file. "
1281 "For more info, see http://www.lyx.org/.\n"
1282 "%% Do not edit unless you really know what "
1284 d->texrow.newline();
1285 d->texrow.newline();
1287 LYXERR(Debug::INFO, "lyx document header finished");
1289 // Don't move this behind the parent_buffer=0 code below,
1290 // because then the macros will not get the right "redefinition"
1291 // flag as they don't see the parent macros which are output before.
1294 // fold macros if possible, still with parent buffer as the
1295 // macros will be put in the prefix anyway.
1296 updateMacroInstances();
1298 // There are a few differences between nice LaTeX and usual files:
1299 // usual is \batchmode and has a
1300 // special input@path to allow the including of figures
1301 // with either \input or \includegraphics (what figinsets do).
1302 // input@path is set when the actual parameter
1303 // original_path is set. This is done for usual tex-file, but not
1304 // for nice-latex-file. (Matthias 250696)
1305 // Note that input@path is only needed for something the user does
1306 // in the preamble, included .tex files or ERT, files included by
1307 // LyX work without it.
1308 if (output_preamble) {
1309 if (!runparams.nice) {
1310 // code for usual, NOT nice-latex-file
1311 os << "\\batchmode\n"; // changed
1312 // from \nonstopmode
1313 d->texrow.newline();
1315 if (!original_path.empty()) {
1317 // We don't know the encoding of inputpath
1318 docstring const inputpath = from_utf8(support::latex_path(original_path));
1319 docstring uncodable_glyphs;
1320 Encoding const * const enc = runparams.encoding;
1322 for (size_t n = 0; n < inputpath.size(); ++n) {
1323 docstring const glyph =
1324 docstring(1, inputpath[n]);
1325 if (enc->latexChar(inputpath[n], true) != glyph) {
1326 LYXERR0("Uncodable character '"
1328 << "' in input path!");
1329 uncodable_glyphs += glyph;
1334 // warn user if we found uncodable glyphs.
1335 if (!uncodable_glyphs.empty()) {
1336 frontend::Alert::warning(_("Uncodable character in file path"),
1337 support::bformat(_("The path of your document\n"
1339 "contains glyphs that are unknown in the\n"
1340 "current document encoding (namely %2$s).\n"
1341 "This will likely result in incomplete output.\n\n"
1342 "Choose an appropriate document encoding (such as utf8)\n"
1343 "or change the file path name."), inputpath, uncodable_glyphs));
1345 os << "\\makeatletter\n"
1346 << "\\def\\input@path{{"
1347 << inputpath << "/}}\n"
1348 << "\\makeatother\n";
1349 d->texrow.newline();
1350 d->texrow.newline();
1351 d->texrow.newline();
1355 // get parent macros (if this buffer has a parent) which will be
1356 // written at the document begin further down.
1357 MacroSet parentMacros;
1358 listParentMacros(parentMacros, features);
1360 // Write the preamble
1361 runparams.use_babel = params().writeLaTeX(os, features,
1363 d->filename.onlyPath());
1365 runparams.use_japanese = features.isRequired("japanese");
1371 os << "\\begin{document}\n";
1372 d->texrow.newline();
1374 // output the parent macros
1375 MacroSet::iterator it = parentMacros.begin();
1376 MacroSet::iterator end = parentMacros.end();
1377 for (; it != end; ++it) {
1378 int num_lines = (*it)->write(os, true);
1379 d->texrow.newlines(num_lines);
1382 } // output_preamble
1384 d->texrow.start(paragraphs().begin()->id(), 0);
1386 LYXERR(Debug::INFO, "preamble finished, now the body.");
1388 // if we are doing a real file with body, even if this is the
1389 // child of some other buffer, let's cut the link here.
1390 // This happens for example if only a child document is printed.
1391 Buffer const * save_parent = 0;
1392 if (output_preamble) {
1393 save_parent = d->parent();
1398 latexParagraphs(*this, text(), os, d->texrow, runparams);
1400 // Restore the parenthood if needed
1401 if (output_preamble)
1402 d->setParent(save_parent);
1404 // add this just in case after all the paragraphs
1406 d->texrow.newline();
1408 if (output_preamble) {
1409 os << "\\end{document}\n";
1410 d->texrow.newline();
1411 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1413 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1415 runparams_in.encoding = runparams.encoding;
1417 // Just to be sure. (Asger)
1418 d->texrow.newline();
1420 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1421 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1425 bool Buffer::isLatex() const
1427 return params().documentClass().outputType() == LATEX;
1431 bool Buffer::isLiterate() const
1433 return params().documentClass().outputType() == LITERATE;
1437 bool Buffer::isDocBook() const
1439 return params().documentClass().outputType() == DOCBOOK;
1443 void Buffer::makeDocBookFile(FileName const & fname,
1444 OutputParams const & runparams,
1445 bool const body_only) const
1447 LYXERR(Debug::LATEX, "makeDocBookFile...");
1450 if (!openFileWrite(ofs, fname))
1453 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1457 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1461 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1462 OutputParams const & runparams,
1463 bool const only_body) const
1465 LaTeXFeatures features(*this, params(), runparams);
1470 DocumentClass const & tclass = params().documentClass();
1471 string const top_element = tclass.latexname();
1474 if (runparams.flavor == OutputParams::XML)
1475 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1478 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1481 if (! tclass.class_header().empty())
1482 os << from_ascii(tclass.class_header());
1483 else if (runparams.flavor == OutputParams::XML)
1484 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1485 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1487 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1489 docstring preamble = from_utf8(params().preamble);
1490 if (runparams.flavor != OutputParams::XML ) {
1491 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1492 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1493 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1494 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1497 string const name = runparams.nice
1498 ? changeExtension(absFileName(), ".sgml") : fname;
1499 preamble += features.getIncludedFiles(name);
1500 preamble += features.getLyXSGMLEntities();
1502 if (!preamble.empty()) {
1503 os << "\n [ " << preamble << " ]";
1508 string top = top_element;
1510 if (runparams.flavor == OutputParams::XML)
1511 top += params().language->code();
1513 top += params().language->code().substr(0, 2);
1516 if (!params().options.empty()) {
1518 top += params().options;
1521 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1522 << " file was created by LyX " << lyx_version
1523 << "\n See http://www.lyx.org/ for more information -->\n";
1525 params().documentClass().counters().reset();
1529 sgml::openTag(os, top);
1531 docbookParagraphs(text(), *this, os, runparams);
1532 sgml::closeTag(os, top_element);
1536 void Buffer::makeLyXHTMLFile(FileName const & fname,
1537 OutputParams const & runparams,
1538 bool const body_only) const
1540 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1543 if (!openFileWrite(ofs, fname))
1546 writeLyXHTMLSource(ofs, runparams, body_only);
1550 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1554 void Buffer::writeLyXHTMLSource(odocstream & os,
1555 OutputParams const & runparams,
1556 bool const only_body) const
1558 LaTeXFeatures features(*this, params(), runparams);
1560 updateBuffer(UpdateMaster, OutputUpdate);
1561 checkBibInfoCache();
1562 d->bibinfo_.makeCitationLabels(*this);
1564 updateMacroInstances();
1567 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1568 << "<!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"
1569 // FIXME Language should be set properly.
1570 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1572 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1573 // FIXME Presumably need to set this right
1574 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1576 docstring const & doctitle = features.htmlTitle();
1578 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1581 os << "\n<!-- Text Class Preamble -->\n"
1582 << features.getTClassHTMLPreamble()
1583 << "\n<!-- Premable Snippets -->\n"
1584 << from_utf8(features.getPreambleSnippets());
1586 os << "\n<!-- Layout-provided Styles -->\n";
1587 docstring const styleinfo = features.getTClassHTMLStyles();
1588 if (!styleinfo.empty()) {
1589 os << "<style type='text/css'>\n"
1593 os << "</head>\n<body>\n";
1597 params().documentClass().counters().reset();
1598 xhtmlParagraphs(text(), *this, xs, runparams);
1600 os << "</body>\n</html>\n";
1604 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1605 // Other flags: -wall -v0 -x
1606 int Buffer::runChktex()
1610 // get LaTeX-Filename
1611 FileName const path(temppath());
1612 string const name = addName(path.absFilename(), latexName());
1613 string const org_path = filePath();
1615 PathChanger p(path); // path to LaTeX file
1616 message(_("Running chktex..."));
1618 // Generate the LaTeX file if neccessary
1619 OutputParams runparams(¶ms().encoding());
1620 runparams.flavor = OutputParams::LATEX;
1621 runparams.nice = false;
1622 runparams.linelen = lyxrc.plaintext_linelen;
1623 makeLaTeXFile(FileName(name), org_path, runparams);
1626 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1627 int const res = chktex.run(terr); // run chktex
1630 Alert::error(_("chktex failure"),
1631 _("Could not run chktex successfully."));
1632 } else if (res > 0) {
1633 ErrorList & errlist = d->errorLists["ChkTeX"];
1635 bufferErrors(terr, errlist);
1646 void Buffer::validate(LaTeXFeatures & features) const
1648 params().validate(features);
1652 for_each(paragraphs().begin(), paragraphs().end(),
1653 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1655 if (lyxerr.debugging(Debug::LATEX)) {
1656 features.showStruct();
1661 void Buffer::getLabelList(vector<docstring> & list) const
1663 // If this is a child document, use the parent's list instead.
1664 Buffer const * const pbuf = d->parent();
1666 pbuf->getLabelList(list);
1671 Toc & toc = d->toc_backend.toc("label");
1672 TocIterator toc_it = toc.begin();
1673 TocIterator end = toc.end();
1674 for (; toc_it != end; ++toc_it) {
1675 if (toc_it->depth() == 0)
1676 list.push_back(toc_it->str());
1681 void Buffer::updateBibfilesCache(UpdateScope scope) const
1683 // If this is a child document, use the parent's cache instead.
1684 Buffer const * const pbuf = d->parent();
1685 if (pbuf && scope != UpdateChildOnly) {
1686 pbuf->updateBibfilesCache();
1690 d->bibfiles_cache_.clear();
1691 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1692 if (it->lyxCode() == BIBTEX_CODE) {
1693 InsetBibtex const & inset =
1694 static_cast<InsetBibtex const &>(*it);
1695 support::FileNameList const bibfiles = inset.getBibFiles();
1696 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1699 } else if (it->lyxCode() == INCLUDE_CODE) {
1700 InsetInclude & inset =
1701 static_cast<InsetInclude &>(*it);
1702 inset.updateBibfilesCache();
1703 support::FileNameList const & bibfiles =
1704 inset.getBibfilesCache();
1705 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1710 // the bibinfo cache is now invalid
1711 d->bibinfo_cache_valid_ = false;
1715 void Buffer::invalidateBibinfoCache()
1717 d->bibinfo_cache_valid_ = false;
1721 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1723 // If this is a child document, use the parent's cache instead.
1724 Buffer const * const pbuf = d->parent();
1725 if (pbuf && scope != UpdateChildOnly)
1726 return pbuf->getBibfilesCache();
1728 // We update the cache when first used instead of at loading time.
1729 if (d->bibfiles_cache_.empty())
1730 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1732 return d->bibfiles_cache_;
1736 BiblioInfo const & Buffer::masterBibInfo() const
1738 // if this is a child document and the parent is already loaded
1739 // use the parent's list instead [ale990412]
1740 Buffer const * const tmp = masterBuffer();
1743 return tmp->masterBibInfo();
1744 return localBibInfo();
1748 BiblioInfo const & Buffer::localBibInfo() const
1754 void Buffer::checkBibInfoCache() const
1756 support::FileNameList const & bibfilesCache = getBibfilesCache();
1757 // compare the cached timestamps with the actual ones.
1758 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1759 support::FileNameList::const_iterator en = bibfilesCache.end();
1760 for (; ei != en; ++ ei) {
1761 time_t lastw = ei->lastModified();
1762 time_t prevw = d->bibfile_status_[*ei];
1763 if (lastw != prevw) {
1764 d->bibinfo_cache_valid_ = false;
1765 d->bibfile_status_[*ei] = lastw;
1769 if (!d->bibinfo_cache_valid_) {
1770 d->bibinfo_.clear();
1771 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1772 it->fillWithBibKeys(d->bibinfo_, it);
1773 d->bibinfo_cache_valid_ = true;
1778 bool Buffer::isDepClean(string const & name) const
1780 DepClean::const_iterator const it = d->dep_clean.find(name);
1781 if (it == d->dep_clean.end())
1787 void Buffer::markDepClean(string const & name)
1789 d->dep_clean[name] = true;
1793 bool Buffer::isExportableFormat(string const & format) const
1795 typedef vector<Format const *> Formats;
1797 formats = exportableFormats(true);
1798 Formats::const_iterator fit = formats.begin();
1799 Formats::const_iterator end = formats.end();
1800 for (; fit != end ; ++fit) {
1801 if ((*fit)->name() == format)
1808 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1811 // FIXME? if there is an Buffer LFUN that can be dispatched even
1812 // if internal, put a switch '(cmd.action)' here.
1818 switch (cmd.action) {
1820 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1821 flag.setOnOff(isReadonly());
1824 // FIXME: There is need for a command-line import.
1825 //case LFUN_BUFFER_IMPORT:
1827 case LFUN_BUFFER_AUTO_SAVE:
1830 case LFUN_BUFFER_EXPORT_CUSTOM:
1831 // FIXME: Nothing to check here?
1834 case LFUN_BUFFER_EXPORT: {
1835 docstring const arg = cmd.argument();
1836 enable = arg == "custom" || isExportable(to_utf8(arg));
1838 flag.message(bformat(
1839 _("Don't know how to export to format: %1$s"), arg));
1843 case LFUN_BUFFER_CHKTEX:
1844 enable = isLatex() && !lyxrc.chktex_command.empty();
1847 case LFUN_BUILD_PROGRAM:
1848 enable = isExportable("program");
1851 case LFUN_BRANCH_ACTIVATE:
1852 case LFUN_BRANCH_DEACTIVATE: {
1853 BranchList const & branchList = params().branchlist();
1854 docstring const branchName = cmd.argument();
1855 enable = !branchName.empty() && branchList.find(branchName);
1859 case LFUN_BRANCH_ADD:
1860 case LFUN_BRANCHES_RENAME:
1861 case LFUN_BUFFER_PRINT:
1862 // if no Buffer is present, then of course we won't be called!
1865 case LFUN_BUFFER_LANGUAGE:
1866 enable = !isReadonly();
1872 flag.setEnabled(enable);
1877 void Buffer::dispatch(string const & command, DispatchResult & result)
1879 return dispatch(lyxaction.lookupFunc(command), result);
1883 // NOTE We can end up here even if we have no GUI, because we are called
1884 // by LyX::exec to handled command-line requests. So we may need to check
1885 // whether we have a GUI or not. The boolean use_gui holds this information.
1886 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1889 // FIXME? if there is an Buffer LFUN that can be dispatched even
1890 // if internal, put a switch '(cmd.action)' here.
1891 dr.dispatched(false);
1894 string const argument = to_utf8(func.argument());
1895 // We'll set this back to false if need be.
1896 bool dispatched = true;
1897 undo().beginUndoGroup();
1899 switch (func.action) {
1900 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1901 if (lyxvc().inUse())
1902 lyxvc().toggleReadOnly();
1904 setReadonly(!isReadonly());
1907 case LFUN_BUFFER_EXPORT: {
1908 bool success = doExport(argument, false, false);
1909 dr.setError(!success);
1911 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1916 case LFUN_BUILD_PROGRAM:
1917 doExport("program", true, false);
1920 case LFUN_BUFFER_CHKTEX:
1924 case LFUN_BUFFER_EXPORT_CUSTOM: {
1926 string command = split(argument, format_name, ' ');
1927 Format const * format = formats.getFormat(format_name);
1929 lyxerr << "Format \"" << format_name
1930 << "\" not recognized!"
1935 // The name of the file created by the conversion process
1938 // Output to filename
1939 if (format->name() == "lyx") {
1940 string const latexname = latexName(false);
1941 filename = changeExtension(latexname,
1942 format->extension());
1943 filename = addName(temppath(), filename);
1945 if (!writeFile(FileName(filename)))
1949 doExport(format_name, true, false, filename);
1952 // Substitute $$FName for filename
1953 if (!contains(command, "$$FName"))
1954 command = "( " + command + " ) < $$FName";
1955 command = subst(command, "$$FName", filename);
1957 // Execute the command in the background
1959 call.startscript(Systemcall::DontWait, command);
1963 // FIXME: There is need for a command-line import.
1965 case LFUN_BUFFER_IMPORT:
1970 case LFUN_BUFFER_AUTO_SAVE:
1974 case LFUN_BRANCH_ADD: {
1975 docstring const branch_name = func.argument();
1976 if (branch_name.empty()) {
1980 BranchList & branch_list = params().branchlist();
1981 Branch * branch = branch_list.find(branch_name);
1983 LYXERR0("Branch " << branch_name << " already exists.");
1985 docstring const msg =
1986 bformat(_("Branch \"%1$s\" already exists."), branch_name);
1989 branch_list.add(branch_name);
1990 branch = branch_list.find(branch_name);
1991 string const x11hexname = X11hexname(branch->color());
1992 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
1993 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
1995 dr.update(Update::Force);
2000 case LFUN_BRANCH_ACTIVATE:
2001 case LFUN_BRANCH_DEACTIVATE: {
2002 BranchList & branchList = params().branchlist();
2003 docstring const branchName = func.argument();
2004 // the case without a branch name is handled elsewhere
2005 if (branchName.empty()) {
2009 Branch * branch = branchList.find(branchName);
2011 LYXERR0("Branch " << branchName << " does not exist.");
2013 docstring const msg =
2014 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2017 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
2019 dr.update(Update::Force);
2024 case LFUN_BRANCHES_RENAME: {
2025 if (func.argument().empty())
2028 docstring const oldname = from_utf8(func.getArg(0));
2029 docstring const newname = from_utf8(func.getArg(1));
2030 InsetIterator it = inset_iterator_begin(inset());
2031 InsetIterator const end = inset_iterator_end(inset());
2032 bool success = false;
2033 for (; it != end; ++it) {
2034 if (it->lyxCode() == BRANCH_CODE) {
2035 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2036 if (ins.branch() == oldname) {
2037 undo().recordUndo(it);
2038 ins.rename(newname);
2043 if (it->lyxCode() == INCLUDE_CODE) {
2044 // get buffer of external file
2045 InsetInclude const & ins =
2046 static_cast<InsetInclude const &>(*it);
2047 Buffer * child = ins.getChildBuffer();
2050 child->dispatch(func, dr);
2055 dr.update(Update::Force);
2059 case LFUN_BUFFER_PRINT: {
2060 // we'll assume there's a problem until we succeed
2062 string target = func.getArg(0);
2063 string target_name = func.getArg(1);
2064 string command = func.getArg(2);
2067 || target_name.empty()
2068 || command.empty()) {
2069 LYXERR0("Unable to parse " << func.argument());
2070 docstring const msg =
2071 bformat(_("Unable to parse \"%1$s\""), func.argument());
2075 if (target != "printer" && target != "file") {
2076 LYXERR0("Unrecognized target \"" << target << '"');
2077 docstring const msg =
2078 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2083 bool const update_unincluded =
2084 params().maintain_unincluded_children
2085 && !params().getIncludedChildren().empty();
2086 if (!doExport("dvi", true, update_unincluded)) {
2087 showPrintError(absFileName());
2088 dr.setMessage(_("Error exporting to DVI."));
2092 // Push directory path.
2093 string const path = temppath();
2094 // Prevent the compiler from optimizing away p
2098 // there are three cases here:
2099 // 1. we print to a file
2100 // 2. we print directly to a printer
2101 // 3. we print using a spool command (print to file first)
2104 string const dviname = changeExtension(latexName(true), "dvi");
2106 if (target == "printer") {
2107 if (!lyxrc.print_spool_command.empty()) {
2108 // case 3: print using a spool
2109 string const psname = changeExtension(dviname,".ps");
2110 command += ' ' + lyxrc.print_to_file
2113 + quoteName(dviname);
2115 string command2 = lyxrc.print_spool_command + ' ';
2116 if (target_name != "default") {
2117 command2 += lyxrc.print_spool_printerprefix
2121 command2 += quoteName(psname);
2123 // If successful, then spool command
2124 res = one.startscript(Systemcall::Wait, command);
2127 // If there's no GUI, we have to wait on this command. Otherwise,
2128 // LyX deletes the temporary directory, and with it the spooled
2129 // file, before it can be printed!!
2130 Systemcall::Starttype stype = use_gui ?
2131 Systemcall::DontWait : Systemcall::Wait;
2132 res = one.startscript(stype, command2);
2135 // case 2: print directly to a printer
2136 if (target_name != "default")
2137 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2139 Systemcall::Starttype stype = use_gui ?
2140 Systemcall::DontWait : Systemcall::Wait;
2141 res = one.startscript(stype, command + quoteName(dviname));
2145 // case 1: print to a file
2146 FileName const filename(makeAbsPath(target_name, filePath()));
2147 FileName const dvifile(makeAbsPath(dviname, path));
2148 if (filename.exists()) {
2149 docstring text = bformat(
2150 _("The file %1$s already exists.\n\n"
2151 "Do you want to overwrite that file?"),
2152 makeDisplayPath(filename.absFilename()));
2153 if (Alert::prompt(_("Overwrite file?"),
2154 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2157 command += ' ' + lyxrc.print_to_file
2158 + quoteName(filename.toFilesystemEncoding())
2160 + quoteName(dvifile.toFilesystemEncoding());
2162 Systemcall::Starttype stype = use_gui ?
2163 Systemcall::DontWait : Systemcall::Wait;
2164 res = one.startscript(stype, command);
2170 dr.setMessage(_("Error running external commands."));
2171 showPrintError(absFileName());
2176 case LFUN_BUFFER_LANGUAGE: {
2177 Language const * oldL = params().language;
2178 Language const * newL = languages.getLanguage(argument);
2179 if (!newL || oldL == newL)
2181 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual())
2182 changeLanguage(oldL, newL);
2190 dr.dispatched(dispatched);
2191 undo().endUndoGroup();
2195 void Buffer::changeLanguage(Language const * from, Language const * to)
2197 LASSERT(from, /**/);
2200 for_each(par_iterator_begin(),
2202 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2206 bool Buffer::isMultiLingual() const
2208 ParConstIterator end = par_iterator_end();
2209 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2210 if (it->isMultiLingual(params()))
2217 std::set<Language const *> Buffer::getLanguages() const
2219 std::set<Language const *> languages;
2220 getLanguages(languages);
2225 void Buffer::getLanguages(std::set<Language const *> & languages) const
2227 ParConstIterator end = par_iterator_end();
2228 // add the buffer language, even if it's not actively used
2229 languages.insert(language());
2230 // iterate over the paragraphs
2231 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2232 it->getLanguages(languages);
2234 std::vector<Buffer *> clist = getChildren();
2235 for (vector<Buffer *>::const_iterator cit = clist.begin();
2236 cit != clist.end(); ++cit)
2237 (*cit)->getLanguages(languages);
2241 DocIterator Buffer::getParFromID(int const id) const
2243 Buffer * buf = const_cast<Buffer *>(this);
2245 // John says this is called with id == -1 from undo
2246 lyxerr << "getParFromID(), id: " << id << endl;
2247 return doc_iterator_end(buf);
2250 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2251 if (it.paragraph().id() == id)
2254 return doc_iterator_end(buf);
2258 bool Buffer::hasParWithID(int const id) const
2260 return !getParFromID(id).atEnd();
2264 ParIterator Buffer::par_iterator_begin()
2266 return ParIterator(doc_iterator_begin(this));
2270 ParIterator Buffer::par_iterator_end()
2272 return ParIterator(doc_iterator_end(this));
2276 ParConstIterator Buffer::par_iterator_begin() const
2278 return ParConstIterator(doc_iterator_begin(this));
2282 ParConstIterator Buffer::par_iterator_end() const
2284 return ParConstIterator(doc_iterator_end(this));
2288 Language const * Buffer::language() const
2290 return params().language;
2294 docstring const Buffer::B_(string const & l10n) const
2296 return params().B_(l10n);
2300 bool Buffer::isClean() const
2302 return d->lyx_clean;
2306 bool Buffer::isExternallyModified(CheckMethod method) const
2308 LASSERT(d->filename.exists(), /**/);
2309 // if method == timestamp, check timestamp before checksum
2310 return (method == checksum_method
2311 || d->timestamp_ != d->filename.lastModified())
2312 && d->checksum_ != d->filename.checksum();
2316 void Buffer::saveCheckSum(FileName const & file) const
2318 if (file.exists()) {
2319 d->timestamp_ = file.lastModified();
2320 d->checksum_ = file.checksum();
2322 // in the case of save to a new file.
2329 void Buffer::markClean() const
2331 if (!d->lyx_clean) {
2332 d->lyx_clean = true;
2335 // if the .lyx file has been saved, we don't need an
2337 d->bak_clean = true;
2341 void Buffer::setUnnamed(bool flag)
2347 bool Buffer::isUnnamed() const
2354 /// Don't check unnamed, here: isInternal() is used in
2355 /// newBuffer(), where the unnamed flag has not been set by anyone
2356 /// yet. Also, for an internal buffer, there should be no need for
2357 /// retrieving fileName() nor for checking if it is unnamed or not.
2358 bool Buffer::isInternal() const
2360 return fileName().extension() == "internal";
2364 void Buffer::markDirty()
2367 d->lyx_clean = false;
2370 d->bak_clean = false;
2372 DepClean::iterator it = d->dep_clean.begin();
2373 DepClean::const_iterator const end = d->dep_clean.end();
2375 for (; it != end; ++it)
2380 FileName Buffer::fileName() const
2386 string Buffer::absFileName() const
2388 return d->filename.absFilename();
2392 string Buffer::filePath() const
2394 return d->filename.onlyPath().absFilename() + "/";
2398 bool Buffer::isReadonly() const
2400 return d->read_only;
2404 void Buffer::setParent(Buffer const * buffer)
2406 // Avoids recursive include.
2407 d->setParent(buffer == this ? 0 : buffer);
2412 Buffer const * Buffer::parent() const
2418 void Buffer::Impl::collectRelatives(BufferSet & bufs) const
2420 bufs.insert(owner_);
2422 parent()->d->collectRelatives(bufs);
2424 // loop over children
2425 BufferPositionMap::const_iterator it = children_positions.begin();
2426 BufferPositionMap::const_iterator end = children_positions.end();
2427 for (; it != end; ++it)
2428 bufs.insert(const_cast<Buffer *>(it->first));
2432 std::vector<Buffer const *> Buffer::allRelatives() const
2435 d->collectRelatives(bufs);
2436 BufferSet::iterator it = bufs.begin();
2437 std::vector<Buffer const *> ret;
2438 for (; it != bufs.end(); ++it)
2444 Buffer const * Buffer::masterBuffer() const
2446 Buffer const * const pbuf = d->parent();
2450 return pbuf->masterBuffer();
2454 bool Buffer::isChild(Buffer * child) const
2456 return d->children_positions.find(child) != d->children_positions.end();
2460 DocIterator Buffer::firstChildPosition(Buffer const * child)
2462 Impl::BufferPositionMap::iterator it;
2463 it = d->children_positions.find(child);
2464 if (it == d->children_positions.end())
2465 return DocIterator(this);
2470 void Buffer::getChildren(std::vector<Buffer *> & clist, bool grand_children) const
2472 // loop over children
2473 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2474 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2475 for (; it != end; ++it) {
2476 Buffer * child = const_cast<Buffer *>(it->first);
2477 clist.push_back(child);
2478 if (grand_children) {
2479 // there might be grandchildren
2480 vector<Buffer *> glist = child->getChildren();
2481 clist.insert(clist.end(), glist.begin(), glist.end());
2487 vector<Buffer *> Buffer::getChildren(bool grand_children) const
2490 getChildren(v, grand_children);
2495 template<typename M>
2496 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2501 typename M::const_iterator it = m.lower_bound(x);
2502 if (it == m.begin())
2510 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2511 DocIterator const & pos) const
2513 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2515 // if paragraphs have no macro context set, pos will be empty
2519 // we haven't found anything yet
2520 DocIterator bestPos = owner_->par_iterator_begin();
2521 MacroData const * bestData = 0;
2523 // find macro definitions for name
2524 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2525 if (nameIt != macros.end()) {
2526 // find last definition in front of pos or at pos itself
2527 PositionScopeMacroMap::const_iterator it
2528 = greatest_below(nameIt->second, pos);
2529 if (it != nameIt->second.end()) {
2531 // scope ends behind pos?
2532 if (pos < it->second.first) {
2533 // Looks good, remember this. If there
2534 // is no external macro behind this,
2535 // we found the right one already.
2536 bestPos = it->first;
2537 bestData = &it->second.second;
2541 // try previous macro if there is one
2542 if (it == nameIt->second.begin())
2549 // find macros in included files
2550 PositionScopeBufferMap::const_iterator it
2551 = greatest_below(position_to_children, pos);
2552 if (it == position_to_children.end())
2553 // no children before
2557 // do we know something better (i.e. later) already?
2558 if (it->first < bestPos )
2561 // scope ends behind pos?
2562 if (pos < it->second.first) {
2563 // look for macro in external file
2565 MacroData const * data
2566 = it->second.second->getMacro(name, false);
2569 bestPos = it->first;
2575 // try previous file if there is one
2576 if (it == position_to_children.begin())
2581 // return the best macro we have found
2586 MacroData const * Buffer::getMacro(docstring const & name,
2587 DocIterator const & pos, bool global) const
2592 // query buffer macros
2593 MacroData const * data = d->getBufferMacro(name, pos);
2597 // If there is a master buffer, query that
2598 Buffer const * const pbuf = d->parent();
2600 d->macro_lock = true;
2601 MacroData const * macro = pbuf->getMacro(
2602 name, *this, false);
2603 d->macro_lock = false;
2609 data = MacroTable::globalMacros().get(name);
2618 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2620 // set scope end behind the last paragraph
2621 DocIterator scope = par_iterator_begin();
2622 scope.pit() = scope.lastpit() + 1;
2624 return getMacro(name, scope, global);
2628 MacroData const * Buffer::getMacro(docstring const & name,
2629 Buffer const & child, bool global) const
2631 // look where the child buffer is included first
2632 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2633 if (it == d->children_positions.end())
2636 // check for macros at the inclusion position
2637 return getMacro(name, it->second, global);
2641 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2643 pit_type const lastpit = it.lastpit();
2645 // look for macros in each paragraph
2646 while (it.pit() <= lastpit) {
2647 Paragraph & par = it.paragraph();
2649 // iterate over the insets of the current paragraph
2650 InsetList const & insets = par.insetList();
2651 InsetList::const_iterator iit = insets.begin();
2652 InsetList::const_iterator end = insets.end();
2653 for (; iit != end; ++iit) {
2654 it.pos() = iit->pos;
2656 // is it a nested text inset?
2657 if (iit->inset->asInsetText()) {
2658 // Inset needs its own scope?
2659 InsetText const * itext = iit->inset->asInsetText();
2660 bool newScope = itext->isMacroScope();
2662 // scope which ends just behind the inset
2663 DocIterator insetScope = it;
2666 // collect macros in inset
2667 it.push_back(CursorSlice(*iit->inset));
2668 updateMacros(it, newScope ? insetScope : scope);
2673 // is it an external file?
2674 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2675 // get buffer of external file
2676 InsetInclude const & inset =
2677 static_cast<InsetInclude const &>(*iit->inset);
2679 Buffer * child = inset.getChildBuffer();
2684 // register its position, but only when it is
2685 // included first in the buffer
2686 if (children_positions.find(child) ==
2687 children_positions.end())
2688 children_positions[child] = it;
2690 // register child with its scope
2691 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2695 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2699 MathMacroTemplate & macroTemplate =
2700 static_cast<MathMacroTemplate &>(*iit->inset);
2701 MacroContext mc(owner_, it);
2702 macroTemplate.updateToContext(mc);
2705 bool valid = macroTemplate.validMacro();
2706 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2707 // then the BufferView's cursor will be invalid in
2708 // some cases which leads to crashes.
2713 // FIXME (Abdel), I don't understandt why we pass 'it' here
2714 // instead of 'macroTemplate' defined above... is this correct?
2715 macros[macroTemplate.name()][it] =
2716 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2726 void Buffer::updateMacros() const
2731 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2733 // start with empty table
2735 d->children_positions.clear();
2736 d->position_to_children.clear();
2738 // Iterate over buffer, starting with first paragraph
2739 // The scope must be bigger than any lookup DocIterator
2740 // later. For the global lookup, lastpit+1 is used, hence
2741 // we use lastpit+2 here.
2742 DocIterator it = par_iterator_begin();
2743 DocIterator outerScope = it;
2744 outerScope.pit() = outerScope.lastpit() + 2;
2745 d->updateMacros(it, outerScope);
2749 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2751 InsetIterator it = inset_iterator_begin(inset());
2752 InsetIterator const end = inset_iterator_end(inset());
2753 for (; it != end; ++it) {
2754 if (it->lyxCode() == BRANCH_CODE) {
2755 InsetBranch & br = static_cast<InsetBranch &>(*it);
2756 docstring const name = br.branch();
2757 if (!from_master && !params().branchlist().find(name))
2758 result.push_back(name);
2759 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2760 result.push_back(name);
2763 if (it->lyxCode() == INCLUDE_CODE) {
2764 // get buffer of external file
2765 InsetInclude const & ins =
2766 static_cast<InsetInclude const &>(*it);
2767 Buffer * child = ins.getChildBuffer();
2770 child->getUsedBranches(result, true);
2773 // remove duplicates
2778 void Buffer::updateMacroInstances() const
2780 LYXERR(Debug::MACROS, "updateMacroInstances for "
2781 << d->filename.onlyFileName());
2782 DocIterator it = doc_iterator_begin(this);
2784 DocIterator const end = doc_iterator_end(this);
2785 for (; it != end; it.forwardInset()) {
2786 // look for MathData cells in InsetMathNest insets
2787 InsetMath * minset = it.nextInset()->asInsetMath();
2791 // update macro in all cells of the InsetMathNest
2792 DocIterator::idx_type n = minset->nargs();
2793 MacroContext mc = MacroContext(this, it);
2794 for (DocIterator::idx_type i = 0; i < n; ++i) {
2795 MathData & data = minset->cell(i);
2796 data.updateMacros(0, mc);
2802 void Buffer::listMacroNames(MacroNameSet & macros) const
2807 d->macro_lock = true;
2809 // loop over macro names
2810 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2811 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2812 for (; nameIt != nameEnd; ++nameIt)
2813 macros.insert(nameIt->first);
2815 // loop over children
2816 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2817 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2818 for (; it != end; ++it)
2819 it->first->listMacroNames(macros);
2822 Buffer const * const pbuf = d->parent();
2824 pbuf->listMacroNames(macros);
2826 d->macro_lock = false;
2830 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2832 Buffer const * const pbuf = d->parent();
2837 pbuf->listMacroNames(names);
2840 MacroNameSet::iterator it = names.begin();
2841 MacroNameSet::iterator end = names.end();
2842 for (; it != end; ++it) {
2844 MacroData const * data =
2845 pbuf->getMacro(*it, *this, false);
2847 macros.insert(data);
2849 // we cannot access the original MathMacroTemplate anymore
2850 // here to calls validate method. So we do its work here manually.
2851 // FIXME: somehow make the template accessible here.
2852 if (data->optionals() > 0)
2853 features.require("xargs");
2859 Buffer::References & Buffer::references(docstring const & label)
2862 return const_cast<Buffer *>(masterBuffer())->references(label);
2864 RefCache::iterator it = d->ref_cache_.find(label);
2865 if (it != d->ref_cache_.end())
2866 return it->second.second;
2868 static InsetLabel const * dummy_il = 0;
2869 static References const dummy_refs;
2870 it = d->ref_cache_.insert(
2871 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2872 return it->second.second;
2876 Buffer::References const & Buffer::references(docstring const & label) const
2878 return const_cast<Buffer *>(this)->references(label);
2882 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2884 masterBuffer()->d->ref_cache_[label].first = il;
2888 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2890 return masterBuffer()->d->ref_cache_[label].first;
2894 void Buffer::clearReferenceCache() const
2897 d->ref_cache_.clear();
2901 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2904 //FIXME: This does not work for child documents yet.
2905 LASSERT(code == CITE_CODE, /**/);
2906 // Check if the label 'from' appears more than once
2907 vector<docstring> labels;
2909 checkBibInfoCache();
2910 BiblioInfo const & keys = masterBibInfo();
2911 BiblioInfo::const_iterator bit = keys.begin();
2912 BiblioInfo::const_iterator bend = keys.end();
2914 for (; bit != bend; ++bit)
2916 labels.push_back(bit->first);
2919 if (count(labels.begin(), labels.end(), from) > 1)
2922 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2923 if (it->lyxCode() == code) {
2924 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2925 docstring const oldValue = inset.getParam(paramName);
2926 if (oldValue == from)
2927 inset.setParam(paramName, to);
2933 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2934 pit_type par_end, bool full_source) const
2936 OutputParams runparams(¶ms().encoding());
2937 runparams.nice = true;
2938 runparams.flavor = params().useXetex ?
2939 OutputParams::XETEX : OutputParams::LATEX;
2940 runparams.linelen = lyxrc.plaintext_linelen;
2941 // No side effect of file copying and image conversion
2942 runparams.dryrun = true;
2945 os << "% " << _("Preview source code") << "\n\n";
2947 d->texrow.newline();
2948 d->texrow.newline();
2950 writeDocBookSource(os, absFileName(), runparams, false);
2952 // latex or literate
2953 writeLaTeXSource(os, string(), runparams, true, true);
2955 runparams.par_begin = par_begin;
2956 runparams.par_end = par_end;
2957 if (par_begin + 1 == par_end) {
2959 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2963 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2964 convert<docstring>(par_begin),
2965 convert<docstring>(par_end - 1))
2972 // output paragraphs
2974 docbookParagraphs(text(), *this, os, runparams);
2976 // latex or literate
2977 latexParagraphs(*this, text(), os, texrow, runparams);
2982 ErrorList & Buffer::errorList(string const & type) const
2984 static ErrorList emptyErrorList;
2985 map<string, ErrorList>::iterator it = d->errorLists.find(type);
2986 if (it == d->errorLists.end())
2987 return emptyErrorList;
2993 void Buffer::updateTocItem(std::string const & type,
2994 DocIterator const & dit) const
2997 d->gui_->updateTocItem(type, dit);
3001 void Buffer::structureChanged() const
3004 d->gui_->structureChanged();
3008 void Buffer::errors(string const & err, bool from_master) const
3011 d->gui_->errors(err, from_master);
3015 void Buffer::message(docstring const & msg) const
3018 d->gui_->message(msg);
3022 void Buffer::setBusy(bool on) const
3025 d->gui_->setBusy(on);
3029 void Buffer::updateTitles() const
3032 d->wa_->updateTitles();
3036 void Buffer::resetAutosaveTimers() const
3039 d->gui_->resetAutosaveTimers();
3043 bool Buffer::hasGuiDelegate() const
3049 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3058 class AutoSaveBuffer : public ForkedProcess {
3061 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3062 : buffer_(buffer), fname_(fname) {}
3064 virtual boost::shared_ptr<ForkedProcess> clone() const
3066 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3071 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3072 from_utf8(fname_.absFilename())));
3073 return run(DontWait);
3077 virtual int generateChild();
3079 Buffer const & buffer_;
3084 int AutoSaveBuffer::generateChild()
3086 #if defined(__APPLE__)
3087 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3088 * We should use something else like threads.
3090 * Since I do not know how to determine at run time what is the OS X
3091 * version, I just disable forking altogether for now (JMarc)
3093 pid_t const pid = -1;
3095 // tmp_ret will be located (usually) in /tmp
3096 // will that be a problem?
3097 // Note that this calls ForkedCalls::fork(), so it's
3098 // ok cross-platform.
3099 pid_t const pid = fork();
3100 // If you want to debug the autosave
3101 // you should set pid to -1, and comment out the fork.
3102 if (pid != 0 && pid != -1)
3106 // pid = -1 signifies that lyx was unable
3107 // to fork. But we will do the save
3109 bool failed = false;
3110 FileName const tmp_ret = FileName::tempName("lyxauto");
3111 if (!tmp_ret.empty()) {
3112 buffer_.writeFile(tmp_ret);
3113 // assume successful write of tmp_ret
3114 if (!tmp_ret.moveTo(fname_))
3120 // failed to write/rename tmp_ret so try writing direct
3121 if (!buffer_.writeFile(fname_)) {
3122 // It is dangerous to do this in the child,
3123 // but safe in the parent, so...
3124 if (pid == -1) // emit message signal.
3125 buffer_.message(_("Autosave failed!"));
3129 if (pid == 0) // we are the child so...
3138 FileName Buffer::getAutosaveFilename() const
3140 // if the document is unnamed try to save in the backup dir, else
3141 // in the default document path, and as a last try in the filePath,
3142 // which will most often be the temporary directory
3145 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3146 : lyxrc.backupdir_path;
3147 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3150 string const fname = "#" + d->filename.onlyFileName() + "#";
3151 return makeAbsPath(fname, fpath);
3155 void Buffer::removeAutosaveFile() const
3157 FileName const f = getAutosaveFilename();
3163 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3165 FileName const newauto = getAutosaveFilename();
3167 if (newauto != oldauto && oldauto.exists())
3168 if (!oldauto.moveTo(newauto))
3169 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3173 // Perfect target for a thread...
3174 void Buffer::autoSave() const
3176 if (d->bak_clean || isReadonly()) {
3177 // We don't save now, but we'll try again later
3178 resetAutosaveTimers();
3182 // emit message signal.
3183 message(_("Autosaving current document..."));
3184 AutoSaveBuffer autosave(*this, getAutosaveFilename());
3187 d->bak_clean = true;
3189 resetAutosaveTimers();
3193 string Buffer::bufferFormat() const
3195 string format = params().documentClass().outputFormat();
3196 if (format == "latex") {
3197 if (params().useXetex)
3199 if (params().encoding().package() == Encoding::japanese)
3206 string Buffer::getDefaultOutputFormat() const
3208 if (!params().defaultOutputFormat.empty()
3209 && params().defaultOutputFormat != "default")
3210 return params().defaultOutputFormat;
3211 typedef vector<Format const *> Formats;
3212 Formats formats = exportableFormats(true);
3215 || params().useXetex
3216 || params().encoding().package() == Encoding::japanese) {
3217 if (formats.empty())
3219 // return the first we find
3220 return formats.front()->name();
3222 return lyxrc.default_view_format;
3227 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3228 bool includeall, string & result_file) const
3230 string backend_format;
3231 OutputParams runparams(¶ms().encoding());
3232 runparams.flavor = OutputParams::LATEX;
3233 runparams.linelen = lyxrc.plaintext_linelen;
3234 runparams.includeall = includeall;
3235 vector<string> backs = backends();
3236 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3237 // Get shortest path to format
3238 Graph::EdgePath path;
3239 for (vector<string>::const_iterator it = backs.begin();
3240 it != backs.end(); ++it) {
3241 Graph::EdgePath p = theConverters().getPath(*it, format);
3242 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3243 backend_format = *it;
3248 if (!put_in_tempdir) {
3249 // Only show this alert if this is an export to a non-temporary
3250 // file (not for previewing).
3251 Alert::error(_("Couldn't export file"), bformat(
3252 _("No information for exporting the format %1$s."),
3253 formats.prettyName(format)));
3257 runparams.flavor = theConverters().getFlavor(path);
3260 backend_format = format;
3261 // FIXME: Don't hardcode format names here, but use a flag
3262 if (backend_format == "pdflatex")
3263 runparams.flavor = OutputParams::PDFLATEX;
3266 string filename = latexName(false);
3267 filename = addName(temppath(), filename);
3268 filename = changeExtension(filename,
3269 formats.extension(backend_format));
3272 updateMacroInstances();
3274 // Plain text backend
3275 if (backend_format == "text") {
3276 runparams.flavor = OutputParams::TEXT;
3277 writePlaintextFile(*this, FileName(filename), runparams);
3280 else if (backend_format == "xhtml") {
3281 runparams.flavor = OutputParams::HTML;
3282 switch (params().html_math_output) {
3283 case BufferParams::MathML:
3284 runparams.math_flavor = OutputParams::MathAsMathML;
3286 case BufferParams::HTML:
3287 runparams.math_flavor = OutputParams::MathAsHTML;
3289 case BufferParams::Images:
3290 runparams.math_flavor = OutputParams::MathAsImages;
3292 case BufferParams::LaTeX:
3293 runparams.math_flavor = OutputParams::MathAsLaTeX;
3297 makeLyXHTMLFile(FileName(filename), runparams);
3298 } else if (backend_format == "lyx")
3299 writeFile(FileName(filename));
3301 else if (isDocBook()) {
3302 runparams.nice = !put_in_tempdir;
3303 makeDocBookFile(FileName(filename), runparams);
3306 else if (backend_format == format) {
3307 runparams.nice = true;
3308 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3310 } else if (!lyxrc.tex_allows_spaces
3311 && contains(filePath(), ' ')) {
3312 Alert::error(_("File name error"),
3313 _("The directory path to the document cannot contain spaces."));
3316 runparams.nice = false;
3317 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3321 string const error_type = (format == "program")
3322 ? "Build" : bufferFormat();
3323 ErrorList & error_list = d->errorLists[error_type];
3324 string const ext = formats.extension(format);
3325 FileName const tmp_result_file(changeExtension(filename, ext));
3326 bool const success = theConverters().convert(this, FileName(filename),
3327 tmp_result_file, FileName(absFileName()), backend_format, format,
3330 // Emit the signal to show the error list or copy it back to the
3331 // cloned Buffer so that it cab be emitted afterwards.
3332 if (format != backend_format) {
3333 if (d->cloned_buffer_) {
3334 d->cloned_buffer_->d->errorLists[error_type] =
3335 d->errorLists[error_type];
3338 // also to the children, in case of master-buffer-view
3339 std::vector<Buffer *> clist = getChildren();
3340 for (vector<Buffer *>::const_iterator cit = clist.begin();
3341 cit != clist.end(); ++cit) {
3342 if (d->cloned_buffer_) {
3343 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3344 (*cit)->d->errorLists[error_type];
3346 (*cit)->errors(error_type, true);
3350 if (d->cloned_buffer_) {
3351 // Enable reverse dvi or pdf to work by copying back the texrow
3352 // object to the cloned buffer.
3353 // FIXME: There is a possibility of concurrent access to texrow
3354 // here from the main GUI thread that should be securized.
3355 d->cloned_buffer_->d->texrow = d->texrow;
3356 string const error_type = bufferFormat();
3357 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3363 if (put_in_tempdir) {
3364 result_file = tmp_result_file.absFilename();
3368 result_file = changeExtension(d->exportFileName().absFilename(), ext);
3369 // We need to copy referenced files (e. g. included graphics
3370 // if format == "dvi") to the result dir.
3371 vector<ExportedFile> const files =
3372 runparams.exportdata->externalFiles(format);
3373 string const dest = onlyPath(result_file);
3374 CopyStatus status = SUCCESS;
3376 vector<ExportedFile>::const_iterator it = files.begin();
3377 vector<ExportedFile>::const_iterator const en = files.end();
3378 for (; it != en && status != CANCEL; ++it) {
3379 string const fmt = formats.getFormatFromFile(it->sourceName);
3380 status = copyFile(fmt, it->sourceName,
3381 makeAbsPath(it->exportName, dest),
3382 it->exportName, status == FORCE);
3385 if (status == CANCEL) {
3386 message(_("Document export cancelled."));
3387 } else if (tmp_result_file.exists()) {
3388 // Finally copy the main file
3389 status = copyFile(format, tmp_result_file,
3390 FileName(result_file), result_file,
3392 message(bformat(_("Document exported as %1$s "
3394 formats.prettyName(format),
3395 makeDisplayPath(result_file)));
3397 // This must be a dummy converter like fax (bug 1888)
3398 message(bformat(_("Document exported as %1$s"),
3399 formats.prettyName(format)));
3406 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3407 bool includeall) const
3410 // (1) export with all included children (omit \includeonly)
3411 if (includeall && !doExport(format, put_in_tempdir, true, result_file))
3413 // (2) export with included children only
3414 return doExport(format, put_in_tempdir, false, result_file);
3418 bool Buffer::preview(string const & format, bool includeall) const
3421 // (1) export with all included children (omit \includeonly)
3422 if (includeall && !doExport(format, true, true))
3424 // (2) export with included children only
3425 if (!doExport(format, true, false, result_file))
3427 return formats.view(*this, FileName(result_file), format);
3431 bool Buffer::isExportable(string const & format) const
3433 vector<string> backs = backends();
3434 for (vector<string>::const_iterator it = backs.begin();
3435 it != backs.end(); ++it)
3436 if (theConverters().isReachable(*it, format))
3442 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3444 vector<string> const backs = backends();
3445 vector<Format const *> result =
3446 theConverters().getReachable(backs[0], only_viewable, true);
3447 for (vector<string>::const_iterator it = backs.begin() + 1;
3448 it != backs.end(); ++it) {
3449 vector<Format const *> r =
3450 theConverters().getReachable(*it, only_viewable, false);
3451 result.insert(result.end(), r.begin(), r.end());
3457 vector<string> Buffer::backends() const
3460 v.push_back(bufferFormat());
3461 // FIXME: Don't hardcode format names here, but use a flag
3462 if (v.back() == "latex")
3463 v.push_back("pdflatex");
3464 v.push_back("xhtml");
3465 v.push_back("text");
3471 bool Buffer::readFileHelper(FileName const & s)
3473 // File information about normal file
3475 docstring const file = makeDisplayPath(s.absFilename(), 50);
3476 docstring text = bformat(_("The specified document\n%1$s"
3477 "\ncould not be read."), file);
3478 Alert::error(_("Could not read document"), text);
3482 // Check if emergency save file exists and is newer.
3483 FileName const e(s.absFilename() + ".emergency");
3485 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3486 docstring const file = makeDisplayPath(s.absFilename(), 20);
3487 docstring const text =
3488 bformat(_("An emergency save of the document "
3490 "Recover emergency save?"), file);
3491 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3492 _("&Recover"), _("&Load Original"),
3496 // the file is not saved if we load the emergency file.
3501 if ((res = readFile(e)) == success)
3502 str = _("Document was successfully recovered.");
3504 str = _("Document was NOT successfully recovered.");
3505 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3506 makeDisplayPath(e.absFilename()));
3508 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3509 _("&Remove"), _("&Keep it"))) {
3512 Alert::warning(_("Emergency file deleted"),
3513 _("Do not forget to save your file now!"), true);
3518 if (!Alert::prompt(_("Delete emergency file?"),
3519 _("Remove emergency file now?"), 1, 1,
3520 _("&Remove"), _("&Keep it")))
3528 // Now check if autosave file is newer.
3529 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3531 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3532 docstring const file = makeDisplayPath(s.absFilename(), 20);
3533 docstring const text =
3534 bformat(_("The backup of the document "
3535 "%1$s is newer.\n\nLoad the "
3536 "backup instead?"), file);
3537 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3538 _("&Load backup"), _("Load &original"),
3542 // the file is not saved if we load the autosave file.
3546 // Here we delete the autosave
3557 bool Buffer::loadLyXFile(FileName const & s)
3559 // If the file is not readable, we try to
3560 // retrieve the file from version control.
3561 if (!s.isReadableFile()
3562 && !LyXVC::file_not_found_hook(s))
3565 if (s.isReadableFile()){
3566 // InsetInfo needs to know if file is under VCS
3567 lyxvc().file_found_hook(s);
3568 if (readFileHelper(s)) {
3569 d->read_only = !s.isWritable();
3577 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3579 TeXErrors::Errors::const_iterator cit = terr.begin();
3580 TeXErrors::Errors::const_iterator end = terr.end();
3582 for (; cit != end; ++cit) {
3585 int errorRow = cit->error_in_line;
3586 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3592 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3593 } while (found && id_start == id_end && pos_start == pos_end);
3595 errorList.push_back(ErrorItem(cit->error_desc,
3596 cit->error_text, id_start, pos_start, pos_end));
3601 void Buffer::setBuffersForInsets() const
3603 inset().setBuffer(const_cast<Buffer &>(*this));
3607 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3609 // Use the master text class also for child documents
3610 Buffer const * const master = masterBuffer();
3611 DocumentClass const & textclass = master->params().documentClass();
3613 // do this only if we are the top-level Buffer
3614 if (scope != UpdateMaster || master == this)
3615 checkBibInfoCache();
3617 // keep the buffers to be children in this set. If the call from the
3618 // master comes back we can see which of them were actually seen (i.e.
3619 // via an InsetInclude). The remaining ones in the set need still be updated.
3620 static std::set<Buffer const *> bufToUpdate;
3621 if (scope == UpdateMaster) {
3622 // If this is a child document start with the master
3623 if (master != this) {
3624 bufToUpdate.insert(this);
3625 master->updateBuffer(UpdateMaster, utype);
3626 // Do this here in case the master has no gui associated with it. Then,
3627 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3628 if (!master->d->gui_)
3631 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3632 if (bufToUpdate.find(this) == bufToUpdate.end())
3636 // start over the counters in the master
3637 textclass.counters().reset();
3640 // update will be done below for this buffer
3641 bufToUpdate.erase(this);
3643 // update all caches
3644 clearReferenceCache();
3647 Buffer & cbuf = const_cast<Buffer &>(*this);
3649 LASSERT(!text().paragraphs().empty(), /**/);
3652 ParIterator parit = cbuf.par_iterator_begin();
3653 updateBuffer(parit, utype);
3656 // TocBackend update will be done later.
3659 cbuf.tocBackend().update();
3660 if (scope == UpdateMaster)
3661 cbuf.structureChanged();
3665 static depth_type getDepth(DocIterator const & it)
3667 depth_type depth = 0;
3668 for (size_t i = 0 ; i < it.depth() ; ++i)
3669 if (!it[i].inset().inMathed())
3670 depth += it[i].paragraph().getDepth() + 1;
3671 // remove 1 since the outer inset does not count
3675 static depth_type getItemDepth(ParIterator const & it)
3677 Paragraph const & par = *it;
3678 LabelType const labeltype = par.layout().labeltype;
3680 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3683 // this will hold the lowest depth encountered up to now.
3684 depth_type min_depth = getDepth(it);
3685 ParIterator prev_it = it;
3688 --prev_it.top().pit();
3690 // start of nested inset: go to outer par
3692 if (prev_it.empty()) {
3693 // start of document: nothing to do
3698 // We search for the first paragraph with same label
3699 // that is not more deeply nested.
3700 Paragraph & prev_par = *prev_it;
3701 depth_type const prev_depth = getDepth(prev_it);
3702 if (labeltype == prev_par.layout().labeltype) {
3703 if (prev_depth < min_depth)
3704 return prev_par.itemdepth + 1;
3705 if (prev_depth == min_depth)
3706 return prev_par.itemdepth;
3708 min_depth = min(min_depth, prev_depth);
3709 // small optimization: if we are at depth 0, we won't
3710 // find anything else
3711 if (prev_depth == 0)
3717 static bool needEnumCounterReset(ParIterator const & it)
3719 Paragraph const & par = *it;
3720 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3721 depth_type const cur_depth = par.getDepth();
3722 ParIterator prev_it = it;
3723 while (prev_it.pit()) {
3724 --prev_it.top().pit();
3725 Paragraph const & prev_par = *prev_it;
3726 if (prev_par.getDepth() <= cur_depth)
3727 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3729 // start of nested inset: reset
3734 // set the label of a paragraph. This includes the counters.
3735 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
3737 BufferParams const & bp = owner_->masterBuffer()->params();
3738 DocumentClass const & textclass = bp.documentClass();
3739 Paragraph & par = it.paragraph();
3740 Layout const & layout = par.layout();
3741 Counters & counters = textclass.counters();
3743 if (par.params().startOfAppendix()) {
3744 // FIXME: only the counter corresponding to toplevel
3745 // sectioning should be reset
3747 counters.appendix(true);
3749 par.params().appendix(counters.appendix());
3751 // Compute the item depth of the paragraph
3752 par.itemdepth = getItemDepth(it);
3754 if (layout.margintype == MARGIN_MANUAL
3755 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3756 if (par.params().labelWidthString().empty())
3757 par.params().labelWidthString(par.expandLabel(layout, bp));
3759 par.params().labelWidthString(docstring());
3762 switch(layout.labeltype) {
3764 if (layout.toclevel <= bp.secnumdepth
3765 && (layout.latextype != LATEX_ENVIRONMENT
3766 || it.text()->isFirstInSequence(it.pit()))) {
3767 counters.step(layout.counter, utype);
3768 par.params().labelString(
3769 par.expandLabel(layout, bp));
3771 par.params().labelString(docstring());
3774 case LABEL_ITEMIZE: {
3775 // At some point of time we should do something more
3776 // clever here, like:
3777 // par.params().labelString(
3778 // bp.user_defined_bullet(par.itemdepth).getText());
3779 // for now, use a simple hardcoded label
3780 docstring itemlabel;
3781 switch (par.itemdepth) {
3783 itemlabel = char_type(0x2022);
3786 itemlabel = char_type(0x2013);
3789 itemlabel = char_type(0x2217);
3792 itemlabel = char_type(0x2219); // or 0x00b7
3795 par.params().labelString(itemlabel);
3799 case LABEL_ENUMERATE: {
3800 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3802 switch (par.itemdepth) {
3811 enumcounter += "iv";
3814 // not a valid enumdepth...
3818 // Maybe we have to reset the enumeration counter.
3819 if (needEnumCounterReset(it))
3820 counters.reset(enumcounter);
3821 counters.step(enumcounter, utype);
3823 string const & lang = par.getParLanguage(bp)->code();
3824 par.params().labelString(counters.theCounter(enumcounter, lang));
3829 case LABEL_SENSITIVE: {
3830 string const & type = counters.current_float();
3831 docstring full_label;
3833 full_label = owner_->B_("Senseless!!! ");
3835 docstring name = owner_->B_(textclass.floats().getType(type).name());
3836 if (counters.hasCounter(from_utf8(type))) {
3837 string const & lang = par.getParLanguage(bp)->code();
3838 counters.step(from_utf8(type), utype);
3839 full_label = bformat(from_ascii("%1$s %2$s:"),
3841 counters.theCounter(from_utf8(type), lang));
3843 full_label = bformat(from_ascii("%1$s #:"), name);
3845 par.params().labelString(full_label);
3849 case LABEL_NO_LABEL:
3850 par.params().labelString(docstring());
3854 case LABEL_TOP_ENVIRONMENT:
3855 case LABEL_CENTERED_TOP_ENVIRONMENT:
3858 par.params().labelString(par.expandLabel(layout, bp));
3864 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
3866 LASSERT(parit.pit() == 0, /**/);
3868 // set the position of the text in the buffer to be able
3869 // to resolve macros in it. This has nothing to do with
3870 // labels, but by putting it here we avoid implementing
3871 // a whole bunch of traversal routines just for this call.
3872 parit.text()->setMacrocontextPosition(parit);
3874 depth_type maxdepth = 0;
3875 pit_type const lastpit = parit.lastpit();
3876 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3877 // reduce depth if necessary
3878 parit->params().depth(min(parit->params().depth(), maxdepth));
3879 maxdepth = parit->getMaxDepthAfter();
3881 if (utype == OutputUpdate) {
3882 // track the active counters
3883 // we have to do this for the master buffer, since the local
3884 // buffer isn't tracking anything.
3885 masterBuffer()->params().documentClass().counters().
3886 setActiveLayout(parit->layout());
3889 // set the counter for this paragraph
3890 d->setLabel(parit, utype);
3893 InsetList::const_iterator iit = parit->insetList().begin();
3894 InsetList::const_iterator end = parit->insetList().end();
3895 for (; iit != end; ++iit) {
3896 parit.pos() = iit->pos;
3897 iit->inset->updateBuffer(parit, utype);
3903 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3904 WordLangTuple & word_lang, docstring_list & suggestions) const
3908 suggestions.clear();
3909 word_lang = WordLangTuple();
3910 // OK, we start from here.
3911 DocIterator const end = doc_iterator_end(this);
3912 for (; from != end; from.forwardPos()) {
3913 // We are only interested in text so remove the math CursorSlice.
3914 while (from.inMathed()) {
3918 // If from is at the end of the document (which is possible
3919 // when leaving the mathed) LyX will crash later.
3923 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {
3928 // Do not increase progress when from == to, otherwise the word
3929 // count will be wrong.
3939 bool Buffer::reload()
3943 removeAutosaveFile();
3944 // e.g., read-only status could have changed due to version control
3945 d->filename.refresh();
3946 docstring const disp_fn = makeDisplayPath(d->filename.absFilename());
3948 bool const success = loadLyXFile(d->filename);
3953 message(bformat(_("Document %1$s reloaded."), disp_fn));
3955 message(bformat(_("Could not reload document %1$s."), disp_fn));
3958 thePreviews().removeLoader(*this);
3959 if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
3960 thePreviews().generateBufferPreviews(*this);
3966 // FIXME We could do better here, but it is complicated. What would be
3967 // nice is to offer either (a) to save the child buffer to an appropriate
3968 // location, so that it would "move with the master", or else (b) to update
3969 // the InsetInclude so that it pointed to the same file. But (a) is a bit
3970 // complicated, because the code for this lives in GuiView.
3971 void Buffer::checkChildBuffers()
3973 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3974 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
3975 for (; it != en; ++it) {
3976 DocIterator dit = it->second;
3977 Buffer * cbuf = const_cast<Buffer *>(it->first);
3978 if (!cbuf || !theBufferList().isLoaded(cbuf))
3980 Inset * inset = dit.nextInset();
3981 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
3982 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
3983 docstring const & incfile = inset_inc->getParam("filename");
3984 string oldloc = cbuf->absFileName();
3985 string newloc = makeAbsPath(to_utf8(incfile),
3986 onlyPath(absFileName())).absFilename();
3987 if (oldloc == newloc)
3989 // the location of the child file is incorrect.
3990 Alert::warning(_("Included File Invalid"),
3991 bformat(_("Saving this document to a new location has made the file:\n"
3993 "inaccessible. You will need to update the included filename."),
3994 from_utf8(oldloc)));
3996 inset_inc->setChildBuffer(0);
3998 // invalidate cache of children
3999 d->children_positions.clear();
4000 d->position_to_children.clear();