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 "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
49 #include "output_docbook.h"
51 #include "output_latex.h"
52 #include "output_xhtml.h"
53 #include "output_plaintext.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
58 #include "SpellChecker.h"
61 #include "TexStream.h"
63 #include "TextClass.h"
64 #include "TocBackend.h"
66 #include "VCBackend.h"
68 #include "WordLangTuple.h"
71 #include "insets/InsetBibtex.h"
72 #include "insets/InsetBranch.h"
73 #include "insets/InsetInclude.h"
74 #include "insets/InsetTabular.h"
75 #include "insets/InsetText.h"
77 #include "mathed/InsetMathHull.h"
78 #include "mathed/MacroTable.h"
79 #include "mathed/MathMacroTemplate.h"
80 #include "mathed/MathSupport.h"
82 #include "graphics/PreviewLoader.h"
84 #include "frontends/alert.h"
85 #include "frontends/Delegates.h"
86 #include "frontends/WorkAreaManager.h"
88 #include "support/lassert.h"
89 #include "support/convert.h"
90 #include "support/debug.h"
91 #include "support/docstring_list.h"
92 #include "support/ExceptionMessage.h"
93 #include "support/FileName.h"
94 #include "support/FileNameList.h"
95 #include "support/filetools.h"
96 #include "support/ForkedCalls.h"
97 #include "support/gettext.h"
98 #include "support/gzstream.h"
99 #include "support/lstrings.h"
100 #include "support/lyxalgo.h"
101 #include "support/os.h"
102 #include "support/Package.h"
103 #include "support/PathChanger.h"
104 #include "support/Systemcall.h"
105 #include "support/TempFile.h"
106 #include "support/textutils.h"
107 #include "support/types.h"
109 #include "support/bind.h"
110 #include "support/shared_ptr.h"
121 using namespace lyx::support;
122 using namespace lyx::graphics;
126 namespace Alert = frontend::Alert;
127 namespace os = support::os;
131 int const LYX_FORMAT = LYX_FORMAT_LYX;
133 typedef map<string, bool> DepClean;
134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
136 void showPrintError(string const & name)
138 docstring str = bformat(_("Could not print the document %1$s.\n"
139 "Check that your printer is set up correctly."),
140 makeDisplayPath(name, 50));
141 Alert::error(_("Print document failed"), str);
147 // A storehouse for the cloned buffers.
148 list<CloneList *> cloned_buffers;
154 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
158 delete preview_loader_;
166 /// search for macro in local (buffer) table or in children
167 MacroData const * getBufferMacro(docstring const & name,
168 DocIterator const & pos) const;
170 /// Update macro table starting with position of it \param it in some
172 void updateMacros(DocIterator & it, DocIterator & scope);
174 void setLabel(ParIterator & it, UpdateType utype) const;
176 /** If we have branches that use the file suffix
177 feature, return the file name with suffix appended.
179 support::FileName exportFileName() const;
186 mutable TexRow texrow;
188 /// need to regenerate .tex?
192 mutable bool lyx_clean;
194 /// is autosave needed?
195 mutable bool bak_clean;
197 /// is this an unnamed file (New...)?
200 /// is this an internal bufffer?
201 bool internal_buffer;
206 /// name of the file the buffer is associated with.
209 /** Set to true only when the file is fully loaded.
210 * Used to prevent the premature generation of previews
211 * and by the citation inset.
213 bool file_fully_loaded;
215 /// Ignore the parent (e.g. when exporting a child standalone)?
219 mutable TocBackend toc_backend;
222 typedef pair<DocIterator, MacroData> ScopeMacro;
223 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
224 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
225 /// map from the macro name to the position map,
226 /// which maps the macro definition position to the scope and the MacroData.
227 NamePositionScopeMacroMap macros;
228 /// This seem to change the way Buffer::getMacro() works
229 mutable bool macro_lock;
231 /// positions of child buffers in the buffer
232 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
233 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
234 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
235 /// position of children buffers in this buffer
236 BufferPositionMap children_positions;
237 /// map from children inclusion positions to their scope and their buffer
238 PositionScopeBufferMap position_to_children;
240 /// Container for all sort of Buffer dependant errors.
241 map<string, ErrorList> errorLists;
243 /// timestamp and checksum used to test if the file has been externally
244 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
246 unsigned long checksum_;
249 frontend::WorkAreaManager * wa_;
251 frontend::GuiBufferDelegate * gui_;
256 /// A cache for the bibfiles (including bibfiles of loaded child
257 /// documents), needed for appropriate update of natbib labels.
258 mutable support::FileNameList bibfiles_cache_;
260 // FIXME The caching mechanism could be improved. At present, we have a
261 // cache for each Buffer, that caches all the bibliography info for that
262 // Buffer. A more efficient solution would be to have a global cache per
263 // file, and then to construct the Buffer's bibinfo from that.
264 /// A cache for bibliography info
265 mutable BiblioInfo bibinfo_;
266 /// whether the bibinfo cache is valid
267 mutable bool bibinfo_cache_valid_;
268 /// whether the bibfile cache is valid
269 mutable bool bibfile_cache_valid_;
270 /// Cache of timestamps of .bib files
271 map<FileName, time_t> bibfile_status_;
272 /// Indicates whether the bibinfo has changed since the last time
273 /// we ran updateBuffer(), i.e., whether citation labels may need
275 mutable bool cite_labels_valid_;
277 mutable RefCache ref_cache_;
279 /// our Text that should be wrapped in an InsetText
283 PreviewLoader * preview_loader_;
285 /// This is here to force the test to be done whenever parent_buffer
287 Buffer const * parent() const
289 // ignore_parent temporarily "orphans" a buffer
290 // (e.g. if a child is compiled standalone)
293 // if parent_buffer is not loaded, then it has been unloaded,
294 // which means that parent_buffer is an invalid pointer. So we
295 // set it to null in that case.
296 // however, the BufferList doesn't know about cloned buffers, so
297 // they will always be regarded as unloaded. in that case, we hope
299 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
301 return parent_buffer;
305 void setParent(Buffer const * pb)
307 if (parent_buffer == pb)
310 if (!cloned_buffer_ && parent_buffer && pb)
311 LYXERR0("Warning: a buffer should not have two parents!");
313 if (!cloned_buffer_ && parent_buffer) {
314 parent_buffer->invalidateBibfileCache();
315 parent_buffer->invalidateBibinfoCache();
319 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
320 /// This one is useful for preview detached in a thread.
321 Buffer const * cloned_buffer_;
323 CloneList * clone_list_;
324 /// are we in the process of exporting this buffer?
325 mutable bool doing_export;
327 /// compute statistics
328 /// \p from initial position
329 /// \p to points to the end position
330 void updateStatistics(DocIterator & from, DocIterator & to,
331 bool skipNoOutput = true);
332 /// statistics accessor functions
333 int wordCount() const
337 int charCount(bool with_blanks) const
340 + (with_blanks ? blank_count_ : 0);
344 /// So we can force access via the accessors.
345 mutable Buffer const * parent_buffer;
354 /// Creates the per buffer temporary directory
355 static FileName createBufferTmpDir()
358 // We are in our own directory. Why bother to mangle name?
359 // In fact I wrote this code to circumvent a problematic behaviour
360 // (bug?) of EMX mkstemp().
361 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
362 convert<string>(count++));
364 if (!tmpfl.createDirectory(0777)) {
365 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
366 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
367 from_utf8(tmpfl.absFileName())));
373 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
374 Buffer const * cloned_buffer)
375 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
376 internal_buffer(false), read_only(readonly_), filename(file),
377 file_fully_loaded(false), ignore_parent(false), toc_backend(owner),
378 macro_lock(false), timestamp_(0), checksum_(0), wa_(0), gui_(0),
379 undo_(*owner), bibinfo_cache_valid_(false), bibfile_cache_valid_(false),
380 cite_labels_valid_(false), preview_loader_(0),
381 cloned_buffer_(cloned_buffer), clone_list_(0),
382 doing_export(false), parent_buffer(0)
384 if (!cloned_buffer_) {
385 temppath = createBufferTmpDir();
386 lyxvc.setBuffer(owner_);
388 wa_ = new frontend::WorkAreaManager;
391 temppath = cloned_buffer_->d->temppath;
392 file_fully_loaded = true;
393 params = cloned_buffer_->d->params;
394 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
395 bibinfo_ = cloned_buffer_->d->bibinfo_;
396 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
397 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
398 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
399 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
400 unnamed = cloned_buffer_->d->unnamed;
401 internal_buffer = cloned_buffer_->d->internal_buffer;
405 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
406 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
408 LYXERR(Debug::INFO, "Buffer::Buffer()");
410 d->inset = new InsetText(*cloned_buffer->d->inset);
411 d->inset->setBuffer(*this);
412 // FIXME: optimize this loop somewhat, maybe by creating a new
413 // general recursive Inset::setId().
414 DocIterator it = doc_iterator_begin(this);
415 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
416 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
417 it.paragraph().setId(cloned_it.paragraph().id());
419 d->inset = new InsetText(this);
420 d->inset->setAutoBreakRows(true);
421 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
427 LYXERR(Debug::INFO, "Buffer::~Buffer()");
428 // here the buffer should take care that it is
429 // saved properly, before it goes into the void.
431 // GuiView already destroyed
435 // No need to do additional cleanups for internal buffer.
441 // this is in case of recursive includes: we won't try to delete
442 // ourselves as a child.
443 d->clone_list_->erase(this);
444 // loop over children
445 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
446 Impl::BufferPositionMap::iterator end = d->children_positions.end();
447 for (; it != end; ++it) {
448 Buffer * child = const_cast<Buffer *>(it->first);
449 if (d->clone_list_->erase(child))
452 // if we're the master buffer, then we should get rid of the list
455 // If this is not empty, we have leaked something. Worse, one of the
456 // children still has a reference to this list. But we will try to
457 // continue, rather than shut down.
458 LATTEST(d->clone_list_->empty());
459 list<CloneList *>::iterator it =
460 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
461 if (it == cloned_buffers.end()) {
462 // We will leak in this case, but it is safe to continue.
465 cloned_buffers.erase(it);
466 delete d->clone_list_;
468 // FIXME Do we really need to do this right before we delete d?
469 // clear references to children in macro tables
470 d->children_positions.clear();
471 d->position_to_children.clear();
473 // loop over children
474 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
475 Impl::BufferPositionMap::iterator end = d->children_positions.end();
476 for (; it != end; ++it) {
477 Buffer * child = const_cast<Buffer *>(it->first);
478 if (theBufferList().isLoaded(child))
479 theBufferList().releaseChild(this, child);
483 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
484 msg += emergencyWrite();
485 Alert::warning(_("Attempting to close changed document!"), msg);
488 // FIXME Do we really need to do this right before we delete d?
489 // clear references to children in macro tables
490 d->children_positions.clear();
491 d->position_to_children.clear();
493 if (!d->temppath.destroyDirectory()) {
494 Alert::warning(_("Could not remove temporary directory"),
495 bformat(_("Could not remove the temporary directory %1$s"),
496 from_utf8(d->temppath.absFileName())));
505 Buffer * Buffer::cloneFromMaster() const
508 cloned_buffers.push_back(new CloneList);
509 CloneList * clones = cloned_buffers.back();
511 masterBuffer()->cloneWithChildren(bufmap, clones);
513 // make sure we got cloned
514 BufferMap::const_iterator bit = bufmap.find(this);
515 LASSERT(bit != bufmap.end(), return 0);
516 Buffer * cloned_buffer = bit->second;
518 return cloned_buffer;
522 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
524 // have we already been cloned?
525 if (bufmap.find(this) != bufmap.end())
528 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
530 // The clone needs its own DocumentClass, since running updateBuffer() will
531 // modify it, and we would otherwise be sharing it with the original Buffer.
532 buffer_clone->params().makeDocumentClass();
534 cap::switchBetweenClasses(
535 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
536 static_cast<InsetText &>(buffer_clone->inset()), el);
538 bufmap[this] = buffer_clone;
539 clones->insert(buffer_clone);
540 buffer_clone->d->clone_list_ = clones;
541 buffer_clone->d->macro_lock = true;
542 buffer_clone->d->children_positions.clear();
544 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
545 // math macro caches need to be rethought and simplified.
546 // I am not sure wether we should handle Buffer cloning here or in BufferList.
547 // Right now BufferList knows nothing about buffer clones.
548 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
549 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
550 for (; it != end; ++it) {
551 DocIterator dit = it->first.clone(buffer_clone);
552 dit.setBuffer(buffer_clone);
553 Buffer * child = const_cast<Buffer *>(it->second.second);
555 child->cloneWithChildren(bufmap, clones);
556 BufferMap::iterator const bit = bufmap.find(child);
557 LASSERT(bit != bufmap.end(), continue);
558 Buffer * child_clone = bit->second;
560 Inset * inset = dit.nextInset();
561 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
562 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
563 inset_inc->setChildBuffer(child_clone);
564 child_clone->d->setParent(buffer_clone);
565 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
566 buffer_clone->setChild(dit, child_clone);
568 buffer_clone->d->macro_lock = false;
573 Buffer * Buffer::cloneBufferOnly() const {
574 cloned_buffers.push_back(new CloneList);
575 CloneList * clones = cloned_buffers.back();
576 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
578 // The clone needs its own DocumentClass, since running updateBuffer() will
579 // modify it, and we would otherwise be sharing it with the original Buffer.
580 buffer_clone->params().makeDocumentClass();
582 cap::switchBetweenClasses(
583 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
584 static_cast<InsetText &>(buffer_clone->inset()), el);
586 clones->insert(buffer_clone);
587 buffer_clone->d->clone_list_ = clones;
589 // we won't be cloning the children
590 buffer_clone->d->children_positions.clear();
595 bool Buffer::isClone() const
597 return d->cloned_buffer_;
601 void Buffer::changed(bool update_metrics) const
604 d->wa_->redrawAll(update_metrics);
608 frontend::WorkAreaManager & Buffer::workAreaManager() const
615 Text & Buffer::text() const
617 return d->inset->text();
621 Inset & Buffer::inset() const
627 BufferParams & Buffer::params()
633 BufferParams const & Buffer::params() const
639 ParagraphList & Buffer::paragraphs()
641 return text().paragraphs();
645 ParagraphList const & Buffer::paragraphs() const
647 return text().paragraphs();
651 LyXVC & Buffer::lyxvc()
657 LyXVC const & Buffer::lyxvc() const
663 string const Buffer::temppath() const
665 return d->temppath.absFileName();
669 TexRow & Buffer::texrow()
675 TexRow const & Buffer::texrow() const
681 TocBackend & Buffer::tocBackend() const
683 return d->toc_backend;
687 Undo & Buffer::undo()
693 void Buffer::setChild(DocIterator const & dit, Buffer * child)
695 d->children_positions[child] = dit;
699 string Buffer::latexName(bool const no_path) const
701 FileName latex_name =
702 makeLatexName(d->exportFileName());
703 return no_path ? latex_name.onlyFileName()
704 : latex_name.absFileName();
708 FileName Buffer::Impl::exportFileName() const
710 docstring const branch_suffix =
711 params.branchlist().getFileNameSuffix();
712 if (branch_suffix.empty())
715 string const name = filename.onlyFileNameWithoutExt()
716 + to_utf8(branch_suffix);
717 FileName res(filename.onlyPath().absFileName() + "/" + name);
718 res.changeExtension(filename.extension());
724 string Buffer::logName(LogType * type) const
726 string const filename = latexName(false);
728 if (filename.empty()) {
734 string const path = temppath();
736 FileName const fname(addName(temppath(),
737 onlyFileName(changeExtension(filename,
740 // FIXME: how do we know this is the name of the build log?
741 FileName const bname(
742 addName(path, onlyFileName(
743 changeExtension(filename,
744 formats.extension(params().bufferFormat()) + ".out"))));
746 // Also consider the master buffer log file
747 FileName masterfname = fname;
749 if (masterBuffer() != this) {
750 string const mlogfile = masterBuffer()->logName(&mtype);
751 masterfname = FileName(mlogfile);
754 // If no Latex log or Build log is newer, show Build log
755 if (bname.exists() &&
756 ((!fname.exists() && !masterfname.exists())
757 || (fname.lastModified() < bname.lastModified()
758 && masterfname.lastModified() < bname.lastModified()))) {
759 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
762 return bname.absFileName();
763 // If we have a newer master file log or only a master log, show this
764 } else if (fname != masterfname
765 && (!fname.exists() && (masterfname.exists()
766 || fname.lastModified() < masterfname.lastModified()))) {
767 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
770 return masterfname.absFileName();
772 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
775 return fname.absFileName();
779 void Buffer::setReadonly(bool const flag)
781 if (d->read_only != flag) {
788 void Buffer::setFileName(FileName const & fname)
790 bool const changed = fname != d->filename;
793 lyxvc().file_found_hook(fname);
794 setReadonly(d->filename.isReadOnly());
800 int Buffer::readHeader(Lexer & lex)
802 int unknown_tokens = 0;
804 int begin_header_line = -1;
806 // Initialize parameters that may be/go lacking in header:
807 params().branchlist().clear();
808 params().preamble.erase();
809 params().options.erase();
810 params().master.erase();
811 params().float_placement.erase();
812 params().paperwidth.erase();
813 params().paperheight.erase();
814 params().leftmargin.erase();
815 params().rightmargin.erase();
816 params().topmargin.erase();
817 params().bottommargin.erase();
818 params().headheight.erase();
819 params().headsep.erase();
820 params().footskip.erase();
821 params().columnsep.erase();
822 params().fonts_cjk.erase();
823 params().listings_params.clear();
824 params().clearLayoutModules();
825 params().clearRemovedModules();
826 params().clearIncludedChildren();
827 params().pdfoptions().clear();
828 params().indiceslist().clear();
829 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
830 params().isbackgroundcolor = false;
831 params().fontcolor = RGBColor(0, 0, 0);
832 params().isfontcolor = false;
833 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
834 params().boxbgcolor = RGBColor(0xFF, 0, 0);
835 params().html_latex_start.clear();
836 params().html_latex_end.clear();
837 params().html_math_img_scale = 1.0;
838 params().output_sync_macro.erase();
839 params().setLocalLayout(string(), false);
840 params().setLocalLayout(string(), true);
842 for (int i = 0; i < 4; ++i) {
843 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
844 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
847 ErrorList & errorList = d->errorLists["Parse"];
856 if (token == "\\end_header")
860 if (token == "\\begin_header") {
861 begin_header_line = line;
865 LYXERR(Debug::PARSER, "Handling document header token: `"
868 string unknown = params().readToken(lex, token, d->filename.onlyPath());
869 if (!unknown.empty()) {
870 if (unknown[0] != '\\' && token == "\\textclass") {
871 Alert::warning(_("Unknown document class"),
872 bformat(_("Using the default document class, because the "
873 "class %1$s is unknown."), from_utf8(unknown)));
876 docstring const s = bformat(_("Unknown token: "
880 errorList.push_back(ErrorItem(_("Document header error"),
885 if (begin_header_line) {
886 docstring const s = _("\\begin_header is missing");
887 errorList.push_back(ErrorItem(_("Document header error"),
891 params().makeDocumentClass();
893 return unknown_tokens;
898 // changed to be public and have one parameter
899 // Returns true if "\end_document" is not read (Asger)
900 bool Buffer::readDocument(Lexer & lex)
902 ErrorList & errorList = d->errorLists["Parse"];
905 // remove dummy empty par
906 paragraphs().clear();
908 if (!lex.checkFor("\\begin_document")) {
909 docstring const s = _("\\begin_document is missing");
910 errorList.push_back(ErrorItem(_("Document header error"),
916 if (params().outputChanges) {
917 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
918 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
919 LaTeXFeatures::isAvailable("xcolor");
921 if (!dvipost && !xcolorulem) {
922 Alert::warning(_("Changes not shown in LaTeX output"),
923 _("Changes will not be highlighted in LaTeX output, "
924 "because neither dvipost nor xcolor/ulem are installed.\n"
925 "Please install these packages or redefine "
926 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
927 } else if (!xcolorulem) {
928 Alert::warning(_("Changes not shown in LaTeX output"),
929 _("Changes will not be highlighted in LaTeX output "
930 "when using pdflatex, because xcolor and ulem are not installed.\n"
931 "Please install both packages or redefine "
932 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
936 if (!params().master.empty()) {
937 FileName const master_file = makeAbsPath(params().master,
938 onlyPath(absFileName()));
939 if (isLyXFileName(master_file.absFileName())) {
941 checkAndLoadLyXFile(master_file, true);
943 // necessary e.g. after a reload
944 // to re-register the child (bug 5873)
945 // FIXME: clean up updateMacros (here, only
946 // child registering is needed).
947 master->updateMacros();
948 // set master as master buffer, but only
949 // if we are a real child
950 if (master->isChild(this))
952 // if the master is not fully loaded
953 // it is probably just loading this
954 // child. No warning needed then.
955 else if (master->isFullyLoaded())
956 LYXERR0("The master '"
958 << "' assigned to this document ("
960 << ") does not include "
961 "this document. Ignoring the master assignment.");
966 // assure we have a default index
967 params().indiceslist().addDefault(B_("Index"));
970 bool const res = text().read(lex, errorList, d->inset);
972 // inform parent buffer about local macros
974 Buffer const * pbuf = parent();
975 UserMacroSet::const_iterator cit = usermacros.begin();
976 UserMacroSet::const_iterator end = usermacros.end();
977 for (; cit != end; ++cit)
978 pbuf->usermacros.insert(*cit);
982 updateMacroInstances(InternalUpdate);
987 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
989 Format const * fmt = formats.getFormat(format);
992 // It is important to use the correct extension here, since some
993 // converters create a wrong output file otherwise (e.g. html2latex)
994 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
995 FileName const name(tempfile.name());
996 ofdocstream os(name.toFilesystemEncoding().c_str());
997 bool const success = (os << contents);
1000 bool converted = false;
1002 params().compressed = false;
1004 // remove dummy empty par
1005 paragraphs().clear();
1007 converted = importFile(format, name, errorList);
1016 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1018 if (!theConverters().isReachable(format, "lyx"))
1021 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1022 FileName const lyx(tempfile.name());
1023 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1024 return readFile(lyx) == ReadSuccess;
1030 bool Buffer::readString(string const & s)
1032 params().compressed = false;
1035 istringstream is(s);
1037 FileName const fn = FileName::tempName("Buffer_readString");
1040 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1042 if (success && file_format != LYX_FORMAT) {
1043 // We need to call lyx2lyx, so write the input to a file
1044 ofstream os(fn.toFilesystemEncoding().c_str());
1047 // lyxvc in readFile
1048 if (readFile(fn) != ReadSuccess)
1052 if (readDocument(lex))
1060 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1064 if (!lex.setFile(fname)) {
1065 Alert::error(_("File Not Found"),
1066 bformat(_("Unable to open file `%1$s'."),
1067 from_utf8(fn.absFileName())));
1068 return ReadFileNotFound;
1072 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1073 if (ret_plf != ReadSuccess)
1076 if (file_format != LYX_FORMAT) {
1078 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1079 if (ret_clf != ReadSuccess)
1081 return readFile(tmpFile);
1084 // FIXME: InsetInfo needs to know whether the file is under VCS
1085 // during the parse process, so this has to be done before.
1086 lyxvc().file_found_hook(d->filename);
1088 if (readDocument(lex)) {
1089 Alert::error(_("Document format failure"),
1090 bformat(_("%1$s ended unexpectedly, which means"
1091 " that it is probably corrupted."),
1092 from_utf8(fn.absFileName())));
1093 return ReadDocumentFailure;
1096 d->file_fully_loaded = true;
1097 d->read_only = !d->filename.isWritable();
1098 params().compressed = formats.isZippedFile(d->filename);
1104 bool Buffer::isFullyLoaded() const
1106 return d->file_fully_loaded;
1110 void Buffer::setFullyLoaded(bool value)
1112 d->file_fully_loaded = value;
1116 PreviewLoader * Buffer::loader() const
1118 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1120 if (!d->preview_loader_)
1121 d->preview_loader_ = new PreviewLoader(*this);
1122 return d->preview_loader_;
1126 void Buffer::removePreviews() const
1128 delete d->preview_loader_;
1129 d->preview_loader_ = 0;
1133 void Buffer::updatePreviews() const
1135 PreviewLoader * ploader = loader();
1139 InsetIterator it = inset_iterator_begin(*d->inset);
1140 InsetIterator const end = inset_iterator_end(*d->inset);
1141 for (; it != end; ++it)
1142 it->addPreview(it, *ploader);
1144 ploader->startLoading();
1148 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1149 FileName const & fn, int & file_format) const
1151 if(!lex.checkFor("\\lyxformat")) {
1152 Alert::error(_("Document format failure"),
1153 bformat(_("%1$s is not a readable LyX document."),
1154 from_utf8(fn.absFileName())));
1155 return ReadNoLyXFormat;
1161 // LyX formats 217 and earlier were written as 2.17. This corresponds
1162 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1163 // these cases. See also: www.lyx.org/trac/changeset/1313.
1164 size_t dot = tmp_format.find_first_of(".,");
1165 if (dot != string::npos)
1166 tmp_format.erase(dot, 1);
1168 file_format = convert<int>(tmp_format);
1173 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1174 FileName & tmpfile, int from_format)
1176 tmpfile = FileName::tempName("Buffer_convertLyXFormatXXXXXX.lyx");
1177 if(tmpfile.empty()) {
1178 Alert::error(_("Conversion failed"),
1179 bformat(_("%1$s is from a different"
1180 " version of LyX, but a temporary"
1181 " file for converting it could"
1182 " not be created."),
1183 from_utf8(fn.absFileName())));
1184 return LyX2LyXNoTempFile;
1187 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1188 if (lyx2lyx.empty()) {
1189 Alert::error(_("Conversion script not found"),
1190 bformat(_("%1$s is from a different"
1191 " version of LyX, but the"
1192 " conversion script lyx2lyx"
1193 " could not be found."),
1194 from_utf8(fn.absFileName())));
1195 return LyX2LyXNotFound;
1199 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1200 ostringstream command;
1201 command << os::python()
1202 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1203 << " -t " << convert<string>(LYX_FORMAT)
1204 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1205 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1206 string const command_str = command.str();
1208 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1210 cmd_ret const ret = runCommand(command_str);
1211 if (ret.first != 0) {
1212 if (from_format < LYX_FORMAT) {
1213 Alert::error(_("Conversion script failed"),
1214 bformat(_("%1$s is from an older version"
1215 " of LyX and the lyx2lyx script"
1216 " failed to convert it."),
1217 from_utf8(fn.absFileName())));
1218 return LyX2LyXOlderFormat;
1220 Alert::error(_("Conversion script failed"),
1221 bformat(_("%1$s is from a newer version"
1222 " of LyX and the lyx2lyx script"
1223 " failed to convert it."),
1224 from_utf8(fn.absFileName())));
1225 return LyX2LyXNewerFormat;
1232 // Should probably be moved to somewhere else: BufferView? GuiView?
1233 bool Buffer::save() const
1235 docstring const file = makeDisplayPath(absFileName(), 20);
1236 d->filename.refresh();
1238 // check the read-only status before moving the file as a backup
1239 if (d->filename.exists()) {
1240 bool const read_only = !d->filename.isWritable();
1242 Alert::warning(_("File is read-only"),
1243 bformat(_("The file %1$s cannot be written because it "
1244 "is marked as read-only."), file));
1249 // ask if the disk file has been externally modified (use checksum method)
1250 if (fileName().exists() && isExternallyModified(checksum_method)) {
1252 bformat(_("Document %1$s has been externally modified. "
1253 "Are you sure you want to overwrite this file?"), file);
1254 int const ret = Alert::prompt(_("Overwrite modified file?"),
1255 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1260 // We don't need autosaves in the immediate future. (Asger)
1261 resetAutosaveTimers();
1263 FileName backupName;
1264 bool madeBackup = false;
1266 // make a backup if the file already exists
1267 if (lyxrc.make_backup && fileName().exists()) {
1268 backupName = FileName(absFileName() + '~');
1269 if (!lyxrc.backupdir_path.empty()) {
1270 string const mangledName =
1271 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1272 backupName = FileName(addName(lyxrc.backupdir_path,
1276 // Except file is symlink do not copy because of #6587.
1277 // Hard links have bad luck.
1278 if (fileName().isSymLink())
1279 madeBackup = fileName().copyTo(backupName);
1281 madeBackup = fileName().moveTo(backupName);
1284 Alert::error(_("Backup failure"),
1285 bformat(_("Cannot create backup file %1$s.\n"
1286 "Please check whether the directory exists and is writable."),
1287 from_utf8(backupName.absFileName())));
1288 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1292 if (writeFile(d->filename)) {
1296 // Saving failed, so backup is not backup
1298 backupName.moveTo(d->filename);
1304 bool Buffer::writeFile(FileName const & fname) const
1306 if (d->read_only && fname == d->filename)
1309 bool retval = false;
1311 docstring const str = bformat(_("Saving document %1$s..."),
1312 makeDisplayPath(fname.absFileName()));
1315 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1317 if (params().compressed) {
1318 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1319 retval = ofs && write(ofs);
1321 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1322 retval = ofs && write(ofs);
1326 message(str + _(" could not write file!"));
1331 // removeAutosaveFile();
1334 message(str + _(" done."));
1340 docstring Buffer::emergencyWrite()
1342 // No need to save if the buffer has not changed.
1346 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1348 docstring user_message = bformat(
1349 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1351 // We try to save three places:
1352 // 1) Same place as document. Unless it is an unnamed doc.
1354 string s = absFileName();
1357 if (writeFile(FileName(s))) {
1359 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1360 return user_message;
1362 user_message += " " + _("Save failed! Trying again...\n");
1366 // 2) In HOME directory.
1367 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1369 lyxerr << ' ' << s << endl;
1370 if (writeFile(FileName(s))) {
1372 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1373 return user_message;
1376 user_message += " " + _("Save failed! Trying yet again...\n");
1378 // 3) In "/tmp" directory.
1379 // MakeAbsPath to prepend the current
1380 // drive letter on OS/2
1381 s = addName(package().temp_dir().absFileName(), absFileName());
1383 lyxerr << ' ' << s << endl;
1384 if (writeFile(FileName(s))) {
1386 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1387 return user_message;
1390 user_message += " " + _("Save failed! Bummer. Document is lost.");
1393 return user_message;
1397 bool Buffer::write(ostream & ofs) const
1400 // Use the standard "C" locale for file output.
1401 ofs.imbue(locale::classic());
1404 // The top of the file should not be written by params().
1406 // write out a comment in the top of the file
1407 // Important: Keep the version formatting in sync with lyx2lyx and
1408 // tex2lyx (bug 7951)
1409 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1410 << " created this file. For more info see http://www.lyx.org/\n"
1411 << "\\lyxformat " << LYX_FORMAT << "\n"
1412 << "\\begin_document\n";
1414 /// For each author, set 'used' to true if there is a change
1415 /// by this author in the document; otherwise set it to 'false'.
1416 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1417 AuthorList::Authors::const_iterator a_end = params().authors().end();
1418 for (; a_it != a_end; ++a_it)
1419 a_it->setUsed(false);
1421 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1422 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1423 for ( ; it != end; ++it)
1424 it->checkAuthors(params().authors());
1426 // now write out the buffer parameters.
1427 ofs << "\\begin_header\n";
1428 params().writeFile(ofs);
1429 ofs << "\\end_header\n";
1432 ofs << "\n\\begin_body\n";
1434 ofs << "\n\\end_body\n";
1436 // Write marker that shows file is complete
1437 ofs << "\\end_document" << endl;
1439 // Shouldn't really be needed....
1442 // how to check if close went ok?
1443 // Following is an attempt... (BE 20001011)
1445 // good() returns false if any error occured, including some
1446 // formatting error.
1447 // bad() returns true if something bad happened in the buffer,
1448 // which should include file system full errors.
1453 lyxerr << "File was not closed properly." << endl;
1460 bool Buffer::makeLaTeXFile(FileName const & fname,
1461 string const & original_path,
1462 OutputParams const & runparams_in,
1463 OutputWhat output) const
1465 OutputParams runparams = runparams_in;
1467 // This is necessary for LuaTeX/XeTeX with tex fonts.
1468 // See FIXME in BufferParams::encoding()
1469 if (runparams.isFullUnicode())
1470 runparams.encoding = encodings.fromLyXName("utf8-plain");
1472 string const encoding = runparams.encoding->iconvName();
1473 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1476 try { ofs.reset(encoding); }
1477 catch (iconv_codecvt_facet_exception const & e) {
1478 lyxerr << "Caught iconv exception: " << e.what() << endl;
1479 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1480 "verify that the support software for your encoding (%1$s) is "
1481 "properly installed"), from_ascii(encoding)));
1484 if (!openFileWrite(ofs, fname))
1487 //TexStream ts(ofs.rdbuf(), &texrow());
1488 ErrorList & errorList = d->errorLists["Export"];
1490 bool failed_export = false;
1491 otexstream os(ofs, d->texrow);
1493 // make sure we are ready to export
1494 // this needs to be done before we validate
1495 // FIXME Do we need to do this all the time? I.e., in children
1496 // of a master we are exporting?
1498 updateMacroInstances(OutputUpdate);
1501 os.texrow().reset();
1502 writeLaTeXSource(os, original_path, runparams, output);
1504 catch (EncodingException const & e) {
1505 odocstringstream ods;
1506 ods.put(e.failed_char);
1508 oss << "0x" << hex << e.failed_char << dec;
1509 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1510 " (code point %2$s)"),
1511 ods.str(), from_utf8(oss.str()));
1512 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1513 "representable in the chosen encoding.\n"
1514 "Changing the document encoding to utf8 could help."),
1515 e.par_id, e.pos, e.pos + 1));
1516 failed_export = true;
1518 catch (iconv_codecvt_facet_exception const & e) {
1519 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1520 _(e.what()), -1, 0, 0));
1521 failed_export = true;
1523 catch (exception const & e) {
1524 errorList.push_back(ErrorItem(_("conversion failed"),
1525 _(e.what()), -1, 0, 0));
1526 failed_export = true;
1529 lyxerr << "Caught some really weird exception..." << endl;
1535 failed_export = true;
1536 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1540 return !failed_export;
1544 void Buffer::writeLaTeXSource(otexstream & os,
1545 string const & original_path,
1546 OutputParams const & runparams_in,
1547 OutputWhat output) const
1549 // The child documents, if any, shall be already loaded at this point.
1551 OutputParams runparams = runparams_in;
1553 // If we are compiling a file standalone, even if this is the
1554 // child of some other buffer, let's cut the link here, so the
1555 // file is really independent and no concurring settings from
1556 // the master (e.g. branch state) interfere (see #8100).
1557 if (!runparams.is_child)
1558 d->ignore_parent = true;
1560 // Classify the unicode characters appearing in math insets
1561 Encodings::initUnicodeMath(*this);
1563 // validate the buffer.
1564 LYXERR(Debug::LATEX, " Validating buffer...");
1565 LaTeXFeatures features(*this, params(), runparams);
1567 runparams.use_polyglossia = features.usePolyglossia();
1568 LYXERR(Debug::LATEX, " Buffer validation done.");
1570 bool const output_preamble =
1571 output == FullSource || output == OnlyPreamble;
1572 bool const output_body =
1573 output == FullSource || output == OnlyBody;
1575 // The starting paragraph of the coming rows is the
1576 // first paragraph of the document. (Asger)
1577 if (output_preamble && runparams.nice) {
1578 os << "%% LyX " << lyx_version << " created this file. "
1579 "For more info, see http://www.lyx.org/.\n"
1580 "%% Do not edit unless you really know what "
1583 LYXERR(Debug::INFO, "lyx document header finished");
1585 // There are a few differences between nice LaTeX and usual files:
1586 // usual files have \batchmode and special input@path to allow
1587 // inclusion of figures specified by an explicitly relative path
1588 // (i.e., a path starting with './' or '../') with either \input or
1589 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1590 // input@path is set when the actual parameter original_path is set.
1591 // This is done for usual tex-file, but not for nice-latex-file.
1592 // (Matthias 250696)
1593 // Note that input@path is only needed for something the user does
1594 // in the preamble, included .tex files or ERT, files included by
1595 // LyX work without it.
1596 if (output_preamble) {
1597 if (!runparams.nice) {
1598 // code for usual, NOT nice-latex-file
1599 os << "\\batchmode\n"; // changed from \nonstopmode
1601 if (!original_path.empty()) {
1603 // We don't know the encoding of inputpath
1604 docstring const inputpath = from_utf8(original_path);
1605 docstring uncodable_glyphs;
1606 Encoding const * const enc = runparams.encoding;
1608 for (size_t n = 0; n < inputpath.size(); ++n) {
1609 if (!enc->encodable(inputpath[n])) {
1610 docstring const glyph(1, inputpath[n]);
1611 LYXERR0("Uncodable character '"
1613 << "' in input path!");
1614 uncodable_glyphs += glyph;
1619 // warn user if we found uncodable glyphs.
1620 if (!uncodable_glyphs.empty()) {
1621 frontend::Alert::warning(
1622 _("Uncodable character in file path"),
1624 _("The path of your document\n"
1626 "contains glyphs that are unknown "
1627 "in the current document encoding "
1628 "(namely %2$s). This may result in "
1629 "incomplete output, unless "
1630 "TEXINPUTS contains the document "
1631 "directory and you don't use "
1632 "explicitly relative paths (i.e., "
1633 "paths starting with './' or "
1634 "'../') in the preamble or in ERT."
1635 "\n\nIn case of problems, choose "
1636 "an appropriate document encoding\n"
1637 "(such as utf8) or change the "
1639 inputpath, uncodable_glyphs));
1642 support::latex_path(original_path);
1643 if (contains(docdir, '#')) {
1644 docdir = subst(docdir, "#", "\\#");
1645 os << "\\catcode`\\#=11"
1646 "\\def\\#{#}\\catcode`\\#=6\n";
1648 if (contains(docdir, '%')) {
1649 docdir = subst(docdir, "%", "\\%");
1650 os << "\\catcode`\\%=11"
1651 "\\def\\%{%}\\catcode`\\%=14\n";
1653 os << "\\makeatletter\n"
1654 << "\\def\\input@path{{"
1655 << docdir << "/}}\n"
1656 << "\\makeatother\n";
1660 // get parent macros (if this buffer has a parent) which will be
1661 // written at the document begin further down.
1662 MacroSet parentMacros;
1663 listParentMacros(parentMacros, features);
1665 // Write the preamble
1666 runparams.use_babel = params().writeLaTeX(os, features,
1667 d->filename.onlyPath());
1669 runparams.use_japanese = features.isRequired("japanese");
1672 // Restore the parenthood if needed
1673 if (!runparams.is_child)
1674 d->ignore_parent = false;
1679 os << "\\begin{document}\n";
1681 // output the parent macros
1682 MacroSet::iterator it = parentMacros.begin();
1683 MacroSet::iterator end = parentMacros.end();
1684 for (; it != end; ++it) {
1685 int num_lines = (*it)->write(os.os(), true);
1686 os.texrow().newlines(num_lines);
1689 } // output_preamble
1691 os.texrow().start(paragraphs().begin()->id(), 0);
1693 LYXERR(Debug::INFO, "preamble finished, now the body.");
1696 latexParagraphs(*this, text(), os, runparams);
1698 // Restore the parenthood if needed
1699 if (!runparams.is_child)
1700 d->ignore_parent = false;
1702 // add this just in case after all the paragraphs
1705 if (output_preamble) {
1706 os << "\\end{document}\n";
1707 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1709 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1711 runparams_in.encoding = runparams.encoding;
1713 // Just to be sure. (Asger)
1714 os.texrow().newline();
1716 //for (int i = 0; i<d->texrow.rows(); i++) {
1718 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1719 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1722 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1723 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1727 void Buffer::makeDocBookFile(FileName const & fname,
1728 OutputParams const & runparams,
1729 OutputWhat output) const
1731 LYXERR(Debug::LATEX, "makeDocBookFile...");
1734 if (!openFileWrite(ofs, fname))
1737 // make sure we are ready to export
1738 // this needs to be done before we validate
1740 updateMacroInstances(OutputUpdate);
1742 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1746 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1750 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1751 OutputParams const & runparams,
1752 OutputWhat output) const
1754 LaTeXFeatures features(*this, params(), runparams);
1759 DocumentClass const & tclass = params().documentClass();
1760 string const top_element = tclass.latexname();
1762 bool const output_preamble =
1763 output == FullSource || output == OnlyPreamble;
1764 bool const output_body =
1765 output == FullSource || output == OnlyBody;
1767 if (output_preamble) {
1768 if (runparams.flavor == OutputParams::XML)
1769 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1772 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1775 if (! tclass.class_header().empty())
1776 os << from_ascii(tclass.class_header());
1777 else if (runparams.flavor == OutputParams::XML)
1778 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1779 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1781 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1783 docstring preamble = from_utf8(params().preamble);
1784 if (runparams.flavor != OutputParams::XML ) {
1785 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1786 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1787 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1788 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1791 string const name = runparams.nice
1792 ? changeExtension(absFileName(), ".sgml") : fname;
1793 preamble += features.getIncludedFiles(name);
1794 preamble += features.getLyXSGMLEntities();
1796 if (!preamble.empty()) {
1797 os << "\n [ " << preamble << " ]";
1803 string top = top_element;
1805 if (runparams.flavor == OutputParams::XML)
1806 top += params().language->code();
1808 top += params().language->code().substr(0, 2);
1811 if (!params().options.empty()) {
1813 top += params().options;
1816 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1817 << " file was created by LyX " << lyx_version
1818 << "\n See http://www.lyx.org/ for more information -->\n";
1820 params().documentClass().counters().reset();
1822 sgml::openTag(os, top);
1824 docbookParagraphs(text(), *this, os, runparams);
1825 sgml::closeTag(os, top_element);
1830 void Buffer::makeLyXHTMLFile(FileName const & fname,
1831 OutputParams const & runparams) const
1833 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1836 if (!openFileWrite(ofs, fname))
1839 // make sure we are ready to export
1840 // this has to be done before we validate
1841 updateBuffer(UpdateMaster, OutputUpdate);
1842 updateMacroInstances(OutputUpdate);
1844 writeLyXHTMLSource(ofs, runparams, FullSource);
1848 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1852 void Buffer::writeLyXHTMLSource(odocstream & os,
1853 OutputParams const & runparams,
1854 OutputWhat output) const
1856 LaTeXFeatures features(*this, params(), runparams);
1858 d->bibinfo_.makeCitationLabels(*this);
1860 bool const output_preamble =
1861 output == FullSource || output == OnlyPreamble;
1862 bool const output_body =
1863 output == FullSource || output == OnlyBody || output == IncludedFile;
1865 if (output_preamble) {
1866 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1867 << "<!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"
1868 // FIXME Language should be set properly.
1869 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1871 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1872 // FIXME Presumably need to set this right
1873 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1875 docstring const & doctitle = features.htmlTitle();
1877 << (doctitle.empty() ?
1878 from_ascii("LyX Document") :
1879 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
1882 docstring styles = features.getTClassHTMLPreamble();
1883 if (!styles.empty())
1884 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
1886 styles = from_utf8(features.getPreambleSnippets());
1887 if (!styles.empty())
1888 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
1890 // we will collect CSS information in a stream, and then output it
1891 // either here, as part of the header, or else in a separate file.
1892 odocstringstream css;
1893 styles = from_utf8(features.getCSSSnippets());
1894 if (!styles.empty())
1895 css << "/* LyX Provided Styles */\n" << styles << '\n';
1897 styles = features.getTClassHTMLStyles();
1898 if (!styles.empty())
1899 css << "/* Layout-provided Styles */\n" << styles << '\n';
1901 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
1902 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
1903 if (needfg || needbg) {
1904 css << "\nbody {\n";
1907 << from_ascii(X11hexname(params().fontcolor))
1910 css << " background-color: "
1911 << from_ascii(X11hexname(params().backgroundcolor))
1916 docstring const dstyles = css.str();
1917 if (!dstyles.empty()) {
1918 bool written = false;
1919 if (params().html_css_as_file) {
1920 // open a file for CSS info
1922 string const fcssname = addName(temppath(), "docstyle.css");
1923 FileName const fcssfile = FileName(fcssname);
1924 if (openFileWrite(ocss, fcssfile)) {
1928 // write link to header
1929 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
1931 runparams.exportdata->addExternalFile("xhtml", fcssfile);
1934 // we are here if the CSS is supposed to be written to the header
1935 // or if we failed to write it to an external file.
1937 os << "<style type='text/css'>\n"
1946 bool const output_body_tag = (output != IncludedFile);
1947 if (output_body_tag)
1950 if (output != IncludedFile)
1951 // if we're an included file, the counters are in the master.
1952 params().documentClass().counters().reset();
1953 xhtmlParagraphs(text(), *this, xs, runparams);
1954 if (output_body_tag)
1958 if (output_preamble)
1963 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1964 // Other flags: -wall -v0 -x
1965 int Buffer::runChktex()
1969 // get LaTeX-Filename
1970 FileName const path(temppath());
1971 string const name = addName(path.absFileName(), latexName());
1972 string const org_path = filePath();
1974 PathChanger p(path); // path to LaTeX file
1975 message(_("Running chktex..."));
1977 // Generate the LaTeX file if neccessary
1978 OutputParams runparams(¶ms().encoding());
1979 runparams.flavor = OutputParams::LATEX;
1980 runparams.nice = false;
1981 runparams.linelen = lyxrc.plaintext_linelen;
1982 makeLaTeXFile(FileName(name), org_path, runparams);
1985 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
1986 int const res = chktex.run(terr); // run chktex
1989 Alert::error(_("chktex failure"),
1990 _("Could not run chktex successfully."));
1992 ErrorList & errlist = d->errorLists["ChkTeX"];
1994 bufferErrors(terr, errlist);
2005 void Buffer::validate(LaTeXFeatures & features) const
2007 // Validate the buffer params, but not for included
2008 // files, since they also use the parent buffer's
2010 if (!features.runparams().is_child)
2011 params().validate(features);
2013 for_each(paragraphs().begin(), paragraphs().end(),
2014 bind(&Paragraph::validate, _1, ref(features)));
2016 if (lyxerr.debugging(Debug::LATEX)) {
2017 features.showStruct();
2022 void Buffer::getLabelList(vector<docstring> & list) const
2024 // If this is a child document, use the master's list instead.
2026 masterBuffer()->getLabelList(list);
2031 Toc & toc = d->toc_backend.toc("label");
2032 TocIterator toc_it = toc.begin();
2033 TocIterator end = toc.end();
2034 for (; toc_it != end; ++toc_it) {
2035 if (toc_it->depth() == 0)
2036 list.push_back(toc_it->str());
2041 void Buffer::updateBibfilesCache(UpdateScope scope) const
2043 // FIXME This is probably unnecssary, given where we call this.
2044 // If this is a child document, use the parent's cache instead.
2045 if (parent() && scope != UpdateChildOnly) {
2046 masterBuffer()->updateBibfilesCache();
2050 d->bibfiles_cache_.clear();
2051 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2052 if (it->lyxCode() == BIBTEX_CODE) {
2053 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2054 support::FileNameList const bibfiles = inset.getBibFiles();
2055 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2058 } else if (it->lyxCode() == INCLUDE_CODE) {
2059 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2060 Buffer const * const incbuf = inset.getChildBuffer();
2063 support::FileNameList const & bibfiles =
2064 incbuf->getBibfilesCache(UpdateChildOnly);
2065 if (!bibfiles.empty()) {
2066 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2072 d->bibfile_cache_valid_ = true;
2073 d->bibinfo_cache_valid_ = false;
2074 d->cite_labels_valid_ = false;
2078 void Buffer::invalidateBibinfoCache() const
2080 d->bibinfo_cache_valid_ = false;
2081 d->cite_labels_valid_ = false;
2082 // also invalidate the cache for the parent buffer
2083 Buffer const * const pbuf = d->parent();
2085 pbuf->invalidateBibinfoCache();
2089 void Buffer::invalidateBibfileCache() const
2091 d->bibfile_cache_valid_ = false;
2092 d->bibinfo_cache_valid_ = false;
2093 d->cite_labels_valid_ = false;
2094 // also invalidate the cache for the parent buffer
2095 Buffer const * const pbuf = d->parent();
2097 pbuf->invalidateBibfileCache();
2101 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2103 // FIXME This is probably unnecessary, given where we call this.
2104 // If this is a child document, use the master's cache instead.
2105 Buffer const * const pbuf = masterBuffer();
2106 if (pbuf != this && scope != UpdateChildOnly)
2107 return pbuf->getBibfilesCache();
2109 if (!d->bibfile_cache_valid_)
2110 this->updateBibfilesCache(scope);
2112 return d->bibfiles_cache_;
2116 BiblioInfo const & Buffer::masterBibInfo() const
2118 Buffer const * const tmp = masterBuffer();
2120 return tmp->masterBibInfo();
2125 void Buffer::checkIfBibInfoCacheIsValid() const
2127 // use the master's cache
2128 Buffer const * const tmp = masterBuffer();
2130 tmp->checkIfBibInfoCacheIsValid();
2134 // compare the cached timestamps with the actual ones.
2135 FileNameList const & bibfiles_cache = getBibfilesCache();
2136 FileNameList::const_iterator ei = bibfiles_cache.begin();
2137 FileNameList::const_iterator en = bibfiles_cache.end();
2138 for (; ei != en; ++ ei) {
2139 time_t lastw = ei->lastModified();
2140 time_t prevw = d->bibfile_status_[*ei];
2141 if (lastw != prevw) {
2142 d->bibinfo_cache_valid_ = false;
2143 d->cite_labels_valid_ = false;
2144 d->bibfile_status_[*ei] = lastw;
2150 void Buffer::reloadBibInfoCache() const
2152 // use the master's cache
2153 Buffer const * const tmp = masterBuffer();
2155 tmp->reloadBibInfoCache();
2159 checkIfBibInfoCacheIsValid();
2160 if (d->bibinfo_cache_valid_)
2163 d->bibinfo_.clear();
2165 d->bibinfo_cache_valid_ = true;
2169 void Buffer::collectBibKeys() const
2171 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2172 it->collectBibKeys(it);
2176 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2178 Buffer const * tmp = masterBuffer();
2179 BiblioInfo & masterbi = (tmp == this) ?
2180 d->bibinfo_ : tmp->d->bibinfo_;
2181 masterbi.mergeBiblioInfo(bi);
2185 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2187 Buffer const * tmp = masterBuffer();
2188 BiblioInfo & masterbi = (tmp == this) ?
2189 d->bibinfo_ : tmp->d->bibinfo_;
2194 void Buffer::makeCitationLabels() const
2196 Buffer const * const master = masterBuffer();
2197 return d->bibinfo_.makeCitationLabels(*master);
2201 bool Buffer::citeLabelsValid() const
2203 return masterBuffer()->d->cite_labels_valid_;
2207 void Buffer::removeBiblioTempFiles() const
2209 // We remove files that contain LaTeX commands specific to the
2210 // particular bibliographic style being used, in order to avoid
2211 // LaTeX errors when we switch style.
2212 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2213 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2214 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2215 aux_file.removeFile();
2216 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2217 bbl_file.removeFile();
2218 // Also for the parent buffer
2219 Buffer const * const pbuf = parent();
2221 pbuf->removeBiblioTempFiles();
2225 bool Buffer::isDepClean(string const & name) const
2227 DepClean::const_iterator const it = d->dep_clean.find(name);
2228 if (it == d->dep_clean.end())
2234 void Buffer::markDepClean(string const & name)
2236 d->dep_clean[name] = true;
2240 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2243 // FIXME? if there is an Buffer LFUN that can be dispatched even
2244 // if internal, put a switch '(cmd.action)' here.
2250 switch (cmd.action()) {
2252 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2253 flag.setOnOff(isReadonly());
2256 // FIXME: There is need for a command-line import.
2257 //case LFUN_BUFFER_IMPORT:
2259 case LFUN_BUFFER_AUTO_SAVE:
2262 case LFUN_BUFFER_EXPORT_CUSTOM:
2263 // FIXME: Nothing to check here?
2266 case LFUN_BUFFER_EXPORT: {
2267 docstring const arg = cmd.argument();
2268 if (arg == "custom") {
2272 string format = to_utf8(arg);
2273 size_t pos = format.find(' ');
2274 if (pos != string::npos)
2275 format = format.substr(0, pos);
2276 enable = params().isExportable(format);
2278 flag.message(bformat(
2279 _("Don't know how to export to format: %1$s"), arg));
2283 case LFUN_BUFFER_CHKTEX:
2284 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2287 case LFUN_BUILD_PROGRAM:
2288 enable = params().isExportable("program");
2291 case LFUN_BRANCH_ACTIVATE:
2292 case LFUN_BRANCH_DEACTIVATE:
2293 case LFUN_BRANCH_MASTER_ACTIVATE:
2294 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2295 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2296 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2297 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2298 : params().branchlist();
2299 docstring const branchName = cmd.argument();
2300 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2304 case LFUN_BRANCH_ADD:
2305 case LFUN_BRANCHES_RENAME:
2306 case LFUN_BUFFER_PRINT:
2307 // if no Buffer is present, then of course we won't be called!
2310 case LFUN_BUFFER_LANGUAGE:
2311 enable = !isReadonly();
2317 flag.setEnabled(enable);
2322 void Buffer::dispatch(string const & command, DispatchResult & result)
2324 return dispatch(lyxaction.lookupFunc(command), result);
2328 // NOTE We can end up here even if we have no GUI, because we are called
2329 // by LyX::exec to handled command-line requests. So we may need to check
2330 // whether we have a GUI or not. The boolean use_gui holds this information.
2331 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2334 // FIXME? if there is an Buffer LFUN that can be dispatched even
2335 // if internal, put a switch '(cmd.action())' here.
2336 dr.dispatched(false);
2339 string const argument = to_utf8(func.argument());
2340 // We'll set this back to false if need be.
2341 bool dispatched = true;
2342 undo().beginUndoGroup();
2344 switch (func.action()) {
2345 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2346 if (lyxvc().inUse()) {
2347 string log = lyxvc().toggleReadOnly();
2352 setReadonly(!isReadonly());
2355 case LFUN_BUFFER_EXPORT: {
2356 ExportStatus const status = doExport(argument, false);
2357 dr.setError(status != ExportSuccess);
2358 if (status != ExportSuccess)
2359 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2364 case LFUN_BUILD_PROGRAM:
2365 doExport("program", true);
2368 case LFUN_BUFFER_CHKTEX:
2372 case LFUN_BUFFER_EXPORT_CUSTOM: {
2374 string command = split(argument, format_name, ' ');
2375 Format const * format = formats.getFormat(format_name);
2377 lyxerr << "Format \"" << format_name
2378 << "\" not recognized!"
2383 // The name of the file created by the conversion process
2386 // Output to filename
2387 if (format->name() == "lyx") {
2388 string const latexname = latexName(false);
2389 filename = changeExtension(latexname,
2390 format->extension());
2391 filename = addName(temppath(), filename);
2393 if (!writeFile(FileName(filename)))
2397 doExport(format_name, true, filename);
2400 // Substitute $$FName for filename
2401 if (!contains(command, "$$FName"))
2402 command = "( " + command + " ) < $$FName";
2403 command = subst(command, "$$FName", filename);
2405 // Execute the command in the background
2407 call.startscript(Systemcall::DontWait, command, filePath());
2411 // FIXME: There is need for a command-line import.
2413 case LFUN_BUFFER_IMPORT:
2418 case LFUN_BUFFER_AUTO_SAVE:
2420 resetAutosaveTimers();
2423 case LFUN_BRANCH_ACTIVATE:
2424 case LFUN_BRANCH_DEACTIVATE:
2425 case LFUN_BRANCH_MASTER_ACTIVATE:
2426 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2427 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2428 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2429 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2432 docstring const branch_name = func.argument();
2433 // the case without a branch name is handled elsewhere
2434 if (branch_name.empty()) {
2438 Branch * branch = buf->params().branchlist().find(branch_name);
2440 LYXERR0("Branch " << branch_name << " does not exist.");
2442 docstring const msg =
2443 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2447 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2448 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2449 if (branch->isSelected() != activate) {
2450 buf->undo().recordUndoFullDocument(CursorData());
2451 branch->setSelected(activate);
2453 dr.screenUpdate(Update::Force);
2454 dr.forceBufferUpdate();
2459 case LFUN_BRANCH_ADD: {
2460 docstring branch_name = func.argument();
2461 if (branch_name.empty()) {
2465 BranchList & branch_list = params().branchlist();
2466 vector<docstring> const branches =
2467 getVectorFromString(branch_name, branch_list.separator());
2469 for (vector<docstring>::const_iterator it = branches.begin();
2470 it != branches.end(); ++it) {
2472 Branch * branch = branch_list.find(branch_name);
2474 LYXERR0("Branch " << branch_name << " already exists.");
2478 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2480 branch_list.add(branch_name);
2481 branch = branch_list.find(branch_name);
2482 string const x11hexname = X11hexname(branch->color());
2483 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2484 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2486 dr.screenUpdate(Update::Force);
2494 case LFUN_BRANCHES_RENAME: {
2495 if (func.argument().empty())
2498 docstring const oldname = from_utf8(func.getArg(0));
2499 docstring const newname = from_utf8(func.getArg(1));
2500 InsetIterator it = inset_iterator_begin(inset());
2501 InsetIterator const end = inset_iterator_end(inset());
2502 bool success = false;
2503 for (; it != end; ++it) {
2504 if (it->lyxCode() == BRANCH_CODE) {
2505 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2506 if (ins.branch() == oldname) {
2507 undo().recordUndo(CursorData(it));
2508 ins.rename(newname);
2513 if (it->lyxCode() == INCLUDE_CODE) {
2514 // get buffer of external file
2515 InsetInclude const & ins =
2516 static_cast<InsetInclude const &>(*it);
2517 Buffer * child = ins.getChildBuffer();
2520 child->dispatch(func, dr);
2525 dr.screenUpdate(Update::Force);
2526 dr.forceBufferUpdate();
2531 case LFUN_BUFFER_PRINT: {
2532 // we'll assume there's a problem until we succeed
2534 string target = func.getArg(0);
2535 string target_name = func.getArg(1);
2536 string command = func.getArg(2);
2539 || target_name.empty()
2540 || command.empty()) {
2541 LYXERR0("Unable to parse " << func.argument());
2542 docstring const msg =
2543 bformat(_("Unable to parse \"%1$s\""), func.argument());
2547 if (target != "printer" && target != "file") {
2548 LYXERR0("Unrecognized target \"" << target << '"');
2549 docstring const msg =
2550 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
2555 if (!doExport("dvi", true)) {
2556 showPrintError(absFileName());
2557 dr.setMessage(_("Error exporting to DVI."));
2561 // Push directory path.
2562 string const path = temppath();
2563 // Prevent the compiler from optimizing away p
2567 // there are three cases here:
2568 // 1. we print to a file
2569 // 2. we print directly to a printer
2570 // 3. we print using a spool command (print to file first)
2573 string const dviname = changeExtension(latexName(true), "dvi");
2575 if (target == "printer") {
2576 if (!lyxrc.print_spool_command.empty()) {
2577 // case 3: print using a spool
2578 string const psname = changeExtension(dviname,".ps");
2579 command += ' ' + lyxrc.print_to_file
2582 + quoteName(dviname);
2584 string command2 = lyxrc.print_spool_command + ' ';
2585 if (target_name != "default") {
2586 command2 += lyxrc.print_spool_printerprefix
2590 command2 += quoteName(psname);
2592 // If successful, then spool command
2593 res = one.startscript(Systemcall::Wait, command,
2597 // If there's no GUI, we have to wait on this command. Otherwise,
2598 // LyX deletes the temporary directory, and with it the spooled
2599 // file, before it can be printed!!
2600 Systemcall::Starttype stype = use_gui ?
2601 Systemcall::DontWait : Systemcall::Wait;
2602 res = one.startscript(stype, command2,
2606 // case 2: print directly to a printer
2607 if (target_name != "default")
2608 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2610 Systemcall::Starttype stype = use_gui ?
2611 Systemcall::DontWait : Systemcall::Wait;
2612 res = one.startscript(stype, command +
2613 quoteName(dviname), filePath());
2617 // case 1: print to a file
2618 FileName const filename(makeAbsPath(target_name, filePath()));
2619 FileName const dvifile(makeAbsPath(dviname, path));
2620 if (filename.exists()) {
2621 docstring text = bformat(
2622 _("The file %1$s already exists.\n\n"
2623 "Do you want to overwrite that file?"),
2624 makeDisplayPath(filename.absFileName()));
2625 if (Alert::prompt(_("Overwrite file?"),
2626 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2629 command += ' ' + lyxrc.print_to_file
2630 + quoteName(filename.toFilesystemEncoding())
2632 + quoteName(dvifile.toFilesystemEncoding());
2634 Systemcall::Starttype stype = use_gui ?
2635 Systemcall::DontWait : Systemcall::Wait;
2636 res = one.startscript(stype, command, filePath());
2642 dr.setMessage(_("Error running external commands."));
2643 showPrintError(absFileName());
2652 dr.dispatched(dispatched);
2653 undo().endUndoGroup();
2657 void Buffer::changeLanguage(Language const * from, Language const * to)
2659 LASSERT(from, return);
2660 LASSERT(to, return);
2662 for_each(par_iterator_begin(),
2664 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2668 bool Buffer::isMultiLingual() const
2670 ParConstIterator end = par_iterator_end();
2671 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2672 if (it->isMultiLingual(params()))
2679 std::set<Language const *> Buffer::getLanguages() const
2681 std::set<Language const *> languages;
2682 getLanguages(languages);
2687 void Buffer::getLanguages(std::set<Language const *> & languages) const
2689 ParConstIterator end = par_iterator_end();
2690 // add the buffer language, even if it's not actively used
2691 languages.insert(language());
2692 // iterate over the paragraphs
2693 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2694 it->getLanguages(languages);
2696 ListOfBuffers clist = getDescendents();
2697 ListOfBuffers::const_iterator cit = clist.begin();
2698 ListOfBuffers::const_iterator const cen = clist.end();
2699 for (; cit != cen; ++cit)
2700 (*cit)->getLanguages(languages);
2704 DocIterator Buffer::getParFromID(int const id) const
2706 Buffer * buf = const_cast<Buffer *>(this);
2708 // John says this is called with id == -1 from undo
2709 lyxerr << "getParFromID(), id: " << id << endl;
2710 return doc_iterator_end(buf);
2713 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2714 if (it.paragraph().id() == id)
2717 return doc_iterator_end(buf);
2721 bool Buffer::hasParWithID(int const id) const
2723 return !getParFromID(id).atEnd();
2727 ParIterator Buffer::par_iterator_begin()
2729 return ParIterator(doc_iterator_begin(this));
2733 ParIterator Buffer::par_iterator_end()
2735 return ParIterator(doc_iterator_end(this));
2739 ParConstIterator Buffer::par_iterator_begin() const
2741 return ParConstIterator(doc_iterator_begin(this));
2745 ParConstIterator Buffer::par_iterator_end() const
2747 return ParConstIterator(doc_iterator_end(this));
2751 Language const * Buffer::language() const
2753 return params().language;
2757 docstring const Buffer::B_(string const & l10n) const
2759 return params().B_(l10n);
2763 bool Buffer::isClean() const
2765 return d->lyx_clean;
2769 bool Buffer::isExternallyModified(CheckMethod method) const
2771 LASSERT(d->filename.exists(), return false);
2772 // if method == timestamp, check timestamp before checksum
2773 return (method == checksum_method
2774 || d->timestamp_ != d->filename.lastModified())
2775 && d->checksum_ != d->filename.checksum();
2779 void Buffer::saveCheckSum() const
2781 FileName const & file = d->filename;
2784 if (file.exists()) {
2785 d->timestamp_ = file.lastModified();
2786 d->checksum_ = file.checksum();
2788 // in the case of save to a new file.
2795 void Buffer::markClean() const
2797 if (!d->lyx_clean) {
2798 d->lyx_clean = true;
2801 // if the .lyx file has been saved, we don't need an
2803 d->bak_clean = true;
2804 d->undo_.markDirty();
2808 void Buffer::setUnnamed(bool flag)
2814 bool Buffer::isUnnamed() const
2821 /// Don't check unnamed, here: isInternal() is used in
2822 /// newBuffer(), where the unnamed flag has not been set by anyone
2823 /// yet. Also, for an internal buffer, there should be no need for
2824 /// retrieving fileName() nor for checking if it is unnamed or not.
2825 bool Buffer::isInternal() const
2827 return d->internal_buffer;
2831 void Buffer::setInternal(bool flag)
2833 d->internal_buffer = flag;
2837 void Buffer::markDirty()
2840 d->lyx_clean = false;
2843 d->bak_clean = false;
2845 DepClean::iterator it = d->dep_clean.begin();
2846 DepClean::const_iterator const end = d->dep_clean.end();
2848 for (; it != end; ++it)
2853 FileName Buffer::fileName() const
2859 string Buffer::absFileName() const
2861 return d->filename.absFileName();
2865 string Buffer::filePath() const
2867 string const abs = d->filename.onlyPath().absFileName();
2870 int last = abs.length() - 1;
2872 return abs[last] == '/' ? abs : abs + '/';
2876 bool Buffer::isReadonly() const
2878 return d->read_only;
2882 void Buffer::setParent(Buffer const * buffer)
2884 // Avoids recursive include.
2885 d->setParent(buffer == this ? 0 : buffer);
2890 Buffer const * Buffer::parent() const
2896 ListOfBuffers Buffer::allRelatives() const
2898 ListOfBuffers lb = masterBuffer()->getDescendents();
2899 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2904 Buffer const * Buffer::masterBuffer() const
2906 // FIXME Should be make sure we are not in some kind
2907 // of recursive include? A -> B -> A will crash this.
2908 Buffer const * const pbuf = d->parent();
2912 return pbuf->masterBuffer();
2916 bool Buffer::isChild(Buffer * child) const
2918 return d->children_positions.find(child) != d->children_positions.end();
2922 DocIterator Buffer::firstChildPosition(Buffer const * child)
2924 Impl::BufferPositionMap::iterator it;
2925 it = d->children_positions.find(child);
2926 if (it == d->children_positions.end())
2927 return DocIterator(this);
2932 bool Buffer::hasChildren() const
2934 return !d->children_positions.empty();
2938 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2940 // loop over children
2941 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2942 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2943 for (; it != end; ++it) {
2944 Buffer * child = const_cast<Buffer *>(it->first);
2946 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
2947 if (bit != clist.end())
2949 clist.push_back(child);
2951 // there might be grandchildren
2952 child->collectChildren(clist, true);
2957 ListOfBuffers Buffer::getChildren() const
2960 collectChildren(v, false);
2961 // Make sure we have not included ourselves.
2962 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2963 if (bit != v.end()) {
2964 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2971 ListOfBuffers Buffer::getDescendents() const
2974 collectChildren(v, true);
2975 // Make sure we have not included ourselves.
2976 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
2977 if (bit != v.end()) {
2978 LYXERR0("Recursive include detected in `" << fileName() << "'.");
2985 template<typename M>
2986 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
2991 typename M::const_iterator it = m.lower_bound(x);
2992 if (it == m.begin())
3000 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3001 DocIterator const & pos) const
3003 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3005 // if paragraphs have no macro context set, pos will be empty
3009 // we haven't found anything yet
3010 DocIterator bestPos = owner_->par_iterator_begin();
3011 MacroData const * bestData = 0;
3013 // find macro definitions for name
3014 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3015 if (nameIt != macros.end()) {
3016 // find last definition in front of pos or at pos itself
3017 PositionScopeMacroMap::const_iterator it
3018 = greatest_below(nameIt->second, pos);
3019 if (it != nameIt->second.end()) {
3021 // scope ends behind pos?
3022 if (pos < it->second.first) {
3023 // Looks good, remember this. If there
3024 // is no external macro behind this,
3025 // we found the right one already.
3026 bestPos = it->first;
3027 bestData = &it->second.second;
3031 // try previous macro if there is one
3032 if (it == nameIt->second.begin())
3039 // find macros in included files
3040 PositionScopeBufferMap::const_iterator it
3041 = greatest_below(position_to_children, pos);
3042 if (it == position_to_children.end())
3043 // no children before
3047 // do we know something better (i.e. later) already?
3048 if (it->first < bestPos )
3051 // scope ends behind pos?
3052 if (pos < it->second.first
3053 && (cloned_buffer_ ||
3054 theBufferList().isLoaded(it->second.second))) {
3055 // look for macro in external file
3057 MacroData const * data
3058 = it->second.second->getMacro(name, false);
3061 bestPos = it->first;
3067 // try previous file if there is one
3068 if (it == position_to_children.begin())
3073 // return the best macro we have found
3078 MacroData const * Buffer::getMacro(docstring const & name,
3079 DocIterator const & pos, bool global) const
3084 // query buffer macros
3085 MacroData const * data = d->getBufferMacro(name, pos);
3089 // If there is a master buffer, query that
3090 Buffer const * const pbuf = d->parent();
3092 d->macro_lock = true;
3093 MacroData const * macro = pbuf->getMacro(
3094 name, *this, false);
3095 d->macro_lock = false;
3101 data = MacroTable::globalMacros().get(name);
3110 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3112 // set scope end behind the last paragraph
3113 DocIterator scope = par_iterator_begin();
3114 scope.pit() = scope.lastpit() + 1;
3116 return getMacro(name, scope, global);
3120 MacroData const * Buffer::getMacro(docstring const & name,
3121 Buffer const & child, bool global) const
3123 // look where the child buffer is included first
3124 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3125 if (it == d->children_positions.end())
3128 // check for macros at the inclusion position
3129 return getMacro(name, it->second, global);
3133 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3135 pit_type const lastpit = it.lastpit();
3137 // look for macros in each paragraph
3138 while (it.pit() <= lastpit) {
3139 Paragraph & par = it.paragraph();
3141 // iterate over the insets of the current paragraph
3142 InsetList const & insets = par.insetList();
3143 InsetList::const_iterator iit = insets.begin();
3144 InsetList::const_iterator end = insets.end();
3145 for (; iit != end; ++iit) {
3146 it.pos() = iit->pos;
3148 // is it a nested text inset?
3149 if (iit->inset->asInsetText()) {
3150 // Inset needs its own scope?
3151 InsetText const * itext = iit->inset->asInsetText();
3152 bool newScope = itext->isMacroScope();
3154 // scope which ends just behind the inset
3155 DocIterator insetScope = it;
3158 // collect macros in inset
3159 it.push_back(CursorSlice(*iit->inset));
3160 updateMacros(it, newScope ? insetScope : scope);
3165 if (iit->inset->asInsetTabular()) {
3166 CursorSlice slice(*iit->inset);
3167 size_t const numcells = slice.nargs();
3168 for (; slice.idx() < numcells; slice.forwardIdx()) {
3169 it.push_back(slice);
3170 updateMacros(it, scope);
3176 // is it an external file?
3177 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3178 // get buffer of external file
3179 InsetInclude const & inset =
3180 static_cast<InsetInclude const &>(*iit->inset);
3182 Buffer * child = inset.getChildBuffer();
3187 // register its position, but only when it is
3188 // included first in the buffer
3189 if (children_positions.find(child) ==
3190 children_positions.end())
3191 children_positions[child] = it;
3193 // register child with its scope
3194 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3198 InsetMath * im = iit->inset->asInsetMath();
3199 if (doing_export && im) {
3200 InsetMathHull * hull = im->asHullInset();
3202 hull->recordLocation(it);
3205 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3209 MathMacroTemplate & macroTemplate =
3210 *iit->inset->asInsetMath()->asMacroTemplate();
3211 MacroContext mc(owner_, it);
3212 macroTemplate.updateToContext(mc);
3215 bool valid = macroTemplate.validMacro();
3216 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3217 // then the BufferView's cursor will be invalid in
3218 // some cases which leads to crashes.
3223 // FIXME (Abdel), I don't understandt why we pass 'it' here
3224 // instead of 'macroTemplate' defined above... is this correct?
3225 macros[macroTemplate.name()][it] =
3226 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3236 void Buffer::updateMacros() const
3241 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3243 // start with empty table
3245 d->children_positions.clear();
3246 d->position_to_children.clear();
3248 // Iterate over buffer, starting with first paragraph
3249 // The scope must be bigger than any lookup DocIterator
3250 // later. For the global lookup, lastpit+1 is used, hence
3251 // we use lastpit+2 here.
3252 DocIterator it = par_iterator_begin();
3253 DocIterator outerScope = it;
3254 outerScope.pit() = outerScope.lastpit() + 2;
3255 d->updateMacros(it, outerScope);
3259 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3261 InsetIterator it = inset_iterator_begin(inset());
3262 InsetIterator const end = inset_iterator_end(inset());
3263 for (; it != end; ++it) {
3264 if (it->lyxCode() == BRANCH_CODE) {
3265 InsetBranch & br = static_cast<InsetBranch &>(*it);
3266 docstring const name = br.branch();
3267 if (!from_master && !params().branchlist().find(name))
3268 result.push_back(name);
3269 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3270 result.push_back(name);
3273 if (it->lyxCode() == INCLUDE_CODE) {
3274 // get buffer of external file
3275 InsetInclude const & ins =
3276 static_cast<InsetInclude const &>(*it);
3277 Buffer * child = ins.getChildBuffer();
3280 child->getUsedBranches(result, true);
3283 // remove duplicates
3288 void Buffer::updateMacroInstances(UpdateType utype) const
3290 LYXERR(Debug::MACROS, "updateMacroInstances for "
3291 << d->filename.onlyFileName());
3292 DocIterator it = doc_iterator_begin(this);
3294 DocIterator const end = doc_iterator_end(this);
3295 for (; it != end; it.forwardInset()) {
3296 // look for MathData cells in InsetMathNest insets
3297 InsetMath * minset = it.nextInset()->asInsetMath();
3301 // update macro in all cells of the InsetMathNest
3302 DocIterator::idx_type n = minset->nargs();
3303 MacroContext mc = MacroContext(this, it);
3304 for (DocIterator::idx_type i = 0; i < n; ++i) {
3305 MathData & data = minset->cell(i);
3306 data.updateMacros(0, mc, utype);
3312 void Buffer::listMacroNames(MacroNameSet & macros) const
3317 d->macro_lock = true;
3319 // loop over macro names
3320 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3321 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3322 for (; nameIt != nameEnd; ++nameIt)
3323 macros.insert(nameIt->first);
3325 // loop over children
3326 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3327 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3328 for (; it != end; ++it)
3329 it->first->listMacroNames(macros);
3332 Buffer const * const pbuf = d->parent();
3334 pbuf->listMacroNames(macros);
3336 d->macro_lock = false;
3340 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3342 Buffer const * const pbuf = d->parent();
3347 pbuf->listMacroNames(names);
3350 MacroNameSet::iterator it = names.begin();
3351 MacroNameSet::iterator end = names.end();
3352 for (; it != end; ++it) {
3354 MacroData const * data =
3355 pbuf->getMacro(*it, *this, false);
3357 macros.insert(data);
3359 // we cannot access the original MathMacroTemplate anymore
3360 // here to calls validate method. So we do its work here manually.
3361 // FIXME: somehow make the template accessible here.
3362 if (data->optionals() > 0)
3363 features.require("xargs");
3369 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3372 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3374 RefCache::iterator it = d->ref_cache_.find(label);
3375 if (it != d->ref_cache_.end())
3376 return it->second.second;
3378 static InsetLabel const * dummy_il = 0;
3379 static References const dummy_refs;
3380 it = d->ref_cache_.insert(
3381 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3382 return it->second.second;
3386 Buffer::References const & Buffer::references(docstring const & label) const
3388 return const_cast<Buffer *>(this)->getReferenceCache(label);
3392 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3394 References & refs = getReferenceCache(label);
3395 refs.push_back(make_pair(inset, it));
3399 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3401 masterBuffer()->d->ref_cache_[label].first = il;
3405 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3407 return masterBuffer()->d->ref_cache_[label].first;
3411 void Buffer::clearReferenceCache() const
3414 d->ref_cache_.clear();
3418 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3420 //FIXME: This does not work for child documents yet.
3421 reloadBibInfoCache();
3423 // Check if the label 'from' appears more than once
3424 BiblioInfo const & keys = masterBibInfo();
3425 BiblioInfo::const_iterator bit = keys.begin();
3426 BiblioInfo::const_iterator bend = keys.end();
3427 vector<docstring> labels;
3429 for (; bit != bend; ++bit)
3431 labels.push_back(bit->first);
3433 if (count(labels.begin(), labels.end(), from) > 1)
3436 string const paramName = "key";
3437 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3438 if (it->lyxCode() != CITE_CODE)
3440 InsetCommand * inset = it->asInsetCommand();
3441 docstring const oldValue = inset->getParam(paramName);
3442 if (oldValue == from)
3443 inset->setParam(paramName, to);
3448 void Buffer::getSourceCode(odocstream & os, string const format,
3449 pit_type par_begin, pit_type par_end,
3450 OutputWhat output, bool master) const
3452 OutputParams runparams(¶ms().encoding());
3453 runparams.nice = true;
3454 runparams.flavor = params().getOutputFlavor(format);
3455 runparams.linelen = lyxrc.plaintext_linelen;
3456 // No side effect of file copying and image conversion
3457 runparams.dryrun = true;
3459 if (output == CurrentParagraph) {
3460 runparams.par_begin = par_begin;
3461 runparams.par_end = par_end;
3462 if (par_begin + 1 == par_end) {
3464 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3468 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3469 convert<docstring>(par_begin),
3470 convert<docstring>(par_end - 1))
3473 // output paragraphs
3474 if (runparams.flavor == OutputParams::LYX) {
3475 Paragraph const & par = text().paragraphs()[par_begin];
3477 depth_type dt = par.getDepth();
3478 par.write(ods, params(), dt);
3479 os << from_utf8(ods.str());
3480 } else if (runparams.flavor == OutputParams::HTML) {
3482 setMathFlavor(runparams);
3483 xhtmlParagraphs(text(), *this, xs, runparams);
3484 } else if (runparams.flavor == OutputParams::TEXT) {
3486 // FIXME Handles only one paragraph, unlike the others.
3487 // Probably should have some routine with a signature like them.
3488 writePlaintextParagraph(*this,
3489 text().paragraphs()[par_begin], os, runparams, dummy);
3490 } else if (params().isDocBook()) {
3491 docbookParagraphs(text(), *this, os, runparams);
3493 // If we are previewing a paragraph, even if this is the
3494 // child of some other buffer, let's cut the link here,
3495 // so that no concurring settings from the master
3496 // (e.g. branch state) interfere (see #8101).
3498 d->ignore_parent = true;
3499 // We need to validate the Buffer params' features here
3500 // in order to know if we should output polyglossia
3501 // macros (instead of babel macros)
3502 LaTeXFeatures features(*this, params(), runparams);
3503 params().validate(features);
3504 runparams.use_polyglossia = features.usePolyglossia();
3509 // latex or literate
3510 otexstream ots(os, texrow);
3513 latexParagraphs(*this, text(), ots, runparams);
3515 // Restore the parenthood
3517 d->ignore_parent = false;
3521 if (output == FullSource)
3522 os << _("Preview source code");
3523 else if (output == OnlyPreamble)
3524 os << _("Preview preamble");
3525 else if (output == OnlyBody)
3526 os << _("Preview body");
3528 if (runparams.flavor == OutputParams::LYX) {
3530 if (output == FullSource)
3532 else if (output == OnlyPreamble)
3533 params().writeFile(ods);
3534 else if (output == OnlyBody)
3536 os << from_utf8(ods.str());
3537 } else if (runparams.flavor == OutputParams::HTML) {
3538 writeLyXHTMLSource(os, runparams, output);
3539 } else if (runparams.flavor == OutputParams::TEXT) {
3540 if (output == OnlyPreamble) {
3541 os << "% "<< _("Plain text does not have a preamble.");
3543 writePlaintextFile(*this, os, runparams);
3544 } else if (params().isDocBook()) {
3545 writeDocBookSource(os, absFileName(), runparams, output);
3547 // latex or literate
3549 d->texrow.newline();
3550 d->texrow.newline();
3551 otexstream ots(os, d->texrow);
3553 runparams.is_child = true;
3554 writeLaTeXSource(ots, string(), runparams, output);
3560 ErrorList & Buffer::errorList(string const & type) const
3562 return d->errorLists[type];
3566 void Buffer::updateTocItem(std::string const & type,
3567 DocIterator const & dit) const
3570 d->gui_->updateTocItem(type, dit);
3574 void Buffer::structureChanged() const
3577 d->gui_->structureChanged();
3581 void Buffer::errors(string const & err, bool from_master) const
3584 d->gui_->errors(err, from_master);
3588 void Buffer::message(docstring const & msg) const
3591 d->gui_->message(msg);
3595 void Buffer::setBusy(bool on) const
3598 d->gui_->setBusy(on);
3602 void Buffer::updateTitles() const
3605 d->wa_->updateTitles();
3609 void Buffer::resetAutosaveTimers() const
3612 d->gui_->resetAutosaveTimers();
3616 bool Buffer::hasGuiDelegate() const
3622 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3631 class AutoSaveBuffer : public ForkedProcess {
3634 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3635 : buffer_(buffer), fname_(fname) {}
3637 virtual shared_ptr<ForkedProcess> clone() const
3639 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3644 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3645 from_utf8(fname_.absFileName())));
3646 return run(DontWait);
3650 virtual int generateChild();
3652 Buffer const & buffer_;
3657 int AutoSaveBuffer::generateChild()
3659 #if defined(__APPLE__)
3660 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3661 * We should use something else like threads.
3663 * Since I do not know how to determine at run time what is the OS X
3664 * version, I just disable forking altogether for now (JMarc)
3666 pid_t const pid = -1;
3668 // tmp_ret will be located (usually) in /tmp
3669 // will that be a problem?
3670 // Note that this calls ForkedCalls::fork(), so it's
3671 // ok cross-platform.
3672 pid_t const pid = fork();
3673 // If you want to debug the autosave
3674 // you should set pid to -1, and comment out the fork.
3675 if (pid != 0 && pid != -1)
3679 // pid = -1 signifies that lyx was unable
3680 // to fork. But we will do the save
3682 bool failed = false;
3683 FileName const tmp_ret = FileName::tempName("lyxauto");
3684 if (!tmp_ret.empty()) {
3685 buffer_.writeFile(tmp_ret);
3686 // assume successful write of tmp_ret
3687 if (!tmp_ret.moveTo(fname_))
3693 // failed to write/rename tmp_ret so try writing direct
3694 if (!buffer_.writeFile(fname_)) {
3695 // It is dangerous to do this in the child,
3696 // but safe in the parent, so...
3697 if (pid == -1) // emit message signal.
3698 buffer_.message(_("Autosave failed!"));
3702 if (pid == 0) // we are the child so...
3711 FileName Buffer::getEmergencyFileName() const
3713 return FileName(d->filename.absFileName() + ".emergency");
3717 FileName Buffer::getAutosaveFileName() const
3719 // if the document is unnamed try to save in the backup dir, else
3720 // in the default document path, and as a last try in the filePath,
3721 // which will most often be the temporary directory
3724 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3725 : lyxrc.backupdir_path;
3726 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3729 string const fname = "#" + d->filename.onlyFileName() + "#";
3731 return makeAbsPath(fname, fpath);
3735 void Buffer::removeAutosaveFile() const
3737 FileName const f = getAutosaveFileName();
3743 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3745 FileName const newauto = getAutosaveFileName();
3747 if (newauto != oldauto && oldauto.exists())
3748 if (!oldauto.moveTo(newauto))
3749 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3753 bool Buffer::autoSave() const
3755 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3756 if (buf->d->bak_clean || isReadonly())
3759 message(_("Autosaving current document..."));
3760 buf->d->bak_clean = true;
3762 FileName const fname = getAutosaveFileName();
3763 LASSERT(d->cloned_buffer_, return false);
3765 // If this buffer is cloned, we assume that
3766 // we are running in a separate thread already.
3767 FileName const tmp_ret = FileName::tempName("lyxauto");
3768 if (!tmp_ret.empty()) {
3770 // assume successful write of tmp_ret
3771 if (tmp_ret.moveTo(fname))
3774 // failed to write/rename tmp_ret so try writing direct
3775 return writeFile(fname);
3779 void Buffer::setExportStatus(bool e) const
3781 d->doing_export = e;
3782 ListOfBuffers clist = getDescendents();
3783 ListOfBuffers::const_iterator cit = clist.begin();
3784 ListOfBuffers::const_iterator const cen = clist.end();
3785 for (; cit != cen; ++cit)
3786 (*cit)->d->doing_export = e;
3790 bool Buffer::isExporting() const
3792 return d->doing_export;
3796 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3800 return doExport(target, put_in_tempdir, result_file);
3803 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3804 string & result_file) const
3806 bool const update_unincluded =
3807 params().maintain_unincluded_children
3808 && !params().getIncludedChildren().empty();
3810 // (1) export with all included children (omit \includeonly)
3811 if (update_unincluded) {
3812 ExportStatus const status =
3813 doExport(target, put_in_tempdir, true, result_file);
3814 if (status != ExportSuccess)
3817 // (2) export with included children only
3818 return doExport(target, put_in_tempdir, false, result_file);
3822 void Buffer::setMathFlavor(OutputParams & op) const
3824 switch (params().html_math_output) {
3825 case BufferParams::MathML:
3826 op.math_flavor = OutputParams::MathAsMathML;
3828 case BufferParams::HTML:
3829 op.math_flavor = OutputParams::MathAsHTML;
3831 case BufferParams::Images:
3832 op.math_flavor = OutputParams::MathAsImages;
3834 case BufferParams::LaTeX:
3835 op.math_flavor = OutputParams::MathAsLaTeX;
3841 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3842 bool includeall, string & result_file) const
3844 LYXERR(Debug::FILES, "target=" << target);
3845 OutputParams runparams(¶ms().encoding());
3846 string format = target;
3847 string dest_filename;
3848 size_t pos = target.find(' ');
3849 if (pos != string::npos) {
3850 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3851 format = target.substr(0, pos);
3852 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3853 FileName(dest_filename).onlyPath().createPath();
3854 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3856 MarkAsExporting exporting(this);
3857 string backend_format;
3858 runparams.flavor = OutputParams::LATEX;
3859 runparams.linelen = lyxrc.plaintext_linelen;
3860 runparams.includeall = includeall;
3861 vector<string> backs = params().backends();
3862 Converters converters = theConverters();
3863 bool need_nice_file = false;
3864 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3865 // Get shortest path to format
3866 converters.buildGraph();
3867 Graph::EdgePath path;
3868 for (vector<string>::const_iterator it = backs.begin();
3869 it != backs.end(); ++it) {
3870 Graph::EdgePath p = converters.getPath(*it, format);
3871 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3872 backend_format = *it;
3877 if (!put_in_tempdir) {
3878 // Only show this alert if this is an export to a non-temporary
3879 // file (not for previewing).
3880 Alert::error(_("Couldn't export file"), bformat(
3881 _("No information for exporting the format %1$s."),
3882 formats.prettyName(format)));
3884 return ExportNoPathToFormat;
3886 runparams.flavor = converters.getFlavor(path, this);
3887 Graph::EdgePath::const_iterator it = path.begin();
3888 Graph::EdgePath::const_iterator en = path.end();
3889 for (; it != en; ++it)
3890 if (theConverters().get(*it).nice) {
3891 need_nice_file = true;
3896 backend_format = format;
3897 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3898 // FIXME: Don't hardcode format names here, but use a flag
3899 if (backend_format == "pdflatex")
3900 runparams.flavor = OutputParams::PDFLATEX;
3901 else if (backend_format == "luatex")
3902 runparams.flavor = OutputParams::LUATEX;
3903 else if (backend_format == "dviluatex")
3904 runparams.flavor = OutputParams::DVILUATEX;
3905 else if (backend_format == "xetex")
3906 runparams.flavor = OutputParams::XETEX;
3909 string filename = latexName(false);
3910 filename = addName(temppath(), filename);
3911 filename = changeExtension(filename,
3912 formats.extension(backend_format));
3913 LYXERR(Debug::FILES, "filename=" << filename);
3915 // Plain text backend
3916 if (backend_format == "text") {
3917 runparams.flavor = OutputParams::TEXT;
3918 writePlaintextFile(*this, FileName(filename), runparams);
3921 else if (backend_format == "xhtml") {
3922 runparams.flavor = OutputParams::HTML;
3923 setMathFlavor(runparams);
3924 makeLyXHTMLFile(FileName(filename), runparams);
3925 } else if (backend_format == "lyx")
3926 writeFile(FileName(filename));
3928 else if (params().isDocBook()) {
3929 runparams.nice = !put_in_tempdir;
3930 makeDocBookFile(FileName(filename), runparams);
3933 else if (backend_format == format || need_nice_file) {
3934 runparams.nice = true;
3935 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
3936 if (d->cloned_buffer_)
3937 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3940 } else if (!lyxrc.tex_allows_spaces
3941 && contains(filePath(), ' ')) {
3942 Alert::error(_("File name error"),
3943 _("The directory path to the document cannot contain spaces."));
3944 return ExportTexPathHasSpaces;
3946 runparams.nice = false;
3947 bool const success = makeLaTeXFile(
3948 FileName(filename), filePath(), runparams);
3949 if (d->cloned_buffer_)
3950 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
3955 string const error_type = (format == "program")
3956 ? "Build" : params().bufferFormat();
3957 ErrorList & error_list = d->errorLists[error_type];
3958 string const ext = formats.extension(format);
3959 FileName const tmp_result_file(changeExtension(filename, ext));
3960 bool const success = converters.convert(this, FileName(filename),
3961 tmp_result_file, FileName(absFileName()), backend_format, format,
3964 // Emit the signal to show the error list or copy it back to the
3965 // cloned Buffer so that it can be emitted afterwards.
3966 if (format != backend_format) {
3967 if (d->cloned_buffer_) {
3968 d->cloned_buffer_->d->errorLists[error_type] =
3969 d->errorLists[error_type];
3972 // also to the children, in case of master-buffer-view
3973 ListOfBuffers clist = getDescendents();
3974 ListOfBuffers::const_iterator cit = clist.begin();
3975 ListOfBuffers::const_iterator const cen = clist.end();
3976 for (; cit != cen; ++cit) {
3977 if (d->cloned_buffer_) {
3978 // Enable reverse search by copying back the
3979 // texrow object to the cloned buffer.
3980 // FIXME: this is not thread safe.
3981 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
3982 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
3983 (*cit)->d->errorLists[error_type];
3985 (*cit)->errors(error_type, true);
3989 if (d->cloned_buffer_) {
3990 // Enable reverse dvi or pdf to work by copying back the texrow
3991 // object to the cloned buffer.
3992 // FIXME: There is a possibility of concurrent access to texrow
3993 // here from the main GUI thread that should be securized.
3994 d->cloned_buffer_->d->texrow = d->texrow;
3995 string const error_type = params().bufferFormat();
3996 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4000 return ExportConverterError;
4002 if (put_in_tempdir) {
4003 result_file = tmp_result_file.absFileName();
4004 return ExportSuccess;
4007 if (dest_filename.empty())
4008 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4010 result_file = dest_filename;
4011 // We need to copy referenced files (e. g. included graphics
4012 // if format == "dvi") to the result dir.
4013 vector<ExportedFile> const files =
4014 runparams.exportdata->externalFiles(format);
4015 string const dest = runparams.export_folder.empty() ?
4016 onlyPath(result_file) : runparams.export_folder;
4017 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4018 : force_overwrite == ALL_FILES;
4019 CopyStatus status = use_force ? FORCE : SUCCESS;
4021 vector<ExportedFile>::const_iterator it = files.begin();
4022 vector<ExportedFile>::const_iterator const en = files.end();
4023 for (; it != en && status != CANCEL; ++it) {
4024 string const fmt = formats.getFormatFromFile(it->sourceName);
4025 string fixedName = it->exportName;
4026 if (!runparams.export_folder.empty()) {
4027 // Relative pathnames starting with ../ will be sanitized
4028 // if exporting to a different folder
4029 while (fixedName.substr(0, 3) == "../")
4030 fixedName = fixedName.substr(3, fixedName.length() - 3);
4032 FileName fixedFileName = makeAbsPath(fixedName, dest);
4033 fixedFileName.onlyPath().createPath();
4034 status = copyFile(fmt, it->sourceName,
4036 it->exportName, status == FORCE,
4037 runparams.export_folder.empty());
4040 if (status == CANCEL) {
4041 message(_("Document export cancelled."));
4042 return ExportCancel;
4045 if (tmp_result_file.exists()) {
4046 // Finally copy the main file
4047 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4048 : force_overwrite != NO_FILES;
4049 if (status == SUCCESS && use_force)
4051 status = copyFile(format, tmp_result_file,
4052 FileName(result_file), result_file,
4054 if (status == CANCEL) {
4055 message(_("Document export cancelled."));
4056 return ExportCancel;
4058 message(bformat(_("Document exported as %1$s "
4060 formats.prettyName(format),
4061 makeDisplayPath(result_file)));
4064 // This must be a dummy converter like fax (bug 1888)
4065 message(bformat(_("Document exported as %1$s"),
4066 formats.prettyName(format)));
4069 return ExportSuccess;
4073 Buffer::ExportStatus Buffer::preview(string const & format) const
4075 bool const update_unincluded =
4076 params().maintain_unincluded_children
4077 && !params().getIncludedChildren().empty();
4078 return preview(format, update_unincluded);
4081 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4083 MarkAsExporting exporting(this);
4085 // (1) export with all included children (omit \includeonly)
4087 ExportStatus const status = doExport(format, true, true, result_file);
4088 if (status != ExportSuccess)
4091 // (2) export with included children only
4092 ExportStatus const status = doExport(format, true, false, result_file);
4093 if (status != ExportSuccess)
4095 if (!formats.view(*this, FileName(result_file), format))
4096 return PreviewError;
4097 return PreviewSuccess;
4101 Buffer::ReadStatus Buffer::extractFromVC()
4103 bool const found = LyXVC::file_not_found_hook(d->filename);
4105 return ReadFileNotFound;
4106 if (!d->filename.isReadableFile())
4112 Buffer::ReadStatus Buffer::loadEmergency()
4114 FileName const emergencyFile = getEmergencyFileName();
4115 if (!emergencyFile.exists()
4116 || emergencyFile.lastModified() <= d->filename.lastModified())
4117 return ReadFileNotFound;
4119 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4120 docstring const text = bformat(_("An emergency save of the document "
4121 "%1$s exists.\n\nRecover emergency save?"), file);
4123 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4124 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4130 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4131 bool const success = (ret_llf == ReadSuccess);
4134 Alert::warning(_("File is read-only"),
4135 bformat(_("An emergency file is successfully loaded, "
4136 "but the original file %1$s is marked read-only. "
4137 "Please make sure to save the document as a different "
4138 "file."), from_utf8(d->filename.absFileName())));
4141 lyxvc().file_found_hook(d->filename);
4142 str = _("Document was successfully recovered.");
4144 str = _("Document was NOT successfully recovered.");
4145 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4146 makeDisplayPath(emergencyFile.absFileName()));
4148 int const del_emerg =
4149 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4150 _("&Remove"), _("&Keep"));
4151 if (del_emerg == 0) {
4152 emergencyFile.removeFile();
4154 Alert::warning(_("Emergency file deleted"),
4155 _("Do not forget to save your file now!"), true);
4157 return success ? ReadSuccess : ReadEmergencyFailure;
4160 int const del_emerg =
4161 Alert::prompt(_("Delete emergency file?"),
4162 _("Remove emergency file now?"), 1, 1,
4163 _("&Remove"), _("&Keep"));
4165 emergencyFile.removeFile();
4166 return ReadOriginal;
4176 Buffer::ReadStatus Buffer::loadAutosave()
4178 // Now check if autosave file is newer.
4179 FileName const autosaveFile = getAutosaveFileName();
4180 if (!autosaveFile.exists()
4181 || autosaveFile.lastModified() <= d->filename.lastModified())
4182 return ReadFileNotFound;
4184 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4185 docstring const text = bformat(_("The backup of the document %1$s "
4186 "is newer.\n\nLoad the backup instead?"), file);
4187 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4188 _("&Load backup"), _("Load &original"), _("&Cancel"));
4193 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4194 // the file is not saved if we load the autosave file.
4195 if (ret_llf == ReadSuccess) {
4197 Alert::warning(_("File is read-only"),
4198 bformat(_("A backup file is successfully loaded, "
4199 "but the original file %1$s is marked read-only. "
4200 "Please make sure to save the document as a "
4202 from_utf8(d->filename.absFileName())));
4205 lyxvc().file_found_hook(d->filename);
4208 return ReadAutosaveFailure;
4211 // Here we delete the autosave
4212 autosaveFile.removeFile();
4213 return ReadOriginal;
4221 Buffer::ReadStatus Buffer::loadLyXFile()
4223 if (!d->filename.isReadableFile()) {
4224 ReadStatus const ret_rvc = extractFromVC();
4225 if (ret_rvc != ReadSuccess)
4229 ReadStatus const ret_re = loadEmergency();
4230 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4233 ReadStatus const ret_ra = loadAutosave();
4234 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4237 return loadThisLyXFile(d->filename);
4241 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4243 return readFile(fn);
4247 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4249 TeXErrors::Errors::const_iterator it = terr.begin();
4250 TeXErrors::Errors::const_iterator end = terr.end();
4251 ListOfBuffers clist = getDescendents();
4252 ListOfBuffers::const_iterator cen = clist.end();
4254 for (; it != end; ++it) {
4257 int errorRow = it->error_in_line;
4258 Buffer const * buf = 0;
4260 if (it->child_name.empty())
4261 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4263 // The error occurred in a child
4264 ListOfBuffers::const_iterator cit = clist.begin();
4265 for (; cit != cen; ++cit) {
4266 string const child_name =
4267 DocFileName(changeExtension(
4268 (*cit)->absFileName(), "tex")).
4270 if (it->child_name != child_name)
4272 (*cit)->d->texrow.getIdFromRow(errorRow,
4273 id_start, pos_start);
4274 if (id_start != -1) {
4275 buf = d->cloned_buffer_
4276 ? (*cit)->d->cloned_buffer_->d->owner_
4277 : (*cit)->d->owner_;
4288 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4289 } while (found && id_start == id_end && pos_start == pos_end);
4291 if (id_start != id_end) {
4292 // Next registered position is outside the inset where
4293 // the error occurred, so signal end-of-paragraph
4297 errorList.push_back(ErrorItem(it->error_desc,
4298 it->error_text, id_start, pos_start, pos_end, buf));
4303 void Buffer::setBuffersForInsets() const
4305 inset().setBuffer(const_cast<Buffer &>(*this));
4309 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4311 LBUFERR(!text().paragraphs().empty());
4313 // Use the master text class also for child documents
4314 Buffer const * const master = masterBuffer();
4315 DocumentClass const & textclass = master->params().documentClass();
4317 // do this only if we are the top-level Buffer
4318 if (master == this) {
4319 textclass.counters().reset(from_ascii("bibitem"));
4320 reloadBibInfoCache();
4323 // keep the buffers to be children in this set. If the call from the
4324 // master comes back we can see which of them were actually seen (i.e.
4325 // via an InsetInclude). The remaining ones in the set need still be updated.
4326 static std::set<Buffer const *> bufToUpdate;
4327 if (scope == UpdateMaster) {
4328 // If this is a child document start with the master
4329 if (master != this) {
4330 bufToUpdate.insert(this);
4331 master->updateBuffer(UpdateMaster, utype);
4332 // Do this here in case the master has no gui associated with it. Then,
4333 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
4334 if (!master->d->gui_)
4337 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4338 if (bufToUpdate.find(this) == bufToUpdate.end())
4342 // start over the counters in the master
4343 textclass.counters().reset();
4346 // update will be done below for this buffer
4347 bufToUpdate.erase(this);
4349 // update all caches
4350 clearReferenceCache();
4353 Buffer & cbuf = const_cast<Buffer &>(*this);
4356 ParIterator parit = cbuf.par_iterator_begin();
4357 updateBuffer(parit, utype);
4360 // TocBackend update will be done later.
4363 d->bibinfo_cache_valid_ = true;
4364 d->cite_labels_valid_ = true;
4365 cbuf.tocBackend().update(utype == OutputUpdate);
4366 if (scope == UpdateMaster)
4367 cbuf.structureChanged();
4371 static depth_type getDepth(DocIterator const & it)
4373 depth_type depth = 0;
4374 for (size_t i = 0 ; i < it.depth() ; ++i)
4375 if (!it[i].inset().inMathed())
4376 depth += it[i].paragraph().getDepth() + 1;
4377 // remove 1 since the outer inset does not count
4381 static depth_type getItemDepth(ParIterator const & it)
4383 Paragraph const & par = *it;
4384 LabelType const labeltype = par.layout().labeltype;
4386 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4389 // this will hold the lowest depth encountered up to now.
4390 depth_type min_depth = getDepth(it);
4391 ParIterator prev_it = it;
4394 --prev_it.top().pit();
4396 // start of nested inset: go to outer par
4398 if (prev_it.empty()) {
4399 // start of document: nothing to do
4404 // We search for the first paragraph with same label
4405 // that is not more deeply nested.
4406 Paragraph & prev_par = *prev_it;
4407 depth_type const prev_depth = getDepth(prev_it);
4408 if (labeltype == prev_par.layout().labeltype) {
4409 if (prev_depth < min_depth)
4410 return prev_par.itemdepth + 1;
4411 if (prev_depth == min_depth)
4412 return prev_par.itemdepth;
4414 min_depth = min(min_depth, prev_depth);
4415 // small optimization: if we are at depth 0, we won't
4416 // find anything else
4417 if (prev_depth == 0)
4423 static bool needEnumCounterReset(ParIterator const & it)
4425 Paragraph const & par = *it;
4426 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4427 depth_type const cur_depth = par.getDepth();
4428 ParIterator prev_it = it;
4429 while (prev_it.pit()) {
4430 --prev_it.top().pit();
4431 Paragraph const & prev_par = *prev_it;
4432 if (prev_par.getDepth() <= cur_depth)
4433 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4435 // start of nested inset: reset
4440 // set the label of a paragraph. This includes the counters.
4441 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4443 BufferParams const & bp = owner_->masterBuffer()->params();
4444 DocumentClass const & textclass = bp.documentClass();
4445 Paragraph & par = it.paragraph();
4446 Layout const & layout = par.layout();
4447 Counters & counters = textclass.counters();
4449 if (par.params().startOfAppendix()) {
4450 // We want to reset the counter corresponding to toplevel sectioning
4451 Layout const & lay = textclass.getTOCLayout();
4452 docstring const cnt = lay.counter;
4454 counters.reset(cnt);
4455 counters.appendix(true);
4457 par.params().appendix(counters.appendix());
4459 // Compute the item depth of the paragraph
4460 par.itemdepth = getItemDepth(it);
4462 if (layout.margintype == MARGIN_MANUAL) {
4463 if (par.params().labelWidthString().empty())
4464 par.params().labelWidthString(par.expandLabel(layout, bp));
4465 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4466 // we do not need to do anything here, since the empty case is
4467 // handled during export.
4469 par.params().labelWidthString(docstring());
4472 switch(layout.labeltype) {
4473 case LABEL_ITEMIZE: {
4474 // At some point of time we should do something more
4475 // clever here, like:
4476 // par.params().labelString(
4477 // bp.user_defined_bullet(par.itemdepth).getText());
4478 // for now, use a simple hardcoded label
4479 docstring itemlabel;
4480 switch (par.itemdepth) {
4482 itemlabel = char_type(0x2022);
4485 itemlabel = char_type(0x2013);
4488 itemlabel = char_type(0x2217);
4491 itemlabel = char_type(0x2219); // or 0x00b7
4494 par.params().labelString(itemlabel);
4498 case LABEL_ENUMERATE: {
4499 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4501 switch (par.itemdepth) {
4510 enumcounter += "iv";
4513 // not a valid enumdepth...
4517 // Maybe we have to reset the enumeration counter.
4518 if (needEnumCounterReset(it))
4519 counters.reset(enumcounter);
4520 counters.step(enumcounter, utype);
4522 string const & lang = par.getParLanguage(bp)->code();
4523 par.params().labelString(counters.theCounter(enumcounter, lang));
4528 case LABEL_SENSITIVE: {
4529 string const & type = counters.current_float();
4530 docstring full_label;
4532 full_label = owner_->B_("Senseless!!! ");
4534 docstring name = owner_->B_(textclass.floats().getType(type).name());
4535 if (counters.hasCounter(from_utf8(type))) {
4536 string const & lang = par.getParLanguage(bp)->code();
4537 counters.step(from_utf8(type), utype);
4538 full_label = bformat(from_ascii("%1$s %2$s:"),
4540 counters.theCounter(from_utf8(type), lang));
4542 full_label = bformat(from_ascii("%1$s #:"), name);
4544 par.params().labelString(full_label);
4548 case LABEL_NO_LABEL:
4549 par.params().labelString(docstring());
4553 case LABEL_CENTERED:
4554 case LABEL_STATIC: {
4555 docstring const & lcounter = layout.counter;
4556 if (!lcounter.empty()) {
4557 if (layout.toclevel <= bp.secnumdepth
4558 && (layout.latextype != LATEX_ENVIRONMENT
4559 || it.text()->isFirstInSequence(it.pit()))) {
4560 if (counters.hasCounter(lcounter))
4561 counters.step(lcounter, utype);
4562 par.params().labelString(par.expandLabel(layout, bp));
4564 par.params().labelString(docstring());
4566 par.params().labelString(par.expandLabel(layout, bp));
4572 par.params().labelString(par.expandLabel(layout, bp));
4577 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4579 // LASSERT: Is it safe to continue here, or should we just return?
4580 LASSERT(parit.pit() == 0, /**/);
4582 // Set the position of the text in the buffer to be able
4583 // to resolve macros in it.
4584 parit.text()->setMacrocontextPosition(parit);
4586 depth_type maxdepth = 0;
4587 pit_type const lastpit = parit.lastpit();
4588 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4589 // reduce depth if necessary
4590 if (parit->params().depth() > maxdepth) {
4591 /** FIXME: this function is const, but
4592 * nevertheless it modifies the buffer. To be
4593 * cleaner, one should modify the buffer in
4594 * another function, which is actually
4595 * non-const. This would however be costly in
4596 * terms of code duplication.
4598 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4599 parit->params().depth(maxdepth);
4601 maxdepth = parit->getMaxDepthAfter();
4603 if (utype == OutputUpdate) {
4604 // track the active counters
4605 // we have to do this for the master buffer, since the local
4606 // buffer isn't tracking anything.
4607 masterBuffer()->params().documentClass().counters().
4608 setActiveLayout(parit->layout());
4611 // set the counter for this paragraph
4612 d->setLabel(parit, utype);
4615 InsetList::const_iterator iit = parit->insetList().begin();
4616 InsetList::const_iterator end = parit->insetList().end();
4617 for (; iit != end; ++iit) {
4618 parit.pos() = iit->pos;
4619 iit->inset->updateBuffer(parit, utype);
4625 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4626 WordLangTuple & word_lang, docstring_list & suggestions) const
4630 suggestions.clear();
4631 word_lang = WordLangTuple();
4632 bool const to_end = to.empty();
4633 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4634 // OK, we start from here.
4635 for (; from != end; from.forwardPos()) {
4636 // We are only interested in text so remove the math CursorSlice.
4637 while (from.inMathed()) {
4641 // If from is at the end of the document (which is possible
4642 // when leaving the mathed) LyX will crash later otherwise.
4643 if (from.atEnd() || (!to_end && from >= end))
4646 from.paragraph().spellCheck();
4647 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4648 if (SpellChecker::misspelled(res)) {
4653 // Do not increase progress when from == to, otherwise the word
4654 // count will be wrong.
4664 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4666 bool inword = false;
4671 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4672 if (!dit.inTexted()) {
4677 Paragraph const & par = dit.paragraph();
4678 pos_type const pos = dit.pos();
4680 // Copied and adapted from isWordSeparator() in Paragraph
4681 if (pos == dit.lastpos()) {
4684 Inset const * ins = par.getInset(pos);
4685 if (ins && skipNoOutput && !ins->producesOutput()) {
4688 // stop if end of range was skipped
4689 if (!to.atEnd() && dit >= to)
4692 } else if (!par.isDeleted(pos)) {
4693 if (par.isWordSeparator(pos))
4699 if (ins && ins->isLetter())
4701 else if (ins && ins->isSpace())
4704 char_type const c = par.getChar(pos);
4705 if (isPrintableNonspace(c))
4707 else if (isSpace(c))
4717 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4719 d->updateStatistics(from, to, skipNoOutput);
4723 int Buffer::wordCount() const
4725 return d->wordCount();
4729 int Buffer::charCount(bool with_blanks) const
4731 return d->charCount(with_blanks);
4735 Buffer::ReadStatus Buffer::reload(bool clearUndo)
4738 // c.f. bug http://www.lyx.org/trac/ticket/6587
4739 removeAutosaveFile();
4740 // e.g., read-only status could have changed due to version control
4741 d->filename.refresh();
4742 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4744 // clear parent. this will get reset if need be.
4746 ReadStatus const status = loadLyXFile();
4747 if (status == ReadSuccess) {
4752 message(bformat(_("Document %1$s reloaded."), disp_fn));
4756 message(bformat(_("Could not reload document %1$s."), disp_fn));
4766 bool Buffer::saveAs(FileName const & fn)
4768 FileName const old_name = fileName();
4769 FileName const old_auto = getAutosaveFileName();
4770 bool const old_unnamed = isUnnamed();
4777 // bring the autosave file with us, just in case.
4778 moveAutosaveFile(old_auto);
4779 // validate version control data and
4780 // correct buffer title
4781 lyxvc().file_found_hook(fileName());
4783 // the file has now been saved to the new location.
4784 // we need to check that the locations of child buffers
4786 checkChildBuffers();
4787 checkMasterBuffer();
4791 // reset the old filename and unnamed state
4792 setFileName(old_name);
4793 setUnnamed(old_unnamed);
4799 // FIXME We could do better here, but it is complicated. What would be
4800 // nice is to offer either (a) to save the child buffer to an appropriate
4801 // location, so that it would "move with the master", or else (b) to update
4802 // the InsetInclude so that it pointed to the same file. But (a) is a bit
4803 // complicated, because the code for this lives in GuiView.
4804 void Buffer::checkChildBuffers()
4806 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4807 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4808 for (; it != en; ++it) {
4809 DocIterator dit = it->second;
4810 Buffer * cbuf = const_cast<Buffer *>(it->first);
4811 if (!cbuf || !theBufferList().isLoaded(cbuf))
4813 Inset * inset = dit.nextInset();
4814 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4815 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4816 docstring const & incfile = inset_inc->getParam("filename");
4817 string oldloc = cbuf->absFileName();
4818 string newloc = makeAbsPath(to_utf8(incfile),
4819 onlyPath(absFileName())).absFileName();
4820 if (oldloc == newloc)
4822 // the location of the child file is incorrect.
4823 Alert::warning(_("Included File Invalid"),
4824 bformat(_("Saving this document to a new location has made the file:\n"
4826 "inaccessible. You will need to update the included filename."),
4827 from_utf8(oldloc)));
4829 inset_inc->setChildBuffer(0);
4831 // invalidate cache of children
4832 d->children_positions.clear();
4833 d->position_to_children.clear();
4837 // If a child has been saved under a different name/path, it might have been
4838 // orphaned. Therefore the master needs to be reset (bug 8161).
4839 void Buffer::checkMasterBuffer()
4841 Buffer const * const master = masterBuffer();
4845 // necessary to re-register the child (bug 5873)
4846 // FIXME: clean up updateMacros (here, only
4847 // child registering is needed).
4848 master->updateMacros();
4849 // (re)set master as master buffer, but only
4850 // if we are a real child
4851 if (master->isChild(this))