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"
28 #include "DispatchResult.h"
29 #include "DocIterator.h"
31 #include "ErrorList.h"
34 #include "FuncRequest.h"
35 #include "FuncStatus.h"
36 #include "IndicesList.h"
37 #include "InsetIterator.h"
38 #include "InsetList.h"
40 #include "LaTeXFeatures.h"
44 #include "LyXAction.h"
48 #include "output_docbook.h"
50 #include "output_latex.h"
51 #include "output_xhtml.h"
52 #include "output_plaintext.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
56 #include "PDFOptions.h"
57 #include "SpellChecker.h"
60 #include "TexStream.h"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetTabular.h"
74 #include "insets/InsetText.h"
76 #include "mathed/InsetMathHull.h"
77 #include "mathed/MacroTable.h"
78 #include "mathed/MathMacroTemplate.h"
79 #include "mathed/MathSupport.h"
81 #include "graphics/PreviewLoader.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileName.h"
93 #include "support/FileNameList.h"
94 #include "support/filetools.h"
95 #include "support/ForkedCalls.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/lyxalgo.h"
100 #include "support/os.h"
101 #include "support/Package.h"
102 #include "support/Path.h"
103 #include "support/Systemcall.h"
104 #include "support/textutils.h"
105 #include "support/types.h"
107 #include "support/bind.h"
108 #include "support/shared_ptr.h"
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...)?
198 /// is this an internal bufffer?
199 bool internal_buffer;
204 /// name of the file the buffer is associated with.
207 /** Set to true only when the file is fully loaded.
208 * Used to prevent the premature generation of previews
209 * and by the citation inset.
211 bool file_fully_loaded;
213 /// Ignore the parent (e.g. when exporting a child standalone)?
217 mutable TocBackend toc_backend;
220 typedef pair<DocIterator, MacroData> ScopeMacro;
221 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
222 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
223 /// map from the macro name to the position map,
224 /// which maps the macro definition position to the scope and the MacroData.
225 NamePositionScopeMacroMap macros;
226 /// This seem to change the way Buffer::getMacro() works
227 mutable bool macro_lock;
229 /// positions of child buffers in the buffer
230 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
231 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
232 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
233 /// position of children buffers in this buffer
234 BufferPositionMap children_positions;
235 /// map from children inclusion positions to their scope and their buffer
236 PositionScopeBufferMap position_to_children;
238 /// Container for all sort of Buffer dependant errors.
239 map<string, ErrorList> errorLists;
241 /// timestamp and checksum used to test if the file has been externally
242 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
244 unsigned long checksum_;
247 frontend::WorkAreaManager * wa_;
249 frontend::GuiBufferDelegate * gui_;
254 /// A cache for the bibfiles (including bibfiles of loaded child
255 /// documents), needed for appropriate update of natbib labels.
256 mutable support::FileNameList bibfiles_cache_;
258 // FIXME The caching mechanism could be improved. At present, we have a
259 // cache for each Buffer, that caches all the bibliography info for that
260 // Buffer. A more efficient solution would be to have a global cache per
261 // file, and then to construct the Buffer's bibinfo from that.
262 /// A cache for bibliography info
263 mutable BiblioInfo bibinfo_;
264 /// whether the bibinfo cache is valid
265 mutable bool bibinfo_cache_valid_;
266 /// whether the bibfile cache is valid
267 mutable bool bibfile_cache_valid_;
268 /// Cache of timestamps of .bib files
269 map<FileName, time_t> bibfile_status_;
270 /// Indicates whether the bibinfo has changed since the last time
271 /// we ran updateBuffer(), i.e., whether citation labels may need
273 mutable bool cite_labels_valid_;
275 mutable RefCache ref_cache_;
277 /// our Text that should be wrapped in an InsetText
281 PreviewLoader * preview_loader_;
283 /// This is here to force the test to be done whenever parent_buffer
285 Buffer const * parent() const
287 // ignore_parent temporarily "orphans" a buffer
288 // (e.g. if a child is compiled standalone)
291 // if parent_buffer is not loaded, then it has been unloaded,
292 // which means that parent_buffer is an invalid pointer. So we
293 // set it to null in that case.
294 // however, the BufferList doesn't know about cloned buffers, so
295 // they will always be regarded as unloaded. in that case, we hope
297 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
299 return parent_buffer;
303 void setParent(Buffer const * pb)
305 if (parent_buffer == pb)
308 if (!cloned_buffer_ && parent_buffer && pb)
309 LYXERR0("Warning: a buffer should not have two parents!");
311 if (!cloned_buffer_ && parent_buffer) {
312 parent_buffer->invalidateBibfileCache();
313 parent_buffer->invalidateBibinfoCache();
317 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
318 /// This one is useful for preview detached in a thread.
319 Buffer const * cloned_buffer_;
321 CloneList * clone_list_;
322 /// are we in the process of exporting this buffer?
323 mutable bool doing_export;
325 /// compute statistics
326 /// \p from initial position
327 /// \p to points to the end position
328 void updateStatistics(DocIterator & from, DocIterator & to,
329 bool skipNoOutput = true);
330 /// statistics accessor functions
331 int wordCount() const
335 int charCount(bool with_blanks) const
338 + (with_blanks ? blank_count_ : 0);
342 /// So we can force access via the accessors.
343 mutable Buffer const * parent_buffer;
352 /// Creates the per buffer temporary directory
353 static FileName createBufferTmpDir()
356 // We are in our own directory. Why bother to mangle name?
357 // In fact I wrote this code to circumvent a problematic behaviour
358 // (bug?) of EMX mkstemp().
359 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
360 convert<string>(count++));
362 if (!tmpfl.createDirectory(0777)) {
363 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
364 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
365 from_utf8(tmpfl.absFileName())));
371 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
372 Buffer const * cloned_buffer)
373 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
374 internal_buffer(false), read_only(readonly_), filename(file),
375 file_fully_loaded(false), ignore_parent(false), toc_backend(owner),
376 macro_lock(false), timestamp_(0), checksum_(0), wa_(0), gui_(0),
377 undo_(*owner), bibinfo_cache_valid_(false), bibfile_cache_valid_(false),
378 cite_labels_valid_(false), preview_loader_(0),
379 cloned_buffer_(cloned_buffer), clone_list_(0),
380 doing_export(false), parent_buffer(0)
382 if (!cloned_buffer_) {
383 temppath = createBufferTmpDir();
384 lyxvc.setBuffer(owner_);
386 wa_ = new frontend::WorkAreaManager;
389 temppath = cloned_buffer_->d->temppath;
390 file_fully_loaded = true;
391 params = cloned_buffer_->d->params;
392 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
393 bibinfo_ = cloned_buffer_->d->bibinfo_;
394 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
395 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
396 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
397 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
398 unnamed = cloned_buffer_->d->unnamed;
399 internal_buffer = cloned_buffer_->d->internal_buffer;
403 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
404 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
406 LYXERR(Debug::INFO, "Buffer::Buffer()");
408 d->inset = new InsetText(*cloned_buffer->d->inset);
409 d->inset->setBuffer(*this);
410 // FIXME: optimize this loop somewhat, maybe by creating a new
411 // general recursive Inset::setId().
412 DocIterator it = doc_iterator_begin(this);
413 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
414 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
415 it.paragraph().setId(cloned_it.paragraph().id());
417 d->inset = new InsetText(this);
418 d->inset->setAutoBreakRows(true);
419 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
425 LYXERR(Debug::INFO, "Buffer::~Buffer()");
426 // here the buffer should take care that it is
427 // saved properly, before it goes into the void.
429 // GuiView already destroyed
433 // No need to do additional cleanups for internal buffer.
439 // this is in case of recursive includes: we won't try to delete
440 // ourselves as a child.
441 d->clone_list_->erase(this);
442 // loop over children
443 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
444 Impl::BufferPositionMap::iterator end = d->children_positions.end();
445 for (; it != end; ++it) {
446 Buffer * child = const_cast<Buffer *>(it->first);
447 if (d->clone_list_->erase(child))
450 // if we're the master buffer, then we should get rid of the list
453 // if this is not empty, we have leaked something. worse, one of the
454 // children still has a reference to this list.
455 LASSERT(d->clone_list_->empty(), /* */);
456 list<CloneList *>::iterator it =
457 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
458 LASSERT(it != cloned_buffers.end(), /* */);
459 cloned_buffers.erase(it);
460 delete d->clone_list_;
462 // FIXME Do we really need to do this right before we delete d?
463 // clear references to children in macro tables
464 d->children_positions.clear();
465 d->position_to_children.clear();
467 // loop over children
468 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
469 Impl::BufferPositionMap::iterator end = d->children_positions.end();
470 for (; it != end; ++it) {
471 Buffer * child = const_cast<Buffer *>(it->first);
472 if (theBufferList().isLoaded(child))
473 theBufferList().releaseChild(this, child);
477 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
478 msg += emergencyWrite();
479 Alert::warning(_("Attempting to close changed document!"), msg);
482 // FIXME Do we really need to do this right before we delete d?
483 // clear references to children in macro tables
484 d->children_positions.clear();
485 d->position_to_children.clear();
487 if (!d->temppath.destroyDirectory()) {
488 Alert::warning(_("Could not remove temporary directory"),
489 bformat(_("Could not remove the temporary directory %1$s"),
490 from_utf8(d->temppath.absFileName())));
499 Buffer * Buffer::cloneFromMaster() const
502 cloned_buffers.push_back(new CloneList);
503 CloneList * clones = cloned_buffers.back();
505 masterBuffer()->cloneWithChildren(bufmap, clones);
507 // make sure we got cloned
508 BufferMap::const_iterator bit = bufmap.find(this);
509 LASSERT(bit != bufmap.end(), return 0);
510 Buffer * cloned_buffer = bit->second;
512 return cloned_buffer;
516 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
518 // have we already been cloned?
519 if (bufmap.find(this) != bufmap.end())
522 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
523 bufmap[this] = buffer_clone;
524 clones->insert(buffer_clone);
525 buffer_clone->d->clone_list_ = clones;
526 buffer_clone->d->macro_lock = true;
527 buffer_clone->d->children_positions.clear();
528 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
529 // math macro caches need to be rethought and simplified.
530 // I am not sure wether we should handle Buffer cloning here or in BufferList.
531 // Right now BufferList knows nothing about buffer clones.
532 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
533 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
534 for (; it != end; ++it) {
535 DocIterator dit = it->first.clone(buffer_clone);
536 dit.setBuffer(buffer_clone);
537 Buffer * child = const_cast<Buffer *>(it->second.second);
539 child->cloneWithChildren(bufmap, clones);
540 BufferMap::iterator const bit = bufmap.find(child);
541 LASSERT(bit != bufmap.end(), continue);
542 Buffer * child_clone = bit->second;
544 Inset * inset = dit.nextInset();
545 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
546 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
547 inset_inc->setChildBuffer(child_clone);
548 child_clone->d->setParent(buffer_clone);
549 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
550 buffer_clone->setChild(dit, child_clone);
552 buffer_clone->d->macro_lock = false;
557 Buffer * Buffer::cloneBufferOnly() const {
558 cloned_buffers.push_back(new CloneList);
559 CloneList * clones = cloned_buffers.back();
560 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
561 clones->insert(buffer_clone);
562 buffer_clone->d->clone_list_ = clones;
563 // we won't be cloning the children
564 buffer_clone->d->children_positions.clear();
569 bool Buffer::isClone() const
571 return d->cloned_buffer_;
575 void Buffer::changed(bool update_metrics) const
578 d->wa_->redrawAll(update_metrics);
582 frontend::WorkAreaManager & Buffer::workAreaManager() const
584 LASSERT(d->wa_, /**/);
589 Text & Buffer::text() const
591 return d->inset->text();
595 Inset & Buffer::inset() const
601 BufferParams & Buffer::params()
607 BufferParams const & Buffer::params() const
613 ParagraphList & Buffer::paragraphs()
615 return text().paragraphs();
619 ParagraphList const & Buffer::paragraphs() const
621 return text().paragraphs();
625 LyXVC & Buffer::lyxvc()
631 LyXVC const & Buffer::lyxvc() const
637 string const Buffer::temppath() const
639 return d->temppath.absFileName();
643 TexRow & Buffer::texrow()
649 TexRow const & Buffer::texrow() const
655 TocBackend & Buffer::tocBackend() const
657 return d->toc_backend;
661 Undo & Buffer::undo()
667 void Buffer::setChild(DocIterator const & dit, Buffer * child)
669 d->children_positions[child] = dit;
673 string Buffer::latexName(bool const no_path) const
675 FileName latex_name =
676 makeLatexName(d->exportFileName());
677 return no_path ? latex_name.onlyFileName()
678 : latex_name.absFileName();
682 FileName Buffer::Impl::exportFileName() const
684 docstring const branch_suffix =
685 params.branchlist().getFileNameSuffix();
686 if (branch_suffix.empty())
689 string const name = filename.onlyFileNameWithoutExt()
690 + to_utf8(branch_suffix);
691 FileName res(filename.onlyPath().absFileName() + "/" + name);
692 res.changeExtension(filename.extension());
698 string Buffer::logName(LogType * type) const
700 string const filename = latexName(false);
702 if (filename.empty()) {
708 string const path = temppath();
710 FileName const fname(addName(temppath(),
711 onlyFileName(changeExtension(filename,
714 // FIXME: how do we know this is the name of the build log?
715 FileName const bname(
716 addName(path, onlyFileName(
717 changeExtension(filename,
718 formats.extension(params().bufferFormat()) + ".out"))));
720 // Also consider the master buffer log file
721 FileName masterfname = fname;
723 if (masterBuffer() != this) {
724 string const mlogfile = masterBuffer()->logName(&mtype);
725 masterfname = FileName(mlogfile);
728 // If no Latex log or Build log is newer, show Build log
729 if (bname.exists() &&
730 ((!fname.exists() && !masterfname.exists())
731 || (fname.lastModified() < bname.lastModified()
732 && masterfname.lastModified() < bname.lastModified()))) {
733 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
736 return bname.absFileName();
737 // If we have a newer master file log or only a master log, show this
738 } else if (fname != masterfname
739 && (!fname.exists() && (masterfname.exists()
740 || fname.lastModified() < masterfname.lastModified()))) {
741 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
744 return masterfname.absFileName();
746 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
749 return fname.absFileName();
753 void Buffer::setReadonly(bool const flag)
755 if (d->read_only != flag) {
762 void Buffer::setFileName(FileName const & fname)
764 bool const changed = fname != d->filename;
767 lyxvc().file_found_hook(fname);
768 setReadonly(d->filename.isReadOnly());
774 int Buffer::readHeader(Lexer & lex)
776 int unknown_tokens = 0;
778 int begin_header_line = -1;
780 // Initialize parameters that may be/go lacking in header:
781 params().branchlist().clear();
782 params().preamble.erase();
783 params().options.erase();
784 params().master.erase();
785 params().float_placement.erase();
786 params().paperwidth.erase();
787 params().paperheight.erase();
788 params().leftmargin.erase();
789 params().rightmargin.erase();
790 params().topmargin.erase();
791 params().bottommargin.erase();
792 params().headheight.erase();
793 params().headsep.erase();
794 params().footskip.erase();
795 params().columnsep.erase();
796 params().fonts_cjk.erase();
797 params().listings_params.clear();
798 params().clearLayoutModules();
799 params().clearRemovedModules();
800 params().clearIncludedChildren();
801 params().pdfoptions().clear();
802 params().indiceslist().clear();
803 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
804 params().isbackgroundcolor = false;
805 params().fontcolor = RGBColor(0, 0, 0);
806 params().isfontcolor = false;
807 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
808 params().boxbgcolor = RGBColor(0xFF, 0, 0);
809 params().html_latex_start.clear();
810 params().html_latex_end.clear();
811 params().html_math_img_scale = 1.0;
812 params().output_sync_macro.erase();
813 params().local_layout.clear();
815 for (int i = 0; i < 4; ++i) {
816 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
817 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
820 ErrorList & errorList = d->errorLists["Parse"];
829 if (token == "\\end_header")
833 if (token == "\\begin_header") {
834 begin_header_line = line;
838 LYXERR(Debug::PARSER, "Handling document header token: `"
841 string unknown = params().readToken(lex, token, d->filename.onlyPath());
842 if (!unknown.empty()) {
843 if (unknown[0] != '\\' && token == "\\textclass") {
844 Alert::warning(_("Unknown document class"),
845 bformat(_("Using the default document class, because the "
846 "class %1$s is unknown."), from_utf8(unknown)));
849 docstring const s = bformat(_("Unknown token: "
853 errorList.push_back(ErrorItem(_("Document header error"),
858 if (begin_header_line) {
859 docstring const s = _("\\begin_header is missing");
860 errorList.push_back(ErrorItem(_("Document header error"),
864 params().makeDocumentClass();
866 return unknown_tokens;
871 // changed to be public and have one parameter
872 // Returns true if "\end_document" is not read (Asger)
873 bool Buffer::readDocument(Lexer & lex)
875 ErrorList & errorList = d->errorLists["Parse"];
878 // remove dummy empty par
879 paragraphs().clear();
881 if (!lex.checkFor("\\begin_document")) {
882 docstring const s = _("\\begin_document is missing");
883 errorList.push_back(ErrorItem(_("Document header error"),
889 if (params().outputChanges) {
890 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
891 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
892 LaTeXFeatures::isAvailable("xcolor");
894 if (!dvipost && !xcolorulem) {
895 Alert::warning(_("Changes not shown in LaTeX output"),
896 _("Changes will not be highlighted in LaTeX output, "
897 "because neither dvipost nor xcolor/ulem are installed.\n"
898 "Please install these packages or redefine "
899 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
900 } else if (!xcolorulem) {
901 Alert::warning(_("Changes not shown in LaTeX output"),
902 _("Changes will not be highlighted in LaTeX output "
903 "when using pdflatex, because xcolor and ulem are not installed.\n"
904 "Please install both packages or redefine "
905 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
909 if (!params().master.empty()) {
910 FileName const master_file = makeAbsPath(params().master,
911 onlyPath(absFileName()));
912 if (isLyXFileName(master_file.absFileName())) {
914 checkAndLoadLyXFile(master_file, true);
916 // necessary e.g. after a reload
917 // to re-register the child (bug 5873)
918 // FIXME: clean up updateMacros (here, only
919 // child registering is needed).
920 master->updateMacros();
921 // set master as master buffer, but only
922 // if we are a real child
923 if (master->isChild(this))
925 // if the master is not fully loaded
926 // it is probably just loading this
927 // child. No warning needed then.
928 else if (master->isFullyLoaded())
929 LYXERR0("The master '"
931 << "' assigned to this document ("
933 << ") does not include "
934 "this document. Ignoring the master assignment.");
939 // assure we have a default index
940 params().indiceslist().addDefault(B_("Index"));
943 bool const res = text().read(lex, errorList, d->inset);
945 // inform parent buffer about local macros
947 Buffer const * pbuf = parent();
948 UserMacroSet::const_iterator cit = usermacros.begin();
949 UserMacroSet::const_iterator end = usermacros.end();
950 for (; cit != end; ++cit)
951 pbuf->usermacros.insert(*cit);
955 updateMacroInstances(InternalUpdate);
960 bool Buffer::readString(string const & s)
962 params().compressed = false;
967 FileName const fn = FileName::tempName("Buffer_readString");
970 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
971 if (ret_plf != ReadSuccess)
974 if (file_format != LYX_FORMAT) {
975 // We need to call lyx2lyx, so write the input to a file
976 ofstream os(fn.toFilesystemEncoding().c_str());
980 return readFile(fn) == ReadSuccess;
983 if (readDocument(lex))
989 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
993 if (!lex.setFile(fname)) {
994 Alert::error(_("File Not Found"),
995 bformat(_("Unable to open file `%1$s'."),
996 from_utf8(fn.absFileName())));
997 return ReadFileNotFound;
1001 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1002 if (ret_plf != ReadSuccess)
1005 if (file_format != LYX_FORMAT) {
1007 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1008 if (ret_clf != ReadSuccess)
1010 return readFile(tmpFile);
1013 // FIXME: InsetInfo needs to know whether the file is under VCS
1014 // during the parse process, so this has to be done before.
1015 lyxvc().file_found_hook(d->filename);
1017 if (readDocument(lex)) {
1018 Alert::error(_("Document format failure"),
1019 bformat(_("%1$s ended unexpectedly, which means"
1020 " that it is probably corrupted."),
1021 from_utf8(fn.absFileName())));
1022 return ReadDocumentFailure;
1025 d->file_fully_loaded = true;
1026 d->read_only = !d->filename.isWritable();
1027 params().compressed = formats.isZippedFile(d->filename);
1033 bool Buffer::isFullyLoaded() const
1035 return d->file_fully_loaded;
1039 void Buffer::setFullyLoaded(bool value)
1041 d->file_fully_loaded = value;
1045 PreviewLoader * Buffer::loader() const
1047 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1049 if (!d->preview_loader_)
1050 d->preview_loader_ = new PreviewLoader(*this);
1051 return d->preview_loader_;
1055 void Buffer::removePreviews() const
1057 delete d->preview_loader_;
1058 d->preview_loader_ = 0;
1062 void Buffer::updatePreviews() const
1064 PreviewLoader * ploader = loader();
1068 InsetIterator it = inset_iterator_begin(*d->inset);
1069 InsetIterator const end = inset_iterator_end(*d->inset);
1070 for (; it != end; ++it)
1071 it->addPreview(it, *ploader);
1073 ploader->startLoading();
1077 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1078 FileName const & fn, int & file_format) const
1080 if(!lex.checkFor("\\lyxformat")) {
1081 Alert::error(_("Document format failure"),
1082 bformat(_("%1$s is not a readable LyX document."),
1083 from_utf8(fn.absFileName())));
1084 return ReadNoLyXFormat;
1090 // LyX formats 217 and earlier were written as 2.17. This corresponds
1091 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1092 // these cases. See also: www.lyx.org/trac/changeset/1313.
1093 size_t dot = tmp_format.find_first_of(".,");
1094 if (dot != string::npos)
1095 tmp_format.erase(dot, 1);
1097 file_format = convert<int>(tmp_format);
1102 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1103 FileName & tmpfile, int from_format)
1105 tmpfile = FileName::tempName("Buffer_convertLyXFormat");
1106 if(tmpfile.empty()) {
1107 Alert::error(_("Conversion failed"),
1108 bformat(_("%1$s is from a different"
1109 " version of LyX, but a temporary"
1110 " file for converting it could"
1111 " not be created."),
1112 from_utf8(fn.absFileName())));
1113 return LyX2LyXNoTempFile;
1116 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1117 if (lyx2lyx.empty()) {
1118 Alert::error(_("Conversion script not found"),
1119 bformat(_("%1$s is from a different"
1120 " version of LyX, but the"
1121 " conversion script lyx2lyx"
1122 " could not be found."),
1123 from_utf8(fn.absFileName())));
1124 return LyX2LyXNotFound;
1128 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1129 ostringstream command;
1130 command << os::python()
1131 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1132 << " -t " << convert<string>(LYX_FORMAT)
1133 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1134 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1135 string const command_str = command.str();
1137 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1139 cmd_ret const ret = runCommand(command_str);
1140 if (ret.first != 0) {
1141 if (from_format < LYX_FORMAT) {
1142 Alert::error(_("Conversion script failed"),
1143 bformat(_("%1$s is from an older version"
1144 " of LyX and the lyx2lyx script"
1145 " failed to convert it."),
1146 from_utf8(fn.absFileName())));
1147 return LyX2LyXOlderFormat;
1149 Alert::error(_("Conversion script failed"),
1150 bformat(_("%1$s is from a newer version"
1151 " of LyX and the lyx2lyx script"
1152 " failed to convert it."),
1153 from_utf8(fn.absFileName())));
1154 return LyX2LyXNewerFormat;
1161 // Should probably be moved to somewhere else: BufferView? GuiView?
1162 bool Buffer::save() const
1164 docstring const file = makeDisplayPath(absFileName(), 20);
1165 d->filename.refresh();
1167 // check the read-only status before moving the file as a backup
1168 if (d->filename.exists()) {
1169 bool const read_only = !d->filename.isWritable();
1171 Alert::warning(_("File is read-only"),
1172 bformat(_("The file %1$s cannot be written because it "
1173 "is marked as read-only."), file));
1178 // ask if the disk file has been externally modified (use checksum method)
1179 if (fileName().exists() && isExternallyModified(checksum_method)) {
1181 bformat(_("Document %1$s has been externally modified. "
1182 "Are you sure you want to overwrite this file?"), file);
1183 int const ret = Alert::prompt(_("Overwrite modified file?"),
1184 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1189 // We don't need autosaves in the immediate future. (Asger)
1190 resetAutosaveTimers();
1192 FileName backupName;
1193 bool madeBackup = false;
1195 // make a backup if the file already exists
1196 if (lyxrc.make_backup && fileName().exists()) {
1197 backupName = FileName(absFileName() + '~');
1198 if (!lyxrc.backupdir_path.empty()) {
1199 string const mangledName =
1200 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1201 backupName = FileName(addName(lyxrc.backupdir_path,
1205 // Except file is symlink do not copy because of #6587.
1206 // Hard links have bad luck.
1207 if (fileName().isSymLink())
1208 madeBackup = fileName().copyTo(backupName);
1210 madeBackup = fileName().moveTo(backupName);
1213 Alert::error(_("Backup failure"),
1214 bformat(_("Cannot create backup file %1$s.\n"
1215 "Please check whether the directory exists and is writable."),
1216 from_utf8(backupName.absFileName())));
1217 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1221 if (writeFile(d->filename)) {
1225 // Saving failed, so backup is not backup
1227 backupName.moveTo(d->filename);
1233 bool Buffer::writeFile(FileName const & fname) const
1235 // FIXME Do we need to do these here? I don't think writing
1236 // the LyX file depends upon it. (RGH)
1238 // updateMacroInstances();
1240 if (d->read_only && fname == d->filename)
1243 bool retval = false;
1245 docstring const str = bformat(_("Saving document %1$s..."),
1246 makeDisplayPath(fname.absFileName()));
1249 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1251 if (params().compressed) {
1252 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1253 retval = ofs && write(ofs);
1255 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1256 retval = ofs && write(ofs);
1260 message(str + _(" could not write file!"));
1265 // removeAutosaveFile();
1268 message(str + _(" done."));
1274 docstring Buffer::emergencyWrite()
1276 // No need to save if the buffer has not changed.
1280 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1282 docstring user_message = bformat(
1283 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1285 // We try to save three places:
1286 // 1) Same place as document. Unless it is an unnamed doc.
1288 string s = absFileName();
1291 if (writeFile(FileName(s))) {
1293 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1294 return user_message;
1296 user_message += " " + _("Save failed! Trying again...\n");
1300 // 2) In HOME directory.
1301 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1303 lyxerr << ' ' << s << endl;
1304 if (writeFile(FileName(s))) {
1306 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1307 return user_message;
1310 user_message += " " + _("Save failed! Trying yet again...\n");
1312 // 3) In "/tmp" directory.
1313 // MakeAbsPath to prepend the current
1314 // drive letter on OS/2
1315 s = addName(package().temp_dir().absFileName(), absFileName());
1317 lyxerr << ' ' << s << endl;
1318 if (writeFile(FileName(s))) {
1320 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1321 return user_message;
1324 user_message += " " + _("Save failed! Bummer. Document is lost.");
1327 return user_message;
1331 bool Buffer::write(ostream & ofs) const
1334 // Use the standard "C" locale for file output.
1335 ofs.imbue(locale::classic());
1338 // The top of the file should not be written by params().
1340 // write out a comment in the top of the file
1341 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1342 << " created this file. For more info see http://www.lyx.org/\n"
1343 << "\\lyxformat " << LYX_FORMAT << "\n"
1344 << "\\begin_document\n";
1346 /// For each author, set 'used' to true if there is a change
1347 /// by this author in the document; otherwise set it to 'false'.
1348 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1349 AuthorList::Authors::const_iterator a_end = params().authors().end();
1350 for (; a_it != a_end; ++a_it)
1351 a_it->setUsed(false);
1353 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1354 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1355 for ( ; it != end; ++it)
1356 it->checkAuthors(params().authors());
1358 // now write out the buffer parameters.
1359 ofs << "\\begin_header\n";
1360 params().writeFile(ofs);
1361 ofs << "\\end_header\n";
1364 ofs << "\n\\begin_body\n";
1366 ofs << "\n\\end_body\n";
1368 // Write marker that shows file is complete
1369 ofs << "\\end_document" << endl;
1371 // Shouldn't really be needed....
1374 // how to check if close went ok?
1375 // Following is an attempt... (BE 20001011)
1377 // good() returns false if any error occured, including some
1378 // formatting error.
1379 // bad() returns true if something bad happened in the buffer,
1380 // which should include file system full errors.
1385 lyxerr << "File was not closed properly." << endl;
1392 bool Buffer::makeLaTeXFile(FileName const & fname,
1393 string const & original_path,
1394 OutputParams const & runparams_in,
1395 OutputWhat output) const
1397 OutputParams runparams = runparams_in;
1399 // This is necessary for LuaTeX/XeTeX with tex fonts.
1400 // See FIXME in BufferParams::encoding()
1401 if (runparams.isFullUnicode())
1402 runparams.encoding = encodings.fromLyXName("utf8-plain");
1404 string const encoding = runparams.encoding->iconvName();
1405 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1408 try { ofs.reset(encoding); }
1409 catch (iconv_codecvt_facet_exception const & e) {
1410 lyxerr << "Caught iconv exception: " << e.what() << endl;
1411 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1412 "verify that the support software for your encoding (%1$s) is "
1413 "properly installed"), from_ascii(encoding)));
1416 if (!openFileWrite(ofs, fname))
1419 //TexStream ts(ofs.rdbuf(), &texrow());
1420 ErrorList & errorList = d->errorLists["Export"];
1422 bool failed_export = false;
1423 otexstream os(ofs, d->texrow);
1425 // make sure we are ready to export
1426 // this needs to be done before we validate
1427 // FIXME Do we need to do this all the time? I.e., in children
1428 // of a master we are exporting?
1430 updateMacroInstances(OutputUpdate);
1433 os.texrow().reset();
1434 writeLaTeXSource(os, original_path, runparams, output);
1436 catch (EncodingException const & e) {
1437 odocstringstream ods;
1438 ods.put(e.failed_char);
1440 oss << "0x" << hex << e.failed_char << dec;
1441 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1442 " (code point %2$s)"),
1443 ods.str(), from_utf8(oss.str()));
1444 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1445 "representable in the chosen encoding.\n"
1446 "Changing the document encoding to utf8 could help."),
1447 e.par_id, e.pos, e.pos + 1));
1448 failed_export = true;
1450 catch (iconv_codecvt_facet_exception const & e) {
1451 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1452 _(e.what()), -1, 0, 0));
1453 failed_export = true;
1455 catch (exception const & e) {
1456 errorList.push_back(ErrorItem(_("conversion failed"),
1457 _(e.what()), -1, 0, 0));
1458 failed_export = true;
1461 lyxerr << "Caught some really weird exception..." << endl;
1467 failed_export = true;
1468 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1472 return !failed_export;
1476 void Buffer::writeLaTeXSource(otexstream & os,
1477 string const & original_path,
1478 OutputParams const & runparams_in,
1479 OutputWhat output) const
1481 // The child documents, if any, shall be already loaded at this point.
1483 OutputParams runparams = runparams_in;
1485 // If we are compiling a file standalone, even if this is the
1486 // child of some other buffer, let's cut the link here, so the
1487 // file is really independent and no concurring settings from
1488 // the master (e.g. branch state) interfere (see #8100).
1489 if (!runparams.is_child)
1490 d->ignore_parent = true;
1492 // Classify the unicode characters appearing in math insets
1493 Encodings::initUnicodeMath(*this);
1495 // validate the buffer.
1496 LYXERR(Debug::LATEX, " Validating buffer...");
1497 LaTeXFeatures features(*this, params(), runparams);
1499 runparams.use_polyglossia = features.usePolyglossia();
1500 LYXERR(Debug::LATEX, " Buffer validation done.");
1502 bool const output_preamble =
1503 output == FullSource || output == OnlyPreamble;
1504 bool const output_body =
1505 output == FullSource || output == OnlyBody;
1507 // The starting paragraph of the coming rows is the
1508 // first paragraph of the document. (Asger)
1509 if (output_preamble && runparams.nice) {
1510 os << "%% LyX " << lyx_version << " created this file. "
1511 "For more info, see http://www.lyx.org/.\n"
1512 "%% Do not edit unless you really know what "
1515 LYXERR(Debug::INFO, "lyx document header finished");
1517 // There are a few differences between nice LaTeX and usual files:
1518 // usual files have \batchmode and special input@path to allow
1519 // inclusion of figures specified by an explicitly relative path
1520 // (i.e., a path starting with './' or '../') with either \input or
1521 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1522 // input@path is set when the actual parameter original_path is set.
1523 // This is done for usual tex-file, but not for nice-latex-file.
1524 // (Matthias 250696)
1525 // Note that input@path is only needed for something the user does
1526 // in the preamble, included .tex files or ERT, files included by
1527 // LyX work without it.
1528 if (output_preamble) {
1529 if (!runparams.nice) {
1530 // code for usual, NOT nice-latex-file
1531 os << "\\batchmode\n"; // changed from \nonstopmode
1533 if (!original_path.empty()) {
1535 // We don't know the encoding of inputpath
1536 docstring const inputpath = from_utf8(original_path);
1537 docstring uncodable_glyphs;
1538 Encoding const * const enc = runparams.encoding;
1540 for (size_t n = 0; n < inputpath.size(); ++n) {
1541 if (!enc->encodable(inputpath[n])) {
1542 docstring const glyph(1, inputpath[n]);
1543 LYXERR0("Uncodable character '"
1545 << "' in input path!");
1546 uncodable_glyphs += glyph;
1551 // warn user if we found uncodable glyphs.
1552 if (!uncodable_glyphs.empty()) {
1553 frontend::Alert::warning(
1554 _("Uncodable character in file path"),
1556 _("The path of your document\n"
1558 "contains glyphs that are unknown "
1559 "in the current document encoding "
1560 "(namely %2$s). This may result in "
1561 "incomplete output, unless "
1562 "TEXINPUTS contains the document "
1563 "directory and you don't use "
1564 "explicitly relative paths (i.e., "
1565 "paths starting with './' or "
1566 "'../') in the preamble or in ERT."
1567 "\n\nIn case of problems, choose "
1568 "an appropriate document encoding\n"
1569 "(such as utf8) or change the "
1571 inputpath, uncodable_glyphs));
1574 support::latex_path(original_path);
1575 if (contains(docdir, '#')) {
1576 docdir = subst(docdir, "#", "\\#");
1577 os << "\\catcode`\\#=11"
1578 "\\def\\#{#}\\catcode`\\#=6\n";
1580 if (contains(docdir, '%')) {
1581 docdir = subst(docdir, "%", "\\%");
1582 os << "\\catcode`\\%=11"
1583 "\\def\\%{%}\\catcode`\\%=14\n";
1585 os << "\\makeatletter\n"
1586 << "\\def\\input@path{{"
1587 << docdir << "/}}\n"
1588 << "\\makeatother\n";
1592 // get parent macros (if this buffer has a parent) which will be
1593 // written at the document begin further down.
1594 MacroSet parentMacros;
1595 listParentMacros(parentMacros, features);
1597 // Write the preamble
1598 runparams.use_babel = params().writeLaTeX(os, features,
1599 d->filename.onlyPath());
1601 runparams.use_japanese = features.isRequired("japanese");
1604 // Restore the parenthood if needed
1605 if (!runparams.is_child)
1606 d->ignore_parent = false;
1611 os << "\\begin{document}\n";
1613 // output the parent macros
1614 MacroSet::iterator it = parentMacros.begin();
1615 MacroSet::iterator end = parentMacros.end();
1616 for (; it != end; ++it) {
1617 int num_lines = (*it)->write(os.os(), true);
1618 os.texrow().newlines(num_lines);
1621 } // output_preamble
1623 os.texrow().start(paragraphs().begin()->id(), 0);
1625 LYXERR(Debug::INFO, "preamble finished, now the body.");
1628 latexParagraphs(*this, text(), os, runparams);
1630 // Restore the parenthood if needed
1631 if (!runparams.is_child)
1632 d->ignore_parent = false;
1634 // add this just in case after all the paragraphs
1637 if (output_preamble) {
1638 os << "\\end{document}\n";
1639 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1641 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1643 runparams_in.encoding = runparams.encoding;
1645 // Just to be sure. (Asger)
1646 os.texrow().newline();
1648 //for (int i = 0; i<d->texrow.rows(); i++) {
1650 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1651 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1654 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1655 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1659 void Buffer::makeDocBookFile(FileName const & fname,
1660 OutputParams const & runparams,
1661 OutputWhat output) const
1663 LYXERR(Debug::LATEX, "makeDocBookFile...");
1666 if (!openFileWrite(ofs, fname))
1669 // make sure we are ready to export
1670 // this needs to be done before we validate
1672 updateMacroInstances(OutputUpdate);
1674 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1678 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1682 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1683 OutputParams const & runparams,
1684 OutputWhat output) const
1686 LaTeXFeatures features(*this, params(), runparams);
1691 DocumentClass const & tclass = params().documentClass();
1692 string const top_element = tclass.latexname();
1694 bool const output_preamble =
1695 output == FullSource || output == OnlyPreamble;
1696 bool const output_body =
1697 output == FullSource || output == OnlyBody;
1699 if (output_preamble) {
1700 if (runparams.flavor == OutputParams::XML)
1701 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1704 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1707 if (! tclass.class_header().empty())
1708 os << from_ascii(tclass.class_header());
1709 else if (runparams.flavor == OutputParams::XML)
1710 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1711 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1713 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1715 docstring preamble = from_utf8(params().preamble);
1716 if (runparams.flavor != OutputParams::XML ) {
1717 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1718 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1719 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1720 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1723 string const name = runparams.nice
1724 ? changeExtension(absFileName(), ".sgml") : fname;
1725 preamble += features.getIncludedFiles(name);
1726 preamble += features.getLyXSGMLEntities();
1728 if (!preamble.empty()) {
1729 os << "\n [ " << preamble << " ]";
1735 string top = top_element;
1737 if (runparams.flavor == OutputParams::XML)
1738 top += params().language->code();
1740 top += params().language->code().substr(0, 2);
1743 if (!params().options.empty()) {
1745 top += params().options;
1748 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1749 << " file was created by LyX " << lyx_version
1750 << "\n See http://www.lyx.org/ for more information -->\n";
1752 params().documentClass().counters().reset();
1754 sgml::openTag(os, top);
1756 docbookParagraphs(text(), *this, os, runparams);
1757 sgml::closeTag(os, top_element);
1762 void Buffer::makeLyXHTMLFile(FileName const & fname,
1763 OutputParams const & runparams) const
1765 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1768 if (!openFileWrite(ofs, fname))
1771 // make sure we are ready to export
1772 // this has to be done before we validate
1773 updateBuffer(UpdateMaster, OutputUpdate);
1774 updateMacroInstances(OutputUpdate);
1776 writeLyXHTMLSource(ofs, runparams, FullSource);
1780 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1784 void Buffer::writeLyXHTMLSource(odocstream & os,
1785 OutputParams const & runparams,
1786 OutputWhat output) const
1788 LaTeXFeatures features(*this, params(), runparams);
1790 d->bibinfo_.makeCitationLabels(*this);
1792 bool const output_preamble =
1793 output == FullSource || output == OnlyPreamble;
1794 bool const output_body =
1795 output == FullSource || output == OnlyBody || output == IncludedFile;
1797 if (output_preamble) {
1798 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1799 << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/TR/2001/REC-MathML2-20010221/dtd/xhtml-math11-f.dtd\">\n"
1800 // FIXME Language should be set properly.
1801 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1803 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1804 // FIXME Presumably need to set this right
1805 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1807 docstring const & doctitle = features.htmlTitle();
1809 << (doctitle.empty() ?
1810 from_ascii("LyX Document") :
1811 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
1814 docstring styles = features.getTClassHTMLPreamble();
1815 if (!styles.empty())
1816 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
1818 styles = from_utf8(features.getPreambleSnippets());
1819 if (!styles.empty())
1820 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
1822 // we will collect CSS information in a stream, and then output it
1823 // either here, as part of the header, or else in a separate file.
1824 odocstringstream css;
1825 styles = from_utf8(features.getCSSSnippets());
1826 if (!styles.empty())
1827 css << "/* LyX Provided Styles */\n" << styles << '\n';
1829 styles = features.getTClassHTMLStyles();
1830 if (!styles.empty())
1831 css << "/* Layout-provided Styles */\n" << styles << '\n';
1833 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1834 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1835 if (needfg || needbg) {
1836 css << "\nbody {\n";
1839 << from_ascii(X11hexname(params().fontcolor))
1842 css << " background-color: "
1843 << from_ascii(X11hexname(params().backgroundcolor))
1848 docstring const dstyles = css.str();
1849 if (!dstyles.empty()) {
1850 bool written = false;
1851 if (params().html_css_as_file) {
1852 // open a file for CSS info
1854 string const fcssname = addName(temppath(), "docstyle.css");
1855 FileName const fcssfile = FileName(fcssname);
1856 if (openFileWrite(ocss, fcssfile)) {
1860 // write link to header
1861 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
1863 runparams.exportdata->addExternalFile("xhtml", fcssfile);
1866 // we are here if the CSS is supposed to be written to the header
1867 // or if we failed to write it to an external file.
1869 os << "<style type='text/css'>\n"
1878 bool const output_body_tag = (output != IncludedFile);
1879 if (output_body_tag)
1882 params().documentClass().counters().reset();
1883 xhtmlParagraphs(text(), *this, xs, runparams);
1884 if (output_body_tag)
1888 if (output_preamble)
1893 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1894 // Other flags: -wall -v0 -x
1895 int Buffer::runChktex()
1899 // get LaTeX-Filename
1900 FileName const path(temppath());
1901 string const name = addName(path.absFileName(), latexName());
1902 string const org_path = filePath();
1904 PathChanger p(path); // path to LaTeX file
1905 message(_("Running chktex..."));
1907 // Generate the LaTeX file if neccessary
1908 OutputParams runparams(¶ms().encoding());
1909 runparams.flavor = OutputParams::LATEX;
1910 runparams.nice = false;
1911 runparams.linelen = lyxrc.plaintext_linelen;
1912 makeLaTeXFile(FileName(name), org_path, runparams);
1915 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1916 int const res = chktex.run(terr); // run chktex
1919 Alert::error(_("chktex failure"),
1920 _("Could not run chktex successfully."));
1921 } else if (res > 0) {
1922 ErrorList & errlist = d->errorLists["ChkTeX"];
1924 bufferErrors(terr, errlist);
1935 void Buffer::validate(LaTeXFeatures & features) const
1937 // Validate the buffer params, but not for included
1938 // files, since they also use the parent buffer's
1940 if (!features.runparams().is_child)
1941 params().validate(features);
1943 for_each(paragraphs().begin(), paragraphs().end(),
1944 bind(&Paragraph::validate, _1, ref(features)));
1946 if (lyxerr.debugging(Debug::LATEX)) {
1947 features.showStruct();
1952 void Buffer::getLabelList(vector<docstring> & list) const
1954 // If this is a child document, use the master's list instead.
1956 masterBuffer()->getLabelList(list);
1961 Toc & toc = d->toc_backend.toc("label");
1962 TocIterator toc_it = toc.begin();
1963 TocIterator end = toc.end();
1964 for (; toc_it != end; ++toc_it) {
1965 if (toc_it->depth() == 0)
1966 list.push_back(toc_it->str());
1971 void Buffer::updateBibfilesCache(UpdateScope scope) const
1973 // FIXME This is probably unnecssary, given where we call this.
1974 // If this is a child document, use the parent's cache instead.
1975 if (parent() && scope != UpdateChildOnly) {
1976 masterBuffer()->updateBibfilesCache();
1980 d->bibfiles_cache_.clear();
1981 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1982 if (it->lyxCode() == BIBTEX_CODE) {
1983 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
1984 support::FileNameList const bibfiles = inset.getBibFiles();
1985 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
1988 } else if (it->lyxCode() == INCLUDE_CODE) {
1989 InsetInclude & inset = static_cast<InsetInclude &>(*it);
1990 Buffer const * const incbuf = inset.getChildBuffer();
1993 support::FileNameList const & bibfiles =
1994 incbuf->getBibfilesCache(UpdateChildOnly);
1995 if (!bibfiles.empty()) {
1996 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2002 d->bibfile_cache_valid_ = true;
2003 d->bibinfo_cache_valid_ = false;
2004 d->cite_labels_valid_ = false;
2008 void Buffer::invalidateBibinfoCache() const
2010 d->bibinfo_cache_valid_ = false;
2011 d->cite_labels_valid_ = false;
2012 // also invalidate the cache for the parent buffer
2013 Buffer const * const pbuf = d->parent();
2015 pbuf->invalidateBibinfoCache();
2019 void Buffer::invalidateBibfileCache() const
2021 d->bibfile_cache_valid_ = false;
2022 d->bibinfo_cache_valid_ = false;
2023 d->cite_labels_valid_ = false;
2024 // also invalidate the cache for the parent buffer
2025 Buffer const * const pbuf = d->parent();
2027 pbuf->invalidateBibfileCache();
2031 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2033 // FIXME This is probably unnecessary, given where we call this.
2034 // If this is a child document, use the master's cache instead.
2035 Buffer const * const pbuf = masterBuffer();
2036 if (pbuf != this && scope != UpdateChildOnly)
2037 return pbuf->getBibfilesCache();
2039 if (!d->bibfile_cache_valid_)
2040 this->updateBibfilesCache(scope);
2042 return d->bibfiles_cache_;
2046 BiblioInfo const & Buffer::masterBibInfo() const
2048 Buffer const * const tmp = masterBuffer();
2050 return tmp->masterBibInfo();
2055 void Buffer::checkIfBibInfoCacheIsValid() const
2057 // use the master's cache
2058 Buffer const * const tmp = masterBuffer();
2060 tmp->checkIfBibInfoCacheIsValid();
2064 // compare the cached timestamps with the actual ones.
2065 FileNameList const & bibfiles_cache = getBibfilesCache();
2066 FileNameList::const_iterator ei = bibfiles_cache.begin();
2067 FileNameList::const_iterator en = bibfiles_cache.end();
2068 for (; ei != en; ++ ei) {
2069 time_t lastw = ei->lastModified();
2070 time_t prevw = d->bibfile_status_[*ei];
2071 if (lastw != prevw) {
2072 d->bibinfo_cache_valid_ = false;
2073 d->cite_labels_valid_ = false;
2074 d->bibfile_status_[*ei] = lastw;
2080 void Buffer::reloadBibInfoCache() const
2082 // use the master's cache
2083 Buffer const * const tmp = masterBuffer();
2085 tmp->reloadBibInfoCache();
2089 checkIfBibInfoCacheIsValid();
2090 if (d->bibinfo_cache_valid_)
2093 d->bibinfo_.clear();
2095 d->bibinfo_cache_valid_ = true;
2099 void Buffer::collectBibKeys() const
2101 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2102 it->collectBibKeys(it);
2106 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2108 Buffer const * tmp = masterBuffer();
2109 BiblioInfo & masterbi = (tmp == this) ?
2110 d->bibinfo_ : tmp->d->bibinfo_;
2111 masterbi.mergeBiblioInfo(bi);
2115 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2117 Buffer const * tmp = masterBuffer();
2118 BiblioInfo & masterbi = (tmp == this) ?
2119 d->bibinfo_ : tmp->d->bibinfo_;
2124 bool Buffer::citeLabelsValid() const
2126 return masterBuffer()->d->cite_labels_valid_;
2130 void Buffer::removeBiblioTempFiles() const
2132 // We remove files that contain LaTeX commands specific to the
2133 // particular bibliographic style being used, in order to avoid
2134 // LaTeX errors when we switch style.
2135 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2136 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2137 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2138 aux_file.removeFile();
2139 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2140 bbl_file.removeFile();
2141 // Also for the parent buffer
2142 Buffer const * const pbuf = parent();
2144 pbuf->removeBiblioTempFiles();
2148 bool Buffer::isDepClean(string const & name) const
2150 DepClean::const_iterator const it = d->dep_clean.find(name);
2151 if (it == d->dep_clean.end())
2157 void Buffer::markDepClean(string const & name)
2159 d->dep_clean[name] = true;
2163 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2166 // FIXME? if there is an Buffer LFUN that can be dispatched even
2167 // if internal, put a switch '(cmd.action)' here.
2173 switch (cmd.action()) {
2175 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2176 flag.setOnOff(isReadonly());
2179 // FIXME: There is need for a command-line import.
2180 //case LFUN_BUFFER_IMPORT:
2182 case LFUN_BUFFER_AUTO_SAVE:
2185 case LFUN_BUFFER_EXPORT_CUSTOM:
2186 // FIXME: Nothing to check here?
2189 case LFUN_BUFFER_EXPORT: {
2190 docstring const arg = cmd.argument();
2191 if (arg == "custom") {
2195 string format = to_utf8(arg);
2196 size_t pos = format.find(' ');
2197 if (pos != string::npos)
2198 format = format.substr(0, pos);
2199 enable = params().isExportable(format);
2201 flag.message(bformat(
2202 _("Don't know how to export to format: %1$s"), arg));
2206 case LFUN_BUFFER_CHKTEX:
2207 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2210 case LFUN_BUILD_PROGRAM:
2211 enable = params().isExportable("program");
2214 case LFUN_BRANCH_ADD:
2215 case LFUN_BRANCHES_RENAME:
2216 case LFUN_BUFFER_PRINT:
2217 // if no Buffer is present, then of course we won't be called!
2220 case LFUN_BUFFER_LANGUAGE:
2221 enable = !isReadonly();
2227 flag.setEnabled(enable);
2232 void Buffer::dispatch(string const & command, DispatchResult & result)
2234 return dispatch(lyxaction.lookupFunc(command), result);
2238 // NOTE We can end up here even if we have no GUI, because we are called
2239 // by LyX::exec to handled command-line requests. So we may need to check
2240 // whether we have a GUI or not. The boolean use_gui holds this information.
2241 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2244 // FIXME? if there is an Buffer LFUN that can be dispatched even
2245 // if internal, put a switch '(cmd.action())' here.
2246 dr.dispatched(false);
2249 string const argument = to_utf8(func.argument());
2250 // We'll set this back to false if need be.
2251 bool dispatched = true;
2252 undo().beginUndoGroup();
2254 switch (func.action()) {
2255 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2256 if (lyxvc().inUse())
2257 lyxvc().toggleReadOnly();
2259 setReadonly(!isReadonly());
2262 case LFUN_BUFFER_EXPORT: {
2263 ExportStatus const status = doExport(argument, false);
2264 dr.setError(status != ExportSuccess);
2265 if (status != ExportSuccess)
2266 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2271 case LFUN_BUILD_PROGRAM:
2272 doExport("program", true);
2275 case LFUN_BUFFER_CHKTEX:
2279 case LFUN_BUFFER_EXPORT_CUSTOM: {
2281 string command = split(argument, format_name, ' ');
2282 Format const * format = formats.getFormat(format_name);
2284 lyxerr << "Format \"" << format_name
2285 << "\" not recognized!"
2290 // The name of the file created by the conversion process
2293 // Output to filename
2294 if (format->name() == "lyx") {
2295 string const latexname = latexName(false);
2296 filename = changeExtension(latexname,
2297 format->extension());
2298 filename = addName(temppath(), filename);
2300 if (!writeFile(FileName(filename)))
2304 doExport(format_name, true, filename);
2307 // Substitute $$FName for filename
2308 if (!contains(command, "$$FName"))
2309 command = "( " + command + " ) < $$FName";
2310 command = subst(command, "$$FName", filename);
2312 // Execute the command in the background
2314 call.startscript(Systemcall::DontWait, command, filePath());
2318 // FIXME: There is need for a command-line import.
2320 case LFUN_BUFFER_IMPORT:
2325 case LFUN_BUFFER_AUTO_SAVE:
2327 resetAutosaveTimers();
2330 case LFUN_BRANCH_ADD: {
2331 docstring branch_name = func.argument();
2332 if (branch_name.empty()) {
2336 BranchList & branch_list = params().branchlist();
2337 vector<docstring> const branches =
2338 getVectorFromString(branch_name, branch_list.separator());
2340 for (vector<docstring>::const_iterator it = branches.begin();
2341 it != branches.end(); ++it) {
2343 Branch * branch = branch_list.find(branch_name);
2345 LYXERR0("Branch " << branch_name << " already exists.");
2349 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2351 branch_list.add(branch_name);
2352 branch = branch_list.find(branch_name);
2353 string const x11hexname = X11hexname(branch->color());
2354 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2355 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2357 dr.screenUpdate(Update::Force);
2365 case LFUN_BRANCHES_RENAME: {
2366 if (func.argument().empty())
2369 docstring const oldname = from_utf8(func.getArg(0));
2370 docstring const newname = from_utf8(func.getArg(1));
2371 InsetIterator it = inset_iterator_begin(inset());
2372 InsetIterator const end = inset_iterator_end(inset());
2373 bool success = false;
2374 for (; it != end; ++it) {
2375 if (it->lyxCode() == BRANCH_CODE) {
2376 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2377 if (ins.branch() == oldname) {
2378 undo().recordUndo(CursorData(it));
2379 ins.rename(newname);
2384 if (it->lyxCode() == INCLUDE_CODE) {
2385 // get buffer of external file
2386 InsetInclude const & ins =
2387 static_cast<InsetInclude const &>(*it);
2388 Buffer * child = ins.getChildBuffer();
2391 child->dispatch(func, dr);
2396 dr.screenUpdate(Update::Force);
2397 dr.forceBufferUpdate();
2402 case LFUN_BUFFER_PRINT: {
2403 // we'll assume there's a problem until we succeed
2405 string target = func.getArg(0);
2406 string target_name = func.getArg(1);
2407 string command = func.getArg(2);
2410 || target_name.empty()
2411 || command.empty()) {
2412 LYXERR0("Unable to parse " << func.argument());
2413 docstring const msg =
2414 bformat(_("Unable to parse \"%1$s\""), func.argument());
2418 if (target != "printer" && target != "file") {
2419 LYXERR0("Unrecognized target \"" << target << '"');
2420 docstring const msg =
2421 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2426 if (!doExport("dvi", true)) {
2427 showPrintError(absFileName());
2428 dr.setMessage(_("Error exporting to DVI."));
2432 // Push directory path.
2433 string const path = temppath();
2434 // Prevent the compiler from optimizing away p
2438 // there are three cases here:
2439 // 1. we print to a file
2440 // 2. we print directly to a printer
2441 // 3. we print using a spool command (print to file first)
2444 string const dviname = changeExtension(latexName(true), "dvi");
2446 if (target == "printer") {
2447 if (!lyxrc.print_spool_command.empty()) {
2448 // case 3: print using a spool
2449 string const psname = changeExtension(dviname,".ps");
2450 command += ' ' + lyxrc.print_to_file
2453 + quoteName(dviname);
2455 string command2 = lyxrc.print_spool_command + ' ';
2456 if (target_name != "default") {
2457 command2 += lyxrc.print_spool_printerprefix
2461 command2 += quoteName(psname);
2463 // If successful, then spool command
2464 res = one.startscript(Systemcall::Wait, command,
2468 // If there's no GUI, we have to wait on this command. Otherwise,
2469 // LyX deletes the temporary directory, and with it the spooled
2470 // file, before it can be printed!!
2471 Systemcall::Starttype stype = use_gui ?
2472 Systemcall::DontWait : Systemcall::Wait;
2473 res = one.startscript(stype, command2,
2477 // case 2: print directly to a printer
2478 if (target_name != "default")
2479 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2481 Systemcall::Starttype stype = use_gui ?
2482 Systemcall::DontWait : Systemcall::Wait;
2483 res = one.startscript(stype, command +
2484 quoteName(dviname), filePath());
2488 // case 1: print to a file
2489 FileName const filename(makeAbsPath(target_name, filePath()));
2490 FileName const dvifile(makeAbsPath(dviname, path));
2491 if (filename.exists()) {
2492 docstring text = bformat(
2493 _("The file %1$s already exists.\n\n"
2494 "Do you want to overwrite that file?"),
2495 makeDisplayPath(filename.absFileName()));
2496 if (Alert::prompt(_("Overwrite file?"),
2497 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2500 command += ' ' + lyxrc.print_to_file
2501 + quoteName(filename.toFilesystemEncoding())
2503 + quoteName(dvifile.toFilesystemEncoding());
2505 Systemcall::Starttype stype = use_gui ?
2506 Systemcall::DontWait : Systemcall::Wait;
2507 res = one.startscript(stype, command, filePath());
2513 dr.setMessage(_("Error running external commands."));
2514 showPrintError(absFileName());
2523 dr.dispatched(dispatched);
2524 undo().endUndoGroup();
2528 void Buffer::changeLanguage(Language const * from, Language const * to)
2530 LASSERT(from, /**/);
2533 for_each(par_iterator_begin(),
2535 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2539 bool Buffer::isMultiLingual() const
2541 ParConstIterator end = par_iterator_end();
2542 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2543 if (it->isMultiLingual(params()))
2550 std::set<Language const *> Buffer::getLanguages() const
2552 std::set<Language const *> languages;
2553 getLanguages(languages);
2558 void Buffer::getLanguages(std::set<Language const *> & languages) const
2560 ParConstIterator end = par_iterator_end();
2561 // add the buffer language, even if it's not actively used
2562 languages.insert(language());
2563 // iterate over the paragraphs
2564 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2565 it->getLanguages(languages);
2567 ListOfBuffers clist = getDescendents();
2568 ListOfBuffers::const_iterator cit = clist.begin();
2569 ListOfBuffers::const_iterator const cen = clist.end();
2570 for (; cit != cen; ++cit)
2571 (*cit)->getLanguages(languages);
2575 DocIterator Buffer::getParFromID(int const id) const
2577 Buffer * buf = const_cast<Buffer *>(this);
2579 // John says this is called with id == -1 from undo
2580 lyxerr << "getParFromID(), id: " << id << endl;
2581 return doc_iterator_end(buf);
2584 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2585 if (it.paragraph().id() == id)
2588 return doc_iterator_end(buf);
2592 bool Buffer::hasParWithID(int const id) const
2594 return !getParFromID(id).atEnd();
2598 ParIterator Buffer::par_iterator_begin()
2600 return ParIterator(doc_iterator_begin(this));
2604 ParIterator Buffer::par_iterator_end()
2606 return ParIterator(doc_iterator_end(this));
2610 ParConstIterator Buffer::par_iterator_begin() const
2612 return ParConstIterator(doc_iterator_begin(this));
2616 ParConstIterator Buffer::par_iterator_end() const
2618 return ParConstIterator(doc_iterator_end(this));
2622 Language const * Buffer::language() const
2624 return params().language;
2628 docstring const Buffer::B_(string const & l10n) const
2630 return params().B_(l10n);
2634 bool Buffer::isClean() const
2636 return d->lyx_clean;
2640 bool Buffer::isExternallyModified(CheckMethod method) const
2642 LASSERT(d->filename.exists(), /**/);
2643 // if method == timestamp, check timestamp before checksum
2644 return (method == checksum_method
2645 || d->timestamp_ != d->filename.lastModified())
2646 && d->checksum_ != d->filename.checksum();
2650 void Buffer::saveCheckSum() const
2652 FileName const & file = d->filename;
2655 if (file.exists()) {
2656 d->timestamp_ = file.lastModified();
2657 d->checksum_ = file.checksum();
2659 // in the case of save to a new file.
2666 void Buffer::markClean() const
2668 if (!d->lyx_clean) {
2669 d->lyx_clean = true;
2672 // if the .lyx file has been saved, we don't need an
2674 d->bak_clean = true;
2675 d->undo_.markDirty();
2679 void Buffer::setUnnamed(bool flag)
2685 bool Buffer::isUnnamed() const
2692 /// Don't check unnamed, here: isInternal() is used in
2693 /// newBuffer(), where the unnamed flag has not been set by anyone
2694 /// yet. Also, for an internal buffer, there should be no need for
2695 /// retrieving fileName() nor for checking if it is unnamed or not.
2696 bool Buffer::isInternal() const
2698 return d->internal_buffer;
2702 void Buffer::setInternal(bool flag)
2704 d->internal_buffer = flag;
2708 void Buffer::markDirty()
2711 d->lyx_clean = false;
2714 d->bak_clean = false;
2716 DepClean::iterator it = d->dep_clean.begin();
2717 DepClean::const_iterator const end = d->dep_clean.end();
2719 for (; it != end; ++it)
2724 FileName Buffer::fileName() const
2730 string Buffer::absFileName() const
2732 return d->filename.absFileName();
2736 string Buffer::filePath() const
2738 int last = d->filename.onlyPath().absFileName().length() - 1;
2740 return d->filename.onlyPath().absFileName()[last] == '/'
2741 ? d->filename.onlyPath().absFileName()
2742 : d->filename.onlyPath().absFileName() + "/";
2746 bool Buffer::isReadonly() const
2748 return d->read_only;
2752 void Buffer::setParent(Buffer const * buffer)
2754 // Avoids recursive include.
2755 d->setParent(buffer == this ? 0 : buffer);
2760 Buffer const * Buffer::parent() const
2766 ListOfBuffers Buffer::allRelatives() const
2768 ListOfBuffers lb = masterBuffer()->getDescendents();
2769 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2774 Buffer const * Buffer::masterBuffer() const
2776 // FIXME Should be make sure we are not in some kind
2777 // of recursive include? A -> B -> A will crash this.
2778 Buffer const * const pbuf = d->parent();
2782 return pbuf->masterBuffer();
2786 bool Buffer::isChild(Buffer * child) const
2788 return d->children_positions.find(child) != d->children_positions.end();
2792 DocIterator Buffer::firstChildPosition(Buffer const * child)
2794 Impl::BufferPositionMap::iterator it;
2795 it = d->children_positions.find(child);
2796 if (it == d->children_positions.end())
2797 return DocIterator(this);
2802 bool Buffer::hasChildren() const
2804 return !d->children_positions.empty();
2808 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2810 // loop over children
2811 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2812 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2813 for (; it != end; ++it) {
2814 Buffer * child = const_cast<Buffer *>(it->first);
2816 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2817 if (bit != clist.end())
2819 clist.push_back(child);
2821 // there might be grandchildren
2822 child->collectChildren(clist, true);
2827 ListOfBuffers Buffer::getChildren() const
2830 collectChildren(v, false);
2831 // Make sure we have not included ourselves.
2832 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2833 if (bit != v.end()) {
2834 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2841 ListOfBuffers Buffer::getDescendents() const
2844 collectChildren(v, true);
2845 // Make sure we have not included ourselves.
2846 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2847 if (bit != v.end()) {
2848 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2855 template<typename M>
2856 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2861 typename M::const_iterator it = m.lower_bound(x);
2862 if (it == m.begin())
2870 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
2871 DocIterator const & pos) const
2873 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2875 // if paragraphs have no macro context set, pos will be empty
2879 // we haven't found anything yet
2880 DocIterator bestPos = owner_->par_iterator_begin();
2881 MacroData const * bestData = 0;
2883 // find macro definitions for name
2884 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
2885 if (nameIt != macros.end()) {
2886 // find last definition in front of pos or at pos itself
2887 PositionScopeMacroMap::const_iterator it
2888 = greatest_below(nameIt->second, pos);
2889 if (it != nameIt->second.end()) {
2891 // scope ends behind pos?
2892 if (pos < it->second.first) {
2893 // Looks good, remember this. If there
2894 // is no external macro behind this,
2895 // we found the right one already.
2896 bestPos = it->first;
2897 bestData = &it->second.second;
2901 // try previous macro if there is one
2902 if (it == nameIt->second.begin())
2909 // find macros in included files
2910 PositionScopeBufferMap::const_iterator it
2911 = greatest_below(position_to_children, pos);
2912 if (it == position_to_children.end())
2913 // no children before
2917 // do we know something better (i.e. later) already?
2918 if (it->first < bestPos )
2921 // scope ends behind pos?
2922 if (pos < it->second.first
2923 && (cloned_buffer_ ||
2924 theBufferList().isLoaded(it->second.second))) {
2925 // look for macro in external file
2927 MacroData const * data
2928 = it->second.second->getMacro(name, false);
2931 bestPos = it->first;
2937 // try previous file if there is one
2938 if (it == position_to_children.begin())
2943 // return the best macro we have found
2948 MacroData const * Buffer::getMacro(docstring const & name,
2949 DocIterator const & pos, bool global) const
2954 // query buffer macros
2955 MacroData const * data = d->getBufferMacro(name, pos);
2959 // If there is a master buffer, query that
2960 Buffer const * const pbuf = d->parent();
2962 d->macro_lock = true;
2963 MacroData const * macro = pbuf->getMacro(
2964 name, *this, false);
2965 d->macro_lock = false;
2971 data = MacroTable::globalMacros().get(name);
2980 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2982 // set scope end behind the last paragraph
2983 DocIterator scope = par_iterator_begin();
2984 scope.pit() = scope.lastpit() + 1;
2986 return getMacro(name, scope, global);
2990 MacroData const * Buffer::getMacro(docstring const & name,
2991 Buffer const & child, bool global) const
2993 // look where the child buffer is included first
2994 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2995 if (it == d->children_positions.end())
2998 // check for macros at the inclusion position
2999 return getMacro(name, it->second, global);
3003 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3005 pit_type const lastpit = it.lastpit();
3007 // look for macros in each paragraph
3008 while (it.pit() <= lastpit) {
3009 Paragraph & par = it.paragraph();
3011 // iterate over the insets of the current paragraph
3012 InsetList const & insets = par.insetList();
3013 InsetList::const_iterator iit = insets.begin();
3014 InsetList::const_iterator end = insets.end();
3015 for (; iit != end; ++iit) {
3016 it.pos() = iit->pos;
3018 // is it a nested text inset?
3019 if (iit->inset->asInsetText()) {
3020 // Inset needs its own scope?
3021 InsetText const * itext = iit->inset->asInsetText();
3022 bool newScope = itext->isMacroScope();
3024 // scope which ends just behind the inset
3025 DocIterator insetScope = it;
3028 // collect macros in inset
3029 it.push_back(CursorSlice(*iit->inset));
3030 updateMacros(it, newScope ? insetScope : scope);
3035 if (iit->inset->asInsetTabular()) {
3036 CursorSlice slice(*iit->inset);
3037 size_t const numcells = slice.nargs();
3038 for (; slice.idx() < numcells; slice.forwardIdx()) {
3039 it.push_back(slice);
3040 updateMacros(it, scope);
3046 // is it an external file?
3047 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3048 // get buffer of external file
3049 InsetInclude const & inset =
3050 static_cast<InsetInclude const &>(*iit->inset);
3052 Buffer * child = inset.getChildBuffer();
3057 // register its position, but only when it is
3058 // included first in the buffer
3059 if (children_positions.find(child) ==
3060 children_positions.end())
3061 children_positions[child] = it;
3063 // register child with its scope
3064 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3068 InsetMath * im = iit->inset->asInsetMath();
3069 if (doing_export && im) {
3070 InsetMathHull * hull = im->asHullInset();
3072 hull->recordLocation(it);
3075 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3079 MathMacroTemplate & macroTemplate =
3080 *iit->inset->asInsetMath()->asMacroTemplate();
3081 MacroContext mc(owner_, it);
3082 macroTemplate.updateToContext(mc);
3085 bool valid = macroTemplate.validMacro();
3086 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3087 // then the BufferView's cursor will be invalid in
3088 // some cases which leads to crashes.
3093 // FIXME (Abdel), I don't understandt why we pass 'it' here
3094 // instead of 'macroTemplate' defined above... is this correct?
3095 macros[macroTemplate.name()][it] =
3096 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3106 void Buffer::updateMacros() const
3111 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3113 // start with empty table
3115 d->children_positions.clear();
3116 d->position_to_children.clear();
3118 // Iterate over buffer, starting with first paragraph
3119 // The scope must be bigger than any lookup DocIterator
3120 // later. For the global lookup, lastpit+1 is used, hence
3121 // we use lastpit+2 here.
3122 DocIterator it = par_iterator_begin();
3123 DocIterator outerScope = it;
3124 outerScope.pit() = outerScope.lastpit() + 2;
3125 d->updateMacros(it, outerScope);
3129 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3131 InsetIterator it = inset_iterator_begin(inset());
3132 InsetIterator const end = inset_iterator_end(inset());
3133 for (; it != end; ++it) {
3134 if (it->lyxCode() == BRANCH_CODE) {
3135 InsetBranch & br = static_cast<InsetBranch &>(*it);
3136 docstring const name = br.branch();
3137 if (!from_master && !params().branchlist().find(name))
3138 result.push_back(name);
3139 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3140 result.push_back(name);
3143 if (it->lyxCode() == INCLUDE_CODE) {
3144 // get buffer of external file
3145 InsetInclude const & ins =
3146 static_cast<InsetInclude const &>(*it);
3147 Buffer * child = ins.getChildBuffer();
3150 child->getUsedBranches(result, true);
3153 // remove duplicates
3158 void Buffer::updateMacroInstances(UpdateType utype) const
3160 LYXERR(Debug::MACROS, "updateMacroInstances for "
3161 << d->filename.onlyFileName());
3162 DocIterator it = doc_iterator_begin(this);
3164 DocIterator const end = doc_iterator_end(this);
3165 for (; it != end; it.forwardInset()) {
3166 // look for MathData cells in InsetMathNest insets
3167 InsetMath * minset = it.nextInset()->asInsetMath();
3171 // update macro in all cells of the InsetMathNest
3172 DocIterator::idx_type n = minset->nargs();
3173 MacroContext mc = MacroContext(this, it);
3174 for (DocIterator::idx_type i = 0; i < n; ++i) {
3175 MathData & data = minset->cell(i);
3176 data.updateMacros(0, mc, utype);
3182 void Buffer::listMacroNames(MacroNameSet & macros) const
3187 d->macro_lock = true;
3189 // loop over macro names
3190 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3191 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3192 for (; nameIt != nameEnd; ++nameIt)
3193 macros.insert(nameIt->first);
3195 // loop over children
3196 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3197 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3198 for (; it != end; ++it)
3199 it->first->listMacroNames(macros);
3202 Buffer const * const pbuf = d->parent();
3204 pbuf->listMacroNames(macros);
3206 d->macro_lock = false;
3210 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3212 Buffer const * const pbuf = d->parent();
3217 pbuf->listMacroNames(names);
3220 MacroNameSet::iterator it = names.begin();
3221 MacroNameSet::iterator end = names.end();
3222 for (; it != end; ++it) {
3224 MacroData const * data =
3225 pbuf->getMacro(*it, *this, false);
3227 macros.insert(data);
3229 // we cannot access the original MathMacroTemplate anymore
3230 // here to calls validate method. So we do its work here manually.
3231 // FIXME: somehow make the template accessible here.
3232 if (data->optionals() > 0)
3233 features.require("xargs");
3239 Buffer::References & Buffer::references(docstring const & label)
3242 return const_cast<Buffer *>(masterBuffer())->references(label);
3244 RefCache::iterator it = d->ref_cache_.find(label);
3245 if (it != d->ref_cache_.end())
3246 return it->second.second;
3248 static InsetLabel const * dummy_il = 0;
3249 static References const dummy_refs;
3250 it = d->ref_cache_.insert(
3251 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3252 return it->second.second;
3256 Buffer::References const & Buffer::references(docstring const & label) const
3258 return const_cast<Buffer *>(this)->references(label);
3262 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3264 masterBuffer()->d->ref_cache_[label].first = il;
3268 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3270 return masterBuffer()->d->ref_cache_[label].first;
3274 void Buffer::clearReferenceCache() const
3277 d->ref_cache_.clear();
3281 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
3284 //FIXME: This does not work for child documents yet.
3285 LASSERT(code == CITE_CODE, /**/);
3287 reloadBibInfoCache();
3289 // Check if the label 'from' appears more than once
3290 BiblioInfo const & keys = masterBibInfo();
3291 BiblioInfo::const_iterator bit = keys.begin();
3292 BiblioInfo::const_iterator bend = keys.end();
3293 vector<docstring> labels;
3295 for (; bit != bend; ++bit)
3297 labels.push_back(bit->first);
3299 if (count(labels.begin(), labels.end(), from) > 1)
3302 string const paramName = "key";
3303 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3304 if (it->lyxCode() == code) {
3305 InsetCommand * inset = it->asInsetCommand();
3308 docstring const oldValue = inset->getParam(paramName);
3309 if (oldValue == from)
3310 inset->setParam(paramName, to);
3316 void Buffer::getSourceCode(odocstream & os, string const format,
3317 pit_type par_begin, pit_type par_end,
3318 OutputWhat output, bool master) const
3320 OutputParams runparams(¶ms().encoding());
3321 runparams.nice = true;
3322 runparams.flavor = params().getOutputFlavor(format);
3323 runparams.linelen = lyxrc.plaintext_linelen;
3324 // No side effect of file copying and image conversion
3325 runparams.dryrun = true;
3327 if (output == CurrentParagraph) {
3328 runparams.par_begin = par_begin;
3329 runparams.par_end = par_end;
3330 if (par_begin + 1 == par_end) {
3332 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3336 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3337 convert<docstring>(par_begin),
3338 convert<docstring>(par_end - 1))
3341 // output paragraphs
3342 if (runparams.flavor == OutputParams::LYX) {
3343 Paragraph const & par = text().paragraphs()[par_begin];
3345 depth_type dt = par.getDepth();
3346 par.write(ods, params(), dt);
3347 os << from_utf8(ods.str());
3348 } else if (runparams.flavor == OutputParams::HTML) {
3350 setMathFlavor(runparams);
3351 xhtmlParagraphs(text(), *this, xs, runparams);
3352 } else if (runparams.flavor == OutputParams::TEXT) {
3354 // FIXME Handles only one paragraph, unlike the others.
3355 // Probably should have some routine with a signature like them.
3356 writePlaintextParagraph(*this,
3357 text().paragraphs()[par_begin], os, runparams, dummy);
3358 } else if (params().isDocBook()) {
3359 docbookParagraphs(text(), *this, os, runparams);
3361 // If we are previewing a paragraph, even if this is the
3362 // child of some other buffer, let's cut the link here,
3363 // so that no concurring settings from the master
3364 // (e.g. branch state) interfere (see #8101).
3366 d->ignore_parent = true;
3367 // We need to validate the Buffer params' features here
3368 // in order to know if we should output polyglossia
3369 // macros (instead of babel macros)
3370 LaTeXFeatures features(*this, params(), runparams);
3371 params().validate(features);
3372 runparams.use_polyglossia = features.usePolyglossia();
3377 // latex or literate
3378 otexstream ots(os, texrow);
3381 latexParagraphs(*this, text(), ots, runparams);
3383 // Restore the parenthood
3385 d->ignore_parent = false;
3389 if (output == FullSource)
3390 os << _("Preview source code");
3391 else if (output == OnlyPreamble)
3392 os << _("Preview preamble");
3393 else if (output == OnlyBody)
3394 os << _("Preview body");
3396 if (runparams.flavor == OutputParams::LYX) {
3398 if (output == FullSource)
3400 else if (output == OnlyPreamble)
3401 params().writeFile(ods);
3402 else if (output == OnlyBody)
3404 os << from_utf8(ods.str());
3405 } else if (runparams.flavor == OutputParams::HTML) {
3406 writeLyXHTMLSource(os, runparams, output);
3407 } else if (runparams.flavor == OutputParams::TEXT) {
3408 if (output == OnlyPreamble) {
3409 os << "% "<< _("Plain text does not have a preamble.");
3411 writePlaintextFile(*this, os, runparams);
3412 } else if (params().isDocBook()) {
3413 writeDocBookSource(os, absFileName(), runparams, output);
3415 // latex or literate
3417 d->texrow.newline();
3418 d->texrow.newline();
3419 otexstream ots(os, d->texrow);
3421 runparams.is_child = true;
3422 writeLaTeXSource(ots, string(), runparams, output);
3428 ErrorList & Buffer::errorList(string const & type) const
3430 return d->errorLists[type];
3434 void Buffer::updateTocItem(std::string const & type,
3435 DocIterator const & dit) const
3438 d->gui_->updateTocItem(type, dit);
3442 void Buffer::structureChanged() const
3445 d->gui_->structureChanged();
3449 void Buffer::errors(string const & err, bool from_master) const
3452 d->gui_->errors(err, from_master);
3456 void Buffer::message(docstring const & msg) const
3459 d->gui_->message(msg);
3463 void Buffer::setBusy(bool on) const
3466 d->gui_->setBusy(on);
3470 void Buffer::updateTitles() const
3473 d->wa_->updateTitles();
3477 void Buffer::resetAutosaveTimers() const
3480 d->gui_->resetAutosaveTimers();
3484 bool Buffer::hasGuiDelegate() const
3490 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3499 class AutoSaveBuffer : public ForkedProcess {
3502 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3503 : buffer_(buffer), fname_(fname) {}
3505 virtual shared_ptr<ForkedProcess> clone() const
3507 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3512 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3513 from_utf8(fname_.absFileName())));
3514 return run(DontWait);
3518 virtual int generateChild();
3520 Buffer const & buffer_;
3525 int AutoSaveBuffer::generateChild()
3527 #if defined(__APPLE__)
3528 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3529 * We should use something else like threads.
3531 * Since I do not know how to determine at run time what is the OS X
3532 * version, I just disable forking altogether for now (JMarc)
3534 pid_t const pid = -1;
3536 // tmp_ret will be located (usually) in /tmp
3537 // will that be a problem?
3538 // Note that this calls ForkedCalls::fork(), so it's
3539 // ok cross-platform.
3540 pid_t const pid = fork();
3541 // If you want to debug the autosave
3542 // you should set pid to -1, and comment out the fork.
3543 if (pid != 0 && pid != -1)
3547 // pid = -1 signifies that lyx was unable
3548 // to fork. But we will do the save
3550 bool failed = false;
3551 FileName const tmp_ret = FileName::tempName("lyxauto");
3552 if (!tmp_ret.empty()) {
3553 buffer_.writeFile(tmp_ret);
3554 // assume successful write of tmp_ret
3555 if (!tmp_ret.moveTo(fname_))
3561 // failed to write/rename tmp_ret so try writing direct
3562 if (!buffer_.writeFile(fname_)) {
3563 // It is dangerous to do this in the child,
3564 // but safe in the parent, so...
3565 if (pid == -1) // emit message signal.
3566 buffer_.message(_("Autosave failed!"));
3570 if (pid == 0) // we are the child so...
3579 FileName Buffer::getEmergencyFileName() const
3581 return FileName(d->filename.absFileName() + ".emergency");
3585 FileName Buffer::getAutosaveFileName() const
3587 // if the document is unnamed try to save in the backup dir, else
3588 // in the default document path, and as a last try in the filePath,
3589 // which will most often be the temporary directory
3592 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3593 : lyxrc.backupdir_path;
3594 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3597 string const fname = "#" + d->filename.onlyFileName() + "#";
3599 return makeAbsPath(fname, fpath);
3603 void Buffer::removeAutosaveFile() const
3605 FileName const f = getAutosaveFileName();
3611 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3613 FileName const newauto = getAutosaveFileName();
3615 if (newauto != oldauto && oldauto.exists())
3616 if (!oldauto.moveTo(newauto))
3617 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3621 bool Buffer::autoSave() const
3623 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3624 if (buf->d->bak_clean || isReadonly())
3627 message(_("Autosaving current document..."));
3628 buf->d->bak_clean = true;
3630 FileName const fname = getAutosaveFileName();
3631 LASSERT(d->cloned_buffer_, return false);
3633 // If this buffer is cloned, we assume that
3634 // we are running in a separate thread already.
3635 FileName const tmp_ret = FileName::tempName("lyxauto");
3636 if (!tmp_ret.empty()) {
3638 // assume successful write of tmp_ret
3639 if (tmp_ret.moveTo(fname))
3642 // failed to write/rename tmp_ret so try writing direct
3643 return writeFile(fname);
3647 // helper class, to guarantee this gets reset properly
3648 class Buffer::MarkAsExporting {
3650 MarkAsExporting(Buffer const * buf) : buf_(buf)
3652 LASSERT(buf_, /* */);
3653 buf_->setExportStatus(true);
3657 buf_->setExportStatus(false);
3660 Buffer const * const buf_;
3665 void Buffer::setExportStatus(bool e) const
3667 d->doing_export = e;
3668 ListOfBuffers clist = getDescendents();
3669 ListOfBuffers::const_iterator cit = clist.begin();
3670 ListOfBuffers::const_iterator const cen = clist.end();
3671 for (; cit != cen; ++cit)
3672 (*cit)->d->doing_export = e;
3676 bool Buffer::isExporting() const
3678 return d->doing_export;
3682 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3686 return doExport(target, put_in_tempdir, result_file);
3689 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3690 string & result_file) const
3692 bool const update_unincluded =
3693 params().maintain_unincluded_children
3694 && !params().getIncludedChildren().empty();
3696 // (1) export with all included children (omit \includeonly)
3697 if (update_unincluded) {
3698 ExportStatus const status =
3699 doExport(target, put_in_tempdir, true, result_file);
3700 if (status != ExportSuccess)
3703 // (2) export with included children only
3704 return doExport(target, put_in_tempdir, false, result_file);
3708 void Buffer::setMathFlavor(OutputParams & op) const
3710 switch (params().html_math_output) {
3711 case BufferParams::MathML:
3712 op.math_flavor = OutputParams::MathAsMathML;
3714 case BufferParams::HTML:
3715 op.math_flavor = OutputParams::MathAsHTML;
3717 case BufferParams::Images:
3718 op.math_flavor = OutputParams::MathAsImages;
3720 case BufferParams::LaTeX:
3721 op.math_flavor = OutputParams::MathAsLaTeX;
3727 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3728 bool includeall, string & result_file) const
3730 LYXERR(Debug::FILES, "target=" << target);
3731 OutputParams runparams(¶ms().encoding());
3732 string format = target;
3733 string dest_filename;
3734 size_t pos = target.find(' ');
3735 if (pos != string::npos) {
3736 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3737 format = target.substr(0, pos);
3738 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3739 FileName(dest_filename).onlyPath().createPath();
3740 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3742 MarkAsExporting exporting(this);
3743 string backend_format;
3744 runparams.flavor = OutputParams::LATEX;
3745 runparams.linelen = lyxrc.plaintext_linelen;
3746 runparams.includeall = includeall;
3747 vector<string> backs = params().backends();
3748 Converters converters = theConverters();
3749 bool need_nice_file = false;
3750 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3751 // Get shortest path to format
3752 converters.buildGraph();
3753 Graph::EdgePath path;
3754 for (vector<string>::const_iterator it = backs.begin();
3755 it != backs.end(); ++it) {
3756 Graph::EdgePath p = converters.getPath(*it, format);
3757 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3758 backend_format = *it;
3763 if (!put_in_tempdir) {
3764 // Only show this alert if this is an export to a non-temporary
3765 // file (not for previewing).
3766 Alert::error(_("Couldn't export file"), bformat(
3767 _("No information for exporting the format %1$s."),
3768 formats.prettyName(format)));
3770 return ExportNoPathToFormat;
3772 runparams.flavor = converters.getFlavor(path, this);
3773 Graph::EdgePath::const_iterator it = path.begin();
3774 Graph::EdgePath::const_iterator en = path.end();
3775 for (; it != en; ++it)
3776 if (theConverters().get(*it).nice) {
3777 need_nice_file = true;
3782 backend_format = format;
3783 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3784 // FIXME: Don't hardcode format names here, but use a flag
3785 if (backend_format == "pdflatex")
3786 runparams.flavor = OutputParams::PDFLATEX;
3787 else if (backend_format == "luatex")
3788 runparams.flavor = OutputParams::LUATEX;
3789 else if (backend_format == "dviluatex")
3790 runparams.flavor = OutputParams::DVILUATEX;
3791 else if (backend_format == "xetex")
3792 runparams.flavor = OutputParams::XETEX;
3795 string filename = latexName(false);
3796 filename = addName(temppath(), filename);
3797 filename = changeExtension(filename,
3798 formats.extension(backend_format));
3799 LYXERR(Debug::FILES, "filename=" << filename);
3801 // Plain text backend
3802 if (backend_format == "text") {
3803 runparams.flavor = OutputParams::TEXT;
3804 writePlaintextFile(*this, FileName(filename), runparams);
3807 else if (backend_format == "xhtml") {
3808 runparams.flavor = OutputParams::HTML;
3809 setMathFlavor(runparams);
3810 makeLyXHTMLFile(FileName(filename), runparams);
3811 } else if (backend_format == "lyx")
3812 writeFile(FileName(filename));
3814 else if (params().isDocBook()) {
3815 runparams.nice = !put_in_tempdir;
3816 makeDocBookFile(FileName(filename), runparams);
3819 else if (backend_format == format || need_nice_file) {
3820 runparams.nice = true;
3821 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
3822 if (d->cloned_buffer_)
3823 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3826 } else if (!lyxrc.tex_allows_spaces
3827 && contains(filePath(), ' ')) {
3828 Alert::error(_("File name error"),
3829 _("The directory path to the document cannot contain spaces."));
3830 return ExportTexPathHasSpaces;
3832 runparams.nice = false;
3833 bool const success = makeLaTeXFile(
3834 FileName(filename), filePath(), runparams);
3835 if (d->cloned_buffer_)
3836 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3841 string const error_type = (format == "program")
3842 ? "Build" : params().bufferFormat();
3843 ErrorList & error_list = d->errorLists[error_type];
3844 string const ext = formats.extension(format);
3845 FileName const tmp_result_file(changeExtension(filename, ext));
3846 bool const success = converters.convert(this, FileName(filename),
3847 tmp_result_file, FileName(absFileName()), backend_format, format,
3850 // Emit the signal to show the error list or copy it back to the
3851 // cloned Buffer so that it can be emitted afterwards.
3852 if (format != backend_format) {
3853 if (d->cloned_buffer_) {
3854 d->cloned_buffer_->d->errorLists[error_type] =
3855 d->errorLists[error_type];
3858 // also to the children, in case of master-buffer-view
3859 ListOfBuffers clist = getDescendents();
3860 ListOfBuffers::const_iterator cit = clist.begin();
3861 ListOfBuffers::const_iterator const cen = clist.end();
3862 for (; cit != cen; ++cit) {
3863 if (d->cloned_buffer_) {
3864 // Enable reverse search by copying back the
3865 // texrow object to the cloned buffer.
3866 // FIXME: this is not thread safe.
3867 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3868 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3869 (*cit)->d->errorLists[error_type];
3871 (*cit)->errors(error_type, true);
3875 if (d->cloned_buffer_) {
3876 // Enable reverse dvi or pdf to work by copying back the texrow
3877 // object to the cloned buffer.
3878 // FIXME: There is a possibility of concurrent access to texrow
3879 // here from the main GUI thread that should be securized.
3880 d->cloned_buffer_->d->texrow = d->texrow;
3881 string const error_type = params().bufferFormat();
3882 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
3886 return ExportConverterError;
3888 if (put_in_tempdir) {
3889 result_file = tmp_result_file.absFileName();
3890 return ExportSuccess;
3893 if (dest_filename.empty())
3894 result_file = changeExtension(d->exportFileName().absFileName(), ext);
3896 result_file = dest_filename;
3897 // We need to copy referenced files (e. g. included graphics
3898 // if format == "dvi") to the result dir.
3899 vector<ExportedFile> const files =
3900 runparams.exportdata->externalFiles(format);
3901 string const dest = runparams.export_folder.empty() ?
3902 onlyPath(result_file) : runparams.export_folder;
3903 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
3904 : force_overwrite == ALL_FILES;
3905 CopyStatus status = use_force ? FORCE : SUCCESS;
3907 vector<ExportedFile>::const_iterator it = files.begin();
3908 vector<ExportedFile>::const_iterator const en = files.end();
3909 for (; it != en && status != CANCEL; ++it) {
3910 string const fmt = formats.getFormatFromFile(it->sourceName);
3911 string fixedName = it->exportName;
3912 if (!runparams.export_folder.empty()) {
3913 // Relative pathnames starting with ../ will be sanitized
3914 // if exporting to a different folder
3915 while (fixedName.substr(0, 3) == "../")
3916 fixedName = fixedName.substr(3, fixedName.length() - 3);
3918 FileName fixedFileName = makeAbsPath(fixedName, dest);
3919 fixedFileName.onlyPath().createPath();
3920 status = copyFile(fmt, it->sourceName,
3922 it->exportName, status == FORCE,
3923 runparams.export_folder.empty());
3926 if (status == CANCEL) {
3927 message(_("Document export cancelled."));
3928 return ExportCancel;
3931 if (tmp_result_file.exists()) {
3932 // Finally copy the main file
3933 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
3934 : force_overwrite != NO_FILES;
3935 if (status == SUCCESS && use_force)
3937 status = copyFile(format, tmp_result_file,
3938 FileName(result_file), result_file,
3940 if (status == CANCEL) {
3941 message(_("Document export cancelled."));
3942 return ExportCancel;
3944 message(bformat(_("Document exported as %1$s "
3946 formats.prettyName(format),
3947 makeDisplayPath(result_file)));
3950 // This must be a dummy converter like fax (bug 1888)
3951 message(bformat(_("Document exported as %1$s"),
3952 formats.prettyName(format)));
3955 return ExportSuccess;
3959 Buffer::ExportStatus Buffer::preview(string const & format) const
3961 bool const update_unincluded =
3962 params().maintain_unincluded_children
3963 && !params().getIncludedChildren().empty();
3964 return preview(format, update_unincluded);
3967 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
3969 MarkAsExporting exporting(this);
3971 // (1) export with all included children (omit \includeonly)
3973 ExportStatus const status = doExport(format, true, true, result_file);
3974 if (status != ExportSuccess)
3977 // (2) export with included children only
3978 ExportStatus const status = doExport(format, true, false, result_file);
3979 if (status != ExportSuccess)
3981 if (!formats.view(*this, FileName(result_file), format))
3982 return PreviewError;
3983 return PreviewSuccess;
3987 Buffer::ReadStatus Buffer::extractFromVC()
3989 bool const found = LyXVC::file_not_found_hook(d->filename);
3991 return ReadFileNotFound;
3992 if (!d->filename.isReadableFile())
3998 Buffer::ReadStatus Buffer::loadEmergency()
4000 FileName const emergencyFile = getEmergencyFileName();
4001 if (!emergencyFile.exists()
4002 || emergencyFile.lastModified() <= d->filename.lastModified())
4003 return ReadFileNotFound;
4005 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4006 docstring const text = bformat(_("An emergency save of the document "
4007 "%1$s exists.\n\nRecover emergency save?"), file);
4009 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4010 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4016 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4017 bool const success = (ret_llf == ReadSuccess);
4020 Alert::warning(_("File is read-only"),
4021 bformat(_("An emergency file is successfully loaded, "
4022 "but the original file %1$s is marked read-only. "
4023 "Please make sure to save the document as a different "
4024 "file."), from_utf8(d->filename.absFileName())));
4027 lyxvc().file_found_hook(d->filename);
4028 str = _("Document was successfully recovered.");
4030 str = _("Document was NOT successfully recovered.");
4031 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4032 makeDisplayPath(emergencyFile.absFileName()));
4034 int const del_emerg =
4035 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4036 _("&Remove"), _("&Keep"));
4037 if (del_emerg == 0) {
4038 emergencyFile.removeFile();
4040 Alert::warning(_("Emergency file deleted"),
4041 _("Do not forget to save your file now!"), true);
4043 return success ? ReadSuccess : ReadEmergencyFailure;
4046 int const del_emerg =
4047 Alert::prompt(_("Delete emergency file?"),
4048 _("Remove emergency file now?"), 1, 1,
4049 _("&Remove"), _("&Keep"));
4051 emergencyFile.removeFile();
4052 return ReadOriginal;
4062 Buffer::ReadStatus Buffer::loadAutosave()
4064 // Now check if autosave file is newer.
4065 FileName const autosaveFile = getAutosaveFileName();
4066 if (!autosaveFile.exists()
4067 || autosaveFile.lastModified() <= d->filename.lastModified())
4068 return ReadFileNotFound;
4070 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4071 docstring const text = bformat(_("The backup of the document %1$s "
4072 "is newer.\n\nLoad the backup instead?"), file);
4073 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4074 _("&Load backup"), _("Load &original"), _("&Cancel"));
4079 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4080 // the file is not saved if we load the autosave file.
4081 if (ret_llf == ReadSuccess) {
4083 Alert::warning(_("File is read-only"),
4084 bformat(_("A backup file is successfully loaded, "
4085 "but the original file %1$s is marked read-only. "
4086 "Please make sure to save the document as a "
4088 from_utf8(d->filename.absFileName())));
4091 lyxvc().file_found_hook(d->filename);
4094 return ReadAutosaveFailure;
4097 // Here we delete the autosave
4098 autosaveFile.removeFile();
4099 return ReadOriginal;
4107 Buffer::ReadStatus Buffer::loadLyXFile()
4109 if (!d->filename.isReadableFile()) {
4110 ReadStatus const ret_rvc = extractFromVC();
4111 if (ret_rvc != ReadSuccess)
4115 ReadStatus const ret_re = loadEmergency();
4116 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4119 ReadStatus const ret_ra = loadAutosave();
4120 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4123 return loadThisLyXFile(d->filename);
4127 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4129 return readFile(fn);
4133 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4135 TeXErrors::Errors::const_iterator it = terr.begin();
4136 TeXErrors::Errors::const_iterator end = terr.end();
4137 ListOfBuffers clist = getDescendents();
4138 ListOfBuffers::const_iterator cen = clist.end();
4140 for (; it != end; ++it) {
4143 int errorRow = it->error_in_line;
4144 Buffer const * buf = 0;
4146 if (it->child_name.empty())
4147 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4149 // The error occurred in a child
4150 ListOfBuffers::const_iterator cit = clist.begin();
4151 for (; cit != cen; ++cit) {
4152 string const child_name =
4153 DocFileName(changeExtension(
4154 (*cit)->absFileName(), "tex")).
4156 if (it->child_name != child_name)
4158 (*cit)->d->texrow.getIdFromRow(errorRow,
4159 id_start, pos_start);
4160 if (id_start != -1) {
4161 buf = d->cloned_buffer_
4162 ? (*cit)->d->cloned_buffer_->d->owner_
4163 : (*cit)->d->owner_;
4174 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4175 } while (found && id_start == id_end && pos_start == pos_end);
4177 if (id_start != id_end) {
4178 // Next registered position is outside the inset where
4179 // the error occurred, so signal end-of-paragraph
4183 errorList.push_back(ErrorItem(it->error_desc,
4184 it->error_text, id_start, pos_start, pos_end, buf));
4189 void Buffer::setBuffersForInsets() const
4191 inset().setBuffer(const_cast<Buffer &>(*this));
4195 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4197 // Use the master text class also for child documents
4198 Buffer const * const master = masterBuffer();
4199 DocumentClass const & textclass = master->params().documentClass();
4201 // do this only if we are the top-level Buffer
4203 reloadBibInfoCache();
4205 // keep the buffers to be children in this set. If the call from the
4206 // master comes back we can see which of them were actually seen (i.e.
4207 // via an InsetInclude). The remaining ones in the set need still be updated.
4208 static std::set<Buffer const *> bufToUpdate;
4209 if (scope == UpdateMaster) {
4210 // If this is a child document start with the master
4211 if (master != this) {
4212 bufToUpdate.insert(this);
4213 master->updateBuffer(UpdateMaster, utype);
4214 // Do this here in case the master has no gui associated with it. Then,
4215 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4216 if (!master->d->gui_)
4219 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4220 if (bufToUpdate.find(this) == bufToUpdate.end())
4224 // start over the counters in the master
4225 textclass.counters().reset();
4228 // update will be done below for this buffer
4229 bufToUpdate.erase(this);
4231 // update all caches
4232 clearReferenceCache();
4235 Buffer & cbuf = const_cast<Buffer &>(*this);
4237 LASSERT(!text().paragraphs().empty(), /**/);
4240 ParIterator parit = cbuf.par_iterator_begin();
4241 updateBuffer(parit, utype);
4244 // TocBackend update will be done later.
4247 d->bibinfo_cache_valid_ = true;
4248 d->cite_labels_valid_ = true;
4249 cbuf.tocBackend().update();
4250 if (scope == UpdateMaster)
4251 cbuf.structureChanged();
4255 static depth_type getDepth(DocIterator const & it)
4257 depth_type depth = 0;
4258 for (size_t i = 0 ; i < it.depth() ; ++i)
4259 if (!it[i].inset().inMathed())
4260 depth += it[i].paragraph().getDepth() + 1;
4261 // remove 1 since the outer inset does not count
4265 static depth_type getItemDepth(ParIterator const & it)
4267 Paragraph const & par = *it;
4268 LabelType const labeltype = par.layout().labeltype;
4270 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4273 // this will hold the lowest depth encountered up to now.
4274 depth_type min_depth = getDepth(it);
4275 ParIterator prev_it = it;
4278 --prev_it.top().pit();
4280 // start of nested inset: go to outer par
4282 if (prev_it.empty()) {
4283 // start of document: nothing to do
4288 // We search for the first paragraph with same label
4289 // that is not more deeply nested.
4290 Paragraph & prev_par = *prev_it;
4291 depth_type const prev_depth = getDepth(prev_it);
4292 if (labeltype == prev_par.layout().labeltype) {
4293 if (prev_depth < min_depth)
4294 return prev_par.itemdepth + 1;
4295 if (prev_depth == min_depth)
4296 return prev_par.itemdepth;
4298 min_depth = min(min_depth, prev_depth);
4299 // small optimization: if we are at depth 0, we won't
4300 // find anything else
4301 if (prev_depth == 0)
4307 static bool needEnumCounterReset(ParIterator const & it)
4309 Paragraph const & par = *it;
4310 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
4311 depth_type const cur_depth = par.getDepth();
4312 ParIterator prev_it = it;
4313 while (prev_it.pit()) {
4314 --prev_it.top().pit();
4315 Paragraph const & prev_par = *prev_it;
4316 if (prev_par.getDepth() <= cur_depth)
4317 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4319 // start of nested inset: reset
4324 // set the label of a paragraph. This includes the counters.
4325 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4327 BufferParams const & bp = owner_->masterBuffer()->params();
4328 DocumentClass const & textclass = bp.documentClass();
4329 Paragraph & par = it.paragraph();
4330 Layout const & layout = par.layout();
4331 Counters & counters = textclass.counters();
4333 if (par.params().startOfAppendix()) {
4334 // We want to reset the counter corresponding to toplevel sectioning
4335 Layout const & lay = textclass.getTOCLayout();
4336 docstring const cnt = lay.counter;
4338 counters.reset(cnt);
4339 counters.appendix(true);
4341 par.params().appendix(counters.appendix());
4343 // Compute the item depth of the paragraph
4344 par.itemdepth = getItemDepth(it);
4346 if (layout.margintype == MARGIN_MANUAL) {
4347 if (par.params().labelWidthString().empty())
4348 par.params().labelWidthString(par.expandLabel(layout, bp));
4349 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4350 // we do not need to do anything here, since the empty case is
4351 // handled during export.
4353 par.params().labelWidthString(docstring());
4356 switch(layout.labeltype) {
4358 if (layout.toclevel <= bp.secnumdepth
4359 && (layout.latextype != LATEX_ENVIRONMENT
4360 || it.text()->isFirstInSequence(it.pit()))) {
4361 if (counters.hasCounter(layout.counter))
4362 counters.step(layout.counter, utype);
4363 par.params().labelString(par.expandLabel(layout, bp));
4365 par.params().labelString(docstring());
4368 case LABEL_ITEMIZE: {
4369 // At some point of time we should do something more
4370 // clever here, like:
4371 // par.params().labelString(
4372 // bp.user_defined_bullet(par.itemdepth).getText());
4373 // for now, use a simple hardcoded label
4374 docstring itemlabel;
4375 switch (par.itemdepth) {
4377 itemlabel = char_type(0x2022);
4380 itemlabel = char_type(0x2013);
4383 itemlabel = char_type(0x2217);
4386 itemlabel = char_type(0x2219); // or 0x00b7
4389 par.params().labelString(itemlabel);
4393 case LABEL_ENUMERATE: {
4394 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4396 switch (par.itemdepth) {
4405 enumcounter += "iv";
4408 // not a valid enumdepth...
4412 // Maybe we have to reset the enumeration counter.
4413 if (needEnumCounterReset(it))
4414 counters.reset(enumcounter);
4415 counters.step(enumcounter, utype);
4417 string const & lang = par.getParLanguage(bp)->code();
4418 par.params().labelString(counters.theCounter(enumcounter, lang));
4423 case LABEL_SENSITIVE: {
4424 string const & type = counters.current_float();
4425 docstring full_label;
4427 full_label = owner_->B_("Senseless!!! ");
4429 docstring name = owner_->B_(textclass.floats().getType(type).name());
4430 if (counters.hasCounter(from_utf8(type))) {
4431 string const & lang = par.getParLanguage(bp)->code();
4432 counters.step(from_utf8(type), utype);
4433 full_label = bformat(from_ascii("%1$s %2$s:"),
4435 counters.theCounter(from_utf8(type), lang));
4437 full_label = bformat(from_ascii("%1$s #:"), name);
4439 par.params().labelString(full_label);
4443 case LABEL_NO_LABEL:
4444 par.params().labelString(docstring());
4448 case LABEL_TOP_ENVIRONMENT:
4449 case LABEL_CENTERED_TOP_ENVIRONMENT:
4452 par.params().labelString(par.expandLabel(layout, bp));
4458 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4460 LASSERT(parit.pit() == 0, /**/);
4462 // Set the position of the text in the buffer to be able
4463 // to resolve macros in it.
4464 parit.text()->setMacrocontextPosition(parit);
4466 depth_type maxdepth = 0;
4467 pit_type const lastpit = parit.lastpit();
4468 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4469 // reduce depth if necessary
4470 if (parit->params().depth() > maxdepth) {
4471 /** FIXME: this function is const, but
4472 * nevertheless it modifies the buffer. To be
4473 * cleaner, one should modify the buffer in
4474 * another function, which is actually
4475 * non-const. This would however be costly in
4476 * terms of code duplication.
4478 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4479 parit->params().depth(maxdepth);
4481 maxdepth = parit->getMaxDepthAfter();
4483 if (utype == OutputUpdate) {
4484 // track the active counters
4485 // we have to do this for the master buffer, since the local
4486 // buffer isn't tracking anything.
4487 masterBuffer()->params().documentClass().counters().
4488 setActiveLayout(parit->layout());
4491 // set the counter for this paragraph
4492 d->setLabel(parit, utype);
4495 InsetList::const_iterator iit = parit->insetList().begin();
4496 InsetList::const_iterator end = parit->insetList().end();
4497 for (; iit != end; ++iit) {
4498 parit.pos() = iit->pos;
4499 iit->inset->updateBuffer(parit, utype);
4505 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4506 WordLangTuple & word_lang, docstring_list & suggestions) const
4510 suggestions.clear();
4511 word_lang = WordLangTuple();
4512 bool const to_end = to.empty();
4513 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4514 // OK, we start from here.
4515 for (; from != end; from.forwardPos()) {
4516 // We are only interested in text so remove the math CursorSlice.
4517 while (from.inMathed()) {
4521 // If from is at the end of the document (which is possible
4522 // when leaving the mathed) LyX will crash later otherwise.
4523 if (from.atEnd() || (!to_end && from >= end))
4526 from.paragraph().spellCheck();
4527 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4528 if (SpellChecker::misspelled(res)) {
4533 // Do not increase progress when from == to, otherwise the word
4534 // count will be wrong.
4544 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4546 bool inword = false;
4551 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4552 if (!dit.inTexted()) {
4557 Paragraph const & par = dit.paragraph();
4558 pos_type const pos = dit.pos();
4560 // Copied and adapted from isWordSeparator() in Paragraph
4561 if (pos == dit.lastpos()) {
4564 Inset const * ins = par.getInset(pos);
4565 if (ins && skipNoOutput && !ins->producesOutput()) {
4568 // stop if end of range was skipped
4569 if (!to.atEnd() && dit >= to)
4572 } else if (!par.isDeleted(pos)) {
4573 if (par.isWordSeparator(pos))
4579 if (ins && ins->isLetter())
4581 else if (ins && ins->isSpace())
4584 char_type const c = par.getChar(pos);
4585 if (isPrintableNonspace(c))
4587 else if (isSpace(c))
4597 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4599 d->updateStatistics(from, to, skipNoOutput);
4603 int Buffer::wordCount() const
4605 return d->wordCount();
4609 int Buffer::charCount(bool with_blanks) const
4611 return d->charCount(with_blanks);
4615 Buffer::ReadStatus Buffer::reload(bool clearUndo)
4618 // c.f. bug http://www.lyx.org/trac/ticket/6587
4619 removeAutosaveFile();
4620 // e.g., read-only status could have changed due to version control
4621 d->filename.refresh();
4622 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4624 // clear parent. this will get reset if need be.
4626 ReadStatus const status = loadLyXFile();
4627 if (status == ReadSuccess) {
4632 message(bformat(_("Document %1$s reloaded."), disp_fn));
4636 message(bformat(_("Could not reload document %1$s."), disp_fn));
4646 bool Buffer::saveAs(FileName const & fn)
4648 FileName const old_name = fileName();
4649 FileName const old_auto = getAutosaveFileName();
4650 bool const old_unnamed = isUnnamed();
4657 // bring the autosave file with us, just in case.
4658 moveAutosaveFile(old_auto);
4659 // validate version control data and
4660 // correct buffer title
4661 lyxvc().file_found_hook(fileName());
4663 // the file has now been saved to the new location.
4664 // we need to check that the locations of child buffers
4666 checkChildBuffers();
4667 checkMasterBuffer();
4671 // reset the old filename and unnamed state
4672 setFileName(old_name);
4673 setUnnamed(old_unnamed);
4679 // FIXME We could do better here, but it is complicated. What would be
4680 // nice is to offer either (a) to save the child buffer to an appropriate
4681 // location, so that it would "move with the master", or else (b) to update
4682 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4683 // complicated, because the code for this lives in GuiView.
4684 void Buffer::checkChildBuffers()
4686 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4687 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4688 for (; it != en; ++it) {
4689 DocIterator dit = it->second;
4690 Buffer * cbuf = const_cast<Buffer *>(it->first);
4691 if (!cbuf || !theBufferList().isLoaded(cbuf))
4693 Inset * inset = dit.nextInset();
4694 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4695 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4696 docstring const & incfile = inset_inc->getParam("filename");
4697 string oldloc = cbuf->absFileName();
4698 string newloc = makeAbsPath(to_utf8(incfile),
4699 onlyPath(absFileName())).absFileName();
4700 if (oldloc == newloc)
4702 // the location of the child file is incorrect.
4703 Alert::warning(_("Included File Invalid"),
4704 bformat(_("Saving this document to a new location has made the file:\n"
4706 "inaccessible. You will need to update the included filename."),
4707 from_utf8(oldloc)));
4709 inset_inc->setChildBuffer(0);
4711 // invalidate cache of children
4712 d->children_positions.clear();
4713 d->position_to_children.clear();
4717 // If a child has been saved under a different name/path, it might have been
4718 // orphaned. Therefore the master needs to be reset (bug 8161).
4719 void Buffer::checkMasterBuffer()
4721 Buffer const * const master = masterBuffer();
4725 // necessary to re-register the child (bug 5873)
4726 // FIXME: clean up updateMacros (here, only
4727 // child registering is needed).
4728 master->updateMacros();
4729 // (re)set master as master buffer, but only
4730 // if we are a real child
4731 if (master->isChild(this))