3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibtex.h"
70 #include "insets/InsetBranch.h"
71 #include "insets/InsetInclude.h"
72 #include "insets/InsetTabular.h"
73 #include "insets/InsetText.h"
75 #include "mathed/InsetMathHull.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "graphics/PreviewLoader.h"
82 #include "frontends/alert.h"
83 #include "frontends/Delegates.h"
84 #include "frontends/WorkAreaManager.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include "support/bind.h"
107 #include "support/shared_ptr.h"
119 using namespace lyx::support;
120 using namespace lyx::graphics;
124 namespace Alert = frontend::Alert;
125 namespace os = support::os;
129 int const LYX_FORMAT = LYX_FORMAT_LYX;
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);
148 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
152 delete preview_loader_;
160 /// search for macro in local (buffer) table or in children
161 MacroData const * getBufferMacro(docstring const & name,
162 DocIterator const & pos) const;
164 /// Update macro table starting with position of it \param it in some
166 void updateMacros(DocIterator & it, DocIterator & scope);
168 void setLabel(ParIterator & it, UpdateType utype) const;
170 /** If we have branches that use the file suffix
171 feature, return the file name with suffix appended.
173 support::FileName exportFileName() const;
180 mutable TexRow texrow;
182 /// need to regenerate .tex?
186 mutable bool lyx_clean;
188 /// is autosave needed?
189 mutable bool bak_clean;
191 /// is this an unnamed file (New...)?
197 /// name of the file the buffer is associated with.
200 /** Set to true only when the file is fully loaded.
201 * Used to prevent the premature generation of previews
202 * and by the citation inset.
204 bool file_fully_loaded;
207 mutable TocBackend toc_backend;
210 typedef pair<DocIterator, MacroData> ScopeMacro;
211 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
212 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
213 /// map from the macro name to the position map,
214 /// which maps the macro definition position to the scope and the MacroData.
215 NamePositionScopeMacroMap macros;
216 /// This seem to change the way Buffer::getMacro() works
217 mutable bool macro_lock;
219 /// positions of child buffers in the buffer
220 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
221 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
222 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
223 /// position of children buffers in this buffer
224 BufferPositionMap children_positions;
225 /// map from children inclusion positions to their scope and their buffer
226 PositionScopeBufferMap position_to_children;
228 /// Container for all sort of Buffer dependant errors.
229 map<string, ErrorList> errorLists;
231 /// timestamp and checksum used to test if the file has been externally
232 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
234 unsigned long checksum_;
237 frontend::WorkAreaManager * wa_;
239 frontend::GuiBufferDelegate * gui_;
244 /// A cache for the bibfiles (including bibfiles of loaded child
245 /// documents), needed for appropriate update of natbib labels.
246 mutable support::FileNameList bibfiles_cache_;
248 // FIXME The caching mechanism could be improved. At present, we have a
249 // cache for each Buffer, that caches all the bibliography info for that
250 // Buffer. A more efficient solution would be to have a global cache per
251 // file, and then to construct the Buffer's bibinfo from that.
252 /// A cache for bibliography info
253 mutable BiblioInfo bibinfo_;
254 /// whether the bibinfo cache is valid
255 mutable bool bibinfo_cache_valid_;
256 /// whether the bibfile cache is valid
257 mutable bool bibfile_cache_valid_;
258 /// Cache of timestamps of .bib files
259 map<FileName, time_t> bibfile_status_;
260 /// Indicates whether the bibinfo has changed since the last time
261 /// we ran updateBuffer(), i.e., whether citation labels may need
263 mutable bool cite_labels_valid_;
265 mutable RefCache ref_cache_;
267 /// our Text that should be wrapped in an InsetText
271 PreviewLoader * preview_loader_;
273 /// This is here to force the test to be done whenever parent_buffer
275 Buffer const * parent() const {
276 // if parent_buffer is not loaded, then it has been unloaded,
277 // which means that parent_buffer is an invalid pointer. So we
278 // set it to null in that case.
279 // however, the BufferList doesn't know about cloned buffers, so
280 // they will always be regarded as unloaded. in that case, we hope
282 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
284 return parent_buffer;
288 void setParent(Buffer const * pb) {
289 if (parent_buffer == pb)
292 if (!cloned_buffer_ && parent_buffer && pb)
293 LYXERR0("Warning: a buffer should not have two parents!");
295 if (!cloned_buffer_ && parent_buffer) {
296 parent_buffer->invalidateBibfileCache();
297 parent_buffer->invalidateBibinfoCache();
301 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
302 /// This one is useful for preview detached in a thread.
303 Buffer const * cloned_buffer_;
304 /// are we in the process of exporting this buffer?
305 mutable bool doing_export;
308 /// So we can force access via the accessors.
309 mutable Buffer const * parent_buffer;
314 /// Creates the per buffer temporary directory
315 static FileName createBufferTmpDir()
318 // We are in our own directory. Why bother to mangle name?
319 // In fact I wrote this code to circumvent a problematic behaviour
320 // (bug?) of EMX mkstemp().
321 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
322 convert<string>(count++));
324 if (!tmpfl.createDirectory(0777)) {
325 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
326 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
327 from_utf8(tmpfl.absFileName())));
333 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
334 Buffer const * cloned_buffer)
335 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
336 read_only(readonly_), filename(file), file_fully_loaded(false),
337 toc_backend(owner), macro_lock(false), timestamp_(0), checksum_(0),
338 wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
339 bibfile_cache_valid_(false), cite_labels_valid_(false),
340 preview_loader_(0), cloned_buffer_(cloned_buffer),
341 doing_export(false), parent_buffer(0)
343 if (!cloned_buffer_) {
344 temppath = createBufferTmpDir();
345 lyxvc.setBuffer(owner_);
347 wa_ = new frontend::WorkAreaManager;
350 temppath = cloned_buffer_->d->temppath;
351 file_fully_loaded = true;
352 params = cloned_buffer_->d->params;
353 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
354 bibinfo_ = cloned_buffer_->d->bibinfo_;
355 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
356 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
357 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
358 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
359 unnamed = cloned_buffer_->d->unnamed;
363 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
364 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
366 LYXERR(Debug::INFO, "Buffer::Buffer()");
368 d->inset = new InsetText(*cloned_buffer->d->inset);
369 d->inset->setBuffer(*this);
370 // FIXME: optimize this loop somewhat, maybe by creating a new
371 // general recursive Inset::setId().
372 DocIterator it = doc_iterator_begin(this);
373 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
374 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
375 it.paragraph().setId(cloned_it.paragraph().id());
377 d->inset = new InsetText(this);
378 d->inset->setAutoBreakRows(true);
379 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
385 LYXERR(Debug::INFO, "Buffer::~Buffer()");
386 // here the buffer should take care that it is
387 // saved properly, before it goes into the void.
389 // GuiView already destroyed
393 // No need to do additional cleanups for internal buffer.
398 // loop over children
399 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
400 Impl::BufferPositionMap::iterator end = d->children_positions.end();
401 for (; it != end; ++it) {
402 Buffer * child = const_cast<Buffer *>(it->first);
403 if (d->cloned_buffer_)
405 // The child buffer might have been closed already.
406 else if (theBufferList().isLoaded(child))
407 theBufferList().releaseChild(this, child);
411 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
412 msg += emergencyWrite();
413 Alert::warning(_("Attempting to close changed document!"), msg);
416 // clear references to children in macro tables
417 d->children_positions.clear();
418 d->position_to_children.clear();
420 if (!d->cloned_buffer_ && !d->temppath.destroyDirectory()) {
421 Alert::warning(_("Could not remove temporary directory"),
422 bformat(_("Could not remove the temporary directory %1$s"),
423 from_utf8(d->temppath.absFileName())));
433 Buffer * Buffer::clone() const
436 masterBuffer()->clone(bufmap);
437 BufferMap::iterator it = bufmap.find(this);
438 LASSERT(it != bufmap.end(), return 0);
443 void Buffer::clone(BufferMap & bufmap) const
445 // have we already been cloned?
446 if (bufmap.find(this) != bufmap.end())
449 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
450 bufmap[this] = buffer_clone;
451 buffer_clone->d->macro_lock = true;
452 buffer_clone->d->children_positions.clear();
453 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
454 // math macro caches need to be rethought and simplified.
455 // I am not sure wether we should handle Buffer cloning here or in BufferList.
456 // Right now BufferList knows nothing about buffer clones.
457 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
458 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
459 for (; it != end; ++it) {
460 DocIterator dit = it->first.clone(buffer_clone);
461 dit.setBuffer(buffer_clone);
462 Buffer * child = const_cast<Buffer *>(it->second.second);
464 child->clone(bufmap);
465 BufferMap::iterator const bit = bufmap.find(child);
466 LASSERT(bit != bufmap.end(), continue);
467 Buffer * child_clone = bit->second;
469 Inset * inset = dit.nextInset();
470 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
471 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
472 inset_inc->setChildBuffer(child_clone);
473 child_clone->d->setParent(buffer_clone);
474 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
475 buffer_clone->setChild(dit, child_clone);
477 buffer_clone->d->macro_lock = false;
482 bool Buffer::isClone() const
484 return d->cloned_buffer_;
488 void Buffer::changed(bool update_metrics) const
491 d->wa_->redrawAll(update_metrics);
495 frontend::WorkAreaManager & Buffer::workAreaManager() const
497 LASSERT(d->wa_, /**/);
502 Text & Buffer::text() const
504 return d->inset->text();
508 Inset & Buffer::inset() const
514 BufferParams & Buffer::params()
520 BufferParams const & Buffer::params() const
526 ParagraphList & Buffer::paragraphs()
528 return text().paragraphs();
532 ParagraphList const & Buffer::paragraphs() const
534 return text().paragraphs();
538 LyXVC & Buffer::lyxvc()
544 LyXVC const & Buffer::lyxvc() const
550 string const Buffer::temppath() const
552 return d->temppath.absFileName();
556 TexRow & Buffer::texrow()
562 TexRow const & Buffer::texrow() const
568 TocBackend & Buffer::tocBackend() const
570 return d->toc_backend;
574 Undo & Buffer::undo()
580 void Buffer::setChild(DocIterator const & dit, Buffer * child)
582 d->children_positions[child] = dit;
586 string Buffer::latexName(bool const no_path) const
588 FileName latex_name =
589 makeLatexName(d->exportFileName());
590 return no_path ? latex_name.onlyFileName()
591 : latex_name.absFileName();
595 FileName Buffer::Impl::exportFileName() const
597 docstring const branch_suffix =
598 params.branchlist().getFileNameSuffix();
599 if (branch_suffix.empty())
602 string const name = filename.onlyFileNameWithoutExt()
603 + to_utf8(branch_suffix);
604 FileName res(filename.onlyPath().absFileName() + "/" + name);
605 res.changeExtension(filename.extension());
611 string Buffer::logName(LogType * type) const
613 string const filename = latexName(false);
615 if (filename.empty()) {
621 string const path = temppath();
623 FileName const fname(addName(temppath(),
624 onlyFileName(changeExtension(filename,
627 // FIXME: how do we know this is the name of the build log?
628 FileName const bname(
629 addName(path, onlyFileName(
630 changeExtension(filename,
631 formats.extension(params().bufferFormat()) + ".out"))));
633 // Also consider the master buffer log file
634 FileName masterfname = fname;
636 if (masterBuffer() != this) {
637 string const mlogfile = masterBuffer()->logName(&mtype);
638 masterfname = FileName(mlogfile);
641 // If no Latex log or Build log is newer, show Build log
642 if (bname.exists() &&
643 ((!fname.exists() && !masterfname.exists())
644 || (fname.lastModified() < bname.lastModified()
645 && masterfname.lastModified() < bname.lastModified()))) {
646 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
649 return bname.absFileName();
650 // If we have a newer master file log or only a master log, show this
651 } else if (fname != masterfname
652 && (!fname.exists() && (masterfname.exists()
653 || fname.lastModified() < masterfname.lastModified()))) {
654 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
657 return masterfname.absFileName();
659 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
662 return fname.absFileName();
666 void Buffer::setReadonly(bool const flag)
668 if (d->read_only != flag) {
675 void Buffer::setFileName(FileName const & fname)
678 setReadonly(d->filename.isReadOnly());
684 int Buffer::readHeader(Lexer & lex)
686 int unknown_tokens = 0;
688 int begin_header_line = -1;
690 // Initialize parameters that may be/go lacking in header:
691 params().branchlist().clear();
692 params().preamble.erase();
693 params().options.erase();
694 params().master.erase();
695 params().float_placement.erase();
696 params().paperwidth.erase();
697 params().paperheight.erase();
698 params().leftmargin.erase();
699 params().rightmargin.erase();
700 params().topmargin.erase();
701 params().bottommargin.erase();
702 params().headheight.erase();
703 params().headsep.erase();
704 params().footskip.erase();
705 params().columnsep.erase();
706 params().fonts_cjk.erase();
707 params().listings_params.clear();
708 params().clearLayoutModules();
709 params().clearRemovedModules();
710 params().clearIncludedChildren();
711 params().pdfoptions().clear();
712 params().indiceslist().clear();
713 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
714 params().isbackgroundcolor = false;
715 params().fontcolor = RGBColor(0, 0, 0);
716 params().isfontcolor = false;
717 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
718 params().boxbgcolor = RGBColor(0xFF, 0, 0);
719 params().html_latex_start.clear();
720 params().html_latex_end.clear();
721 params().html_math_img_scale = 1.0;
722 params().output_sync_macro.erase();
724 for (int i = 0; i < 4; ++i) {
725 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
726 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
729 ErrorList & errorList = d->errorLists["Parse"];
738 if (token == "\\end_header")
742 if (token == "\\begin_header") {
743 begin_header_line = line;
747 LYXERR(Debug::PARSER, "Handling document header token: `"
750 string unknown = params().readToken(lex, token, d->filename.onlyPath());
751 if (!unknown.empty()) {
752 if (unknown[0] != '\\' && token == "\\textclass") {
753 Alert::warning(_("Unknown document class"),
754 bformat(_("Using the default document class, because the "
755 "class %1$s is unknown."), from_utf8(unknown)));
758 docstring const s = bformat(_("Unknown token: "
762 errorList.push_back(ErrorItem(_("Document header error"),
767 if (begin_header_line) {
768 docstring const s = _("\\begin_header is missing");
769 errorList.push_back(ErrorItem(_("Document header error"),
773 params().makeDocumentClass();
775 return unknown_tokens;
780 // changed to be public and have one parameter
781 // Returns true if "\end_document" is not read (Asger)
782 bool Buffer::readDocument(Lexer & lex)
784 ErrorList & errorList = d->errorLists["Parse"];
787 // remove dummy empty par
788 paragraphs().clear();
790 if (!lex.checkFor("\\begin_document")) {
791 docstring const s = _("\\begin_document is missing");
792 errorList.push_back(ErrorItem(_("Document header error"),
798 if (params().outputChanges) {
799 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
800 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
801 LaTeXFeatures::isAvailable("xcolor");
803 if (!dvipost && !xcolorulem) {
804 Alert::warning(_("Changes not shown in LaTeX output"),
805 _("Changes will not be highlighted in LaTeX output, "
806 "because neither dvipost nor xcolor/ulem are installed.\n"
807 "Please install these packages or redefine "
808 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
809 } else if (!xcolorulem) {
810 Alert::warning(_("Changes not shown in LaTeX output"),
811 _("Changes will not be highlighted in LaTeX output "
812 "when using pdflatex, because xcolor and ulem are not installed.\n"
813 "Please install both packages or redefine "
814 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
818 if (!params().master.empty()) {
819 FileName const master_file = makeAbsPath(params().master,
820 onlyPath(absFileName()));
821 if (isLyXFileName(master_file.absFileName())) {
823 checkAndLoadLyXFile(master_file, true);
825 // necessary e.g. after a reload
826 // to re-register the child (bug 5873)
827 // FIXME: clean up updateMacros (here, only
828 // child registering is needed).
829 master->updateMacros();
830 // set master as master buffer, but only
831 // if we are a real child
832 if (master->isChild(this))
834 // if the master is not fully loaded
835 // it is probably just loading this
836 // child. No warning needed then.
837 else if (master->isFullyLoaded())
838 LYXERR0("The master '"
840 << "' assigned to this document ("
842 << ") does not include "
843 "this document. Ignoring the master assignment.");
848 // assure we have a default index
849 params().indiceslist().addDefault(B_("Index"));
852 bool const res = text().read(lex, errorList, d->inset);
854 // inform parent buffer about local macros
856 Buffer const * pbuf = parent();
857 UserMacroSet::const_iterator cit = usermacros.begin();
858 UserMacroSet::const_iterator end = usermacros.end();
859 for (; cit != end; ++cit)
860 pbuf->usermacros.insert(*cit);
864 updateMacroInstances(InternalUpdate);
869 bool Buffer::readString(string const & s)
871 params().compressed = false;
876 FileName const fn = FileName::tempName("Buffer_readString");
879 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
880 if (ret_plf != ReadSuccess)
883 if (file_format != LYX_FORMAT) {
884 // We need to call lyx2lyx, so write the input to a file
885 ofstream os(fn.toFilesystemEncoding().c_str());
889 return readFile(fn) == ReadSuccess;
892 if (readDocument(lex))
898 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
902 if (!lex.setFile(fname)) {
903 Alert::error(_("File Not Found"),
904 bformat(_("Unable to open file `%1$s'."),
905 from_utf8(fn.absFileName())));
906 return ReadFileNotFound;
910 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
911 if (ret_plf != ReadSuccess)
914 if (file_format != LYX_FORMAT) {
916 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
917 if (ret_clf != ReadSuccess)
919 return readFile(tmpFile);
922 // FIXME: InsetInfo needs to know whether the file is under VCS
923 // during the parse process, so this has to be done before.
924 lyxvc().file_found_hook(d->filename);
926 if (readDocument(lex)) {
927 Alert::error(_("Document format failure"),
928 bformat(_("%1$s ended unexpectedly, which means"
929 " that it is probably corrupted."),
930 from_utf8(fn.absFileName())));
931 return ReadDocumentFailure;
934 d->file_fully_loaded = true;
935 d->read_only = !d->filename.isWritable();
936 params().compressed = d->filename.isZippedFile();
942 bool Buffer::isFullyLoaded() const
944 return d->file_fully_loaded;
948 void Buffer::setFullyLoaded(bool value)
950 d->file_fully_loaded = value;
954 PreviewLoader * Buffer::loader() const
956 if (lyxrc.preview == LyXRC::PREVIEW_OFF)
958 if (!d->preview_loader_)
959 d->preview_loader_ = new PreviewLoader(*this);
960 return d->preview_loader_;
964 void Buffer::removePreviews() const
966 delete d->preview_loader_;
967 d->preview_loader_ = 0;
971 void Buffer::updatePreviews() const
973 PreviewLoader * ploader = loader();
977 InsetIterator it = inset_iterator_begin(*d->inset);
978 InsetIterator const end = inset_iterator_end(*d->inset);
979 for (; it != end; ++it)
980 it->addPreview(it, *ploader);
982 ploader->startLoading();
986 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
987 FileName const & fn, int & file_format) const
989 if(!lex.checkFor("\\lyxformat")) {
990 Alert::error(_("Document format failure"),
991 bformat(_("%1$s is not a readable LyX document."),
992 from_utf8(fn.absFileName())));
993 return ReadNoLyXFormat;
999 // LyX formats 217 and earlier were written as 2.17. This corresponds
1000 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1001 // these cases. See also: www.lyx.org/trac/changeset/1313.
1002 size_t dot = tmp_format.find_first_of(".,");
1003 if (dot != string::npos)
1004 tmp_format.erase(dot, 1);
1006 file_format = convert<int>(tmp_format);
1011 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1012 FileName & tmpfile, int from_format)
1014 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
1015 if(tmpfile.empty()) {
1016 Alert::error(_("Conversion failed"),
1017 bformat(_("%1$s is from a different"
1018 " version of LyX, but a temporary"
1019 " file for converting it could"
1020 " not be created."),
1021 from_utf8(fn.absFileName())));
1022 return LyX2LyXNoTempFile;
1025 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1026 if (lyx2lyx.empty()) {
1027 Alert::error(_("Conversion script not found"),
1028 bformat(_("%1$s is from a different"
1029 " version of LyX, but the"
1030 " conversion script lyx2lyx"
1031 " could not be found."),
1032 from_utf8(fn.absFileName())));
1033 return LyX2LyXNotFound;
1037 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1038 ostringstream command;
1039 command << os::python()
1040 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1041 << " -t " << convert<string>(LYX_FORMAT)
1042 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1043 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1044 string const command_str = command.str();
1046 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1048 cmd_ret const ret = runCommand(command_str);
1049 if (ret.first != 0) {
1050 if (from_format < LYX_FORMAT) {
1051 Alert::error(_("Conversion script failed"),
1052 bformat(_("%1$s is from an older version"
1053 " of LyX and the lyx2lyx script"
1054 " failed to convert it."),
1055 from_utf8(fn.absFileName())));
1056 return LyX2LyXOlderFormat;
1058 Alert::error(_("Conversion script failed"),
1059 bformat(_("%1$s is from a newer version"
1060 " of LyX and the lyx2lyx script"
1061 " failed to convert it."),
1062 from_utf8(fn.absFileName())));
1063 return LyX2LyXNewerFormat;
1070 // Should probably be moved to somewhere else: BufferView? GuiView?
1071 bool Buffer::save() const
1073 docstring const file = makeDisplayPath(absFileName(), 20);
1074 d->filename.refresh();
1076 // check the read-only status before moving the file as a backup
1077 if (d->filename.exists()) {
1078 bool const read_only = !d->filename.isWritable();
1080 Alert::warning(_("File is read-only"),
1081 bformat(_("The file %1$s cannot be written because it "
1082 "is marked as read-only."), file));
1087 // ask if the disk file has been externally modified (use checksum method)
1088 if (fileName().exists() && isExternallyModified(checksum_method)) {
1090 bformat(_("Document %1$s has been externally modified. "
1091 "Are you sure you want to overwrite this file?"), file);
1092 int const ret = Alert::prompt(_("Overwrite modified file?"),
1093 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1098 // We don't need autosaves in the immediate future. (Asger)
1099 resetAutosaveTimers();
1101 FileName backupName;
1102 bool madeBackup = false;
1104 // make a backup if the file already exists
1105 if (lyxrc.make_backup && fileName().exists()) {
1106 backupName = FileName(absFileName() + '~');
1107 if (!lyxrc.backupdir_path.empty()) {
1108 string const mangledName =
1109 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1110 backupName = FileName(addName(lyxrc.backupdir_path,
1114 // Except file is symlink do not copy because of #6587.
1115 // Hard links have bad luck.
1116 if (fileName().isSymLink())
1117 madeBackup = fileName().copyTo(backupName);
1119 madeBackup = fileName().moveTo(backupName);
1122 Alert::error(_("Backup failure"),
1123 bformat(_("Cannot create backup file %1$s.\n"
1124 "Please check whether the directory exists and is writable."),
1125 from_utf8(backupName.absFileName())));
1126 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1130 if (writeFile(d->filename)) {
1134 // Saving failed, so backup is not backup
1136 backupName.moveTo(d->filename);
1142 bool Buffer::writeFile(FileName const & fname) const
1144 // FIXME Do we need to do these here? I don't think writing
1145 // the LyX file depends upon it. (RGH)
1147 // updateMacroInstances();
1149 if (d->read_only && fname == d->filename)
1152 bool retval = false;
1154 docstring const str = bformat(_("Saving document %1$s..."),
1155 makeDisplayPath(fname.absFileName()));
1158 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1160 if (params().compressed) {
1161 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1162 retval = ofs && write(ofs);
1164 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1165 retval = ofs && write(ofs);
1169 message(str + _(" could not write file!"));
1174 // removeAutosaveFile();
1177 message(str + _(" done."));
1183 docstring Buffer::emergencyWrite()
1185 // No need to save if the buffer has not changed.
1189 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1191 docstring user_message = bformat(
1192 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1194 // We try to save three places:
1195 // 1) Same place as document. Unless it is an unnamed doc.
1197 string s = absFileName();
1200 if (writeFile(FileName(s))) {
1202 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1203 return user_message;
1205 user_message += " " + _("Save failed! Trying again...\n");
1209 // 2) In HOME directory.
1210 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1212 lyxerr << ' ' << s << endl;
1213 if (writeFile(FileName(s))) {
1215 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1216 return user_message;
1219 user_message += " " + _("Save failed! Trying yet again...\n");
1221 // 3) In "/tmp" directory.
1222 // MakeAbsPath to prepend the current
1223 // drive letter on OS/2
1224 s = addName(package().temp_dir().absFileName(), absFileName());
1226 lyxerr << ' ' << s << endl;
1227 if (writeFile(FileName(s))) {
1229 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1230 return user_message;
1233 user_message += " " + _("Save failed! Bummer. Document is lost.");
1236 return user_message;
1240 bool Buffer::write(ostream & ofs) const
1243 // Use the standard "C" locale for file output.
1244 ofs.imbue(locale::classic());
1247 // The top of the file should not be written by params().
1249 // write out a comment in the top of the file
1250 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1251 << " created this file. For more info see http://www.lyx.org/\n"
1252 << "\\lyxformat " << LYX_FORMAT << "\n"
1253 << "\\begin_document\n";
1255 /// For each author, set 'used' to true if there is a change
1256 /// by this author in the document; otherwise set it to 'false'.
1257 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1258 AuthorList::Authors::const_iterator a_end = params().authors().end();
1259 for (; a_it != a_end; ++a_it)
1260 a_it->setUsed(false);
1262 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1263 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1264 for ( ; it != end; ++it)
1265 it->checkAuthors(params().authors());
1267 // now write out the buffer parameters.
1268 ofs << "\\begin_header\n";
1269 params().writeFile(ofs);
1270 ofs << "\\end_header\n";
1273 ofs << "\n\\begin_body\n";
1275 ofs << "\n\\end_body\n";
1277 // Write marker that shows file is complete
1278 ofs << "\\end_document" << endl;
1280 // Shouldn't really be needed....
1283 // how to check if close went ok?
1284 // Following is an attempt... (BE 20001011)
1286 // good() returns false if any error occured, including some
1287 // formatting error.
1288 // bad() returns true if something bad happened in the buffer,
1289 // which should include file system full errors.
1294 lyxerr << "File was not closed properly." << endl;
1301 bool Buffer::makeLaTeXFile(FileName const & fname,
1302 string const & original_path,
1303 OutputParams const & runparams_in,
1304 bool output_preamble, bool output_body) const
1306 OutputParams runparams = runparams_in;
1308 // This is necessary for LuaTeX/XeTeX with tex fonts.
1309 // See FIXME in BufferParams::encoding()
1310 if (runparams.isFullUnicode())
1311 runparams.encoding = encodings.fromLyXName("utf8-plain");
1313 string const encoding = runparams.encoding->iconvName();
1314 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1317 try { ofs.reset(encoding); }
1318 catch (iconv_codecvt_facet_exception & e) {
1319 lyxerr << "Caught iconv exception: " << e.what() << endl;
1320 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1321 "verify that the support software for your encoding (%1$s) is "
1322 "properly installed"), from_ascii(encoding)));
1325 if (!openFileWrite(ofs, fname))
1328 //TexStream ts(ofs.rdbuf(), &texrow());
1329 ErrorList & errorList = d->errorLists["Export"];
1331 bool failed_export = false;
1332 otexstream os(ofs, d->texrow);
1334 // make sure we are ready to export
1335 // this needs to be done before we validate
1336 // FIXME Do we need to do this all the time? I.e., in children
1337 // of a master we are exporting?
1339 updateMacroInstances(OutputUpdate);
1342 os.texrow().reset();
1343 writeLaTeXSource(os, original_path,
1344 runparams, output_preamble, output_body);
1346 catch (EncodingException & e) {
1347 odocstringstream ods;
1348 ods.put(e.failed_char);
1350 oss << "0x" << hex << e.failed_char << dec;
1351 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1352 " (code point %2$s)"),
1353 ods.str(), from_utf8(oss.str()));
1354 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1355 "representable in the chosen encoding.\n"
1356 "Changing the document encoding to utf8 could help."),
1357 e.par_id, e.pos, e.pos + 1));
1358 failed_export = true;
1360 catch (iconv_codecvt_facet_exception & e) {
1361 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1362 _(e.what()), -1, 0, 0));
1363 failed_export = true;
1365 catch (exception const & e) {
1366 errorList.push_back(ErrorItem(_("conversion failed"),
1367 _(e.what()), -1, 0, 0));
1368 failed_export = true;
1371 lyxerr << "Caught some really weird exception..." << endl;
1377 failed_export = true;
1378 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1382 return !failed_export;
1386 void Buffer::writeLaTeXSource(otexstream & os,
1387 string const & original_path,
1388 OutputParams const & runparams_in,
1389 bool const output_preamble, bool const output_body) const
1391 // The child documents, if any, shall be already loaded at this point.
1393 OutputParams runparams = runparams_in;
1395 // Classify the unicode characters appearing in math insets
1396 Encodings::initUnicodeMath(*this);
1398 // validate the buffer.
1399 LYXERR(Debug::LATEX, " Validating buffer...");
1400 LaTeXFeatures features(*this, params(), runparams);
1402 LYXERR(Debug::LATEX, " Buffer validation done.");
1404 // The starting paragraph of the coming rows is the
1405 // first paragraph of the document. (Asger)
1406 if (output_preamble && runparams.nice) {
1407 os << "%% LyX " << lyx_version << " created this file. "
1408 "For more info, see http://www.lyx.org/.\n"
1409 "%% Do not edit unless you really know what "
1412 LYXERR(Debug::INFO, "lyx document header finished");
1414 // There are a few differences between nice LaTeX and usual files:
1415 // usual files have \batchmode and special input@path to allow
1416 // inclusion of figures specified by an explicitly relative path
1417 // (i.e., a path starting with './' or '../') with either \input or
1418 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1419 // input@path is set when the actual parameter original_path is set.
1420 // This is done for usual tex-file, but not for nice-latex-file.
1421 // (Matthias 250696)
1422 // Note that input@path is only needed for something the user does
1423 // in the preamble, included .tex files or ERT, files included by
1424 // LyX work without it.
1425 if (output_preamble) {
1426 if (!runparams.nice) {
1427 // code for usual, NOT nice-latex-file
1428 os << "\\batchmode\n"; // changed from \nonstopmode
1430 if (!original_path.empty()) {
1432 // We don't know the encoding of inputpath
1433 docstring const inputpath = from_utf8(original_path);
1434 docstring uncodable_glyphs;
1435 Encoding const * const enc = runparams.encoding;
1437 for (size_t n = 0; n < inputpath.size(); ++n) {
1438 docstring const glyph =
1439 docstring(1, inputpath[n]);
1440 if (enc->latexChar(inputpath[n], true) != glyph) {
1441 LYXERR0("Uncodable character '"
1443 << "' in input path!");
1444 uncodable_glyphs += glyph;
1449 // warn user if we found uncodable glyphs.
1450 if (!uncodable_glyphs.empty()) {
1451 frontend::Alert::warning(
1452 _("Uncodable character in file path"),
1454 _("The path of your document\n"
1456 "contains glyphs that are unknown "
1457 "in the current document encoding "
1458 "(namely %2$s). This may result in "
1459 "incomplete output, unless "
1460 "TEXINPUTS contains the document "
1461 "directory and you don't use "
1462 "explicitly relative paths (i.e., "
1463 "paths starting with './' or "
1464 "'../') in the preamble or in ERT."
1465 "\n\nIn case of problems, choose "
1466 "an appropriate document encoding\n"
1467 "(such as utf8) or change the "
1469 inputpath, uncodable_glyphs));
1472 support::latex_path(original_path);
1473 if (contains(docdir, '#')) {
1474 docdir = subst(docdir, "#", "\\#");
1475 os << "\\catcode`\\#=11"
1476 "\\def\\#{#}\\catcode`\\#=6\n";
1478 if (contains(docdir, '%')) {
1479 docdir = subst(docdir, "%", "\\%");
1480 os << "\\catcode`\\%=11"
1481 "\\def\\%{%}\\catcode`\\%=14\n";
1483 os << "\\makeatletter\n"
1484 << "\\def\\input@path{{"
1485 << docdir << "/}}\n"
1486 << "\\makeatother\n";
1490 // get parent macros (if this buffer has a parent) which will be
1491 // written at the document begin further down.
1492 MacroSet parentMacros;
1493 listParentMacros(parentMacros, features);
1495 runparams.use_polyglossia = features.usePolyglossia();
1496 // Write the preamble
1497 runparams.use_babel = params().writeLaTeX(os, features,
1498 d->filename.onlyPath());
1500 runparams.use_japanese = features.isRequired("japanese");
1506 os << "\\begin{document}\n";
1508 // output the parent macros
1509 MacroSet::iterator it = parentMacros.begin();
1510 MacroSet::iterator end = parentMacros.end();
1511 for (; it != end; ++it) {
1512 int num_lines = (*it)->write(os.os(), true);
1513 os.texrow().newlines(num_lines);
1516 } // output_preamble
1518 os.texrow().start(paragraphs().begin()->id(), 0);
1520 LYXERR(Debug::INFO, "preamble finished, now the body.");
1522 // if we are doing a real file with body, even if this is the
1523 // child of some other buffer, let's cut the link here.
1524 // This happens for example if only a child document is printed.
1525 Buffer const * save_parent = 0;
1526 if (output_preamble) {
1527 save_parent = d->parent();
1532 latexParagraphs(*this, text(), os, runparams);
1534 // Restore the parenthood if needed
1535 if (output_preamble)
1536 d->setParent(save_parent);
1538 // add this just in case after all the paragraphs
1541 if (output_preamble) {
1542 os << "\\end{document}\n";
1543 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1545 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1547 runparams_in.encoding = runparams.encoding;
1549 // Just to be sure. (Asger)
1550 os.texrow().newline();
1552 //for (int i = 0; i<d->texrow.rows(); i++) {
1554 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1555 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1558 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1559 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1563 void Buffer::makeDocBookFile(FileName const & fname,
1564 OutputParams const & runparams,
1565 bool const body_only) const
1567 LYXERR(Debug::LATEX, "makeDocBookFile...");
1570 if (!openFileWrite(ofs, fname))
1573 // make sure we are ready to export
1574 // this needs to be done before we validate
1576 updateMacroInstances(OutputUpdate);
1578 writeDocBookSource(ofs, fname.absFileName(), runparams, body_only);
1582 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1586 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1587 OutputParams const & runparams,
1588 bool const only_body) const
1590 LaTeXFeatures features(*this, params(), runparams);
1595 DocumentClass const & tclass = params().documentClass();
1596 string const top_element = tclass.latexname();
1599 if (runparams.flavor == OutputParams::XML)
1600 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1603 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1606 if (! tclass.class_header().empty())
1607 os << from_ascii(tclass.class_header());
1608 else if (runparams.flavor == OutputParams::XML)
1609 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1610 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1612 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1614 docstring preamble = from_utf8(params().preamble);
1615 if (runparams.flavor != OutputParams::XML ) {
1616 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1617 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1618 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1619 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1622 string const name = runparams.nice
1623 ? changeExtension(absFileName(), ".sgml") : fname;
1624 preamble += features.getIncludedFiles(name);
1625 preamble += features.getLyXSGMLEntities();
1627 if (!preamble.empty()) {
1628 os << "\n [ " << preamble << " ]";
1633 string top = top_element;
1635 if (runparams.flavor == OutputParams::XML)
1636 top += params().language->code();
1638 top += params().language->code().substr(0, 2);
1641 if (!params().options.empty()) {
1643 top += params().options;
1646 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1647 << " file was created by LyX " << lyx_version
1648 << "\n See http://www.lyx.org/ for more information -->\n";
1650 params().documentClass().counters().reset();
1652 sgml::openTag(os, top);
1654 docbookParagraphs(text(), *this, os, runparams);
1655 sgml::closeTag(os, top_element);
1659 void Buffer::makeLyXHTMLFile(FileName const & fname,
1660 OutputParams const & runparams) const
1662 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1665 if (!openFileWrite(ofs, fname))
1668 // make sure we are ready to export
1669 // this has to be done before we validate
1670 updateBuffer(UpdateMaster, OutputUpdate);
1671 updateMacroInstances(OutputUpdate);
1673 writeLyXHTMLSource(ofs, runparams);
1677 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1681 void Buffer::writeLyXHTMLSource(odocstream & os,
1682 OutputParams const & runparams,
1683 bool const only_body) const
1685 LaTeXFeatures features(*this, params(), runparams);
1687 d->bibinfo_.makeCitationLabels(*this);
1690 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1691 << "<!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"
1692 // FIXME Language should be set properly.
1693 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1695 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1696 // FIXME Presumably need to set this right
1697 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1699 docstring const & doctitle = features.htmlTitle();
1701 << (doctitle.empty() ? from_ascii("LyX Document") : doctitle)
1704 os << "\n<!-- Text Class Preamble -->\n"
1705 << features.getTClassHTMLPreamble()
1706 << "\n<!-- Preamble Snippets -->\n"
1707 << from_utf8(features.getPreambleSnippets());
1709 os << "\n<!-- Layout-provided Styles -->\n";
1710 docstring const styleinfo = features.getTClassHTMLStyles();
1711 if (!styleinfo.empty()) {
1712 os << "<style type='text/css'>\n"
1717 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1718 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1719 if (needfg || needbg) {
1720 os << "<style type='text/css'>\nbody {\n";
1723 << from_ascii(X11hexname(params().fontcolor))
1726 os << " background-color: "
1727 << from_ascii(X11hexname(params().backgroundcolor))
1729 os << "}\n</style>\n";
1731 os << "</head>\n<body>\n";
1735 params().documentClass().counters().reset();
1736 xhtmlParagraphs(text(), *this, xs, runparams);
1738 os << "</body>\n</html>\n";
1742 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1743 // Other flags: -wall -v0 -x
1744 int Buffer::runChktex()
1748 // get LaTeX-Filename
1749 FileName const path(temppath());
1750 string const name = addName(path.absFileName(), latexName());
1751 string const org_path = filePath();
1753 PathChanger p(path); // path to LaTeX file
1754 message(_("Running chktex..."));
1756 // Generate the LaTeX file if neccessary
1757 OutputParams runparams(¶ms().encoding());
1758 runparams.flavor = OutputParams::LATEX;
1759 runparams.nice = false;
1760 runparams.linelen = lyxrc.plaintext_linelen;
1761 makeLaTeXFile(FileName(name), org_path, runparams);
1764 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1765 int const res = chktex.run(terr); // run chktex
1768 Alert::error(_("chktex failure"),
1769 _("Could not run chktex successfully."));
1770 } else if (res > 0) {
1771 ErrorList & errlist = d->errorLists["ChkTeX"];
1773 bufferErrors(terr, errlist);
1784 void Buffer::validate(LaTeXFeatures & features) const
1786 params().validate(features);
1788 for_each(paragraphs().begin(), paragraphs().end(),
1789 bind(&Paragraph::validate, _1, ref(features)));
1791 if (lyxerr.debugging(Debug::LATEX)) {
1792 features.showStruct();
1797 void Buffer::getLabelList(vector<docstring> & list) const
1799 // If this is a child document, use the master's list instead.
1801 masterBuffer()->getLabelList(list);
1806 Toc & toc = d->toc_backend.toc("label");
1807 TocIterator toc_it = toc.begin();
1808 TocIterator end = toc.end();
1809 for (; toc_it != end; ++toc_it) {
1810 if (toc_it->depth() == 0)
1811 list.push_back(toc_it->str());
1816 void Buffer::updateBibfilesCache(UpdateScope scope) const
1818 // FIXME This is probably unnecssary, given where we call this.
1819 // If this is a child document, use the parent's cache instead.
1820 if (parent() && scope != UpdateChildOnly) {
1821 masterBuffer()->updateBibfilesCache();
1825 d->bibfiles_cache_.clear();
1826 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1827 if (it->lyxCode() == BIBTEX_CODE) {
1828 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1829 support::FileNameList const bibfiles = inset.getBibFiles();
1830 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1833 } else if (it->lyxCode() == INCLUDE_CODE) {
1834 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1835 Buffer const * const incbuf = inset.getChildBuffer();
1838 support::FileNameList const & bibfiles =
1839 incbuf->getBibfilesCache(UpdateChildOnly);
1840 if (!bibfiles.empty()) {
1841 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1847 d->bibfile_cache_valid_ = true;
1848 d->bibinfo_cache_valid_ = false;
1849 d->cite_labels_valid_ = false;
1853 void Buffer::invalidateBibinfoCache() const
1855 d->bibinfo_cache_valid_ = false;
1856 d->cite_labels_valid_ = false;
1857 // also invalidate the cache for the parent buffer
1858 Buffer const * const pbuf = d->parent();
1860 pbuf->invalidateBibinfoCache();
1864 void Buffer::invalidateBibfileCache() const
1866 d->bibfile_cache_valid_ = false;
1867 d->bibinfo_cache_valid_ = false;
1868 d->cite_labels_valid_ = false;
1869 // also invalidate the cache for the parent buffer
1870 Buffer const * const pbuf = d->parent();
1872 pbuf->invalidateBibfileCache();
1876 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1878 // FIXME This is probably unnecessary, given where we call this.
1879 // If this is a child document, use the master's cache instead.
1880 Buffer const * const pbuf = masterBuffer();
1881 if (pbuf != this && scope != UpdateChildOnly)
1882 return pbuf->getBibfilesCache();
1884 if (!d->bibfile_cache_valid_)
1885 this->updateBibfilesCache(scope);
1887 return d->bibfiles_cache_;
1891 BiblioInfo const & Buffer::masterBibInfo() const
1893 Buffer const * const tmp = masterBuffer();
1895 return tmp->masterBibInfo();
1900 void Buffer::checkIfBibInfoCacheIsValid() const
1902 // use the master's cache
1903 Buffer const * const tmp = masterBuffer();
1905 tmp->checkIfBibInfoCacheIsValid();
1909 // compare the cached timestamps with the actual ones.
1910 FileNameList const & bibfiles_cache = getBibfilesCache();
1911 FileNameList::const_iterator ei = bibfiles_cache.begin();
1912 FileNameList::const_iterator en = bibfiles_cache.end();
1913 for (; ei != en; ++ ei) {
1914 time_t lastw = ei->lastModified();
1915 time_t prevw = d->bibfile_status_[*ei];
1916 if (lastw != prevw) {
1917 d->bibinfo_cache_valid_ = false;
1918 d->cite_labels_valid_ = false;
1919 d->bibfile_status_[*ei] = lastw;
1925 void Buffer::reloadBibInfoCache() const
1927 // use the master's cache
1928 Buffer const * const tmp = masterBuffer();
1930 tmp->reloadBibInfoCache();
1934 checkIfBibInfoCacheIsValid();
1935 if (d->bibinfo_cache_valid_)
1938 d->bibinfo_.clear();
1940 d->bibinfo_cache_valid_ = true;
1944 void Buffer::collectBibKeys() const
1946 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1947 it->collectBibKeys(it);
1951 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
1953 Buffer const * tmp = masterBuffer();
1954 BiblioInfo & masterbi = (tmp == this) ?
1955 d->bibinfo_ : tmp->d->bibinfo_;
1956 masterbi.mergeBiblioInfo(bi);
1960 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
1962 Buffer const * tmp = masterBuffer();
1963 BiblioInfo & masterbi = (tmp == this) ?
1964 d->bibinfo_ : tmp->d->bibinfo_;
1969 bool Buffer::citeLabelsValid() const
1971 return masterBuffer()->d->cite_labels_valid_;
1975 bool Buffer::isDepClean(string const & name) const
1977 DepClean::const_iterator const it = d->dep_clean.find(name);
1978 if (it == d->dep_clean.end())
1984 void Buffer::markDepClean(string const & name)
1986 d->dep_clean[name] = true;
1990 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1993 // FIXME? if there is an Buffer LFUN that can be dispatched even
1994 // if internal, put a switch '(cmd.action)' here.
2000 switch (cmd.action()) {
2002 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2003 flag.setOnOff(isReadonly());
2006 // FIXME: There is need for a command-line import.
2007 //case LFUN_BUFFER_IMPORT:
2009 case LFUN_BUFFER_AUTO_SAVE:
2012 case LFUN_BUFFER_EXPORT_CUSTOM:
2013 // FIXME: Nothing to check here?
2016 case LFUN_BUFFER_EXPORT: {
2017 docstring const arg = cmd.argument();
2018 if (arg == "custom") {
2022 string format = to_utf8(arg);
2023 size_t pos = format.find(' ');
2024 if (pos != string::npos)
2025 format = format.substr(0, pos);
2026 enable = params().isExportable(format);
2028 flag.message(bformat(
2029 _("Don't know how to export to format: %1$s"), arg));
2033 case LFUN_BUFFER_CHKTEX:
2034 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2037 case LFUN_BUILD_PROGRAM:
2038 enable = params().isExportable("program");
2041 case LFUN_BRANCH_ACTIVATE:
2042 case LFUN_BRANCH_DEACTIVATE: {
2043 BranchList const & branchList = params().branchlist();
2044 docstring const branchName = cmd.argument();
2045 enable = !branchName.empty() && branchList.find(branchName);
2049 case LFUN_BRANCH_ADD:
2050 case LFUN_BRANCHES_RENAME:
2051 case LFUN_BUFFER_PRINT:
2052 // if no Buffer is present, then of course we won't be called!
2055 case LFUN_BUFFER_LANGUAGE:
2056 enable = !isReadonly();
2062 flag.setEnabled(enable);
2067 void Buffer::dispatch(string const & command, DispatchResult & result)
2069 return dispatch(lyxaction.lookupFunc(command), result);
2073 // NOTE We can end up here even if we have no GUI, because we are called
2074 // by LyX::exec to handled command-line requests. So we may need to check
2075 // whether we have a GUI or not. The boolean use_gui holds this information.
2076 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2079 // FIXME? if there is an Buffer LFUN that can be dispatched even
2080 // if internal, put a switch '(cmd.action())' here.
2081 dr.dispatched(false);
2084 string const argument = to_utf8(func.argument());
2085 // We'll set this back to false if need be.
2086 bool dispatched = true;
2087 undo().beginUndoGroup();
2089 switch (func.action()) {
2090 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2091 if (lyxvc().inUse())
2092 lyxvc().toggleReadOnly();
2094 setReadonly(!isReadonly());
2097 case LFUN_BUFFER_EXPORT: {
2098 ExportStatus const status = doExport(argument, false, false);
2099 dr.setError(status != ExportSuccess);
2100 if (status != ExportSuccess)
2101 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2106 case LFUN_BUILD_PROGRAM:
2107 doExport("program", true, false);
2110 case LFUN_BUFFER_CHKTEX:
2114 case LFUN_BUFFER_EXPORT_CUSTOM: {
2116 string command = split(argument, format_name, ' ');
2117 Format const * format = formats.getFormat(format_name);
2119 lyxerr << "Format \"" << format_name
2120 << "\" not recognized!"
2125 // The name of the file created by the conversion process
2128 // Output to filename
2129 if (format->name() == "lyx") {
2130 string const latexname = latexName(false);
2131 filename = changeExtension(latexname,
2132 format->extension());
2133 filename = addName(temppath(), filename);
2135 if (!writeFile(FileName(filename)))
2139 doExport(format_name, true, false, filename);
2142 // Substitute $$FName for filename
2143 if (!contains(command, "$$FName"))
2144 command = "( " + command + " ) < $$FName";
2145 command = subst(command, "$$FName", filename);
2147 // Execute the command in the background
2149 call.startscript(Systemcall::DontWait, command, filePath());
2153 // FIXME: There is need for a command-line import.
2155 case LFUN_BUFFER_IMPORT:
2160 case LFUN_BUFFER_AUTO_SAVE:
2162 resetAutosaveTimers();
2165 case LFUN_BRANCH_ADD: {
2166 docstring branch_name = func.argument();
2167 if (branch_name.empty()) {
2171 BranchList & branch_list = params().branchlist();
2172 vector<docstring> const branches =
2173 getVectorFromString(branch_name, branch_list.separator());
2175 for (vector<docstring>::const_iterator it = branches.begin();
2176 it != branches.end(); ++it) {
2178 Branch * branch = branch_list.find(branch_name);
2180 LYXERR0("Branch " << branch_name << " already exists.");
2184 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2186 branch_list.add(branch_name);
2187 branch = branch_list.find(branch_name);
2188 string const x11hexname = X11hexname(branch->color());
2189 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2190 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2192 dr.screenUpdate(Update::Force);
2200 case LFUN_BRANCH_ACTIVATE:
2201 case LFUN_BRANCH_DEACTIVATE: {
2202 BranchList & branchList = params().branchlist();
2203 docstring const branchName = func.argument();
2204 // the case without a branch name is handled elsewhere
2205 if (branchName.empty()) {
2209 Branch * branch = branchList.find(branchName);
2211 LYXERR0("Branch " << branchName << " does not exist.");
2213 docstring const msg =
2214 bformat(_("Branch \"%1$s\" does not exist."), branchName);
2217 branch->setSelected(func.action() == LFUN_BRANCH_ACTIVATE);
2219 dr.screenUpdate(Update::Force);
2220 dr.forceBufferUpdate();
2225 case LFUN_BRANCHES_RENAME: {
2226 if (func.argument().empty())
2229 docstring const oldname = from_utf8(func.getArg(0));
2230 docstring const newname = from_utf8(func.getArg(1));
2231 InsetIterator it = inset_iterator_begin(inset());
2232 InsetIterator const end = inset_iterator_end(inset());
2233 bool success = false;
2234 for (; it != end; ++it) {
2235 if (it->lyxCode() == BRANCH_CODE) {
2236 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2237 if (ins.branch() == oldname) {
2238 undo().recordUndo(it);
2239 ins.rename(newname);
2244 if (it->lyxCode() == INCLUDE_CODE) {
2245 // get buffer of external file
2246 InsetInclude const & ins =
2247 static_cast<InsetInclude const &>(*it);
2248 Buffer * child = ins.getChildBuffer();
2251 child->dispatch(func, dr);
2256 dr.screenUpdate(Update::Force);
2257 dr.forceBufferUpdate();
2262 case LFUN_BUFFER_PRINT: {
2263 // we'll assume there's a problem until we succeed
2265 string target = func.getArg(0);
2266 string target_name = func.getArg(1);
2267 string command = func.getArg(2);
2270 || target_name.empty()
2271 || command.empty()) {
2272 LYXERR0("Unable to parse " << func.argument());
2273 docstring const msg =
2274 bformat(_("Unable to parse \"%1$s\""), func.argument());
2278 if (target != "printer" && target != "file") {
2279 LYXERR0("Unrecognized target \"" << target << '"');
2280 docstring const msg =
2281 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2286 if (!doExport("dvi", true)) {
2287 showPrintError(absFileName());
2288 dr.setMessage(_("Error exporting to DVI."));
2292 // Push directory path.
2293 string const path = temppath();
2294 // Prevent the compiler from optimizing away p
2298 // there are three cases here:
2299 // 1. we print to a file
2300 // 2. we print directly to a printer
2301 // 3. we print using a spool command (print to file first)
2304 string const dviname = changeExtension(latexName(true), "dvi");
2306 if (target == "printer") {
2307 if (!lyxrc.print_spool_command.empty()) {
2308 // case 3: print using a spool
2309 string const psname = changeExtension(dviname,".ps");
2310 command += ' ' + lyxrc.print_to_file
2313 + quoteName(dviname);
2315 string command2 = lyxrc.print_spool_command + ' ';
2316 if (target_name != "default") {
2317 command2 += lyxrc.print_spool_printerprefix
2321 command2 += quoteName(psname);
2323 // If successful, then spool command
2324 res = one.startscript(Systemcall::Wait, command,
2328 // If there's no GUI, we have to wait on this command. Otherwise,
2329 // LyX deletes the temporary directory, and with it the spooled
2330 // file, before it can be printed!!
2331 Systemcall::Starttype stype = use_gui ?
2332 Systemcall::DontWait : Systemcall::Wait;
2333 res = one.startscript(stype, command2,
2337 // case 2: print directly to a printer
2338 if (target_name != "default")
2339 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2341 Systemcall::Starttype stype = use_gui ?
2342 Systemcall::DontWait : Systemcall::Wait;
2343 res = one.startscript(stype, command +
2344 quoteName(dviname), filePath());
2348 // case 1: print to a file
2349 FileName const filename(makeAbsPath(target_name, filePath()));
2350 FileName const dvifile(makeAbsPath(dviname, path));
2351 if (filename.exists()) {
2352 docstring text = bformat(
2353 _("The file %1$s already exists.\n\n"
2354 "Do you want to overwrite that file?"),
2355 makeDisplayPath(filename.absFileName()));
2356 if (Alert::prompt(_("Overwrite file?"),
2357 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2360 command += ' ' + lyxrc.print_to_file
2361 + quoteName(filename.toFilesystemEncoding())
2363 + quoteName(dvifile.toFilesystemEncoding());
2365 Systemcall::Starttype stype = use_gui ?
2366 Systemcall::DontWait : Systemcall::Wait;
2367 res = one.startscript(stype, command, filePath());
2373 dr.setMessage(_("Error running external commands."));
2374 showPrintError(absFileName());
2383 dr.dispatched(dispatched);
2384 undo().endUndoGroup();
2388 void Buffer::changeLanguage(Language const * from, Language const * to)
2390 LASSERT(from, /**/);
2393 for_each(par_iterator_begin(),
2395 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2399 bool Buffer::isMultiLingual() const
2401 ParConstIterator end = par_iterator_end();
2402 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2403 if (it->isMultiLingual(params()))
2410 std::set<Language const *> Buffer::getLanguages() const
2412 std::set<Language const *> languages;
2413 getLanguages(languages);
2418 void Buffer::getLanguages(std::set<Language const *> & languages) const
2420 ParConstIterator end = par_iterator_end();
2421 // add the buffer language, even if it's not actively used
2422 languages.insert(language());
2423 // iterate over the paragraphs
2424 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2425 it->getLanguages(languages);
2427 ListOfBuffers clist = getDescendents();
2428 ListOfBuffers::const_iterator cit = clist.begin();
2429 ListOfBuffers::const_iterator const cen = clist.end();
2430 for (; cit != cen; ++cit)
2431 (*cit)->getLanguages(languages);
2435 DocIterator Buffer::getParFromID(int const id) const
2437 Buffer * buf = const_cast<Buffer *>(this);
2439 // John says this is called with id == -1 from undo
2440 lyxerr << "getParFromID(), id: " << id << endl;
2441 return doc_iterator_end(buf);
2444 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2445 if (it.paragraph().id() == id)
2448 return doc_iterator_end(buf);
2452 bool Buffer::hasParWithID(int const id) const
2454 return !getParFromID(id).atEnd();
2458 ParIterator Buffer::par_iterator_begin()
2460 return ParIterator(doc_iterator_begin(this));
2464 ParIterator Buffer::par_iterator_end()
2466 return ParIterator(doc_iterator_end(this));
2470 ParConstIterator Buffer::par_iterator_begin() const
2472 return ParConstIterator(doc_iterator_begin(this));
2476 ParConstIterator Buffer::par_iterator_end() const
2478 return ParConstIterator(doc_iterator_end(this));
2482 Language const * Buffer::language() const
2484 return params().language;
2488 docstring const Buffer::B_(string const & l10n) const
2490 return params().B_(l10n);
2494 bool Buffer::isClean() const
2496 return d->lyx_clean;
2500 bool Buffer::isExternallyModified(CheckMethod method) const
2502 LASSERT(d->filename.exists(), /**/);
2503 // if method == timestamp, check timestamp before checksum
2504 return (method == checksum_method
2505 || d->timestamp_ != d->filename.lastModified())
2506 && d->checksum_ != d->filename.checksum();
2510 void Buffer::saveCheckSum() const
2512 FileName const & file = d->filename;
2515 if (file.exists()) {
2516 d->timestamp_ = file.lastModified();
2517 d->checksum_ = file.checksum();
2519 // in the case of save to a new file.
2526 void Buffer::markClean() const
2528 if (!d->lyx_clean) {
2529 d->lyx_clean = true;
2532 // if the .lyx file has been saved, we don't need an
2534 d->bak_clean = true;
2535 d->undo_.markDirty();
2539 void Buffer::setUnnamed(bool flag)
2545 bool Buffer::isUnnamed() const
2552 /// Don't check unnamed, here: isInternal() is used in
2553 /// newBuffer(), where the unnamed flag has not been set by anyone
2554 /// yet. Also, for an internal buffer, there should be no need for
2555 /// retrieving fileName() nor for checking if it is unnamed or not.
2556 bool Buffer::isInternal() const
2558 return fileName().extension() == "internal";
2562 void Buffer::markDirty()
2565 d->lyx_clean = false;
2568 d->bak_clean = false;
2570 DepClean::iterator it = d->dep_clean.begin();
2571 DepClean::const_iterator const end = d->dep_clean.end();
2573 for (; it != end; ++it)
2578 FileName Buffer::fileName() const
2584 string Buffer::absFileName() const
2586 return d->filename.absFileName();
2590 string Buffer::filePath() const
2592 return d->filename.onlyPath().absFileName() + "/";
2596 bool Buffer::isReadonly() const
2598 return d->read_only;
2602 void Buffer::setParent(Buffer const * buffer)
2604 // Avoids recursive include.
2605 d->setParent(buffer == this ? 0 : buffer);
2610 Buffer const * Buffer::parent() const
2616 ListOfBuffers Buffer::allRelatives() const
2618 ListOfBuffers lb = masterBuffer()->getDescendents();
2619 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2624 Buffer const * Buffer::masterBuffer() const
2626 // FIXME Should be make sure we are not in some kind
2627 // of recursive include? A -> B -> A will crash this.
2628 Buffer const * const pbuf = d->parent();
2632 return pbuf->masterBuffer();
2636 bool Buffer::isChild(Buffer * child) const
2638 return d->children_positions.find(child) != d->children_positions.end();
2642 DocIterator Buffer::firstChildPosition(Buffer const * child)
2644 Impl::BufferPositionMap::iterator it;
2645 it = d->children_positions.find(child);
2646 if (it == d->children_positions.end())
2647 return DocIterator(this);
2652 bool Buffer::hasChildren() const
2654 return !d->children_positions.empty();
2658 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2660 // loop over children
2661 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2662 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2663 for (; it != end; ++it) {
2664 Buffer * child = const_cast<Buffer *>(it->first);
2666 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2667 if (bit != clist.end())
2669 clist.push_back(child);
2671 // there might be grandchildren
2672 child->collectChildren(clist, true);
2677 ListOfBuffers Buffer::getChildren() const
2680 collectChildren(v, false);
2681 // Make sure we have not included ourselves.
2682 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2683 if (bit != v.end()) {
2684 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2691 ListOfBuffers Buffer::getDescendents() const
2694 collectChildren(v, true);
2695 // Make sure we have not included ourselves.
2696 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2697 if (bit != v.end()) {
2698 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2705 template<typename M>
2706 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2711 typename M::const_iterator it = m.lower_bound(x);
2712 if (it == m.begin())
2720 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2721 DocIterator const & pos) const
2723 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2725 // if paragraphs have no macro context set, pos will be empty
2729 // we haven't found anything yet
2730 DocIterator bestPos = owner_->par_iterator_begin();
2731 MacroData const * bestData = 0;
2733 // find macro definitions for name
2734 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2735 if (nameIt != macros.end()) {
2736 // find last definition in front of pos or at pos itself
2737 PositionScopeMacroMap::const_iterator it
2738 = greatest_below(nameIt->second, pos);
2739 if (it != nameIt->second.end()) {
2741 // scope ends behind pos?
2742 if (pos < it->second.first) {
2743 // Looks good, remember this. If there
2744 // is no external macro behind this,
2745 // we found the right one already.
2746 bestPos = it->first;
2747 bestData = &it->second.second;
2751 // try previous macro if there is one
2752 if (it == nameIt->second.begin())
2759 // find macros in included files
2760 PositionScopeBufferMap::const_iterator it
2761 = greatest_below(position_to_children, pos);
2762 if (it == position_to_children.end())
2763 // no children before
2767 // do we know something better (i.e. later) already?
2768 if (it->first < bestPos )
2771 // scope ends behind pos?
2772 if (pos < it->second.first
2773 && (cloned_buffer_ ||
2774 theBufferList().isLoaded(it->second.second))) {
2775 // look for macro in external file
2777 MacroData const * data
2778 = it->second.second->getMacro(name, false);
2781 bestPos = it->first;
2787 // try previous file if there is one
2788 if (it == position_to_children.begin())
2793 // return the best macro we have found
2798 MacroData const * Buffer::getMacro(docstring const & name,
2799 DocIterator const & pos, bool global) const
2804 // query buffer macros
2805 MacroData const * data = d->getBufferMacro(name, pos);
2809 // If there is a master buffer, query that
2810 Buffer const * const pbuf = d->parent();
2812 d->macro_lock = true;
2813 MacroData const * macro = pbuf->getMacro(
2814 name, *this, false);
2815 d->macro_lock = false;
2821 data = MacroTable::globalMacros().get(name);
2830 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2832 // set scope end behind the last paragraph
2833 DocIterator scope = par_iterator_begin();
2834 scope.pit() = scope.lastpit() + 1;
2836 return getMacro(name, scope, global);
2840 MacroData const * Buffer::getMacro(docstring const & name,
2841 Buffer const & child, bool global) const
2843 // look where the child buffer is included first
2844 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2845 if (it == d->children_positions.end())
2848 // check for macros at the inclusion position
2849 return getMacro(name, it->second, global);
2853 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2855 pit_type const lastpit = it.lastpit();
2857 // look for macros in each paragraph
2858 while (it.pit() <= lastpit) {
2859 Paragraph & par = it.paragraph();
2861 // iterate over the insets of the current paragraph
2862 InsetList const & insets = par.insetList();
2863 InsetList::const_iterator iit = insets.begin();
2864 InsetList::const_iterator end = insets.end();
2865 for (; iit != end; ++iit) {
2866 it.pos() = iit->pos;
2868 // is it a nested text inset?
2869 if (iit->inset->asInsetText()) {
2870 // Inset needs its own scope?
2871 InsetText const * itext = iit->inset->asInsetText();
2872 bool newScope = itext->isMacroScope();
2874 // scope which ends just behind the inset
2875 DocIterator insetScope = it;
2878 // collect macros in inset
2879 it.push_back(CursorSlice(*iit->inset));
2880 updateMacros(it, newScope ? insetScope : scope);
2885 if (iit->inset->asInsetTabular()) {
2886 CursorSlice slice(*iit->inset);
2887 size_t const numcells = slice.nargs();
2888 for (; slice.idx() < numcells; slice.forwardIdx()) {
2889 it.push_back(slice);
2890 updateMacros(it, scope);
2896 // is it an external file?
2897 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2898 // get buffer of external file
2899 InsetInclude const & inset =
2900 static_cast<InsetInclude const &>(*iit->inset);
2902 Buffer * child = inset.getChildBuffer();
2907 // register its position, but only when it is
2908 // included first in the buffer
2909 if (children_positions.find(child) ==
2910 children_positions.end())
2911 children_positions[child] = it;
2913 // register child with its scope
2914 position_to_children[it] = Impl::ScopeBuffer(scope, child);
2918 InsetMath * im = iit->inset->asInsetMath();
2919 if (doing_export && im) {
2920 InsetMathHull * hull = im->asHullInset();
2922 hull->recordLocation(it);
2925 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2929 MathMacroTemplate & macroTemplate =
2930 *iit->inset->asInsetMath()->asMacroTemplate();
2931 MacroContext mc(owner_, it);
2932 macroTemplate.updateToContext(mc);
2935 bool valid = macroTemplate.validMacro();
2936 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2937 // then the BufferView's cursor will be invalid in
2938 // some cases which leads to crashes.
2943 // FIXME (Abdel), I don't understandt why we pass 'it' here
2944 // instead of 'macroTemplate' defined above... is this correct?
2945 macros[macroTemplate.name()][it] =
2946 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
2956 void Buffer::updateMacros() const
2961 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2963 // start with empty table
2965 d->children_positions.clear();
2966 d->position_to_children.clear();
2968 // Iterate over buffer, starting with first paragraph
2969 // The scope must be bigger than any lookup DocIterator
2970 // later. For the global lookup, lastpit+1 is used, hence
2971 // we use lastpit+2 here.
2972 DocIterator it = par_iterator_begin();
2973 DocIterator outerScope = it;
2974 outerScope.pit() = outerScope.lastpit() + 2;
2975 d->updateMacros(it, outerScope);
2979 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2981 InsetIterator it = inset_iterator_begin(inset());
2982 InsetIterator const end = inset_iterator_end(inset());
2983 for (; it != end; ++it) {
2984 if (it->lyxCode() == BRANCH_CODE) {
2985 InsetBranch & br = static_cast<InsetBranch &>(*it);
2986 docstring const name = br.branch();
2987 if (!from_master && !params().branchlist().find(name))
2988 result.push_back(name);
2989 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2990 result.push_back(name);
2993 if (it->lyxCode() == INCLUDE_CODE) {
2994 // get buffer of external file
2995 InsetInclude const & ins =
2996 static_cast<InsetInclude const &>(*it);
2997 Buffer * child = ins.getChildBuffer();
3000 child->getUsedBranches(result, true);
3003 // remove duplicates
3008 void Buffer::updateMacroInstances(UpdateType utype) const
3010 LYXERR(Debug::MACROS, "updateMacroInstances for "
3011 << d->filename.onlyFileName());
3012 DocIterator it = doc_iterator_begin(this);
3014 DocIterator const end = doc_iterator_end(this);
3015 for (; it != end; it.forwardInset()) {
3016 // look for MathData cells in InsetMathNest insets
3017 InsetMath * minset = it.nextInset()->asInsetMath();
3021 // update macro in all cells of the InsetMathNest
3022 DocIterator::idx_type n = minset->nargs();
3023 MacroContext mc = MacroContext(this, it);
3024 for (DocIterator::idx_type i = 0; i < n; ++i) {
3025 MathData & data = minset->cell(i);
3026 data.updateMacros(0, mc, utype);
3032 void Buffer::listMacroNames(MacroNameSet & macros) const
3037 d->macro_lock = true;
3039 // loop over macro names
3040 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3041 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3042 for (; nameIt != nameEnd; ++nameIt)
3043 macros.insert(nameIt->first);
3045 // loop over children
3046 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3047 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3048 for (; it != end; ++it)
3049 it->first->listMacroNames(macros);
3052 Buffer const * const pbuf = d->parent();
3054 pbuf->listMacroNames(macros);
3056 d->macro_lock = false;
3060 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3062 Buffer const * const pbuf = d->parent();
3067 pbuf->listMacroNames(names);
3070 MacroNameSet::iterator it = names.begin();
3071 MacroNameSet::iterator end = names.end();
3072 for (; it != end; ++it) {
3074 MacroData const * data =
3075 pbuf->getMacro(*it, *this, false);
3077 macros.insert(data);
3079 // we cannot access the original MathMacroTemplate anymore
3080 // here to calls validate method. So we do its work here manually.
3081 // FIXME: somehow make the template accessible here.
3082 if (data->optionals() > 0)
3083 features.require("xargs");
3089 Buffer::References & Buffer::references(docstring const & label)
3092 return const_cast<Buffer *>(masterBuffer())->references(label);
3094 RefCache::iterator it = d->ref_cache_.find(label);
3095 if (it != d->ref_cache_.end())
3096 return it->second.second;
3098 static InsetLabel const * dummy_il = 0;
3099 static References const dummy_refs;
3100 it = d->ref_cache_.insert(
3101 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3102 return it->second.second;
3106 Buffer::References const & Buffer::references(docstring const & label) const
3108 return const_cast<Buffer *>(this)->references(label);
3112 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3114 masterBuffer()->d->ref_cache_[label].first = il;
3118 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3120 return masterBuffer()->d->ref_cache_[label].first;
3124 void Buffer::clearReferenceCache() const
3127 d->ref_cache_.clear();
3131 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3134 //FIXME: This does not work for child documents yet.
3135 LASSERT(code == CITE_CODE, /**/);
3137 reloadBibInfoCache();
3139 // Check if the label 'from' appears more than once
3140 BiblioInfo const & keys = masterBibInfo();
3141 BiblioInfo::const_iterator bit = keys.begin();
3142 BiblioInfo::const_iterator bend = keys.end();
3143 vector<docstring> labels;
3145 for (; bit != bend; ++bit)
3147 labels.push_back(bit->first);
3149 if (count(labels.begin(), labels.end(), from) > 1)
3152 string const paramName = "key";
3153 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3154 if (it->lyxCode() == code) {
3155 InsetCommand * inset = it->asInsetCommand();
3158 docstring const oldValue = inset->getParam(paramName);
3159 if (oldValue == from)
3160 inset->setParam(paramName, to);
3166 void Buffer::getSourceCode(odocstream & os, string const format,
3167 pit_type par_begin, pit_type par_end,
3168 bool full_source) const
3170 OutputParams runparams(¶ms().encoding());
3171 runparams.nice = true;
3172 runparams.flavor = params().getOutputFlavor(format);
3173 runparams.linelen = lyxrc.plaintext_linelen;
3174 // No side effect of file copying and image conversion
3175 runparams.dryrun = true;
3178 os << "% " << _("Preview source code") << "\n\n";
3180 d->texrow.newline();
3181 d->texrow.newline();
3182 if (params().isDocBook())
3183 writeDocBookSource(os, absFileName(), runparams, false);
3184 else if (runparams.flavor == OutputParams::HTML)
3185 writeLyXHTMLSource(os, runparams, false);
3187 // latex or literate
3188 otexstream ots(os, d->texrow);
3189 writeLaTeXSource(ots, string(), runparams, true, true);
3192 runparams.par_begin = par_begin;
3193 runparams.par_end = par_end;
3194 if (par_begin + 1 == par_end) {
3196 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3200 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3201 convert<docstring>(par_begin),
3202 convert<docstring>(par_end - 1))
3209 // output paragraphs
3210 if (params().isDocBook())
3211 docbookParagraphs(text(), *this, os, runparams);
3212 else if (runparams.flavor == OutputParams::HTML) {
3214 xhtmlParagraphs(text(), *this, xs, runparams);
3216 // latex or literate
3217 otexstream ots(os, texrow);
3218 latexParagraphs(*this, text(), ots, runparams);
3224 ErrorList & Buffer::errorList(string const & type) const
3226 return d->errorLists[type];
3230 void Buffer::updateTocItem(std::string const & type,
3231 DocIterator const & dit) const
3234 d->gui_->updateTocItem(type, dit);
3238 void Buffer::structureChanged() const
3241 d->gui_->structureChanged();
3245 void Buffer::errors(string const & err, bool from_master) const
3248 d->gui_->errors(err, from_master);
3252 void Buffer::message(docstring const & msg) const
3255 d->gui_->message(msg);
3259 void Buffer::setBusy(bool on) const
3262 d->gui_->setBusy(on);
3266 void Buffer::updateTitles() const
3269 d->wa_->updateTitles();
3273 void Buffer::resetAutosaveTimers() const
3276 d->gui_->resetAutosaveTimers();
3280 bool Buffer::hasGuiDelegate() const
3286 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3295 class AutoSaveBuffer : public ForkedProcess {
3298 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3299 : buffer_(buffer), fname_(fname) {}
3301 virtual shared_ptr<ForkedProcess> clone() const
3303 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3308 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3309 from_utf8(fname_.absFileName())));
3310 return run(DontWait);
3314 virtual int generateChild();
3316 Buffer const & buffer_;
3321 int AutoSaveBuffer::generateChild()
3323 #if defined(__APPLE__)
3324 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3325 * We should use something else like threads.
3327 * Since I do not know how to determine at run time what is the OS X
3328 * version, I just disable forking altogether for now (JMarc)
3330 pid_t const pid = -1;
3332 // tmp_ret will be located (usually) in /tmp
3333 // will that be a problem?
3334 // Note that this calls ForkedCalls::fork(), so it's
3335 // ok cross-platform.
3336 pid_t const pid = fork();
3337 // If you want to debug the autosave
3338 // you should set pid to -1, and comment out the fork.
3339 if (pid != 0 && pid != -1)
3343 // pid = -1 signifies that lyx was unable
3344 // to fork. But we will do the save
3346 bool failed = false;
3347 FileName const tmp_ret = FileName::tempName("lyxauto");
3348 if (!tmp_ret.empty()) {
3349 buffer_.writeFile(tmp_ret);
3350 // assume successful write of tmp_ret
3351 if (!tmp_ret.moveTo(fname_))
3357 // failed to write/rename tmp_ret so try writing direct
3358 if (!buffer_.writeFile(fname_)) {
3359 // It is dangerous to do this in the child,
3360 // but safe in the parent, so...
3361 if (pid == -1) // emit message signal.
3362 buffer_.message(_("Autosave failed!"));
3366 if (pid == 0) // we are the child so...
3375 FileName Buffer::getEmergencyFileName() const
3377 return FileName(d->filename.absFileName() + ".emergency");
3381 FileName Buffer::getAutosaveFileName() const
3383 // if the document is unnamed try to save in the backup dir, else
3384 // in the default document path, and as a last try in the filePath,
3385 // which will most often be the temporary directory
3388 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3389 : lyxrc.backupdir_path;
3390 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3393 string const fname = "#" + d->filename.onlyFileName() + "#";
3395 return makeAbsPath(fname, fpath);
3399 void Buffer::removeAutosaveFile() const
3401 FileName const f = getAutosaveFileName();
3407 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3409 FileName const newauto = getAutosaveFileName();
3411 if (newauto != oldauto && oldauto.exists())
3412 if (!oldauto.moveTo(newauto))
3413 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3417 bool Buffer::autoSave() const
3419 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3420 if (buf->d->bak_clean || isReadonly())
3423 message(_("Autosaving current document..."));
3424 buf->d->bak_clean = true;
3426 FileName const fname = getAutosaveFileName();
3427 if (d->cloned_buffer_) {
3428 // If this buffer is cloned, we assume that
3429 // we are running in a separate thread already.
3430 FileName const tmp_ret = FileName::tempName("lyxauto");
3431 if (!tmp_ret.empty()) {
3433 // assume successful write of tmp_ret
3434 if (tmp_ret.moveTo(fname))
3437 // failed to write/rename tmp_ret so try writing direct
3438 return writeFile(fname);
3440 /// This function is deprecated as the frontend needs to take care
3441 /// of cloning the buffer and autosaving it in another thread. It
3442 /// is still here to allow (QT_VERSION < 0x040400).
3443 AutoSaveBuffer autosave(*this, fname);
3451 // helper class, to guarantee this gets reset properly
3452 class MarkAsExporting {
3454 MarkAsExporting(Buffer const * buf) : buf_(buf)
3456 LASSERT(buf_, /* */);
3457 buf_->setExportStatus(true);
3461 buf_->setExportStatus(false);
3464 Buffer const * const buf_;
3469 void Buffer::setExportStatus(bool e) const
3471 d->doing_export = e;
3472 ListOfBuffers clist = getDescendents();
3473 ListOfBuffers::const_iterator cit = clist.begin();
3474 ListOfBuffers::const_iterator const cen = clist.end();
3475 for (; cit != cen; ++cit)
3476 (*cit)->d->doing_export = e;
3480 bool Buffer::isExporting() const
3482 return d->doing_export;
3486 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir) const
3488 bool const update_unincluded =
3489 params().maintain_unincluded_children
3490 && !params().getIncludedChildren().empty();
3491 return doExport(target, put_in_tempdir, update_unincluded);
3495 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3496 bool includeall, string & result_file) const
3498 LYXERR(Debug::FILES, "target=" << target);
3499 OutputParams runparams(¶ms().encoding());
3500 string format = target;
3501 string dest_filename;
3502 size_t pos = target.find(' ');
3503 if (pos != string::npos) {
3504 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3505 format = target.substr(0, pos);
3506 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3507 FileName(dest_filename).onlyPath().createPath();
3508 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3510 MarkAsExporting exporting(this);
3511 string backend_format;
3512 runparams.flavor = OutputParams::LATEX;
3513 runparams.linelen = lyxrc.plaintext_linelen;
3514 runparams.includeall = includeall;
3515 vector<string> backs = params().backends();
3516 Converters converters = theConverters();
3517 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3518 // Get shortest path to format
3519 converters.buildGraph();
3520 Graph::EdgePath path;
3521 for (vector<string>::const_iterator it = backs.begin();
3522 it != backs.end(); ++it) {
3523 Graph::EdgePath p = converters.getPath(*it, format);
3524 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3525 backend_format = *it;
3530 if (!put_in_tempdir) {
3531 // Only show this alert if this is an export to a non-temporary
3532 // file (not for previewing).
3533 Alert::error(_("Couldn't export file"), bformat(
3534 _("No information for exporting the format %1$s."),
3535 formats.prettyName(format)));
3537 return ExportNoPathToFormat;
3539 runparams.flavor = converters.getFlavor(path);
3542 backend_format = format;
3543 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3544 // FIXME: Don't hardcode format names here, but use a flag
3545 if (backend_format == "pdflatex")
3546 runparams.flavor = OutputParams::PDFLATEX;
3547 else if (backend_format == "luatex")
3548 runparams.flavor = OutputParams::LUATEX;
3549 else if (backend_format == "dviluatex")
3550 runparams.flavor = OutputParams::DVILUATEX;
3551 else if (backend_format == "xetex")
3552 runparams.flavor = OutputParams::XETEX;
3555 string filename = latexName(false);
3556 filename = addName(temppath(), filename);
3557 filename = changeExtension(filename,
3558 formats.extension(backend_format));
3559 LYXERR(Debug::FILES, "filename=" << filename);
3561 // Plain text backend
3562 if (backend_format == "text") {
3563 runparams.flavor = OutputParams::TEXT;
3564 writePlaintextFile(*this, FileName(filename), runparams);
3567 else if (backend_format == "xhtml") {
3568 runparams.flavor = OutputParams::HTML;
3569 switch (params().html_math_output) {
3570 case BufferParams::MathML:
3571 runparams.math_flavor = OutputParams::MathAsMathML;
3573 case BufferParams::HTML:
3574 runparams.math_flavor = OutputParams::MathAsHTML;
3576 case BufferParams::Images:
3577 runparams.math_flavor = OutputParams::MathAsImages;
3579 case BufferParams::LaTeX:
3580 runparams.math_flavor = OutputParams::MathAsLaTeX;
3583 makeLyXHTMLFile(FileName(filename), runparams);
3584 } else if (backend_format == "lyx")
3585 writeFile(FileName(filename));
3587 else if (params().isDocBook()) {
3588 runparams.nice = !put_in_tempdir;
3589 makeDocBookFile(FileName(filename), runparams);
3592 else if (backend_format == format) {
3593 runparams.nice = true;
3594 if (!makeLaTeXFile(FileName(filename), string(), runparams)) {
3595 if (d->cloned_buffer_) {
3596 d->cloned_buffer_->d->errorLists["Export"] =
3597 d->errorLists["Export"];
3601 } else if (!lyxrc.tex_allows_spaces
3602 && contains(filePath(), ' ')) {
3603 Alert::error(_("File name error"),
3604 _("The directory path to the document cannot contain spaces."));
3605 return ExportTexPathHasSpaces;
3607 runparams.nice = false;
3608 if (!makeLaTeXFile(FileName(filename), filePath(), runparams)) {
3609 if (d->cloned_buffer_) {
3610 d->cloned_buffer_->d->errorLists["Export"] =
3611 d->errorLists["Export"];
3617 string const error_type = (format == "program")
3618 ? "Build" : params().bufferFormat();
3619 ErrorList & error_list = d->errorLists[error_type];
3620 string const ext = formats.extension(format);
3621 FileName const tmp_result_file(changeExtension(filename, ext));
3622 bool const success = converters.convert(this, FileName(filename),
3623 tmp_result_file, FileName(absFileName()), backend_format, format,
3626 // Emit the signal to show the error list or copy it back to the
3627 // cloned Buffer so that it can be emitted afterwards.
3628 if (format != backend_format) {
3629 if (d->cloned_buffer_) {
3630 d->cloned_buffer_->d->errorLists[error_type] =
3631 d->errorLists[error_type];
3634 // also to the children, in case of master-buffer-view
3635 ListOfBuffers clist = getDescendents();
3636 ListOfBuffers::const_iterator cit = clist.begin();
3637 ListOfBuffers::const_iterator const cen = clist.end();
3638 for (; cit != cen; ++cit) {
3639 if (d->cloned_buffer_) {
3640 // Enable reverse search by copying back the
3641 // texrow object to the cloned buffer.
3642 // FIXME: this is not thread safe.
3643 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3644 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3645 (*cit)->d->errorLists[error_type];
3647 (*cit)->errors(error_type, true);
3651 if (d->cloned_buffer_) {
3652 // Enable reverse dvi or pdf to work by copying back the texrow
3653 // object to the cloned buffer.
3654 // FIXME: There is a possibility of concurrent access to texrow
3655 // here from the main GUI thread that should be securized.
3656 d->cloned_buffer_->d->texrow = d->texrow;
3657 string const error_type = params().bufferFormat();
3658 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3662 return ExportConverterError;
3664 if (put_in_tempdir) {
3665 result_file = tmp_result_file.absFileName();
3666 return ExportSuccess;
3669 if (dest_filename.empty())
3670 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3672 result_file = dest_filename;
3673 // We need to copy referenced files (e. g. included graphics
3674 // if format == "dvi") to the result dir.
3675 vector<ExportedFile> const files =
3676 runparams.exportdata->externalFiles(format);
3677 string const dest = runparams.export_folder.empty() ?
3678 onlyPath(result_file) : runparams.export_folder;
3679 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3680 : force_overwrite == ALL_FILES;
3681 CopyStatus status = use_force ? FORCE : SUCCESS;
3683 vector<ExportedFile>::const_iterator it = files.begin();
3684 vector<ExportedFile>::const_iterator const en = files.end();
3685 for (; it != en && status != CANCEL; ++it) {
3686 string const fmt = formats.getFormatFromFile(it->sourceName);
3687 string fixedName = it->exportName;
3688 if (!runparams.export_folder.empty()) {
3689 // Relative pathnames starting with ../ will be sanitized
3690 // if exporting to a different folder
3691 while (fixedName.substr(0, 3) == "../")
3692 fixedName = fixedName.substr(3, fixedName.length() - 3);
3694 FileName fixedFileName = makeAbsPath(fixedName, dest);
3695 fixedFileName.onlyPath().createPath();
3696 status = copyFile(fmt, it->sourceName,
3698 it->exportName, status == FORCE,
3699 runparams.export_folder.empty());
3702 if (status == CANCEL) {
3703 message(_("Document export cancelled."));
3704 } else if (tmp_result_file.exists()) {
3705 // Finally copy the main file
3706 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3707 : force_overwrite != NO_FILES;
3708 if (status == SUCCESS && use_force)
3710 status = copyFile(format, tmp_result_file,
3711 FileName(result_file), result_file,
3713 message(bformat(_("Document exported as %1$s "
3715 formats.prettyName(format),
3716 makeDisplayPath(result_file)));
3718 // This must be a dummy converter like fax (bug 1888)
3719 message(bformat(_("Document exported as %1$s"),
3720 formats.prettyName(format)));
3723 return ExportSuccess;
3727 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3728 bool includeall) const
3731 // (1) export with all included children (omit \includeonly)
3733 ExportStatus const status =
3734 doExport(target, put_in_tempdir, true, result_file);
3735 if (status != ExportSuccess)
3738 // (2) export with included children only
3739 return doExport(target, put_in_tempdir, false, result_file);
3743 Buffer::ExportStatus Buffer::preview(string const & format) const
3745 bool const update_unincluded =
3746 params().maintain_unincluded_children
3747 && !params().getIncludedChildren().empty();
3748 return preview(format, update_unincluded);
3751 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
3753 MarkAsExporting exporting(this);
3755 // (1) export with all included children (omit \includeonly)
3757 ExportStatus const status = doExport(format, true, true);
3758 if (status != ExportSuccess)
3761 // (2) export with included children only
3762 ExportStatus const status = doExport(format, true, false, result_file);
3763 if (status != ExportSuccess)
3765 if (!formats.view(*this, FileName(result_file), format))
3766 return PreviewError;
3767 return PreviewSuccess;
3771 Buffer::ReadStatus Buffer::extractFromVC()
3773 bool const found = LyXVC::file_not_found_hook(d->filename);
3775 return ReadFileNotFound;
3776 if (!d->filename.isReadableFile())
3782 Buffer::ReadStatus Buffer::loadEmergency()
3784 FileName const emergencyFile = getEmergencyFileName();
3785 if (!emergencyFile.exists()
3786 || emergencyFile.lastModified() <= d->filename.lastModified())
3787 return ReadFileNotFound;
3789 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3790 docstring const text = bformat(_("An emergency save of the document "
3791 "%1$s exists.\n\nRecover emergency save?"), file);
3793 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3794 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3800 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3801 bool const success = (ret_llf == ReadSuccess);
3804 Alert::warning(_("File is read-only"),
3805 bformat(_("An emergency file is successfully loaded, "
3806 "but the original file %1$s is marked read-only. "
3807 "Please make sure to save the document as a different "
3808 "file."), from_utf8(d->filename.absFileName())));
3811 str = _("Document was successfully recovered.");
3813 str = _("Document was NOT successfully recovered.");
3814 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3815 makeDisplayPath(emergencyFile.absFileName()));
3817 int const del_emerg =
3818 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3819 _("&Remove"), _("&Keep"));
3820 if (del_emerg == 0) {
3821 emergencyFile.removeFile();
3823 Alert::warning(_("Emergency file deleted"),
3824 _("Do not forget to save your file now!"), true);
3826 return success ? ReadSuccess : ReadEmergencyFailure;
3829 int const del_emerg =
3830 Alert::prompt(_("Delete emergency file?"),
3831 _("Remove emergency file now?"), 1, 1,
3832 _("&Remove"), _("&Keep"));
3834 emergencyFile.removeFile();
3835 return ReadOriginal;
3845 Buffer::ReadStatus Buffer::loadAutosave()
3847 // Now check if autosave file is newer.
3848 FileName const autosaveFile = getAutosaveFileName();
3849 if (!autosaveFile.exists()
3850 || autosaveFile.lastModified() <= d->filename.lastModified())
3851 return ReadFileNotFound;
3853 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3854 docstring const text = bformat(_("The backup of the document %1$s "
3855 "is newer.\n\nLoad the backup instead?"), file);
3856 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
3857 _("&Load backup"), _("Load &original"), _("&Cancel"));
3862 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
3863 // the file is not saved if we load the autosave file.
3864 if (ret_llf == ReadSuccess) {
3866 Alert::warning(_("File is read-only"),
3867 bformat(_("A backup file is successfully loaded, "
3868 "but the original file %1$s is marked read-only. "
3869 "Please make sure to save the document as a "
3871 from_utf8(d->filename.absFileName())));
3876 return ReadAutosaveFailure;
3879 // Here we delete the autosave
3880 autosaveFile.removeFile();
3881 return ReadOriginal;
3889 Buffer::ReadStatus Buffer::loadLyXFile()
3891 if (!d->filename.isReadableFile()) {
3892 ReadStatus const ret_rvc = extractFromVC();
3893 if (ret_rvc != ReadSuccess)
3897 ReadStatus const ret_re = loadEmergency();
3898 if (ret_re == ReadSuccess || ret_re == ReadCancel)
3901 ReadStatus const ret_ra = loadAutosave();
3902 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
3905 return loadThisLyXFile(d->filename);
3909 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
3911 return readFile(fn);
3915 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3917 TeXErrors::Errors::const_iterator it = terr.begin();
3918 TeXErrors::Errors::const_iterator end = terr.end();
3919 ListOfBuffers clist = getDescendents();
3920 ListOfBuffers::const_iterator cen = clist.end();
3922 for (; it != end; ++it) {
3925 int errorRow = it->error_in_line;
3926 Buffer const * buf = 0;
3928 if (it->child_name.empty())
3929 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
3931 // The error occurred in a child
3932 ListOfBuffers::const_iterator cit = clist.begin();
3933 for (; cit != cen; ++cit) {
3934 string const child_name =
3935 DocFileName(changeExtension(
3936 (*cit)->absFileName(), "tex")).
3938 if (it->child_name != child_name)
3940 (*cit)->d->texrow.getIdFromRow(errorRow,
3941 id_start, pos_start);
3942 if (id_start != -1) {
3943 buf = d->cloned_buffer_
3944 ? (*cit)->d->cloned_buffer_->d->owner_
3945 : (*cit)->d->owner_;
3956 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
3957 } while (found && id_start == id_end && pos_start == pos_end);
3959 if (id_start != id_end) {
3960 // Next registered position is outside the inset where
3961 // the error occurred, so signal end-of-paragraph
3965 errorList.push_back(ErrorItem(it->error_desc,
3966 it->error_text, id_start, pos_start, pos_end, buf));
3971 void Buffer::setBuffersForInsets() const
3973 inset().setBuffer(const_cast<Buffer &>(*this));
3977 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
3979 // Use the master text class also for child documents
3980 Buffer const * const master = masterBuffer();
3981 DocumentClass const & textclass = master->params().documentClass();
3983 // do this only if we are the top-level Buffer
3985 reloadBibInfoCache();
3987 // keep the buffers to be children in this set. If the call from the
3988 // master comes back we can see which of them were actually seen (i.e.
3989 // via an InsetInclude). The remaining ones in the set need still be updated.
3990 static std::set<Buffer const *> bufToUpdate;
3991 if (scope == UpdateMaster) {
3992 // If this is a child document start with the master
3993 if (master != this) {
3994 bufToUpdate.insert(this);
3995 master->updateBuffer(UpdateMaster, utype);
3996 // Do this here in case the master has no gui associated with it. Then,
3997 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3998 if (!master->d->gui_)
4001 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4002 if (bufToUpdate.find(this) == bufToUpdate.end())
4006 // start over the counters in the master
4007 textclass.counters().reset();
4010 // update will be done below for this buffer
4011 bufToUpdate.erase(this);
4013 // update all caches
4014 clearReferenceCache();
4017 Buffer & cbuf = const_cast<Buffer &>(*this);
4019 LASSERT(!text().paragraphs().empty(), /**/);
4022 ParIterator parit = cbuf.par_iterator_begin();
4023 updateBuffer(parit, utype);
4026 // TocBackend update will be done later.
4029 d->bibinfo_cache_valid_ = true;
4030 d->cite_labels_valid_ = true;
4031 cbuf.tocBackend().update();
4032 if (scope == UpdateMaster)
4033 cbuf.structureChanged();
4037 static depth_type getDepth(DocIterator const & it)
4039 depth_type depth = 0;
4040 for (size_t i = 0 ; i < it.depth() ; ++i)
4041 if (!it[i].inset().inMathed())
4042 depth += it[i].paragraph().getDepth() + 1;
4043 // remove 1 since the outer inset does not count
4047 static depth_type getItemDepth(ParIterator const & it)
4049 Paragraph const & par = *it;
4050 LabelType const labeltype = par.layout().labeltype;
4052 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4055 // this will hold the lowest depth encountered up to now.
4056 depth_type min_depth = getDepth(it);
4057 ParIterator prev_it = it;
4060 --prev_it.top().pit();
4062 // start of nested inset: go to outer par
4064 if (prev_it.empty()) {
4065 // start of document: nothing to do
4070 // We search for the first paragraph with same label
4071 // that is not more deeply nested.
4072 Paragraph & prev_par = *prev_it;
4073 depth_type const prev_depth = getDepth(prev_it);
4074 if (labeltype == prev_par.layout().labeltype) {
4075 if (prev_depth < min_depth)
4076 return prev_par.itemdepth + 1;
4077 if (prev_depth == min_depth)
4078 return prev_par.itemdepth;
4080 min_depth = min(min_depth, prev_depth);
4081 // small optimization: if we are at depth 0, we won't
4082 // find anything else
4083 if (prev_depth == 0)
4089 static bool needEnumCounterReset(ParIterator const & it)
4091 Paragraph const & par = *it;
4092 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4093 depth_type const cur_depth = par.getDepth();
4094 ParIterator prev_it = it;
4095 while (prev_it.pit()) {
4096 --prev_it.top().pit();
4097 Paragraph const & prev_par = *prev_it;
4098 if (prev_par.getDepth() <= cur_depth)
4099 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4101 // start of nested inset: reset
4106 // set the label of a paragraph. This includes the counters.
4107 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4109 BufferParams const & bp = owner_->masterBuffer()->params();
4110 DocumentClass const & textclass = bp.documentClass();
4111 Paragraph & par = it.paragraph();
4112 Layout const & layout = par.layout();
4113 Counters & counters = textclass.counters();
4115 if (par.params().startOfAppendix()) {
4116 // FIXME: only the counter corresponding to toplevel
4117 // sectioning should be reset
4119 counters.appendix(true);
4121 par.params().appendix(counters.appendix());
4123 // Compute the item depth of the paragraph
4124 par.itemdepth = getItemDepth(it);
4126 if (layout.margintype == MARGIN_MANUAL) {
4127 if (par.params().labelWidthString().empty())
4128 par.params().labelWidthString(par.expandLabel(layout, bp));
4129 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4130 // we do not need to do anything here, since the empty case is
4131 // handled during export.
4133 par.params().labelWidthString(docstring());
4136 switch(layout.labeltype) {
4138 if (layout.toclevel <= bp.secnumdepth
4139 && (layout.latextype != LATEX_ENVIRONMENT
4140 || it.text()->isFirstInSequence(it.pit()))) {
4141 if (counters.hasCounter(layout.counter))
4142 counters.step(layout.counter, utype);
4143 par.params().labelString(par.expandLabel(layout, bp));
4145 par.params().labelString(docstring());
4148 case LABEL_ITEMIZE: {
4149 // At some point of time we should do something more
4150 // clever here, like:
4151 // par.params().labelString(
4152 // bp.user_defined_bullet(par.itemdepth).getText());
4153 // for now, use a simple hardcoded label
4154 docstring itemlabel;
4155 switch (par.itemdepth) {
4157 itemlabel = char_type(0x2022);
4160 itemlabel = char_type(0x2013);
4163 itemlabel = char_type(0x2217);
4166 itemlabel = char_type(0x2219); // or 0x00b7
4169 par.params().labelString(itemlabel);
4173 case LABEL_ENUMERATE: {
4174 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4176 switch (par.itemdepth) {
4185 enumcounter += "iv";
4188 // not a valid enumdepth...
4192 // Maybe we have to reset the enumeration counter.
4193 if (needEnumCounterReset(it))
4194 counters.reset(enumcounter);
4195 counters.step(enumcounter, utype);
4197 string const & lang = par.getParLanguage(bp)->code();
4198 par.params().labelString(counters.theCounter(enumcounter, lang));
4203 case LABEL_SENSITIVE: {
4204 string const & type = counters.current_float();
4205 docstring full_label;
4207 full_label = owner_->B_("Senseless!!! ");
4209 docstring name = owner_->B_(textclass.floats().getType(type).name());
4210 if (counters.hasCounter(from_utf8(type))) {
4211 string const & lang = par.getParLanguage(bp)->code();
4212 counters.step(from_utf8(type), utype);
4213 full_label = bformat(from_ascii("%1$s %2$s:"),
4215 counters.theCounter(from_utf8(type), lang));
4217 full_label = bformat(from_ascii("%1$s #:"), name);
4219 par.params().labelString(full_label);
4223 case LABEL_NO_LABEL:
4224 par.params().labelString(docstring());
4228 case LABEL_TOP_ENVIRONMENT:
4229 case LABEL_CENTERED_TOP_ENVIRONMENT:
4232 par.params().labelString(par.expandLabel(layout, bp));
4238 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4240 LASSERT(parit.pit() == 0, /**/);
4242 // Set the position of the text in the buffer to be able
4243 // to resolve macros in it.
4244 parit.text()->setMacrocontextPosition(parit);
4246 depth_type maxdepth = 0;
4247 pit_type const lastpit = parit.lastpit();
4248 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4249 // reduce depth if necessary
4250 parit->params().depth(min(parit->params().depth(), maxdepth));
4251 maxdepth = parit->getMaxDepthAfter();
4253 if (utype == OutputUpdate) {
4254 // track the active counters
4255 // we have to do this for the master buffer, since the local
4256 // buffer isn't tracking anything.
4257 masterBuffer()->params().documentClass().counters().
4258 setActiveLayout(parit->layout());
4261 // set the counter for this paragraph
4262 d->setLabel(parit, utype);
4265 InsetList::const_iterator iit = parit->insetList().begin();
4266 InsetList::const_iterator end = parit->insetList().end();
4267 for (; iit != end; ++iit) {
4268 parit.pos() = iit->pos;
4269 iit->inset->updateBuffer(parit, utype);
4275 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4276 WordLangTuple & word_lang, docstring_list & suggestions) const
4280 suggestions.clear();
4281 word_lang = WordLangTuple();
4282 bool const to_end = to.empty();
4283 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4284 // OK, we start from here.
4285 for (; from != end; from.forwardPos()) {
4286 // We are only interested in text so remove the math CursorSlice.
4287 while (from.inMathed()) {
4291 // If from is at the end of the document (which is possible
4292 // when leaving the mathed) LyX will crash later otherwise.
4293 if (from.atEnd() || (!to_end && from >= end))
4296 from.paragraph().spellCheck();
4297 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4298 if (SpellChecker::misspelled(res)) {
4303 // Do not increase progress when from == to, otherwise the word
4304 // count will be wrong.
4314 Buffer::ReadStatus Buffer::reload()
4317 // c.f. bug http://www.lyx.org/trac/ticket/6587
4318 removeAutosaveFile();
4319 // e.g., read-only status could have changed due to version control
4320 d->filename.refresh();
4321 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4323 ReadStatus const status = loadLyXFile();
4324 if (status == ReadSuccess) {
4329 message(bformat(_("Document %1$s reloaded."), disp_fn));
4332 message(bformat(_("Could not reload document %1$s."), disp_fn));
4342 bool Buffer::saveAs(FileName const & fn)
4344 FileName const old_name = fileName();
4345 FileName const old_auto = getAutosaveFileName();
4346 bool const old_unnamed = isUnnamed();
4353 // bring the autosave file with us, just in case.
4354 moveAutosaveFile(old_auto);
4355 // validate version control data and
4356 // correct buffer title
4357 lyxvc().file_found_hook(fileName());
4359 // the file has now been saved to the new location.
4360 // we need to check that the locations of child buffers
4362 checkChildBuffers();
4366 // reset the old filename and unnamed state
4367 setFileName(old_name);
4368 setUnnamed(old_unnamed);
4374 // FIXME We could do better here, but it is complicated. What would be
4375 // nice is to offer either (a) to save the child buffer to an appropriate
4376 // location, so that it would "move with the master", or else (b) to update
4377 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4378 // complicated, because the code for this lives in GuiView.
4379 void Buffer::checkChildBuffers()
4381 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4382 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4383 for (; it != en; ++it) {
4384 DocIterator dit = it->second;
4385 Buffer * cbuf = const_cast<Buffer *>(it->first);
4386 if (!cbuf || !theBufferList().isLoaded(cbuf))
4388 Inset * inset = dit.nextInset();
4389 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4390 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4391 docstring const & incfile = inset_inc->getParam("filename");
4392 string oldloc = cbuf->absFileName();
4393 string newloc = makeAbsPath(to_utf8(incfile),
4394 onlyPath(absFileName())).absFileName();
4395 if (oldloc == newloc)
4397 // the location of the child file is incorrect.
4398 Alert::warning(_("Included File Invalid"),
4399 bformat(_("Saving this document to a new location has made the file:\n"
4401 "inaccessible. You will need to update the included filename."),
4402 from_utf8(oldloc)));
4404 inset_inc->setChildBuffer(0);
4406 // invalidate cache of children
4407 d->children_positions.clear();
4408 d->position_to_children.clear();