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);
145 // A storehouse for the cloned buffers.
146 list<CloneList *> cloned_buffers;
152 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
156 delete preview_loader_;
164 /// search for macro in local (buffer) table or in children
165 MacroData const * getBufferMacro(docstring const & name,
166 DocIterator const & pos) const;
168 /// Update macro table starting with position of it \param it in some
170 void updateMacros(DocIterator & it, DocIterator & scope);
172 void setLabel(ParIterator & it, UpdateType utype) const;
174 /** If we have branches that use the file suffix
175 feature, return the file name with suffix appended.
177 support::FileName exportFileName() const;
184 mutable TexRow texrow;
186 /// need to regenerate .tex?
190 mutable bool lyx_clean;
192 /// is autosave needed?
193 mutable bool bak_clean;
195 /// is this an unnamed file (New...)?
201 /// name of the file the buffer is associated with.
204 /** Set to true only when the file is fully loaded.
205 * Used to prevent the premature generation of previews
206 * and by the citation inset.
208 bool file_fully_loaded;
211 mutable TocBackend toc_backend;
214 typedef pair<DocIterator, MacroData> ScopeMacro;
215 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
216 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
217 /// map from the macro name to the position map,
218 /// which maps the macro definition position to the scope and the MacroData.
219 NamePositionScopeMacroMap macros;
220 /// This seem to change the way Buffer::getMacro() works
221 mutable bool macro_lock;
223 /// positions of child buffers in the buffer
224 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
225 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
226 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
227 /// position of children buffers in this buffer
228 BufferPositionMap children_positions;
229 /// map from children inclusion positions to their scope and their buffer
230 PositionScopeBufferMap position_to_children;
232 /// Container for all sort of Buffer dependant errors.
233 map<string, ErrorList> errorLists;
235 /// timestamp and checksum used to test if the file has been externally
236 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
238 unsigned long checksum_;
241 frontend::WorkAreaManager * wa_;
243 frontend::GuiBufferDelegate * gui_;
248 /// A cache for the bibfiles (including bibfiles of loaded child
249 /// documents), needed for appropriate update of natbib labels.
250 mutable support::FileNameList bibfiles_cache_;
252 // FIXME The caching mechanism could be improved. At present, we have a
253 // cache for each Buffer, that caches all the bibliography info for that
254 // Buffer. A more efficient solution would be to have a global cache per
255 // file, and then to construct the Buffer's bibinfo from that.
256 /// A cache for bibliography info
257 mutable BiblioInfo bibinfo_;
258 /// whether the bibinfo cache is valid
259 mutable bool bibinfo_cache_valid_;
260 /// whether the bibfile cache is valid
261 mutable bool bibfile_cache_valid_;
262 /// Cache of timestamps of .bib files
263 map<FileName, time_t> bibfile_status_;
264 /// Indicates whether the bibinfo has changed since the last time
265 /// we ran updateBuffer(), i.e., whether citation labels may need
267 mutable bool cite_labels_valid_;
269 mutable RefCache ref_cache_;
271 /// our Text that should be wrapped in an InsetText
275 PreviewLoader * preview_loader_;
277 /// This is here to force the test to be done whenever parent_buffer
279 Buffer const * parent() const {
280 // if parent_buffer is not loaded, then it has been unloaded,
281 // which means that parent_buffer is an invalid pointer. So we
282 // set it to null in that case.
283 // however, the BufferList doesn't know about cloned buffers, so
284 // they will always be regarded as unloaded. in that case, we hope
286 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
288 return parent_buffer;
292 void setParent(Buffer const * pb) {
293 if (parent_buffer == pb)
296 if (!cloned_buffer_ && parent_buffer && pb)
297 LYXERR0("Warning: a buffer should not have two parents!");
299 if (!cloned_buffer_ && parent_buffer) {
300 parent_buffer->invalidateBibfileCache();
301 parent_buffer->invalidateBibinfoCache();
305 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
306 /// This one is useful for preview detached in a thread.
307 Buffer const * cloned_buffer_;
309 CloneList * clone_list_;
310 /// are we in the process of exporting this buffer?
311 mutable bool doing_export;
313 /// compute statistics
314 /// \p from initial position
315 /// \p to points to the end position
316 void updateStatistics(DocIterator & from, DocIterator & to,
317 bool skipNoOutput = true);
318 /// statistics accessor functions
319 int wordCount() const { return word_count_; }
320 int charCount(bool with_blanks) const {
322 + (with_blanks ? blank_count_ : 0);
326 /// So we can force access via the accessors.
327 mutable Buffer const * parent_buffer;
336 /// Creates the per buffer temporary directory
337 static FileName createBufferTmpDir()
340 // We are in our own directory. Why bother to mangle name?
341 // In fact I wrote this code to circumvent a problematic behaviour
342 // (bug?) of EMX mkstemp().
343 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
344 convert<string>(count++));
346 if (!tmpfl.createDirectory(0777)) {
347 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
348 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
349 from_utf8(tmpfl.absFileName())));
355 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
356 Buffer const * cloned_buffer)
357 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
358 read_only(readonly_), filename(file), file_fully_loaded(false),
359 toc_backend(owner), macro_lock(false), timestamp_(0), checksum_(0),
360 wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
361 bibfile_cache_valid_(false), cite_labels_valid_(false),
362 preview_loader_(0), cloned_buffer_(cloned_buffer), clone_list_(0),
363 doing_export(false), parent_buffer(0)
365 if (!cloned_buffer_) {
366 temppath = createBufferTmpDir();
367 lyxvc.setBuffer(owner_);
369 wa_ = new frontend::WorkAreaManager;
372 temppath = cloned_buffer_->d->temppath;
373 file_fully_loaded = true;
374 params = cloned_buffer_->d->params;
375 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
376 bibinfo_ = cloned_buffer_->d->bibinfo_;
377 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
378 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
379 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
380 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
381 unnamed = cloned_buffer_->d->unnamed;
385 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
386 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
388 LYXERR(Debug::INFO, "Buffer::Buffer()");
390 d->inset = new InsetText(*cloned_buffer->d->inset);
391 d->inset->setBuffer(*this);
392 // FIXME: optimize this loop somewhat, maybe by creating a new
393 // general recursive Inset::setId().
394 DocIterator it = doc_iterator_begin(this);
395 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
396 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
397 it.paragraph().setId(cloned_it.paragraph().id());
399 d->inset = new InsetText(this);
400 d->inset->setAutoBreakRows(true);
401 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
407 LYXERR(Debug::INFO, "Buffer::~Buffer()");
408 // here the buffer should take care that it is
409 // saved properly, before it goes into the void.
411 // GuiView already destroyed
415 // No need to do additional cleanups for internal buffer.
421 // this is in case of recursive includes: we won't try to delete
422 // ourselves as a child.
423 d->clone_list_->erase(this);
424 // loop over children
425 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
426 Impl::BufferPositionMap::iterator end = d->children_positions.end();
427 for (; it != end; ++it) {
428 Buffer * child = const_cast<Buffer *>(it->first);
429 if (d->clone_list_->erase(child))
432 // if we're the master buffer, then we should get rid of the list
435 // if this is not empty, we have leaked something. worse, one of the
436 // children still has a reference to this list.
437 LASSERT(d->clone_list_->empty(), /* */);
438 list<CloneList *>::iterator it =
439 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
440 LASSERT(it != cloned_buffers.end(), /* */);
441 cloned_buffers.erase(it);
442 delete d->clone_list_;
444 // FIXME Do we really need to do this right before we delete d?
445 // clear references to children in macro tables
446 d->children_positions.clear();
447 d->position_to_children.clear();
449 // loop over children
450 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
451 Impl::BufferPositionMap::iterator end = d->children_positions.end();
452 for (; it != end; ++it) {
453 Buffer * child = const_cast<Buffer *>(it->first);
454 if (theBufferList().isLoaded(child))
455 theBufferList().releaseChild(this, child);
459 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
460 msg += emergencyWrite();
461 Alert::warning(_("Attempting to close changed document!"), msg);
464 // FIXME Do we really need to do this right before we delete d?
465 // clear references to children in macro tables
466 d->children_positions.clear();
467 d->position_to_children.clear();
469 if (!d->temppath.destroyDirectory()) {
470 Alert::warning(_("Could not remove temporary directory"),
471 bformat(_("Could not remove the temporary directory %1$s"),
472 from_utf8(d->temppath.absFileName())));
481 Buffer * Buffer::cloneFromMaster() const
484 cloned_buffers.push_back(new CloneList());
485 CloneList * clones = cloned_buffers.back();
487 masterBuffer()->cloneWithChildren(bufmap, clones);
489 // make sure we got cloned
490 BufferMap::const_iterator bit = bufmap.find(this);
491 LASSERT(bit != bufmap.end(), return 0);
492 Buffer * cloned_buffer = bit->second;
494 return cloned_buffer;
498 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
500 // have we already been cloned?
501 if (bufmap.find(this) != bufmap.end())
504 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
505 bufmap[this] = buffer_clone;
506 clones->insert(buffer_clone);
507 buffer_clone->d->clone_list_ = clones;
508 buffer_clone->d->macro_lock = true;
509 buffer_clone->d->children_positions.clear();
510 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
511 // math macro caches need to be rethought and simplified.
512 // I am not sure wether we should handle Buffer cloning here or in BufferList.
513 // Right now BufferList knows nothing about buffer clones.
514 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
515 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
516 for (; it != end; ++it) {
517 DocIterator dit = it->first.clone(buffer_clone);
518 dit.setBuffer(buffer_clone);
519 Buffer * child = const_cast<Buffer *>(it->second.second);
521 child->cloneWithChildren(bufmap, clones);
522 BufferMap::iterator const bit = bufmap.find(child);
523 LASSERT(bit != bufmap.end(), continue);
524 Buffer * child_clone = bit->second;
526 Inset * inset = dit.nextInset();
527 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
528 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
529 inset_inc->setChildBuffer(child_clone);
530 child_clone->d->setParent(buffer_clone);
531 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
532 buffer_clone->setChild(dit, child_clone);
534 buffer_clone->d->macro_lock = false;
539 Buffer * Buffer::cloneBufferOnly() const {
540 cloned_buffers.push_back(new CloneList());
541 CloneList * clones = cloned_buffers.back();
542 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
543 clones->insert(buffer_clone);
544 buffer_clone->d->clone_list_ = clones;
545 // we won't be cloning the children
546 buffer_clone->d->children_positions.clear();
551 bool Buffer::isClone() const
553 return d->cloned_buffer_;
557 void Buffer::changed(bool update_metrics) const
560 d->wa_->redrawAll(update_metrics);
564 frontend::WorkAreaManager & Buffer::workAreaManager() const
566 LASSERT(d->wa_, /**/);
571 Text & Buffer::text() const
573 return d->inset->text();
577 Inset & Buffer::inset() const
583 BufferParams & Buffer::params()
589 BufferParams const & Buffer::params() const
595 ParagraphList & Buffer::paragraphs()
597 return text().paragraphs();
601 ParagraphList const & Buffer::paragraphs() const
603 return text().paragraphs();
607 LyXVC & Buffer::lyxvc()
613 LyXVC const & Buffer::lyxvc() const
619 string const Buffer::temppath() const
621 return d->temppath.absFileName();
625 TexRow & Buffer::texrow()
631 TexRow const & Buffer::texrow() const
637 TocBackend & Buffer::tocBackend() const
639 return d->toc_backend;
643 Undo & Buffer::undo()
649 void Buffer::setChild(DocIterator const & dit, Buffer * child)
651 d->children_positions[child] = dit;
655 string Buffer::latexName(bool const no_path) const
657 FileName latex_name =
658 makeLatexName(d->exportFileName());
659 return no_path ? latex_name.onlyFileName()
660 : latex_name.absFileName();
664 FileName Buffer::Impl::exportFileName() const
666 docstring const branch_suffix =
667 params.branchlist().getFileNameSuffix();
668 if (branch_suffix.empty())
671 string const name = filename.onlyFileNameWithoutExt()
672 + to_utf8(branch_suffix);
673 FileName res(filename.onlyPath().absFileName() + "/" + name);
674 res.changeExtension(filename.extension());
680 string Buffer::logName(LogType * type) const
682 string const filename = latexName(false);
684 if (filename.empty()) {
690 string const path = temppath();
692 FileName const fname(addName(temppath(),
693 onlyFileName(changeExtension(filename,
696 // FIXME: how do we know this is the name of the build log?
697 FileName const bname(
698 addName(path, onlyFileName(
699 changeExtension(filename,
700 formats.extension(params().bufferFormat()) + ".out"))));
702 // Also consider the master buffer log file
703 FileName masterfname = fname;
705 if (masterBuffer() != this) {
706 string const mlogfile = masterBuffer()->logName(&mtype);
707 masterfname = FileName(mlogfile);
710 // If no Latex log or Build log is newer, show Build log
711 if (bname.exists() &&
712 ((!fname.exists() && !masterfname.exists())
713 || (fname.lastModified() < bname.lastModified()
714 && masterfname.lastModified() < bname.lastModified()))) {
715 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
718 return bname.absFileName();
719 // If we have a newer master file log or only a master log, show this
720 } else if (fname != masterfname
721 && (!fname.exists() && (masterfname.exists()
722 || fname.lastModified() < masterfname.lastModified()))) {
723 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
726 return masterfname.absFileName();
728 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
731 return fname.absFileName();
735 void Buffer::setReadonly(bool const flag)
737 if (d->read_only != flag) {
744 void Buffer::setFileName(FileName const & fname)
747 setReadonly(d->filename.isReadOnly());
753 int Buffer::readHeader(Lexer & lex)
755 int unknown_tokens = 0;
757 int begin_header_line = -1;
759 // Initialize parameters that may be/go lacking in header:
760 params().branchlist().clear();
761 params().preamble.erase();
762 params().options.erase();
763 params().master.erase();
764 params().float_placement.erase();
765 params().paperwidth.erase();
766 params().paperheight.erase();
767 params().leftmargin.erase();
768 params().rightmargin.erase();
769 params().topmargin.erase();
770 params().bottommargin.erase();
771 params().headheight.erase();
772 params().headsep.erase();
773 params().footskip.erase();
774 params().columnsep.erase();
775 params().fonts_cjk.erase();
776 params().listings_params.clear();
777 params().clearLayoutModules();
778 params().clearRemovedModules();
779 params().clearIncludedChildren();
780 params().pdfoptions().clear();
781 params().indiceslist().clear();
782 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
783 params().isbackgroundcolor = false;
784 params().fontcolor = RGBColor(0, 0, 0);
785 params().isfontcolor = false;
786 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
787 params().boxbgcolor = RGBColor(0xFF, 0, 0);
788 params().html_latex_start.clear();
789 params().html_latex_end.clear();
790 params().html_math_img_scale = 1.0;
791 params().output_sync_macro.erase();
792 params().local_layout.clear();
794 for (int i = 0; i < 4; ++i) {
795 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
796 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
799 ErrorList & errorList = d->errorLists["Parse"];
808 if (token == "\\end_header")
812 if (token == "\\begin_header") {
813 begin_header_line = line;
817 LYXERR(Debug::PARSER, "Handling document header token: `"
820 string unknown = params().readToken(lex, token, d->filename.onlyPath());
821 if (!unknown.empty()) {
822 if (unknown[0] != '\\' && token == "\\textclass") {
823 Alert::warning(_("Unknown document class"),
824 bformat(_("Using the default document class, because the "
825 "class %1$s is unknown."), from_utf8(unknown)));
828 docstring const s = bformat(_("Unknown token: "
832 errorList.push_back(ErrorItem(_("Document header error"),
837 if (begin_header_line) {
838 docstring const s = _("\\begin_header is missing");
839 errorList.push_back(ErrorItem(_("Document header error"),
843 params().makeDocumentClass();
845 return unknown_tokens;
850 // changed to be public and have one parameter
851 // Returns true if "\end_document" is not read (Asger)
852 bool Buffer::readDocument(Lexer & lex)
854 ErrorList & errorList = d->errorLists["Parse"];
857 // remove dummy empty par
858 paragraphs().clear();
860 if (!lex.checkFor("\\begin_document")) {
861 docstring const s = _("\\begin_document is missing");
862 errorList.push_back(ErrorItem(_("Document header error"),
868 if (params().outputChanges) {
869 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
870 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
871 LaTeXFeatures::isAvailable("xcolor");
873 if (!dvipost && !xcolorulem) {
874 Alert::warning(_("Changes not shown in LaTeX output"),
875 _("Changes will not be highlighted in LaTeX output, "
876 "because neither dvipost nor xcolor/ulem are installed.\n"
877 "Please install these packages or redefine "
878 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
879 } else if (!xcolorulem) {
880 Alert::warning(_("Changes not shown in LaTeX output"),
881 _("Changes will not be highlighted in LaTeX output "
882 "when using pdflatex, because xcolor and ulem are not installed.\n"
883 "Please install both packages or redefine "
884 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
888 if (!params().master.empty()) {
889 FileName const master_file = makeAbsPath(params().master,
890 onlyPath(absFileName()));
891 if (isLyXFileName(master_file.absFileName())) {
893 checkAndLoadLyXFile(master_file, true);
895 // necessary e.g. after a reload
896 // to re-register the child (bug 5873)
897 // FIXME: clean up updateMacros (here, only
898 // child registering is needed).
899 master->updateMacros();
900 // set master as master buffer, but only
901 // if we are a real child
902 if (master->isChild(this))
904 // if the master is not fully loaded
905 // it is probably just loading this
906 // child. No warning needed then.
907 else if (master->isFullyLoaded())
908 LYXERR0("The master '"
910 << "' assigned to this document ("
912 << ") does not include "
913 "this document. Ignoring the master assignment.");
918 // assure we have a default index
919 params().indiceslist().addDefault(B_("Index"));
922 bool const res = text().read(lex, errorList, d->inset);
924 // inform parent buffer about local macros
926 Buffer const * pbuf = parent();
927 UserMacroSet::const_iterator cit = usermacros.begin();
928 UserMacroSet::const_iterator end = usermacros.end();
929 for (; cit != end; ++cit)
930 pbuf->usermacros.insert(*cit);
934 updateMacroInstances(InternalUpdate);
939 bool Buffer::readString(string const & s)
941 params().compressed = false;
946 FileName const fn = FileName::tempName("Buffer_readString");
949 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
950 if (ret_plf != ReadSuccess)
953 if (file_format != LYX_FORMAT) {
954 // We need to call lyx2lyx, so write the input to a file
955 ofstream os(fn.toFilesystemEncoding().c_str());
959 return readFile(fn) == ReadSuccess;
962 if (readDocument(lex))
968 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
972 if (!lex.setFile(fname)) {
973 Alert::error(_("File Not Found"),
974 bformat(_("Unable to open file `%1$s'."),
975 from_utf8(fn.absFileName())));
976 return ReadFileNotFound;
980 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
981 if (ret_plf != ReadSuccess)
984 if (file_format != LYX_FORMAT) {
986 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
987 if (ret_clf != ReadSuccess)
989 return readFile(tmpFile);
992 // FIXME: InsetInfo needs to know whether the file is under VCS
993 // during the parse process, so this has to be done before.
994 lyxvc().file_found_hook(d->filename);
996 if (readDocument(lex)) {
997 Alert::error(_("Document format failure"),
998 bformat(_("%1$s ended unexpectedly, which means"
999 " that it is probably corrupted."),
1000 from_utf8(fn.absFileName())));
1001 return ReadDocumentFailure;
1004 d->file_fully_loaded = true;
1005 d->read_only = !d->filename.isWritable();
1006 params().compressed = formats.isZippedFile(d->filename);
1012 bool Buffer::isFullyLoaded() const
1014 return d->file_fully_loaded;
1018 void Buffer::setFullyLoaded(bool value)
1020 d->file_fully_loaded = value;
1024 PreviewLoader * Buffer::loader() const
1026 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1028 if (!d->preview_loader_)
1029 d->preview_loader_ = new PreviewLoader(*this);
1030 return d->preview_loader_;
1034 void Buffer::removePreviews() const
1036 delete d->preview_loader_;
1037 d->preview_loader_ = 0;
1041 void Buffer::updatePreviews() const
1043 PreviewLoader * ploader = loader();
1047 InsetIterator it = inset_iterator_begin(*d->inset);
1048 InsetIterator const end = inset_iterator_end(*d->inset);
1049 for (; it != end; ++it)
1050 it->addPreview(it, *ploader);
1052 ploader->startLoading();
1056 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1057 FileName const & fn, int & file_format) const
1059 if(!lex.checkFor("\\lyxformat")) {
1060 Alert::error(_("Document format failure"),
1061 bformat(_("%1$s is not a readable LyX document."),
1062 from_utf8(fn.absFileName())));
1063 return ReadNoLyXFormat;
1069 // LyX formats 217 and earlier were written as 2.17. This corresponds
1070 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1071 // these cases. See also: www.lyx.org/trac/changeset/1313.
1072 size_t dot = tmp_format.find_first_of(".,");
1073 if (dot != string::npos)
1074 tmp_format.erase(dot, 1);
1076 file_format = convert<int>(tmp_format);
1081 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1082 FileName & tmpfile, int from_format)
1084 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
1085 if(tmpfile.empty()) {
1086 Alert::error(_("Conversion failed"),
1087 bformat(_("%1$s is from a different"
1088 " version of LyX, but a temporary"
1089 " file for converting it could"
1090 " not be created."),
1091 from_utf8(fn.absFileName())));
1092 return LyX2LyXNoTempFile;
1095 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1096 if (lyx2lyx.empty()) {
1097 Alert::error(_("Conversion script not found"),
1098 bformat(_("%1$s is from a different"
1099 " version of LyX, but the"
1100 " conversion script lyx2lyx"
1101 " could not be found."),
1102 from_utf8(fn.absFileName())));
1103 return LyX2LyXNotFound;
1107 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1108 ostringstream command;
1109 command << os::python()
1110 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1111 << " -t " << convert<string>(LYX_FORMAT)
1112 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1113 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1114 string const command_str = command.str();
1116 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1118 cmd_ret const ret = runCommand(command_str);
1119 if (ret.first != 0) {
1120 if (from_format < LYX_FORMAT) {
1121 Alert::error(_("Conversion script failed"),
1122 bformat(_("%1$s is from an older version"
1123 " of LyX and the lyx2lyx script"
1124 " failed to convert it."),
1125 from_utf8(fn.absFileName())));
1126 return LyX2LyXOlderFormat;
1128 Alert::error(_("Conversion script failed"),
1129 bformat(_("%1$s is from a newer version"
1130 " of LyX and the lyx2lyx script"
1131 " failed to convert it."),
1132 from_utf8(fn.absFileName())));
1133 return LyX2LyXNewerFormat;
1140 // Should probably be moved to somewhere else: BufferView? GuiView?
1141 bool Buffer::save() const
1143 docstring const file = makeDisplayPath(absFileName(), 20);
1144 d->filename.refresh();
1146 // check the read-only status before moving the file as a backup
1147 if (d->filename.exists()) {
1148 bool const read_only = !d->filename.isWritable();
1150 Alert::warning(_("File is read-only"),
1151 bformat(_("The file %1$s cannot be written because it "
1152 "is marked as read-only."), file));
1157 // ask if the disk file has been externally modified (use checksum method)
1158 if (fileName().exists() && isExternallyModified(checksum_method)) {
1160 bformat(_("Document %1$s has been externally modified. "
1161 "Are you sure you want to overwrite this file?"), file);
1162 int const ret = Alert::prompt(_("Overwrite modified file?"),
1163 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1168 // We don't need autosaves in the immediate future. (Asger)
1169 resetAutosaveTimers();
1171 FileName backupName;
1172 bool madeBackup = false;
1174 // make a backup if the file already exists
1175 if (lyxrc.make_backup && fileName().exists()) {
1176 backupName = FileName(absFileName() + '~');
1177 if (!lyxrc.backupdir_path.empty()) {
1178 string const mangledName =
1179 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1180 backupName = FileName(addName(lyxrc.backupdir_path,
1184 // Except file is symlink do not copy because of #6587.
1185 // Hard links have bad luck.
1186 if (fileName().isSymLink())
1187 madeBackup = fileName().copyTo(backupName);
1189 madeBackup = fileName().moveTo(backupName);
1192 Alert::error(_("Backup failure"),
1193 bformat(_("Cannot create backup file %1$s.\n"
1194 "Please check whether the directory exists and is writable."),
1195 from_utf8(backupName.absFileName())));
1196 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1200 if (writeFile(d->filename)) {
1204 // Saving failed, so backup is not backup
1206 backupName.moveTo(d->filename);
1212 bool Buffer::writeFile(FileName const & fname) const
1214 // FIXME Do we need to do these here? I don't think writing
1215 // the LyX file depends upon it. (RGH)
1217 // updateMacroInstances();
1219 if (d->read_only && fname == d->filename)
1222 bool retval = false;
1224 docstring const str = bformat(_("Saving document %1$s..."),
1225 makeDisplayPath(fname.absFileName()));
1228 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1230 if (params().compressed) {
1231 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1232 retval = ofs && write(ofs);
1234 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1235 retval = ofs && write(ofs);
1239 message(str + _(" could not write file!"));
1244 // removeAutosaveFile();
1247 message(str + _(" done."));
1253 docstring Buffer::emergencyWrite()
1255 // No need to save if the buffer has not changed.
1259 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1261 docstring user_message = bformat(
1262 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1264 // We try to save three places:
1265 // 1) Same place as document. Unless it is an unnamed doc.
1267 string s = absFileName();
1270 if (writeFile(FileName(s))) {
1272 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1273 return user_message;
1275 user_message += " " + _("Save failed! Trying again...\n");
1279 // 2) In HOME directory.
1280 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1282 lyxerr << ' ' << s << endl;
1283 if (writeFile(FileName(s))) {
1285 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1286 return user_message;
1289 user_message += " " + _("Save failed! Trying yet again...\n");
1291 // 3) In "/tmp" directory.
1292 // MakeAbsPath to prepend the current
1293 // drive letter on OS/2
1294 s = addName(package().temp_dir().absFileName(), absFileName());
1296 lyxerr << ' ' << s << endl;
1297 if (writeFile(FileName(s))) {
1299 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1300 return user_message;
1303 user_message += " " + _("Save failed! Bummer. Document is lost.");
1306 return user_message;
1310 bool Buffer::write(ostream & ofs) const
1313 // Use the standard "C" locale for file output.
1314 ofs.imbue(locale::classic());
1317 // The top of the file should not be written by params().
1319 // write out a comment in the top of the file
1320 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1321 << " created this file. For more info see http://www.lyx.org/\n"
1322 << "\\lyxformat " << LYX_FORMAT << "\n"
1323 << "\\begin_document\n";
1325 /// For each author, set 'used' to true if there is a change
1326 /// by this author in the document; otherwise set it to 'false'.
1327 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1328 AuthorList::Authors::const_iterator a_end = params().authors().end();
1329 for (; a_it != a_end; ++a_it)
1330 a_it->setUsed(false);
1332 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1333 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1334 for ( ; it != end; ++it)
1335 it->checkAuthors(params().authors());
1337 // now write out the buffer parameters.
1338 ofs << "\\begin_header\n";
1339 params().writeFile(ofs);
1340 ofs << "\\end_header\n";
1343 ofs << "\n\\begin_body\n";
1345 ofs << "\n\\end_body\n";
1347 // Write marker that shows file is complete
1348 ofs << "\\end_document" << endl;
1350 // Shouldn't really be needed....
1353 // how to check if close went ok?
1354 // Following is an attempt... (BE 20001011)
1356 // good() returns false if any error occured, including some
1357 // formatting error.
1358 // bad() returns true if something bad happened in the buffer,
1359 // which should include file system full errors.
1364 lyxerr << "File was not closed properly." << endl;
1371 bool Buffer::makeLaTeXFile(FileName const & fname,
1372 string const & original_path,
1373 OutputParams const & runparams_in,
1374 OutputWhat output) const
1376 OutputParams runparams = runparams_in;
1378 // This is necessary for LuaTeX/XeTeX with tex fonts.
1379 // See FIXME in BufferParams::encoding()
1380 if (runparams.isFullUnicode())
1381 runparams.encoding = encodings.fromLyXName("utf8-plain");
1383 string const encoding = runparams.encoding->iconvName();
1384 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1387 try { ofs.reset(encoding); }
1388 catch (iconv_codecvt_facet_exception & e) {
1389 lyxerr << "Caught iconv exception: " << e.what() << endl;
1390 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1391 "verify that the support software for your encoding (%1$s) is "
1392 "properly installed"), from_ascii(encoding)));
1395 if (!openFileWrite(ofs, fname))
1398 //TexStream ts(ofs.rdbuf(), &texrow());
1399 ErrorList & errorList = d->errorLists["Export"];
1401 bool failed_export = false;
1402 otexstream os(ofs, d->texrow);
1404 // make sure we are ready to export
1405 // this needs to be done before we validate
1406 // FIXME Do we need to do this all the time? I.e., in children
1407 // of a master we are exporting?
1409 updateMacroInstances(OutputUpdate);
1412 os.texrow().reset();
1413 writeLaTeXSource(os, original_path, runparams, output);
1415 catch (EncodingException & e) {
1416 odocstringstream ods;
1417 ods.put(e.failed_char);
1419 oss << "0x" << hex << e.failed_char << dec;
1420 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1421 " (code point %2$s)"),
1422 ods.str(), from_utf8(oss.str()));
1423 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1424 "representable in the chosen encoding.\n"
1425 "Changing the document encoding to utf8 could help."),
1426 e.par_id, e.pos, e.pos + 1));
1427 failed_export = true;
1429 catch (iconv_codecvt_facet_exception & e) {
1430 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1431 _(e.what()), -1, 0, 0));
1432 failed_export = true;
1434 catch (exception const & e) {
1435 errorList.push_back(ErrorItem(_("conversion failed"),
1436 _(e.what()), -1, 0, 0));
1437 failed_export = true;
1440 lyxerr << "Caught some really weird exception..." << endl;
1446 failed_export = true;
1447 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1451 return !failed_export;
1455 void Buffer::writeLaTeXSource(otexstream & os,
1456 string const & original_path,
1457 OutputParams const & runparams_in,
1458 OutputWhat output) const
1460 // The child documents, if any, shall be already loaded at this point.
1462 OutputParams runparams = runparams_in;
1464 // Classify the unicode characters appearing in math insets
1465 Encodings::initUnicodeMath(*this);
1467 // validate the buffer.
1468 LYXERR(Debug::LATEX, " Validating buffer...");
1469 LaTeXFeatures features(*this, params(), runparams);
1471 LYXERR(Debug::LATEX, " Buffer validation done.");
1473 bool const output_preamble =
1474 output == FullSource || output == OnlyPreamble;
1475 bool const output_body =
1476 output == FullSource || output == OnlyBody;
1478 // The starting paragraph of the coming rows is the
1479 // first paragraph of the document. (Asger)
1480 if (output_preamble && runparams.nice) {
1481 os << "%% LyX " << lyx_version << " created this file. "
1482 "For more info, see http://www.lyx.org/.\n"
1483 "%% Do not edit unless you really know what "
1486 LYXERR(Debug::INFO, "lyx document header finished");
1488 // There are a few differences between nice LaTeX and usual files:
1489 // usual files have \batchmode and special input@path to allow
1490 // inclusion of figures specified by an explicitly relative path
1491 // (i.e., a path starting with './' or '../') with either \input or
1492 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1493 // input@path is set when the actual parameter original_path is set.
1494 // This is done for usual tex-file, but not for nice-latex-file.
1495 // (Matthias 250696)
1496 // Note that input@path is only needed for something the user does
1497 // in the preamble, included .tex files or ERT, files included by
1498 // LyX work without it.
1499 if (output_preamble) {
1500 if (!runparams.nice) {
1501 // code for usual, NOT nice-latex-file
1502 os << "\\batchmode\n"; // changed from \nonstopmode
1504 if (!original_path.empty()) {
1506 // We don't know the encoding of inputpath
1507 docstring const inputpath = from_utf8(original_path);
1508 docstring uncodable_glyphs;
1509 Encoding const * const enc = runparams.encoding;
1511 for (size_t n = 0; n < inputpath.size(); ++n) {
1512 if (!enc->encodable(inputpath[n])) {
1513 docstring const glyph(1, inputpath[n]);
1514 LYXERR0("Uncodable character '"
1516 << "' in input path!");
1517 uncodable_glyphs += glyph;
1522 // warn user if we found uncodable glyphs.
1523 if (!uncodable_glyphs.empty()) {
1524 frontend::Alert::warning(
1525 _("Uncodable character in file path"),
1527 _("The path of your document\n"
1529 "contains glyphs that are unknown "
1530 "in the current document encoding "
1531 "(namely %2$s). This may result in "
1532 "incomplete output, unless "
1533 "TEXINPUTS contains the document "
1534 "directory and you don't use "
1535 "explicitly relative paths (i.e., "
1536 "paths starting with './' or "
1537 "'../') in the preamble or in ERT."
1538 "\n\nIn case of problems, choose "
1539 "an appropriate document encoding\n"
1540 "(such as utf8) or change the "
1542 inputpath, uncodable_glyphs));
1545 support::latex_path(original_path);
1546 if (contains(docdir, '#')) {
1547 docdir = subst(docdir, "#", "\\#");
1548 os << "\\catcode`\\#=11"
1549 "\\def\\#{#}\\catcode`\\#=6\n";
1551 if (contains(docdir, '%')) {
1552 docdir = subst(docdir, "%", "\\%");
1553 os << "\\catcode`\\%=11"
1554 "\\def\\%{%}\\catcode`\\%=14\n";
1556 os << "\\makeatletter\n"
1557 << "\\def\\input@path{{"
1558 << docdir << "/}}\n"
1559 << "\\makeatother\n";
1563 // get parent macros (if this buffer has a parent) which will be
1564 // written at the document begin further down.
1565 MacroSet parentMacros;
1566 listParentMacros(parentMacros, features);
1568 runparams.use_polyglossia = features.usePolyglossia();
1569 // Write the preamble
1570 runparams.use_babel = params().writeLaTeX(os, features,
1571 d->filename.onlyPath());
1573 runparams.use_japanese = features.isRequired("japanese");
1579 os << "\\begin{document}\n";
1581 // output the parent macros
1582 MacroSet::iterator it = parentMacros.begin();
1583 MacroSet::iterator end = parentMacros.end();
1584 for (; it != end; ++it) {
1585 int num_lines = (*it)->write(os.os(), true);
1586 os.texrow().newlines(num_lines);
1589 } // output_preamble
1591 os.texrow().start(paragraphs().begin()->id(), 0);
1593 LYXERR(Debug::INFO, "preamble finished, now the body.");
1595 // if we are doing a real file with body, even if this is the
1596 // child of some other buffer, let's cut the link here.
1597 // This happens for example if only a child document is printed.
1598 Buffer const * save_parent = 0;
1599 if (output_preamble) {
1600 save_parent = d->parent();
1605 latexParagraphs(*this, text(), os, runparams);
1607 // Restore the parenthood if needed
1608 if (output_preamble)
1609 d->setParent(save_parent);
1611 // add this just in case after all the paragraphs
1614 if (output_preamble) {
1615 os << "\\end{document}\n";
1616 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1618 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1620 runparams_in.encoding = runparams.encoding;
1622 // Just to be sure. (Asger)
1623 os.texrow().newline();
1625 //for (int i = 0; i<d->texrow.rows(); i++) {
1627 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1628 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1631 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1632 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1636 void Buffer::makeDocBookFile(FileName const & fname,
1637 OutputParams const & runparams,
1638 OutputWhat output) const
1640 LYXERR(Debug::LATEX, "makeDocBookFile...");
1643 if (!openFileWrite(ofs, fname))
1646 // make sure we are ready to export
1647 // this needs to be done before we validate
1649 updateMacroInstances(OutputUpdate);
1651 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1655 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1659 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1660 OutputParams const & runparams,
1661 OutputWhat output) const
1663 LaTeXFeatures features(*this, params(), runparams);
1668 DocumentClass const & tclass = params().documentClass();
1669 string const top_element = tclass.latexname();
1671 bool const output_preamble =
1672 output == FullSource || output == OnlyPreamble;
1673 bool const output_body =
1674 output == FullSource || output == OnlyBody;
1676 if (output_preamble) {
1677 if (runparams.flavor == OutputParams::XML)
1678 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1681 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1684 if (! tclass.class_header().empty())
1685 os << from_ascii(tclass.class_header());
1686 else if (runparams.flavor == OutputParams::XML)
1687 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1688 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1690 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1692 docstring preamble = from_utf8(params().preamble);
1693 if (runparams.flavor != OutputParams::XML ) {
1694 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1695 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1696 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1697 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1700 string const name = runparams.nice
1701 ? changeExtension(absFileName(), ".sgml") : fname;
1702 preamble += features.getIncludedFiles(name);
1703 preamble += features.getLyXSGMLEntities();
1705 if (!preamble.empty()) {
1706 os << "\n [ " << preamble << " ]";
1712 string top = top_element;
1714 if (runparams.flavor == OutputParams::XML)
1715 top += params().language->code();
1717 top += params().language->code().substr(0, 2);
1720 if (!params().options.empty()) {
1722 top += params().options;
1725 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1726 << " file was created by LyX " << lyx_version
1727 << "\n See http://www.lyx.org/ for more information -->\n";
1729 params().documentClass().counters().reset();
1731 sgml::openTag(os, top);
1733 docbookParagraphs(text(), *this, os, runparams);
1734 sgml::closeTag(os, top_element);
1739 void Buffer::makeLyXHTMLFile(FileName const & fname,
1740 OutputParams const & runparams) const
1742 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1745 if (!openFileWrite(ofs, fname))
1748 // make sure we are ready to export
1749 // this has to be done before we validate
1750 updateBuffer(UpdateMaster, OutputUpdate);
1751 updateMacroInstances(OutputUpdate);
1753 writeLyXHTMLSource(ofs, runparams, FullSource);
1757 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1761 void Buffer::writeLyXHTMLSource(odocstream & os,
1762 OutputParams const & runparams,
1763 OutputWhat output) const
1765 LaTeXFeatures features(*this, params(), runparams);
1767 d->bibinfo_.makeCitationLabels(*this);
1769 bool const output_preamble =
1770 output == FullSource || output == OnlyPreamble;
1771 bool const output_body =
1772 output == FullSource || output == OnlyBody || output == IncludedFile;
1774 if (output_preamble) {
1775 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1776 << "<!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"
1777 // FIXME Language should be set properly.
1778 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1780 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1781 // FIXME Presumably need to set this right
1782 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1784 docstring const & doctitle = features.htmlTitle();
1786 << (doctitle.empty() ?
1787 from_ascii("LyX Document") :
1788 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
1791 docstring styles = features.getTClassHTMLPreamble();
1792 if (!styles.empty())
1793 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
1795 styles = from_utf8(features.getPreambleSnippets());
1796 if (!styles.empty())
1797 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
1799 // we will collect CSS information in a stream, and then output it
1800 // either here, as part of the header, or else in a separate file.
1801 odocstringstream css;
1802 styles = from_utf8(features.getCSSSnippets());
1803 if (!styles.empty())
1804 css << "/* LyX Provided Styles */\n" << styles << '\n';
1806 styles = features.getTClassHTMLStyles();
1807 if (!styles.empty())
1808 css << "/* Layout-provided Styles */\n" << styles << '\n';
1810 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1811 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1812 if (needfg || needbg) {
1813 css << "\nbody {\n";
1816 << from_ascii(X11hexname(params().fontcolor))
1819 css << " background-color: "
1820 << from_ascii(X11hexname(params().backgroundcolor))
1825 docstring const dstyles = css.str();
1826 if (!dstyles.empty()) {
1827 bool written = false;
1828 if (params().html_css_as_file) {
1829 // open a file for CSS info
1831 string const fcssname = addName(temppath(), "docstyle.css");
1832 FileName const fcssfile = FileName(fcssname);
1833 if (openFileWrite(ocss, fcssfile)) {
1837 // write link to header
1838 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
1840 runparams.exportdata->addExternalFile("xhtml", fcssfile);
1843 // we are here if the CSS is supposed to be written to the header
1844 // or if we failed to write it to an external file.
1846 os << "<style type='text/css'>\n"
1855 bool const output_body_tag = (output != IncludedFile);
1856 if (output_body_tag)
1859 params().documentClass().counters().reset();
1860 xhtmlParagraphs(text(), *this, xs, runparams);
1861 if (output_body_tag)
1865 if (output_preamble)
1870 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1871 // Other flags: -wall -v0 -x
1872 int Buffer::runChktex()
1876 // get LaTeX-Filename
1877 FileName const path(temppath());
1878 string const name = addName(path.absFileName(), latexName());
1879 string const org_path = filePath();
1881 PathChanger p(path); // path to LaTeX file
1882 message(_("Running chktex..."));
1884 // Generate the LaTeX file if neccessary
1885 OutputParams runparams(¶ms().encoding());
1886 runparams.flavor = OutputParams::LATEX;
1887 runparams.nice = false;
1888 runparams.linelen = lyxrc.plaintext_linelen;
1889 makeLaTeXFile(FileName(name), org_path, runparams);
1892 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1893 int const res = chktex.run(terr); // run chktex
1896 Alert::error(_("chktex failure"),
1897 _("Could not run chktex successfully."));
1898 } else if (res > 0) {
1899 ErrorList & errlist = d->errorLists["ChkTeX"];
1901 bufferErrors(terr, errlist);
1912 void Buffer::validate(LaTeXFeatures & features) const
1914 params().validate(features);
1916 for_each(paragraphs().begin(), paragraphs().end(),
1917 bind(&Paragraph::validate, _1, ref(features)));
1919 if (lyxerr.debugging(Debug::LATEX)) {
1920 features.showStruct();
1925 void Buffer::getLabelList(vector<docstring> & list) const
1927 // If this is a child document, use the master's list instead.
1929 masterBuffer()->getLabelList(list);
1934 Toc & toc = d->toc_backend.toc("label");
1935 TocIterator toc_it = toc.begin();
1936 TocIterator end = toc.end();
1937 for (; toc_it != end; ++toc_it) {
1938 if (toc_it->depth() == 0)
1939 list.push_back(toc_it->str());
1944 void Buffer::updateBibfilesCache(UpdateScope scope) const
1946 // FIXME This is probably unnecssary, given where we call this.
1947 // If this is a child document, use the parent's cache instead.
1948 if (parent() && scope != UpdateChildOnly) {
1949 masterBuffer()->updateBibfilesCache();
1953 d->bibfiles_cache_.clear();
1954 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1955 if (it->lyxCode() == BIBTEX_CODE) {
1956 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1957 support::FileNameList const bibfiles = inset.getBibFiles();
1958 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1961 } else if (it->lyxCode() == INCLUDE_CODE) {
1962 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1963 Buffer const * const incbuf = inset.getChildBuffer();
1966 support::FileNameList const & bibfiles =
1967 incbuf->getBibfilesCache(UpdateChildOnly);
1968 if (!bibfiles.empty()) {
1969 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1975 d->bibfile_cache_valid_ = true;
1976 d->bibinfo_cache_valid_ = false;
1977 d->cite_labels_valid_ = false;
1981 void Buffer::invalidateBibinfoCache() const
1983 d->bibinfo_cache_valid_ = false;
1984 d->cite_labels_valid_ = false;
1985 // also invalidate the cache for the parent buffer
1986 Buffer const * const pbuf = d->parent();
1988 pbuf->invalidateBibinfoCache();
1992 void Buffer::invalidateBibfileCache() const
1994 d->bibfile_cache_valid_ = false;
1995 d->bibinfo_cache_valid_ = false;
1996 d->cite_labels_valid_ = false;
1997 // also invalidate the cache for the parent buffer
1998 Buffer const * const pbuf = d->parent();
2000 pbuf->invalidateBibfileCache();
2004 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2006 // FIXME This is probably unnecessary, given where we call this.
2007 // If this is a child document, use the master's cache instead.
2008 Buffer const * const pbuf = masterBuffer();
2009 if (pbuf != this && scope != UpdateChildOnly)
2010 return pbuf->getBibfilesCache();
2012 if (!d->bibfile_cache_valid_)
2013 this->updateBibfilesCache(scope);
2015 return d->bibfiles_cache_;
2019 BiblioInfo const & Buffer::masterBibInfo() const
2021 Buffer const * const tmp = masterBuffer();
2023 return tmp->masterBibInfo();
2028 void Buffer::checkIfBibInfoCacheIsValid() const
2030 // use the master's cache
2031 Buffer const * const tmp = masterBuffer();
2033 tmp->checkIfBibInfoCacheIsValid();
2037 // compare the cached timestamps with the actual ones.
2038 FileNameList const & bibfiles_cache = getBibfilesCache();
2039 FileNameList::const_iterator ei = bibfiles_cache.begin();
2040 FileNameList::const_iterator en = bibfiles_cache.end();
2041 for (; ei != en; ++ ei) {
2042 time_t lastw = ei->lastModified();
2043 time_t prevw = d->bibfile_status_[*ei];
2044 if (lastw != prevw) {
2045 d->bibinfo_cache_valid_ = false;
2046 d->cite_labels_valid_ = false;
2047 d->bibfile_status_[*ei] = lastw;
2053 void Buffer::reloadBibInfoCache() const
2055 // use the master's cache
2056 Buffer const * const tmp = masterBuffer();
2058 tmp->reloadBibInfoCache();
2062 checkIfBibInfoCacheIsValid();
2063 if (d->bibinfo_cache_valid_)
2066 d->bibinfo_.clear();
2068 d->bibinfo_cache_valid_ = true;
2072 void Buffer::collectBibKeys() const
2074 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2075 it->collectBibKeys(it);
2079 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2081 Buffer const * tmp = masterBuffer();
2082 BiblioInfo & masterbi = (tmp == this) ?
2083 d->bibinfo_ : tmp->d->bibinfo_;
2084 masterbi.mergeBiblioInfo(bi);
2088 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2090 Buffer const * tmp = masterBuffer();
2091 BiblioInfo & masterbi = (tmp == this) ?
2092 d->bibinfo_ : tmp->d->bibinfo_;
2097 bool Buffer::citeLabelsValid() const
2099 return masterBuffer()->d->cite_labels_valid_;
2103 void Buffer::removeBiblioTempFiles() const
2105 // We remove files that contain LaTeX commands specific to the
2106 // particular bibliographic style being used, in order to avoid
2107 // LaTeX errors when we switch style.
2108 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2109 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2110 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2111 aux_file.removeFile();
2112 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2113 bbl_file.removeFile();
2114 // Also for the parent buffer
2115 Buffer const * const pbuf = parent();
2117 pbuf->removeBiblioTempFiles();
2121 bool Buffer::isDepClean(string const & name) const
2123 DepClean::const_iterator const it = d->dep_clean.find(name);
2124 if (it == d->dep_clean.end())
2130 void Buffer::markDepClean(string const & name)
2132 d->dep_clean[name] = true;
2136 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2139 // FIXME? if there is an Buffer LFUN that can be dispatched even
2140 // if internal, put a switch '(cmd.action)' here.
2146 switch (cmd.action()) {
2148 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2149 flag.setOnOff(isReadonly());
2152 // FIXME: There is need for a command-line import.
2153 //case LFUN_BUFFER_IMPORT:
2155 case LFUN_BUFFER_AUTO_SAVE:
2158 case LFUN_BUFFER_EXPORT_CUSTOM:
2159 // FIXME: Nothing to check here?
2162 case LFUN_BUFFER_EXPORT: {
2163 docstring const arg = cmd.argument();
2164 if (arg == "custom") {
2168 string format = to_utf8(arg);
2169 size_t pos = format.find(' ');
2170 if (pos != string::npos)
2171 format = format.substr(0, pos);
2172 enable = params().isExportable(format);
2174 flag.message(bformat(
2175 _("Don't know how to export to format: %1$s"), arg));
2179 case LFUN_BUFFER_CHKTEX:
2180 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2183 case LFUN_BUILD_PROGRAM:
2184 enable = params().isExportable("program");
2187 case LFUN_BRANCH_ADD:
2188 case LFUN_BRANCHES_RENAME:
2189 case LFUN_BUFFER_PRINT:
2190 // if no Buffer is present, then of course we won't be called!
2193 case LFUN_BUFFER_LANGUAGE:
2194 enable = !isReadonly();
2200 flag.setEnabled(enable);
2205 void Buffer::dispatch(string const & command, DispatchResult & result)
2207 return dispatch(lyxaction.lookupFunc(command), result);
2211 // NOTE We can end up here even if we have no GUI, because we are called
2212 // by LyX::exec to handled command-line requests. So we may need to check
2213 // whether we have a GUI or not. The boolean use_gui holds this information.
2214 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2217 // FIXME? if there is an Buffer LFUN that can be dispatched even
2218 // if internal, put a switch '(cmd.action())' here.
2219 dr.dispatched(false);
2222 string const argument = to_utf8(func.argument());
2223 // We'll set this back to false if need be.
2224 bool dispatched = true;
2225 undo().beginUndoGroup();
2227 switch (func.action()) {
2228 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2229 if (lyxvc().inUse())
2230 lyxvc().toggleReadOnly();
2232 setReadonly(!isReadonly());
2235 case LFUN_BUFFER_EXPORT: {
2236 ExportStatus const status = doExport(argument, false);
2237 dr.setError(status != ExportSuccess);
2238 if (status != ExportSuccess)
2239 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2244 case LFUN_BUILD_PROGRAM:
2245 doExport("program", true);
2248 case LFUN_BUFFER_CHKTEX:
2252 case LFUN_BUFFER_EXPORT_CUSTOM: {
2254 string command = split(argument, format_name, ' ');
2255 Format const * format = formats.getFormat(format_name);
2257 lyxerr << "Format \"" << format_name
2258 << "\" not recognized!"
2263 // The name of the file created by the conversion process
2266 // Output to filename
2267 if (format->name() == "lyx") {
2268 string const latexname = latexName(false);
2269 filename = changeExtension(latexname,
2270 format->extension());
2271 filename = addName(temppath(), filename);
2273 if (!writeFile(FileName(filename)))
2277 doExport(format_name, true, filename);
2280 // Substitute $$FName for filename
2281 if (!contains(command, "$$FName"))
2282 command = "( " + command + " ) < $$FName";
2283 command = subst(command, "$$FName", filename);
2285 // Execute the command in the background
2287 call.startscript(Systemcall::DontWait, command, filePath());
2291 // FIXME: There is need for a command-line import.
2293 case LFUN_BUFFER_IMPORT:
2298 case LFUN_BUFFER_AUTO_SAVE:
2300 resetAutosaveTimers();
2303 case LFUN_BRANCH_ADD: {
2304 docstring branch_name = func.argument();
2305 if (branch_name.empty()) {
2309 BranchList & branch_list = params().branchlist();
2310 vector<docstring> const branches =
2311 getVectorFromString(branch_name, branch_list.separator());
2313 for (vector<docstring>::const_iterator it = branches.begin();
2314 it != branches.end(); ++it) {
2316 Branch * branch = branch_list.find(branch_name);
2318 LYXERR0("Branch " << branch_name << " already exists.");
2322 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2324 branch_list.add(branch_name);
2325 branch = branch_list.find(branch_name);
2326 string const x11hexname = X11hexname(branch->color());
2327 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2328 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2330 dr.screenUpdate(Update::Force);
2338 case LFUN_BRANCHES_RENAME: {
2339 if (func.argument().empty())
2342 docstring const oldname = from_utf8(func.getArg(0));
2343 docstring const newname = from_utf8(func.getArg(1));
2344 InsetIterator it = inset_iterator_begin(inset());
2345 InsetIterator const end = inset_iterator_end(inset());
2346 bool success = false;
2347 for (; it != end; ++it) {
2348 if (it->lyxCode() == BRANCH_CODE) {
2349 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2350 if (ins.branch() == oldname) {
2351 undo().recordUndo(it);
2352 ins.rename(newname);
2357 if (it->lyxCode() == INCLUDE_CODE) {
2358 // get buffer of external file
2359 InsetInclude const & ins =
2360 static_cast<InsetInclude const &>(*it);
2361 Buffer * child = ins.getChildBuffer();
2364 child->dispatch(func, dr);
2369 dr.screenUpdate(Update::Force);
2370 dr.forceBufferUpdate();
2375 case LFUN_BUFFER_PRINT: {
2376 // we'll assume there's a problem until we succeed
2378 string target = func.getArg(0);
2379 string target_name = func.getArg(1);
2380 string command = func.getArg(2);
2383 || target_name.empty()
2384 || command.empty()) {
2385 LYXERR0("Unable to parse " << func.argument());
2386 docstring const msg =
2387 bformat(_("Unable to parse \"%1$s\""), func.argument());
2391 if (target != "printer" && target != "file") {
2392 LYXERR0("Unrecognized target \"" << target << '"');
2393 docstring const msg =
2394 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2399 if (!doExport("dvi", true)) {
2400 showPrintError(absFileName());
2401 dr.setMessage(_("Error exporting to DVI."));
2405 // Push directory path.
2406 string const path = temppath();
2407 // Prevent the compiler from optimizing away p
2411 // there are three cases here:
2412 // 1. we print to a file
2413 // 2. we print directly to a printer
2414 // 3. we print using a spool command (print to file first)
2417 string const dviname = changeExtension(latexName(true), "dvi");
2419 if (target == "printer") {
2420 if (!lyxrc.print_spool_command.empty()) {
2421 // case 3: print using a spool
2422 string const psname = changeExtension(dviname,".ps");
2423 command += ' ' + lyxrc.print_to_file
2426 + quoteName(dviname);
2428 string command2 = lyxrc.print_spool_command + ' ';
2429 if (target_name != "default") {
2430 command2 += lyxrc.print_spool_printerprefix
2434 command2 += quoteName(psname);
2436 // If successful, then spool command
2437 res = one.startscript(Systemcall::Wait, command,
2441 // If there's no GUI, we have to wait on this command. Otherwise,
2442 // LyX deletes the temporary directory, and with it the spooled
2443 // file, before it can be printed!!
2444 Systemcall::Starttype stype = use_gui ?
2445 Systemcall::DontWait : Systemcall::Wait;
2446 res = one.startscript(stype, command2,
2450 // case 2: print directly to a printer
2451 if (target_name != "default")
2452 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2454 Systemcall::Starttype stype = use_gui ?
2455 Systemcall::DontWait : Systemcall::Wait;
2456 res = one.startscript(stype, command +
2457 quoteName(dviname), filePath());
2461 // case 1: print to a file
2462 FileName const filename(makeAbsPath(target_name, filePath()));
2463 FileName const dvifile(makeAbsPath(dviname, path));
2464 if (filename.exists()) {
2465 docstring text = bformat(
2466 _("The file %1$s already exists.\n\n"
2467 "Do you want to overwrite that file?"),
2468 makeDisplayPath(filename.absFileName()));
2469 if (Alert::prompt(_("Overwrite file?"),
2470 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2473 command += ' ' + lyxrc.print_to_file
2474 + quoteName(filename.toFilesystemEncoding())
2476 + quoteName(dvifile.toFilesystemEncoding());
2478 Systemcall::Starttype stype = use_gui ?
2479 Systemcall::DontWait : Systemcall::Wait;
2480 res = one.startscript(stype, command, filePath());
2486 dr.setMessage(_("Error running external commands."));
2487 showPrintError(absFileName());
2496 dr.dispatched(dispatched);
2497 undo().endUndoGroup();
2501 void Buffer::changeLanguage(Language const * from, Language const * to)
2503 LASSERT(from, /**/);
2506 for_each(par_iterator_begin(),
2508 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2512 bool Buffer::isMultiLingual() const
2514 ParConstIterator end = par_iterator_end();
2515 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2516 if (it->isMultiLingual(params()))
2523 std::set<Language const *> Buffer::getLanguages() const
2525 std::set<Language const *> languages;
2526 getLanguages(languages);
2531 void Buffer::getLanguages(std::set<Language const *> & languages) const
2533 ParConstIterator end = par_iterator_end();
2534 // add the buffer language, even if it's not actively used
2535 languages.insert(language());
2536 // iterate over the paragraphs
2537 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2538 it->getLanguages(languages);
2540 ListOfBuffers clist = getDescendents();
2541 ListOfBuffers::const_iterator cit = clist.begin();
2542 ListOfBuffers::const_iterator const cen = clist.end();
2543 for (; cit != cen; ++cit)
2544 (*cit)->getLanguages(languages);
2548 DocIterator Buffer::getParFromID(int const id) const
2550 Buffer * buf = const_cast<Buffer *>(this);
2552 // John says this is called with id == -1 from undo
2553 lyxerr << "getParFromID(), id: " << id << endl;
2554 return doc_iterator_end(buf);
2557 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2558 if (it.paragraph().id() == id)
2561 return doc_iterator_end(buf);
2565 bool Buffer::hasParWithID(int const id) const
2567 return !getParFromID(id).atEnd();
2571 ParIterator Buffer::par_iterator_begin()
2573 return ParIterator(doc_iterator_begin(this));
2577 ParIterator Buffer::par_iterator_end()
2579 return ParIterator(doc_iterator_end(this));
2583 ParConstIterator Buffer::par_iterator_begin() const
2585 return ParConstIterator(doc_iterator_begin(this));
2589 ParConstIterator Buffer::par_iterator_end() const
2591 return ParConstIterator(doc_iterator_end(this));
2595 Language const * Buffer::language() const
2597 return params().language;
2601 docstring const Buffer::B_(string const & l10n) const
2603 return params().B_(l10n);
2607 bool Buffer::isClean() const
2609 return d->lyx_clean;
2613 bool Buffer::isExternallyModified(CheckMethod method) const
2615 LASSERT(d->filename.exists(), /**/);
2616 // if method == timestamp, check timestamp before checksum
2617 return (method == checksum_method
2618 || d->timestamp_ != d->filename.lastModified())
2619 && d->checksum_ != d->filename.checksum();
2623 void Buffer::saveCheckSum() const
2625 FileName const & file = d->filename;
2628 if (file.exists()) {
2629 d->timestamp_ = file.lastModified();
2630 d->checksum_ = file.checksum();
2632 // in the case of save to a new file.
2639 void Buffer::markClean() const
2641 if (!d->lyx_clean) {
2642 d->lyx_clean = true;
2645 // if the .lyx file has been saved, we don't need an
2647 d->bak_clean = true;
2648 d->undo_.markDirty();
2652 void Buffer::setUnnamed(bool flag)
2658 bool Buffer::isUnnamed() const
2665 /// Don't check unnamed, here: isInternal() is used in
2666 /// newBuffer(), where the unnamed flag has not been set by anyone
2667 /// yet. Also, for an internal buffer, there should be no need for
2668 /// retrieving fileName() nor for checking if it is unnamed or not.
2669 bool Buffer::isInternal() const
2671 return fileName().extension() == "internal";
2675 void Buffer::markDirty()
2678 d->lyx_clean = false;
2681 d->bak_clean = false;
2683 DepClean::iterator it = d->dep_clean.begin();
2684 DepClean::const_iterator const end = d->dep_clean.end();
2686 for (; it != end; ++it)
2691 FileName Buffer::fileName() const
2697 string Buffer::absFileName() const
2699 return d->filename.absFileName();
2703 string Buffer::filePath() const
2705 return d->filename.onlyPath().absFileName() + "/";
2709 bool Buffer::isReadonly() const
2711 return d->read_only;
2715 void Buffer::setParent(Buffer const * buffer)
2717 // Avoids recursive include.
2718 d->setParent(buffer == this ? 0 : buffer);
2723 Buffer const * Buffer::parent() const
2729 ListOfBuffers Buffer::allRelatives() const
2731 ListOfBuffers lb = masterBuffer()->getDescendents();
2732 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2737 Buffer const * Buffer::masterBuffer() const
2739 // FIXME Should be make sure we are not in some kind
2740 // of recursive include? A -> B -> A will crash this.
2741 Buffer const * const pbuf = d->parent();
2745 return pbuf->masterBuffer();
2749 bool Buffer::isChild(Buffer * child) const
2751 return d->children_positions.find(child) != d->children_positions.end();
2755 DocIterator Buffer::firstChildPosition(Buffer const * child)
2757 Impl::BufferPositionMap::iterator it;
2758 it = d->children_positions.find(child);
2759 if (it == d->children_positions.end())
2760 return DocIterator(this);
2765 bool Buffer::hasChildren() const
2767 return !d->children_positions.empty();
2771 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2773 // loop over children
2774 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2775 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2776 for (; it != end; ++it) {
2777 Buffer * child = const_cast<Buffer *>(it->first);
2779 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2780 if (bit != clist.end())
2782 clist.push_back(child);
2784 // there might be grandchildren
2785 child->collectChildren(clist, true);
2790 ListOfBuffers Buffer::getChildren() const
2793 collectChildren(v, false);
2794 // Make sure we have not included ourselves.
2795 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2796 if (bit != v.end()) {
2797 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2804 ListOfBuffers Buffer::getDescendents() const
2807 collectChildren(v, true);
2808 // Make sure we have not included ourselves.
2809 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2810 if (bit != v.end()) {
2811 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2818 template<typename M>
2819 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2824 typename M::const_iterator it = m.lower_bound(x);
2825 if (it == m.begin())
2833 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2834 DocIterator const & pos) const
2836 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2838 // if paragraphs have no macro context set, pos will be empty
2842 // we haven't found anything yet
2843 DocIterator bestPos = owner_->par_iterator_begin();
2844 MacroData const * bestData = 0;
2846 // find macro definitions for name
2847 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2848 if (nameIt != macros.end()) {
2849 // find last definition in front of pos or at pos itself
2850 PositionScopeMacroMap::const_iterator it
2851 = greatest_below(nameIt->second, pos);
2852 if (it != nameIt->second.end()) {
2854 // scope ends behind pos?
2855 if (pos < it->second.first) {
2856 // Looks good, remember this. If there
2857 // is no external macro behind this,
2858 // we found the right one already.
2859 bestPos = it->first;
2860 bestData = &it->second.second;
2864 // try previous macro if there is one
2865 if (it == nameIt->second.begin())
2872 // find macros in included files
2873 PositionScopeBufferMap::const_iterator it
2874 = greatest_below(position_to_children, pos);
2875 if (it == position_to_children.end())
2876 // no children before
2880 // do we know something better (i.e. later) already?
2881 if (it->first < bestPos )
2884 // scope ends behind pos?
2885 if (pos < it->second.first
2886 && (cloned_buffer_ ||
2887 theBufferList().isLoaded(it->second.second))) {
2888 // look for macro in external file
2890 MacroData const * data
2891 = it->second.second->getMacro(name, false);
2894 bestPos = it->first;
2900 // try previous file if there is one
2901 if (it == position_to_children.begin())
2906 // return the best macro we have found
2911 MacroData const * Buffer::getMacro(docstring const & name,
2912 DocIterator const & pos, bool global) const
2917 // query buffer macros
2918 MacroData const * data = d->getBufferMacro(name, pos);
2922 // If there is a master buffer, query that
2923 Buffer const * const pbuf = d->parent();
2925 d->macro_lock = true;
2926 MacroData const * macro = pbuf->getMacro(
2927 name, *this, false);
2928 d->macro_lock = false;
2934 data = MacroTable::globalMacros().get(name);
2943 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2945 // set scope end behind the last paragraph
2946 DocIterator scope = par_iterator_begin();
2947 scope.pit() = scope.lastpit() + 1;
2949 return getMacro(name, scope, global);
2953 MacroData const * Buffer::getMacro(docstring const & name,
2954 Buffer const & child, bool global) const
2956 // look where the child buffer is included first
2957 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2958 if (it == d->children_positions.end())
2961 // check for macros at the inclusion position
2962 return getMacro(name, it->second, global);
2966 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
2968 pit_type const lastpit = it.lastpit();
2970 // look for macros in each paragraph
2971 while (it.pit() <= lastpit) {
2972 Paragraph & par = it.paragraph();
2974 // iterate over the insets of the current paragraph
2975 InsetList const & insets = par.insetList();
2976 InsetList::const_iterator iit = insets.begin();
2977 InsetList::const_iterator end = insets.end();
2978 for (; iit != end; ++iit) {
2979 it.pos() = iit->pos;
2981 // is it a nested text inset?
2982 if (iit->inset->asInsetText()) {
2983 // Inset needs its own scope?
2984 InsetText const * itext = iit->inset->asInsetText();
2985 bool newScope = itext->isMacroScope();
2987 // scope which ends just behind the inset
2988 DocIterator insetScope = it;
2991 // collect macros in inset
2992 it.push_back(CursorSlice(*iit->inset));
2993 updateMacros(it, newScope ? insetScope : scope);
2998 if (iit->inset->asInsetTabular()) {
2999 CursorSlice slice(*iit->inset);
3000 size_t const numcells = slice.nargs();
3001 for (; slice.idx() < numcells; slice.forwardIdx()) {
3002 it.push_back(slice);
3003 updateMacros(it, scope);
3009 // is it an external file?
3010 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3011 // get buffer of external file
3012 InsetInclude const & inset =
3013 static_cast<InsetInclude const &>(*iit->inset);
3015 Buffer * child = inset.getChildBuffer();
3020 // register its position, but only when it is
3021 // included first in the buffer
3022 if (children_positions.find(child) ==
3023 children_positions.end())
3024 children_positions[child] = it;
3026 // register child with its scope
3027 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3031 InsetMath * im = iit->inset->asInsetMath();
3032 if (doing_export && im) {
3033 InsetMathHull * hull = im->asHullInset();
3035 hull->recordLocation(it);
3038 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3042 MathMacroTemplate & macroTemplate =
3043 *iit->inset->asInsetMath()->asMacroTemplate();
3044 MacroContext mc(owner_, it);
3045 macroTemplate.updateToContext(mc);
3048 bool valid = macroTemplate.validMacro();
3049 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3050 // then the BufferView's cursor will be invalid in
3051 // some cases which leads to crashes.
3056 // FIXME (Abdel), I don't understandt why we pass 'it' here
3057 // instead of 'macroTemplate' defined above... is this correct?
3058 macros[macroTemplate.name()][it] =
3059 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3069 void Buffer::updateMacros() const
3074 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3076 // start with empty table
3078 d->children_positions.clear();
3079 d->position_to_children.clear();
3081 // Iterate over buffer, starting with first paragraph
3082 // The scope must be bigger than any lookup DocIterator
3083 // later. For the global lookup, lastpit+1 is used, hence
3084 // we use lastpit+2 here.
3085 DocIterator it = par_iterator_begin();
3086 DocIterator outerScope = it;
3087 outerScope.pit() = outerScope.lastpit() + 2;
3088 d->updateMacros(it, outerScope);
3092 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3094 InsetIterator it = inset_iterator_begin(inset());
3095 InsetIterator const end = inset_iterator_end(inset());
3096 for (; it != end; ++it) {
3097 if (it->lyxCode() == BRANCH_CODE) {
3098 InsetBranch & br = static_cast<InsetBranch &>(*it);
3099 docstring const name = br.branch();
3100 if (!from_master && !params().branchlist().find(name))
3101 result.push_back(name);
3102 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3103 result.push_back(name);
3106 if (it->lyxCode() == INCLUDE_CODE) {
3107 // get buffer of external file
3108 InsetInclude const & ins =
3109 static_cast<InsetInclude const &>(*it);
3110 Buffer * child = ins.getChildBuffer();
3113 child->getUsedBranches(result, true);
3116 // remove duplicates
3121 void Buffer::updateMacroInstances(UpdateType utype) const
3123 LYXERR(Debug::MACROS, "updateMacroInstances for "
3124 << d->filename.onlyFileName());
3125 DocIterator it = doc_iterator_begin(this);
3127 DocIterator const end = doc_iterator_end(this);
3128 for (; it != end; it.forwardInset()) {
3129 // look for MathData cells in InsetMathNest insets
3130 InsetMath * minset = it.nextInset()->asInsetMath();
3134 // update macro in all cells of the InsetMathNest
3135 DocIterator::idx_type n = minset->nargs();
3136 MacroContext mc = MacroContext(this, it);
3137 for (DocIterator::idx_type i = 0; i < n; ++i) {
3138 MathData & data = minset->cell(i);
3139 data.updateMacros(0, mc, utype);
3145 void Buffer::listMacroNames(MacroNameSet & macros) const
3150 d->macro_lock = true;
3152 // loop over macro names
3153 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3154 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3155 for (; nameIt != nameEnd; ++nameIt)
3156 macros.insert(nameIt->first);
3158 // loop over children
3159 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3160 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3161 for (; it != end; ++it)
3162 it->first->listMacroNames(macros);
3165 Buffer const * const pbuf = d->parent();
3167 pbuf->listMacroNames(macros);
3169 d->macro_lock = false;
3173 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3175 Buffer const * const pbuf = d->parent();
3180 pbuf->listMacroNames(names);
3183 MacroNameSet::iterator it = names.begin();
3184 MacroNameSet::iterator end = names.end();
3185 for (; it != end; ++it) {
3187 MacroData const * data =
3188 pbuf->getMacro(*it, *this, false);
3190 macros.insert(data);
3192 // we cannot access the original MathMacroTemplate anymore
3193 // here to calls validate method. So we do its work here manually.
3194 // FIXME: somehow make the template accessible here.
3195 if (data->optionals() > 0)
3196 features.require("xargs");
3202 Buffer::References & Buffer::references(docstring const & label)
3205 return const_cast<Buffer *>(masterBuffer())->references(label);
3207 RefCache::iterator it = d->ref_cache_.find(label);
3208 if (it != d->ref_cache_.end())
3209 return it->second.second;
3211 static InsetLabel const * dummy_il = 0;
3212 static References const dummy_refs;
3213 it = d->ref_cache_.insert(
3214 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3215 return it->second.second;
3219 Buffer::References const & Buffer::references(docstring const & label) const
3221 return const_cast<Buffer *>(this)->references(label);
3225 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3227 masterBuffer()->d->ref_cache_[label].first = il;
3231 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3233 return masterBuffer()->d->ref_cache_[label].first;
3237 void Buffer::clearReferenceCache() const
3240 d->ref_cache_.clear();
3244 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3247 //FIXME: This does not work for child documents yet.
3248 LASSERT(code == CITE_CODE, /**/);
3250 reloadBibInfoCache();
3252 // Check if the label 'from' appears more than once
3253 BiblioInfo const & keys = masterBibInfo();
3254 BiblioInfo::const_iterator bit = keys.begin();
3255 BiblioInfo::const_iterator bend = keys.end();
3256 vector<docstring> labels;
3258 for (; bit != bend; ++bit)
3260 labels.push_back(bit->first);
3262 if (count(labels.begin(), labels.end(), from) > 1)
3265 string const paramName = "key";
3266 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3267 if (it->lyxCode() == code) {
3268 InsetCommand * inset = it->asInsetCommand();
3271 docstring const oldValue = inset->getParam(paramName);
3272 if (oldValue == from)
3273 inset->setParam(paramName, to);
3279 void Buffer::getSourceCode(odocstream & os, string const format,
3280 pit_type par_begin, pit_type par_end,
3281 OutputWhat output) const
3283 OutputParams runparams(¶ms().encoding());
3284 runparams.nice = true;
3285 runparams.flavor = params().getOutputFlavor(format);
3286 runparams.linelen = lyxrc.plaintext_linelen;
3287 // No side effect of file copying and image conversion
3288 runparams.dryrun = true;
3290 if (output == CurrentParagraph) {
3291 runparams.par_begin = par_begin;
3292 runparams.par_end = par_end;
3293 if (par_begin + 1 == par_end) {
3295 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3299 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3300 convert<docstring>(par_begin),
3301 convert<docstring>(par_end - 1))
3308 // output paragraphs
3309 if (runparams.flavor == OutputParams::HTML) {
3311 setMathFlavor(runparams);
3312 xhtmlParagraphs(text(), *this, xs, runparams);
3313 } else if (runparams.flavor == OutputParams::TEXT) {
3315 // FIXME Handles only one paragraph, unlike the others.
3316 // Probably should have some routine with a signature like them.
3317 writePlaintextParagraph(*this,
3318 text().paragraphs()[par_begin], os, runparams, dummy);
3319 } else if (params().isDocBook()) {
3320 docbookParagraphs(text(), *this, os, runparams);
3322 // latex or literate
3323 otexstream ots(os, texrow);
3324 latexParagraphs(*this, text(), ots, runparams);
3328 if (output == FullSource)
3329 os << _("Preview source code");
3330 else if (output == OnlyPreamble)
3331 os << _("Preview preamble");
3332 else if (output == OnlyBody)
3333 os << _("Preview body");
3336 d->texrow.newline();
3337 d->texrow.newline();
3338 if (runparams.flavor == OutputParams::HTML) {
3339 writeLyXHTMLSource(os, runparams, output);
3340 } else if (runparams.flavor == OutputParams::TEXT) {
3341 if (output == OnlyPreamble) {
3342 os << _("% Plaintext does not have a preamble.");
3344 writePlaintextFile(*this, os, runparams);
3345 } else if (params().isDocBook()) {
3346 writeDocBookSource(os, absFileName(), runparams, output);
3348 // latex or literate
3349 otexstream ots(os, d->texrow);
3350 writeLaTeXSource(ots, string(), runparams, output);
3356 ErrorList & Buffer::errorList(string const & type) const
3358 return d->errorLists[type];
3362 void Buffer::updateTocItem(std::string const & type,
3363 DocIterator const & dit) const
3366 d->gui_->updateTocItem(type, dit);
3370 void Buffer::structureChanged() const
3373 d->gui_->structureChanged();
3377 void Buffer::errors(string const & err, bool from_master) const
3380 d->gui_->errors(err, from_master);
3384 void Buffer::message(docstring const & msg) const
3387 d->gui_->message(msg);
3391 void Buffer::setBusy(bool on) const
3394 d->gui_->setBusy(on);
3398 void Buffer::updateTitles() const
3401 d->wa_->updateTitles();
3405 void Buffer::resetAutosaveTimers() const
3408 d->gui_->resetAutosaveTimers();
3412 bool Buffer::hasGuiDelegate() const
3418 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3427 class AutoSaveBuffer : public ForkedProcess {
3430 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3431 : buffer_(buffer), fname_(fname) {}
3433 virtual shared_ptr<ForkedProcess> clone() const
3435 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3440 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3441 from_utf8(fname_.absFileName())));
3442 return run(DontWait);
3446 virtual int generateChild();
3448 Buffer const & buffer_;
3453 int AutoSaveBuffer::generateChild()
3455 #if defined(__APPLE__)
3456 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3457 * We should use something else like threads.
3459 * Since I do not know how to determine at run time what is the OS X
3460 * version, I just disable forking altogether for now (JMarc)
3462 pid_t const pid = -1;
3464 // tmp_ret will be located (usually) in /tmp
3465 // will that be a problem?
3466 // Note that this calls ForkedCalls::fork(), so it's
3467 // ok cross-platform.
3468 pid_t const pid = fork();
3469 // If you want to debug the autosave
3470 // you should set pid to -1, and comment out the fork.
3471 if (pid != 0 && pid != -1)
3475 // pid = -1 signifies that lyx was unable
3476 // to fork. But we will do the save
3478 bool failed = false;
3479 FileName const tmp_ret = FileName::tempName("lyxauto");
3480 if (!tmp_ret.empty()) {
3481 buffer_.writeFile(tmp_ret);
3482 // assume successful write of tmp_ret
3483 if (!tmp_ret.moveTo(fname_))
3489 // failed to write/rename tmp_ret so try writing direct
3490 if (!buffer_.writeFile(fname_)) {
3491 // It is dangerous to do this in the child,
3492 // but safe in the parent, so...
3493 if (pid == -1) // emit message signal.
3494 buffer_.message(_("Autosave failed!"));
3498 if (pid == 0) // we are the child so...
3507 FileName Buffer::getEmergencyFileName() const
3509 return FileName(d->filename.absFileName() + ".emergency");
3513 FileName Buffer::getAutosaveFileName() const
3515 // if the document is unnamed try to save in the backup dir, else
3516 // in the default document path, and as a last try in the filePath,
3517 // which will most often be the temporary directory
3520 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3521 : lyxrc.backupdir_path;
3522 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3525 string const fname = "#" + d->filename.onlyFileName() + "#";
3527 return makeAbsPath(fname, fpath);
3531 void Buffer::removeAutosaveFile() const
3533 FileName const f = getAutosaveFileName();
3539 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3541 FileName const newauto = getAutosaveFileName();
3543 if (newauto != oldauto && oldauto.exists())
3544 if (!oldauto.moveTo(newauto))
3545 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3549 bool Buffer::autoSave() const
3551 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3552 if (buf->d->bak_clean || isReadonly())
3555 message(_("Autosaving current document..."));
3556 buf->d->bak_clean = true;
3558 FileName const fname = getAutosaveFileName();
3559 if (d->cloned_buffer_) {
3560 // If this buffer is cloned, we assume that
3561 // we are running in a separate thread already.
3562 FileName const tmp_ret = FileName::tempName("lyxauto");
3563 if (!tmp_ret.empty()) {
3565 // assume successful write of tmp_ret
3566 if (tmp_ret.moveTo(fname))
3569 // failed to write/rename tmp_ret so try writing direct
3570 return writeFile(fname);
3572 /// This function is deprecated as the frontend needs to take care
3573 /// of cloning the buffer and autosaving it in another thread. It
3574 /// is still here to allow (QT_VERSION < 0x040400).
3575 AutoSaveBuffer autosave(*this, fname);
3582 // helper class, to guarantee this gets reset properly
3583 class Buffer::MarkAsExporting {
3585 MarkAsExporting(Buffer const * buf) : buf_(buf)
3587 LASSERT(buf_, /* */);
3588 buf_->setExportStatus(true);
3592 buf_->setExportStatus(false);
3595 Buffer const * const buf_;
3600 void Buffer::setExportStatus(bool e) const
3602 d->doing_export = e;
3603 ListOfBuffers clist = getDescendents();
3604 ListOfBuffers::const_iterator cit = clist.begin();
3605 ListOfBuffers::const_iterator const cen = clist.end();
3606 for (; cit != cen; ++cit)
3607 (*cit)->d->doing_export = e;
3611 bool Buffer::isExporting() const
3613 return d->doing_export;
3617 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3621 return doExport(target, put_in_tempdir, result_file);
3624 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3625 string & result_file) const
3627 bool const update_unincluded =
3628 params().maintain_unincluded_children
3629 && !params().getIncludedChildren().empty();
3631 // (1) export with all included children (omit \includeonly)
3632 if (update_unincluded) {
3633 ExportStatus const status =
3634 doExport(target, put_in_tempdir, true, result_file);
3635 if (status != ExportSuccess)
3638 // (2) export with included children only
3639 return doExport(target, put_in_tempdir, false, result_file);
3643 void Buffer::setMathFlavor(OutputParams & op) const
3645 switch (params().html_math_output) {
3646 case BufferParams::MathML:
3647 op.math_flavor = OutputParams::MathAsMathML;
3649 case BufferParams::HTML:
3650 op.math_flavor = OutputParams::MathAsHTML;
3652 case BufferParams::Images:
3653 op.math_flavor = OutputParams::MathAsImages;
3655 case BufferParams::LaTeX:
3656 op.math_flavor = OutputParams::MathAsLaTeX;
3662 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3663 bool includeall, string & result_file) const
3665 LYXERR(Debug::FILES, "target=" << target);
3666 OutputParams runparams(¶ms().encoding());
3667 string format = target;
3668 string dest_filename;
3669 size_t pos = target.find(' ');
3670 if (pos != string::npos) {
3671 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3672 format = target.substr(0, pos);
3673 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3674 FileName(dest_filename).onlyPath().createPath();
3675 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3677 MarkAsExporting exporting(this);
3678 string backend_format;
3679 runparams.flavor = OutputParams::LATEX;
3680 runparams.linelen = lyxrc.plaintext_linelen;
3681 runparams.includeall = includeall;
3682 vector<string> backs = params().backends();
3683 Converters converters = theConverters();
3684 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3685 // Get shortest path to format
3686 converters.buildGraph();
3687 Graph::EdgePath path;
3688 for (vector<string>::const_iterator it = backs.begin();
3689 it != backs.end(); ++it) {
3690 Graph::EdgePath p = converters.getPath(*it, format);
3691 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3692 backend_format = *it;
3697 if (!put_in_tempdir) {
3698 // Only show this alert if this is an export to a non-temporary
3699 // file (not for previewing).
3700 Alert::error(_("Couldn't export file"), bformat(
3701 _("No information for exporting the format %1$s."),
3702 formats.prettyName(format)));
3704 return ExportNoPathToFormat;
3706 runparams.flavor = converters.getFlavor(path, this);
3709 backend_format = format;
3710 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3711 // FIXME: Don't hardcode format names here, but use a flag
3712 if (backend_format == "pdflatex")
3713 runparams.flavor = OutputParams::PDFLATEX;
3714 else if (backend_format == "luatex")
3715 runparams.flavor = OutputParams::LUATEX;
3716 else if (backend_format == "dviluatex")
3717 runparams.flavor = OutputParams::DVILUATEX;
3718 else if (backend_format == "xetex")
3719 runparams.flavor = OutputParams::XETEX;
3722 string filename = latexName(false);
3723 filename = addName(temppath(), filename);
3724 filename = changeExtension(filename,
3725 formats.extension(backend_format));
3726 LYXERR(Debug::FILES, "filename=" << filename);
3728 // Plain text backend
3729 if (backend_format == "text") {
3730 runparams.flavor = OutputParams::TEXT;
3731 writePlaintextFile(*this, FileName(filename), runparams);
3734 else if (backend_format == "xhtml") {
3735 runparams.flavor = OutputParams::HTML;
3736 setMathFlavor(runparams);
3737 makeLyXHTMLFile(FileName(filename), runparams);
3738 } else if (backend_format == "lyx")
3739 writeFile(FileName(filename));
3741 else if (params().isDocBook()) {
3742 runparams.nice = !put_in_tempdir;
3743 makeDocBookFile(FileName(filename), runparams);
3746 else if (backend_format == format) {
3747 runparams.nice = true;
3748 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
3749 if (d->cloned_buffer_)
3750 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3753 } else if (!lyxrc.tex_allows_spaces
3754 && contains(filePath(), ' ')) {
3755 Alert::error(_("File name error"),
3756 _("The directory path to the document cannot contain spaces."));
3757 return ExportTexPathHasSpaces;
3759 runparams.nice = false;
3760 bool const success = makeLaTeXFile(
3761 FileName(filename), filePath(), runparams);
3762 if (d->cloned_buffer_)
3763 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3768 string const error_type = (format == "program")
3769 ? "Build" : params().bufferFormat();
3770 ErrorList & error_list = d->errorLists[error_type];
3771 string const ext = formats.extension(format);
3772 FileName const tmp_result_file(changeExtension(filename, ext));
3773 bool const success = converters.convert(this, FileName(filename),
3774 tmp_result_file, FileName(absFileName()), backend_format, format,
3777 // Emit the signal to show the error list or copy it back to the
3778 // cloned Buffer so that it can be emitted afterwards.
3779 if (format != backend_format) {
3780 if (d->cloned_buffer_) {
3781 d->cloned_buffer_->d->errorLists[error_type] =
3782 d->errorLists[error_type];
3785 // also to the children, in case of master-buffer-view
3786 ListOfBuffers clist = getDescendents();
3787 ListOfBuffers::const_iterator cit = clist.begin();
3788 ListOfBuffers::const_iterator const cen = clist.end();
3789 for (; cit != cen; ++cit) {
3790 if (d->cloned_buffer_) {
3791 // Enable reverse search by copying back the
3792 // texrow object to the cloned buffer.
3793 // FIXME: this is not thread safe.
3794 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3795 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3796 (*cit)->d->errorLists[error_type];
3798 (*cit)->errors(error_type, true);
3802 if (d->cloned_buffer_) {
3803 // Enable reverse dvi or pdf to work by copying back the texrow
3804 // object to the cloned buffer.
3805 // FIXME: There is a possibility of concurrent access to texrow
3806 // here from the main GUI thread that should be securized.
3807 d->cloned_buffer_->d->texrow = d->texrow;
3808 string const error_type = params().bufferFormat();
3809 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3813 return ExportConverterError;
3815 if (put_in_tempdir) {
3816 result_file = tmp_result_file.absFileName();
3817 return ExportSuccess;
3820 if (dest_filename.empty())
3821 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3823 result_file = dest_filename;
3824 // We need to copy referenced files (e. g. included graphics
3825 // if format == "dvi") to the result dir.
3826 vector<ExportedFile> const files =
3827 runparams.exportdata->externalFiles(format);
3828 string const dest = runparams.export_folder.empty() ?
3829 onlyPath(result_file) : runparams.export_folder;
3830 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3831 : force_overwrite == ALL_FILES;
3832 CopyStatus status = use_force ? FORCE : SUCCESS;
3834 vector<ExportedFile>::const_iterator it = files.begin();
3835 vector<ExportedFile>::const_iterator const en = files.end();
3836 for (; it != en && status != CANCEL; ++it) {
3837 string const fmt = formats.getFormatFromFile(it->sourceName);
3838 string fixedName = it->exportName;
3839 if (!runparams.export_folder.empty()) {
3840 // Relative pathnames starting with ../ will be sanitized
3841 // if exporting to a different folder
3842 while (fixedName.substr(0, 3) == "../")
3843 fixedName = fixedName.substr(3, fixedName.length() - 3);
3845 FileName fixedFileName = makeAbsPath(fixedName, dest);
3846 fixedFileName.onlyPath().createPath();
3847 status = copyFile(fmt, it->sourceName,
3849 it->exportName, status == FORCE,
3850 runparams.export_folder.empty());
3853 if (status == CANCEL) {
3854 message(_("Document export cancelled."));
3855 return ExportCancel;
3858 if (tmp_result_file.exists()) {
3859 // Finally copy the main file
3860 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3861 : force_overwrite != NO_FILES;
3862 if (status == SUCCESS && use_force)
3864 status = copyFile(format, tmp_result_file,
3865 FileName(result_file), result_file,
3867 if (status == CANCEL) {
3868 message(_("Document export cancelled."));
3869 return ExportCancel;
3871 message(bformat(_("Document exported as %1$s "
3873 formats.prettyName(format),
3874 makeDisplayPath(result_file)));
3877 // This must be a dummy converter like fax (bug 1888)
3878 message(bformat(_("Document exported as %1$s"),
3879 formats.prettyName(format)));
3882 return ExportSuccess;
3886 Buffer::ExportStatus Buffer::preview(string const & format) const
3888 bool const update_unincluded =
3889 params().maintain_unincluded_children
3890 && !params().getIncludedChildren().empty();
3891 return preview(format, update_unincluded);
3894 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
3896 MarkAsExporting exporting(this);
3898 // (1) export with all included children (omit \includeonly)
3900 ExportStatus const status = doExport(format, true, true, result_file);
3901 if (status != ExportSuccess)
3904 // (2) export with included children only
3905 ExportStatus const status = doExport(format, true, false, result_file);
3906 if (status != ExportSuccess)
3908 if (!formats.view(*this, FileName(result_file), format))
3909 return PreviewError;
3910 return PreviewSuccess;
3914 Buffer::ReadStatus Buffer::extractFromVC()
3916 bool const found = LyXVC::file_not_found_hook(d->filename);
3918 return ReadFileNotFound;
3919 if (!d->filename.isReadableFile())
3925 Buffer::ReadStatus Buffer::loadEmergency()
3927 FileName const emergencyFile = getEmergencyFileName();
3928 if (!emergencyFile.exists()
3929 || emergencyFile.lastModified() <= d->filename.lastModified())
3930 return ReadFileNotFound;
3932 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3933 docstring const text = bformat(_("An emergency save of the document "
3934 "%1$s exists.\n\nRecover emergency save?"), file);
3936 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
3937 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
3943 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
3944 bool const success = (ret_llf == ReadSuccess);
3947 Alert::warning(_("File is read-only"),
3948 bformat(_("An emergency file is successfully loaded, "
3949 "but the original file %1$s is marked read-only. "
3950 "Please make sure to save the document as a different "
3951 "file."), from_utf8(d->filename.absFileName())));
3954 str = _("Document was successfully recovered.");
3956 str = _("Document was NOT successfully recovered.");
3957 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3958 makeDisplayPath(emergencyFile.absFileName()));
3960 int const del_emerg =
3961 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3962 _("&Remove"), _("&Keep"));
3963 if (del_emerg == 0) {
3964 emergencyFile.removeFile();
3966 Alert::warning(_("Emergency file deleted"),
3967 _("Do not forget to save your file now!"), true);
3969 return success ? ReadSuccess : ReadEmergencyFailure;
3972 int const del_emerg =
3973 Alert::prompt(_("Delete emergency file?"),
3974 _("Remove emergency file now?"), 1, 1,
3975 _("&Remove"), _("&Keep"));
3977 emergencyFile.removeFile();
3978 return ReadOriginal;
3988 Buffer::ReadStatus Buffer::loadAutosave()
3990 // Now check if autosave file is newer.
3991 FileName const autosaveFile = getAutosaveFileName();
3992 if (!autosaveFile.exists()
3993 || autosaveFile.lastModified() <= d->filename.lastModified())
3994 return ReadFileNotFound;
3996 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
3997 docstring const text = bformat(_("The backup of the document %1$s "
3998 "is newer.\n\nLoad the backup instead?"), file);
3999 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4000 _("&Load backup"), _("Load &original"), _("&Cancel"));
4005 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4006 // the file is not saved if we load the autosave file.
4007 if (ret_llf == ReadSuccess) {
4009 Alert::warning(_("File is read-only"),
4010 bformat(_("A backup file is successfully loaded, "
4011 "but the original file %1$s is marked read-only. "
4012 "Please make sure to save the document as a "
4014 from_utf8(d->filename.absFileName())));
4019 return ReadAutosaveFailure;
4022 // Here we delete the autosave
4023 autosaveFile.removeFile();
4024 return ReadOriginal;
4032 Buffer::ReadStatus Buffer::loadLyXFile()
4034 if (!d->filename.isReadableFile()) {
4035 ReadStatus const ret_rvc = extractFromVC();
4036 if (ret_rvc != ReadSuccess)
4040 ReadStatus const ret_re = loadEmergency();
4041 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4044 ReadStatus const ret_ra = loadAutosave();
4045 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4048 return loadThisLyXFile(d->filename);
4052 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4054 return readFile(fn);
4058 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4060 TeXErrors::Errors::const_iterator it = terr.begin();
4061 TeXErrors::Errors::const_iterator end = terr.end();
4062 ListOfBuffers clist = getDescendents();
4063 ListOfBuffers::const_iterator cen = clist.end();
4065 for (; it != end; ++it) {
4068 int errorRow = it->error_in_line;
4069 Buffer const * buf = 0;
4071 if (it->child_name.empty())
4072 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4074 // The error occurred in a child
4075 ListOfBuffers::const_iterator cit = clist.begin();
4076 for (; cit != cen; ++cit) {
4077 string const child_name =
4078 DocFileName(changeExtension(
4079 (*cit)->absFileName(), "tex")).
4081 if (it->child_name != child_name)
4083 (*cit)->d->texrow.getIdFromRow(errorRow,
4084 id_start, pos_start);
4085 if (id_start != -1) {
4086 buf = d->cloned_buffer_
4087 ? (*cit)->d->cloned_buffer_->d->owner_
4088 : (*cit)->d->owner_;
4099 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4100 } while (found && id_start == id_end && pos_start == pos_end);
4102 if (id_start != id_end) {
4103 // Next registered position is outside the inset where
4104 // the error occurred, so signal end-of-paragraph
4108 errorList.push_back(ErrorItem(it->error_desc,
4109 it->error_text, id_start, pos_start, pos_end, buf));
4114 void Buffer::setBuffersForInsets() const
4116 inset().setBuffer(const_cast<Buffer &>(*this));
4120 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4122 // Use the master text class also for child documents
4123 Buffer const * const master = masterBuffer();
4124 DocumentClass const & textclass = master->params().documentClass();
4126 // do this only if we are the top-level Buffer
4128 reloadBibInfoCache();
4130 // keep the buffers to be children in this set. If the call from the
4131 // master comes back we can see which of them were actually seen (i.e.
4132 // via an InsetInclude). The remaining ones in the set need still be updated.
4133 static std::set<Buffer const *> bufToUpdate;
4134 if (scope == UpdateMaster) {
4135 // If this is a child document start with the master
4136 if (master != this) {
4137 bufToUpdate.insert(this);
4138 master->updateBuffer(UpdateMaster, utype);
4139 // Do this here in case the master has no gui associated with it. Then,
4140 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4141 if (!master->d->gui_)
4144 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4145 if (bufToUpdate.find(this) == bufToUpdate.end())
4149 // start over the counters in the master
4150 textclass.counters().reset();
4153 // update will be done below for this buffer
4154 bufToUpdate.erase(this);
4156 // update all caches
4157 clearReferenceCache();
4160 Buffer & cbuf = const_cast<Buffer &>(*this);
4162 LASSERT(!text().paragraphs().empty(), /**/);
4165 ParIterator parit = cbuf.par_iterator_begin();
4166 updateBuffer(parit, utype);
4169 // TocBackend update will be done later.
4172 d->bibinfo_cache_valid_ = true;
4173 d->cite_labels_valid_ = true;
4174 cbuf.tocBackend().update();
4175 if (scope == UpdateMaster)
4176 cbuf.structureChanged();
4180 static depth_type getDepth(DocIterator const & it)
4182 depth_type depth = 0;
4183 for (size_t i = 0 ; i < it.depth() ; ++i)
4184 if (!it[i].inset().inMathed())
4185 depth += it[i].paragraph().getDepth() + 1;
4186 // remove 1 since the outer inset does not count
4190 static depth_type getItemDepth(ParIterator const & it)
4192 Paragraph const & par = *it;
4193 LabelType const labeltype = par.layout().labeltype;
4195 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4198 // this will hold the lowest depth encountered up to now.
4199 depth_type min_depth = getDepth(it);
4200 ParIterator prev_it = it;
4203 --prev_it.top().pit();
4205 // start of nested inset: go to outer par
4207 if (prev_it.empty()) {
4208 // start of document: nothing to do
4213 // We search for the first paragraph with same label
4214 // that is not more deeply nested.
4215 Paragraph & prev_par = *prev_it;
4216 depth_type const prev_depth = getDepth(prev_it);
4217 if (labeltype == prev_par.layout().labeltype) {
4218 if (prev_depth < min_depth)
4219 return prev_par.itemdepth + 1;
4220 if (prev_depth == min_depth)
4221 return prev_par.itemdepth;
4223 min_depth = min(min_depth, prev_depth);
4224 // small optimization: if we are at depth 0, we won't
4225 // find anything else
4226 if (prev_depth == 0)
4232 static bool needEnumCounterReset(ParIterator const & it)
4234 Paragraph const & par = *it;
4235 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4236 depth_type const cur_depth = par.getDepth();
4237 ParIterator prev_it = it;
4238 while (prev_it.pit()) {
4239 --prev_it.top().pit();
4240 Paragraph const & prev_par = *prev_it;
4241 if (prev_par.getDepth() <= cur_depth)
4242 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4244 // start of nested inset: reset
4249 // set the label of a paragraph. This includes the counters.
4250 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4252 BufferParams const & bp = owner_->masterBuffer()->params();
4253 DocumentClass const & textclass = bp.documentClass();
4254 Paragraph & par = it.paragraph();
4255 Layout const & layout = par.layout();
4256 Counters & counters = textclass.counters();
4258 if (par.params().startOfAppendix()) {
4259 // FIXME: only the counter corresponding to toplevel
4260 // sectioning should be reset
4262 counters.appendix(true);
4264 par.params().appendix(counters.appendix());
4266 // Compute the item depth of the paragraph
4267 par.itemdepth = getItemDepth(it);
4269 if (layout.margintype == MARGIN_MANUAL) {
4270 if (par.params().labelWidthString().empty())
4271 par.params().labelWidthString(par.expandLabel(layout, bp));
4272 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4273 // we do not need to do anything here, since the empty case is
4274 // handled during export.
4276 par.params().labelWidthString(docstring());
4279 switch(layout.labeltype) {
4281 if (layout.toclevel <= bp.secnumdepth
4282 && (layout.latextype != LATEX_ENVIRONMENT
4283 || it.text()->isFirstInSequence(it.pit()))) {
4284 if (counters.hasCounter(layout.counter))
4285 counters.step(layout.counter, utype);
4286 par.params().labelString(par.expandLabel(layout, bp));
4288 par.params().labelString(docstring());
4291 case LABEL_ITEMIZE: {
4292 // At some point of time we should do something more
4293 // clever here, like:
4294 // par.params().labelString(
4295 // bp.user_defined_bullet(par.itemdepth).getText());
4296 // for now, use a simple hardcoded label
4297 docstring itemlabel;
4298 switch (par.itemdepth) {
4300 itemlabel = char_type(0x2022);
4303 itemlabel = char_type(0x2013);
4306 itemlabel = char_type(0x2217);
4309 itemlabel = char_type(0x2219); // or 0x00b7
4312 par.params().labelString(itemlabel);
4316 case LABEL_ENUMERATE: {
4317 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4319 switch (par.itemdepth) {
4328 enumcounter += "iv";
4331 // not a valid enumdepth...
4335 // Maybe we have to reset the enumeration counter.
4336 if (needEnumCounterReset(it))
4337 counters.reset(enumcounter);
4338 counters.step(enumcounter, utype);
4340 string const & lang = par.getParLanguage(bp)->code();
4341 par.params().labelString(counters.theCounter(enumcounter, lang));
4346 case LABEL_SENSITIVE: {
4347 string const & type = counters.current_float();
4348 docstring full_label;
4350 full_label = owner_->B_("Senseless!!! ");
4352 docstring name = owner_->B_(textclass.floats().getType(type).name());
4353 if (counters.hasCounter(from_utf8(type))) {
4354 string const & lang = par.getParLanguage(bp)->code();
4355 counters.step(from_utf8(type), utype);
4356 full_label = bformat(from_ascii("%1$s %2$s:"),
4358 counters.theCounter(from_utf8(type), lang));
4360 full_label = bformat(from_ascii("%1$s #:"), name);
4362 par.params().labelString(full_label);
4366 case LABEL_NO_LABEL:
4367 par.params().labelString(docstring());
4371 case LABEL_TOP_ENVIRONMENT:
4372 case LABEL_CENTERED_TOP_ENVIRONMENT:
4375 par.params().labelString(par.expandLabel(layout, bp));
4381 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4383 LASSERT(parit.pit() == 0, /**/);
4385 // Set the position of the text in the buffer to be able
4386 // to resolve macros in it.
4387 parit.text()->setMacrocontextPosition(parit);
4389 depth_type maxdepth = 0;
4390 pit_type const lastpit = parit.lastpit();
4391 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4392 // reduce depth if necessary
4393 parit->params().depth(min(parit->params().depth(), maxdepth));
4394 maxdepth = parit->getMaxDepthAfter();
4396 if (utype == OutputUpdate) {
4397 // track the active counters
4398 // we have to do this for the master buffer, since the local
4399 // buffer isn't tracking anything.
4400 masterBuffer()->params().documentClass().counters().
4401 setActiveLayout(parit->layout());
4404 // set the counter for this paragraph
4405 d->setLabel(parit, utype);
4408 InsetList::const_iterator iit = parit->insetList().begin();
4409 InsetList::const_iterator end = parit->insetList().end();
4410 for (; iit != end; ++iit) {
4411 parit.pos() = iit->pos;
4412 iit->inset->updateBuffer(parit, utype);
4418 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4419 WordLangTuple & word_lang, docstring_list & suggestions) const
4423 suggestions.clear();
4424 word_lang = WordLangTuple();
4425 bool const to_end = to.empty();
4426 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4427 // OK, we start from here.
4428 for (; from != end; from.forwardPos()) {
4429 // We are only interested in text so remove the math CursorSlice.
4430 while (from.inMathed()) {
4434 // If from is at the end of the document (which is possible
4435 // when leaving the mathed) LyX will crash later otherwise.
4436 if (from.atEnd() || (!to_end && from >= end))
4439 from.paragraph().spellCheck();
4440 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4441 if (SpellChecker::misspelled(res)) {
4446 // Do not increase progress when from == to, otherwise the word
4447 // count will be wrong.
4457 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4459 bool inword = false;
4464 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4465 if (!dit.inTexted()) {
4470 Paragraph const & par = dit.paragraph();
4471 pos_type const pos = dit.pos();
4473 // Copied and adapted from isWordSeparator() in Paragraph
4474 if (pos == dit.lastpos()) {
4477 Inset const * ins = par.getInset(pos);
4478 if (ins && skipNoOutput && !ins->producesOutput()) {
4481 // stop if end of range was skipped
4482 if (!to.atEnd() && dit >= to)
4485 } else if (!par.isDeleted(pos)) {
4486 if (par.isWordSeparator(pos))
4492 if (ins && ins->isLetter())
4494 else if (ins && ins->isSpace())
4497 char_type const c = par.getChar(pos);
4498 if (isPrintableNonspace(c))
4500 else if (isSpace(c))
4510 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4512 d->updateStatistics(from, to, skipNoOutput);
4516 int Buffer::wordCount() const
4518 return d->wordCount();
4522 int Buffer::charCount(bool with_blanks) const
4524 return d->charCount(with_blanks);
4528 Buffer::ReadStatus Buffer::reload()
4531 // c.f. bug http://www.lyx.org/trac/ticket/6587
4532 removeAutosaveFile();
4533 // e.g., read-only status could have changed due to version control
4534 d->filename.refresh();
4535 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4537 // clear parent. this will get reset if need be.
4539 ReadStatus const status = loadLyXFile();
4540 if (status == ReadSuccess) {
4545 message(bformat(_("Document %1$s reloaded."), disp_fn));
4548 message(bformat(_("Could not reload document %1$s."), disp_fn));
4558 bool Buffer::saveAs(FileName const & fn)
4560 FileName const old_name = fileName();
4561 FileName const old_auto = getAutosaveFileName();
4562 bool const old_unnamed = isUnnamed();
4569 // bring the autosave file with us, just in case.
4570 moveAutosaveFile(old_auto);
4571 // validate version control data and
4572 // correct buffer title
4573 lyxvc().file_found_hook(fileName());
4575 // the file has now been saved to the new location.
4576 // we need to check that the locations of child buffers
4578 checkChildBuffers();
4582 // reset the old filename and unnamed state
4583 setFileName(old_name);
4584 setUnnamed(old_unnamed);
4590 // FIXME We could do better here, but it is complicated. What would be
4591 // nice is to offer either (a) to save the child buffer to an appropriate
4592 // location, so that it would "move with the master", or else (b) to update
4593 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4594 // complicated, because the code for this lives in GuiView.
4595 void Buffer::checkChildBuffers()
4597 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4598 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4599 for (; it != en; ++it) {
4600 DocIterator dit = it->second;
4601 Buffer * cbuf = const_cast<Buffer *>(it->first);
4602 if (!cbuf || !theBufferList().isLoaded(cbuf))
4604 Inset * inset = dit.nextInset();
4605 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4606 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4607 docstring const & incfile = inset_inc->getParam("filename");
4608 string oldloc = cbuf->absFileName();
4609 string newloc = makeAbsPath(to_utf8(incfile),
4610 onlyPath(absFileName())).absFileName();
4611 if (oldloc == newloc)
4613 // the location of the child file is incorrect.
4614 Alert::warning(_("Included File Invalid"),
4615 bformat(_("Saving this document to a new location has made the file:\n"
4617 "inaccessible. You will need to update the included filename."),
4618 from_utf8(oldloc)));
4620 inset_inc->setChildBuffer(0);
4622 // invalidate cache of children
4623 d->children_positions.clear();
4624 d->position_to_children.clear();