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"
31 #include "BufferEncodings.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"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetTabular.h"
74 #include "insets/InsetText.h"
76 #include "mathed/InsetMathHull.h"
77 #include "mathed/MacroTable.h"
78 #include "mathed/MathMacroTemplate.h"
79 #include "mathed/MathSupport.h"
81 #include "graphics/PreviewLoader.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileName.h"
93 #include "support/FileNameList.h"
94 #include "support/filetools.h"
95 #include "support/ForkedCalls.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/lyxalgo.h"
100 #include "support/mutex.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;
139 // A storehouse for the cloned buffers.
140 list<CloneList *> cloned_buffers;
146 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
150 delete preview_loader_;
158 /// search for macro in local (buffer) table or in children
159 MacroData const * getBufferMacro(docstring const & name,
160 DocIterator const & pos) const;
162 /// Update macro table starting with position of it \param it in some
164 void updateMacros(DocIterator & it, DocIterator & scope);
166 void setLabel(ParIterator & it, UpdateType utype) const;
168 /** If we have branches that use the file suffix
169 feature, return the file name with suffix appended.
171 support::FileName exportFileName() const;
178 mutable TexRow texrow;
180 /// need to regenerate .tex?
184 mutable bool lyx_clean;
186 /// is autosave needed?
187 mutable bool bak_clean;
189 /// is this an unnamed file (New...)?
192 /// is this an internal bufffer?
193 bool internal_buffer;
198 /// name of the file the buffer is associated with.
201 /** Set to true only when the file is fully loaded.
202 * Used to prevent the premature generation of previews
203 * and by the citation inset.
205 bool file_fully_loaded;
207 /// Ignore the parent (e.g. when exporting a child standalone)?
211 mutable TocBackend toc_backend;
216 ScopeMacro(DocIterator const & s, MacroData const & m)
217 : scope(s), macro(m) {}
221 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
222 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
223 /// map from the macro name to the position map,
224 /// which maps the macro definition position to the scope and the MacroData.
225 NamePositionScopeMacroMap macros;
226 /// This seem to change the way Buffer::getMacro() works
227 mutable bool macro_lock;
229 /// positions of child buffers in the buffer
230 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
233 ScopeBuffer(DocIterator const & s,Buffer const * b)
234 : scope(s), buffer(b) {}
236 Buffer const * buffer;
238 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
239 /// position of children buffers in this buffer
240 BufferPositionMap children_positions;
241 /// map from children inclusion positions to their scope and their buffer
242 PositionScopeBufferMap position_to_children;
244 /// Contains the old buffer filePath() while saving-as, or the
245 /// directory where the document was last saved while loading.
248 /** Keeps track of the path of local layout files.
249 * If possible, it is always relative to the buffer path.
250 * Empty for layouts in system or user directory.
252 string layout_position;
254 /// Container for all sort of Buffer dependant errors.
255 map<string, ErrorList> errorLists;
257 /// timestamp and checksum used to test if the file has been externally
258 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
260 unsigned long checksum_;
263 frontend::WorkAreaManager * wa_;
265 frontend::GuiBufferDelegate * gui_;
270 /// A cache for the bibfiles (including bibfiles of loaded child
271 /// documents), needed for appropriate update of natbib labels.
272 mutable support::FileNameList bibfiles_cache_;
274 // FIXME The caching mechanism could be improved. At present, we have a
275 // cache for each Buffer, that caches all the bibliography info for that
276 // Buffer. A more efficient solution would be to have a global cache per
277 // file, and then to construct the Buffer's bibinfo from that.
278 /// A cache for bibliography info
279 mutable BiblioInfo bibinfo_;
280 /// whether the bibinfo cache is valid
281 mutable bool bibinfo_cache_valid_;
282 /// whether the bibfile cache is valid
283 mutable bool bibfile_cache_valid_;
284 /// Cache of timestamps of .bib files
285 map<FileName, time_t> bibfile_status_;
286 /// Indicates whether the bibinfo has changed since the last time
287 /// we ran updateBuffer(), i.e., whether citation labels may need
289 mutable bool cite_labels_valid_;
291 /// These two hold the file name and format, written to by
292 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
293 FileName preview_file_;
294 string preview_format_;
295 /// If there was an error when previewing, on the next preview we do
296 /// a fresh compile (e.g. in case the user installed a package that
300 mutable RefCache ref_cache_;
302 /// our Text that should be wrapped in an InsetText
306 PreviewLoader * preview_loader_;
308 /// This is here to force the test to be done whenever parent_buffer
310 Buffer const * parent() const
312 // ignore_parent temporarily "orphans" a buffer
313 // (e.g. if a child is compiled standalone)
316 // if parent_buffer is not loaded, then it has been unloaded,
317 // which means that parent_buffer is an invalid pointer. So we
318 // set it to null in that case.
319 // however, the BufferList doesn't know about cloned buffers, so
320 // they will always be regarded as unloaded. in that case, we hope
322 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
324 return parent_buffer;
328 void setParent(Buffer const * pb)
330 if (parent_buffer == pb)
333 if (!cloned_buffer_ && parent_buffer && pb)
334 LYXERR0("Warning: a buffer should not have two parents!");
336 if (!cloned_buffer_ && parent_buffer) {
337 parent_buffer->invalidateBibfileCache();
338 parent_buffer->invalidateBibinfoCache();
342 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
343 /// This one is useful for preview detached in a thread.
344 Buffer const * cloned_buffer_;
346 CloneList * clone_list_;
347 /// are we in the process of exporting this buffer?
348 mutable bool doing_export;
350 /// compute statistics
351 /// \p from initial position
352 /// \p to points to the end position
353 void updateStatistics(DocIterator & from, DocIterator & to,
354 bool skipNoOutput = true);
355 /// statistics accessor functions
356 int wordCount() const
360 int charCount(bool with_blanks) const
363 + (with_blanks ? blank_count_ : 0);
367 /// So we can force access via the accessors.
368 mutable Buffer const * parent_buffer;
377 /// Creates the per buffer temporary directory
378 static FileName createBufferTmpDir()
380 // FIXME This would be the ideal application for a TempDir class (like
381 // TempFile but for directories)
386 Mutex::Locker locker(&mutex);
387 counter = convert<string>(count++);
389 // We are in our own directory. Why bother to mangle name?
390 // In fact I wrote this code to circumvent a problematic behaviour
391 // (bug?) of EMX mkstemp().
392 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
395 if (!tmpfl.createDirectory(0777)) {
396 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
397 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
398 from_utf8(tmpfl.absFileName())));
404 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
405 Buffer const * cloned_buffer)
406 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
407 internal_buffer(false), read_only(readonly_), filename(file),
408 file_fully_loaded(false), ignore_parent(false), toc_backend(owner),
409 macro_lock(false), timestamp_(0), checksum_(0), wa_(0), gui_(0),
410 undo_(*owner), bibinfo_cache_valid_(false), bibfile_cache_valid_(false),
411 cite_labels_valid_(false), inset(0), preview_loader_(0),
412 cloned_buffer_(cloned_buffer), clone_list_(0),
413 doing_export(false), parent_buffer(0),
414 word_count_(0), char_count_(0), blank_count_(0)
416 if (!cloned_buffer_) {
417 temppath = createBufferTmpDir();
418 lyxvc.setBuffer(owner_);
420 wa_ = new frontend::WorkAreaManager;
423 temppath = cloned_buffer_->d->temppath;
424 file_fully_loaded = true;
425 params = cloned_buffer_->d->params;
426 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
427 bibinfo_ = cloned_buffer_->d->bibinfo_;
428 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
429 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
430 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
431 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
432 unnamed = cloned_buffer_->d->unnamed;
433 internal_buffer = cloned_buffer_->d->internal_buffer;
434 layout_position = cloned_buffer_->d->layout_position;
435 preview_file_ = cloned_buffer_->d->preview_file_;
436 preview_format_ = cloned_buffer_->d->preview_format_;
437 preview_error_ = cloned_buffer_->d->preview_error_;
441 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
442 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
444 LYXERR(Debug::INFO, "Buffer::Buffer()");
446 d->inset = new InsetText(*cloned_buffer->d->inset);
447 d->inset->setBuffer(*this);
448 // FIXME: optimize this loop somewhat, maybe by creating a new
449 // general recursive Inset::setId().
450 DocIterator it = doc_iterator_begin(this);
451 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
452 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
453 it.paragraph().setId(cloned_it.paragraph().id());
455 d->inset = new InsetText(this);
456 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
462 LYXERR(Debug::INFO, "Buffer::~Buffer()");
463 // here the buffer should take care that it is
464 // saved properly, before it goes into the void.
466 // GuiView already destroyed
470 // No need to do additional cleanups for internal buffer.
476 // this is in case of recursive includes: we won't try to delete
477 // ourselves as a child.
478 d->clone_list_->erase(this);
479 // loop over children
480 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
481 Impl::BufferPositionMap::iterator end = d->children_positions.end();
482 for (; it != end; ++it) {
483 Buffer * child = const_cast<Buffer *>(it->first);
484 if (d->clone_list_->erase(child))
487 // if we're the master buffer, then we should get rid of the list
490 // If this is not empty, we have leaked something. Worse, one of the
491 // children still has a reference to this list. But we will try to
492 // continue, rather than shut down.
493 LATTEST(d->clone_list_->empty());
494 list<CloneList *>::iterator it =
495 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
496 if (it == cloned_buffers.end()) {
497 // We will leak in this case, but it is safe to continue.
500 cloned_buffers.erase(it);
501 delete d->clone_list_;
503 // FIXME Do we really need to do this right before we delete d?
504 // clear references to children in macro tables
505 d->children_positions.clear();
506 d->position_to_children.clear();
508 // loop over children
509 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
510 Impl::BufferPositionMap::iterator end = d->children_positions.end();
511 for (; it != end; ++it) {
512 Buffer * child = const_cast<Buffer *>(it->first);
513 if (theBufferList().isLoaded(child))
514 theBufferList().releaseChild(this, child);
518 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
519 msg += emergencyWrite();
520 Alert::warning(_("Attempting to close changed document!"), msg);
523 // FIXME Do we really need to do this right before we delete d?
524 // clear references to children in macro tables
525 d->children_positions.clear();
526 d->position_to_children.clear();
528 if (!d->temppath.destroyDirectory()) {
529 Alert::warning(_("Could not remove temporary directory"),
530 bformat(_("Could not remove the temporary directory %1$s"),
531 from_utf8(d->temppath.absFileName())));
540 Buffer * Buffer::cloneFromMaster() const
543 cloned_buffers.push_back(new CloneList);
544 CloneList * clones = cloned_buffers.back();
546 masterBuffer()->cloneWithChildren(bufmap, clones);
548 // make sure we got cloned
549 BufferMap::const_iterator bit = bufmap.find(this);
550 LASSERT(bit != bufmap.end(), return 0);
551 Buffer * cloned_buffer = bit->second;
553 return cloned_buffer;
557 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
559 // have we already been cloned?
560 if (bufmap.find(this) != bufmap.end())
563 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
565 // The clone needs its own DocumentClass, since running updateBuffer() will
566 // modify it, and we would otherwise be sharing it with the original Buffer.
567 buffer_clone->params().makeDocumentClass(true);
569 cap::switchBetweenClasses(
570 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
571 static_cast<InsetText &>(buffer_clone->inset()), el);
573 bufmap[this] = buffer_clone;
574 clones->insert(buffer_clone);
575 buffer_clone->d->clone_list_ = clones;
576 buffer_clone->d->macro_lock = true;
577 buffer_clone->d->children_positions.clear();
579 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
580 // math macro caches need to be rethought and simplified.
581 // I am not sure wether we should handle Buffer cloning here or in BufferList.
582 // Right now BufferList knows nothing about buffer clones.
583 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
584 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
585 for (; it != end; ++it) {
586 DocIterator dit = it->first.clone(buffer_clone);
587 dit.setBuffer(buffer_clone);
588 Buffer * child = const_cast<Buffer *>(it->second.buffer);
590 child->cloneWithChildren(bufmap, clones);
591 BufferMap::iterator const bit = bufmap.find(child);
592 LASSERT(bit != bufmap.end(), continue);
593 Buffer * child_clone = bit->second;
595 Inset * inset = dit.nextInset();
596 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
597 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
598 inset_inc->setChildBuffer(child_clone);
599 child_clone->d->setParent(buffer_clone);
600 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
601 buffer_clone->setChild(dit, child_clone);
603 buffer_clone->d->macro_lock = false;
608 Buffer * Buffer::cloneBufferOnly() const {
609 cloned_buffers.push_back(new CloneList);
610 CloneList * clones = cloned_buffers.back();
611 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
613 // The clone needs its own DocumentClass, since running updateBuffer() will
614 // modify it, and we would otherwise be sharing it with the original Buffer.
615 buffer_clone->params().makeDocumentClass(true);
617 cap::switchBetweenClasses(
618 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
619 static_cast<InsetText &>(buffer_clone->inset()), el);
621 clones->insert(buffer_clone);
622 buffer_clone->d->clone_list_ = clones;
624 // we won't be cloning the children
625 buffer_clone->d->children_positions.clear();
630 bool Buffer::isClone() const
632 return d->cloned_buffer_;
636 void Buffer::changed(bool update_metrics) const
639 d->wa_->redrawAll(update_metrics);
643 frontend::WorkAreaManager & Buffer::workAreaManager() const
650 Text & Buffer::text() const
652 return d->inset->text();
656 Inset & Buffer::inset() const
662 BufferParams & Buffer::params()
668 BufferParams const & Buffer::params() const
674 BufferParams const & Buffer::masterParams() const
676 if (masterBuffer() == this)
679 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
680 // Copy child authors to the params. We need those pointers.
681 AuthorList const & child_authors = params().authors();
682 AuthorList::Authors::const_iterator it = child_authors.begin();
683 for (; it != child_authors.end(); ++it)
684 mparams.authors().record(*it);
689 double Buffer::fontScalingFactor() const
691 return isExporting() ? 75.0 * params().html_math_img_scale
692 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
696 ParagraphList & Buffer::paragraphs()
698 return text().paragraphs();
702 ParagraphList const & Buffer::paragraphs() const
704 return text().paragraphs();
708 LyXVC & Buffer::lyxvc()
714 LyXVC const & Buffer::lyxvc() const
720 string const Buffer::temppath() const
722 return d->temppath.absFileName();
726 TexRow & Buffer::texrow()
732 TexRow const & Buffer::texrow() const
738 TocBackend & Buffer::tocBackend() const
740 return d->toc_backend;
744 Undo & Buffer::undo()
750 void Buffer::setChild(DocIterator const & dit, Buffer * child)
752 d->children_positions[child] = dit;
756 string Buffer::latexName(bool const no_path) const
758 FileName latex_name =
759 makeLatexName(d->exportFileName());
760 return no_path ? latex_name.onlyFileName()
761 : latex_name.absFileName();
765 FileName Buffer::Impl::exportFileName() const
767 docstring const branch_suffix =
768 params.branchlist().getFileNameSuffix();
769 if (branch_suffix.empty())
772 string const name = filename.onlyFileNameWithoutExt()
773 + to_utf8(branch_suffix);
774 FileName res(filename.onlyPath().absFileName() + "/" + name);
775 res.changeExtension(filename.extension());
781 string Buffer::logName(LogType * type) const
783 string const filename = latexName(false);
785 if (filename.empty()) {
791 string const path = temppath();
793 FileName const fname(addName(temppath(),
794 onlyFileName(changeExtension(filename,
797 // FIXME: how do we know this is the name of the build log?
798 FileName const bname(
799 addName(path, onlyFileName(
800 changeExtension(filename,
801 formats.extension(params().bufferFormat()) + ".out"))));
803 // Also consider the master buffer log file
804 FileName masterfname = fname;
805 LogType mtype = latexlog;
806 if (masterBuffer() != this) {
807 string const mlogfile = masterBuffer()->logName(&mtype);
808 masterfname = FileName(mlogfile);
811 // If no Latex log or Build log is newer, show Build log
812 if (bname.exists() &&
813 ((!fname.exists() && !masterfname.exists())
814 || (fname.lastModified() < bname.lastModified()
815 && masterfname.lastModified() < bname.lastModified()))) {
816 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
819 return bname.absFileName();
820 // If we have a newer master file log or only a master log, show this
821 } else if (fname != masterfname
822 && (!fname.exists() && (masterfname.exists()
823 || fname.lastModified() < masterfname.lastModified()))) {
824 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
827 return masterfname.absFileName();
829 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
832 return fname.absFileName();
836 void Buffer::setReadonly(bool const flag)
838 if (d->read_only != flag) {
845 void Buffer::setFileName(FileName const & fname)
847 bool const changed = fname != d->filename;
850 lyxvc().file_found_hook(fname);
851 setReadonly(d->filename.isReadOnly());
857 int Buffer::readHeader(Lexer & lex)
859 int unknown_tokens = 0;
861 int begin_header_line = -1;
863 // Initialize parameters that may be/go lacking in header:
864 params().branchlist().clear();
865 params().preamble.erase();
866 params().options.erase();
867 params().master.erase();
868 params().float_placement.erase();
869 params().paperwidth.erase();
870 params().paperheight.erase();
871 params().leftmargin.erase();
872 params().rightmargin.erase();
873 params().topmargin.erase();
874 params().bottommargin.erase();
875 params().headheight.erase();
876 params().headsep.erase();
877 params().footskip.erase();
878 params().columnsep.erase();
879 params().fonts_cjk.erase();
880 params().listings_params.clear();
881 params().clearLayoutModules();
882 params().clearRemovedModules();
883 params().clearIncludedChildren();
884 params().pdfoptions().clear();
885 params().indiceslist().clear();
886 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
887 params().isbackgroundcolor = false;
888 params().fontcolor = RGBColor(0, 0, 0);
889 params().isfontcolor = false;
890 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
891 params().boxbgcolor = RGBColor(0xFF, 0, 0);
892 params().html_latex_start.clear();
893 params().html_latex_end.clear();
894 params().html_math_img_scale = 1.0;
895 params().output_sync_macro.erase();
896 params().setLocalLayout(string(), false);
897 params().setLocalLayout(string(), true);
899 for (int i = 0; i < 4; ++i) {
900 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
901 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
904 ErrorList & errorList = d->errorLists["Parse"];
913 if (token == "\\end_header")
917 if (token == "\\begin_header") {
918 begin_header_line = line;
922 LYXERR(Debug::PARSER, "Handling document header token: `"
925 string const result =
926 params().readToken(lex, token, d->filename.onlyPath());
927 if (!result.empty()) {
928 if (token == "\\textclass") {
929 d->layout_position = result;
932 docstring const s = bformat(_("Unknown token: "
936 errorList.push_back(ErrorItem(_("Document header error"),
941 if (begin_header_line) {
942 docstring const s = _("\\begin_header is missing");
943 errorList.push_back(ErrorItem(_("Document header error"),
947 params().makeDocumentClass();
949 return unknown_tokens;
954 // changed to be public and have one parameter
955 // Returns true if "\end_document" is not read (Asger)
956 bool Buffer::readDocument(Lexer & lex)
958 ErrorList & errorList = d->errorLists["Parse"];
961 // remove dummy empty par
962 paragraphs().clear();
964 if (!lex.checkFor("\\begin_document")) {
965 docstring const s = _("\\begin_document is missing");
966 errorList.push_back(ErrorItem(_("Document header error"),
972 if (params().output_changes) {
973 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
974 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
975 LaTeXFeatures::isAvailable("xcolor");
977 if (!dvipost && !xcolorulem) {
978 Alert::warning(_("Changes not shown in LaTeX output"),
979 _("Changes will not be highlighted in LaTeX output, "
980 "because neither dvipost nor xcolor/ulem are installed.\n"
981 "Please install these packages or redefine "
982 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
983 } else if (!xcolorulem) {
984 Alert::warning(_("Changes not shown in LaTeX output"),
985 _("Changes will not be highlighted in LaTeX output "
986 "when using pdflatex, because xcolor and ulem are not installed.\n"
987 "Please install both packages or redefine "
988 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
992 if (!parent() && !params().master.empty()) {
993 FileName const master_file = makeAbsPath(params().master,
994 onlyPath(absFileName()));
995 if (isLyXFileName(master_file.absFileName())) {
997 checkAndLoadLyXFile(master_file, true);
999 // necessary e.g. after a reload
1000 // to re-register the child (bug 5873)
1001 // FIXME: clean up updateMacros (here, only
1002 // child registering is needed).
1003 master->updateMacros();
1004 // set master as master buffer, but only
1005 // if we are a real child
1006 if (master->isChild(this))
1008 // if the master is not fully loaded
1009 // it is probably just loading this
1010 // child. No warning needed then.
1011 else if (master->isFullyLoaded())
1012 LYXERR0("The master '"
1014 << "' assigned to this document ("
1016 << ") does not include "
1017 "this document. Ignoring the master assignment.");
1022 // assure we have a default index
1023 params().indiceslist().addDefault(B_("Index"));
1026 d->old_position = originFilePath();
1027 bool const res = text().read(lex, errorList, d->inset);
1028 d->old_position.clear();
1030 // inform parent buffer about local macros
1032 Buffer const * pbuf = parent();
1033 UserMacroSet::const_iterator cit = usermacros.begin();
1034 UserMacroSet::const_iterator end = usermacros.end();
1035 for (; cit != end; ++cit)
1036 pbuf->usermacros.insert(*cit);
1040 updateMacroInstances(InternalUpdate);
1045 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1047 Format const * fmt = formats.getFormat(format);
1050 // It is important to use the correct extension here, since some
1051 // converters create a wrong output file otherwise (e.g. html2latex)
1052 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1053 FileName const name(tempfile.name());
1054 ofdocstream os(name.toFilesystemEncoding().c_str());
1055 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1056 bool const success = !(os << contents).fail();
1059 bool converted = false;
1061 params().compressed = false;
1063 // remove dummy empty par
1064 paragraphs().clear();
1066 converted = importFile(format, name, errorList);
1075 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1077 if (!theConverters().isReachable(format, "lyx"))
1080 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1081 FileName const lyx(tempfile.name());
1082 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1083 return readFile(lyx) == ReadSuccess;
1089 bool Buffer::readString(string const & s)
1091 params().compressed = false;
1094 istringstream is(s);
1096 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1097 FileName const fn = tempfile.name();
1100 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1102 if (success && file_format != LYX_FORMAT) {
1103 // We need to call lyx2lyx, so write the input to a file
1104 ofstream os(fn.toFilesystemEncoding().c_str());
1107 // lyxvc in readFile
1108 if (readFile(fn) != ReadSuccess)
1112 if (readDocument(lex))
1118 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1122 if (!lex.setFile(fname)) {
1123 Alert::error(_("File Not Found"),
1124 bformat(_("Unable to open file `%1$s'."),
1125 from_utf8(fn.absFileName())));
1126 return ReadFileNotFound;
1130 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1131 if (ret_plf != ReadSuccess)
1134 if (file_format != LYX_FORMAT) {
1136 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1137 if (ret_clf != ReadSuccess)
1139 return readFile(tmpFile);
1142 // FIXME: InsetInfo needs to know whether the file is under VCS
1143 // during the parse process, so this has to be done before.
1144 lyxvc().file_found_hook(d->filename);
1146 if (readDocument(lex)) {
1147 Alert::error(_("Document format failure"),
1148 bformat(_("%1$s ended unexpectedly, which means"
1149 " that it is probably corrupted."),
1150 from_utf8(fn.absFileName())));
1151 return ReadDocumentFailure;
1154 d->file_fully_loaded = true;
1155 d->read_only = !d->filename.isWritable();
1156 params().compressed = formats.isZippedFile(d->filename);
1162 bool Buffer::isFullyLoaded() const
1164 return d->file_fully_loaded;
1168 void Buffer::setFullyLoaded(bool value)
1170 d->file_fully_loaded = value;
1174 bool Buffer::lastPreviewError() const
1176 return d->preview_error_;
1180 PreviewLoader * Buffer::loader() const
1182 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1184 if (!d->preview_loader_)
1185 d->preview_loader_ = new PreviewLoader(*this);
1186 return d->preview_loader_;
1190 void Buffer::removePreviews() const
1192 delete d->preview_loader_;
1193 d->preview_loader_ = 0;
1197 void Buffer::updatePreviews() const
1199 PreviewLoader * ploader = loader();
1203 InsetIterator it = inset_iterator_begin(*d->inset);
1204 InsetIterator const end = inset_iterator_end(*d->inset);
1205 for (; it != end; ++it)
1206 it->addPreview(it, *ploader);
1208 ploader->startLoading();
1212 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1213 FileName const & fn, int & file_format) const
1215 if(!lex.checkFor("\\lyxformat")) {
1216 Alert::error(_("Document format failure"),
1217 bformat(_("%1$s is not a readable LyX document."),
1218 from_utf8(fn.absFileName())));
1219 return ReadNoLyXFormat;
1225 // LyX formats 217 and earlier were written as 2.17. This corresponds
1226 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1227 // these cases. See also: www.lyx.org/trac/changeset/1313.
1228 size_t dot = tmp_format.find_first_of(".,");
1229 if (dot != string::npos)
1230 tmp_format.erase(dot, 1);
1232 file_format = convert<int>(tmp_format);
1237 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1238 FileName & tmpfile, int from_format)
1240 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1241 tempfile.setAutoRemove(false);
1242 tmpfile = tempfile.name();
1243 if(tmpfile.empty()) {
1244 Alert::error(_("Conversion failed"),
1245 bformat(_("%1$s is from a different"
1246 " version of LyX, but a temporary"
1247 " file for converting it could"
1248 " not be created."),
1249 from_utf8(fn.absFileName())));
1250 return LyX2LyXNoTempFile;
1253 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1254 if (lyx2lyx.empty()) {
1255 Alert::error(_("Conversion script not found"),
1256 bformat(_("%1$s is from a different"
1257 " version of LyX, but the"
1258 " conversion script lyx2lyx"
1259 " could not be found."),
1260 from_utf8(fn.absFileName())));
1261 return LyX2LyXNotFound;
1265 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1266 ostringstream command;
1267 command << os::python()
1268 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1269 << " -t " << convert<string>(LYX_FORMAT)
1270 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1271 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1272 string const command_str = command.str();
1274 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1276 cmd_ret const ret = runCommand(command_str);
1277 if (ret.first != 0) {
1278 if (from_format < LYX_FORMAT) {
1279 Alert::error(_("Conversion script failed"),
1280 bformat(_("%1$s is from an older version"
1281 " of LyX and the lyx2lyx script"
1282 " failed to convert it."),
1283 from_utf8(fn.absFileName())));
1284 return LyX2LyXOlderFormat;
1286 Alert::error(_("Conversion script failed"),
1287 bformat(_("%1$s is from a newer version"
1288 " of LyX and the lyx2lyx script"
1289 " failed to convert it."),
1290 from_utf8(fn.absFileName())));
1291 return LyX2LyXNewerFormat;
1298 // Should probably be moved to somewhere else: BufferView? GuiView?
1299 bool Buffer::save() const
1301 docstring const file = makeDisplayPath(absFileName(), 20);
1302 d->filename.refresh();
1304 // check the read-only status before moving the file as a backup
1305 if (d->filename.exists()) {
1306 bool const read_only = !d->filename.isWritable();
1308 Alert::warning(_("File is read-only"),
1309 bformat(_("The file %1$s cannot be written because it "
1310 "is marked as read-only."), file));
1315 // ask if the disk file has been externally modified (use checksum method)
1316 if (fileName().exists() && isExternallyModified(checksum_method)) {
1318 bformat(_("Document %1$s has been externally modified. "
1319 "Are you sure you want to overwrite this file?"), file);
1320 int const ret = Alert::prompt(_("Overwrite modified file?"),
1321 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1326 // We don't need autosaves in the immediate future. (Asger)
1327 resetAutosaveTimers();
1329 // if the file does not yet exist, none of the backup activity
1330 // that follows is necessary
1331 if (!fileName().exists()) {
1332 if (!writeFile(fileName()))
1338 // we first write the file to a new name, then move it to its
1339 // proper location once that has been done successfully. that
1340 // way we preserve the original file if something goes wrong.
1341 string const justname = fileName().onlyFileNameWithoutExt();
1342 boost::scoped_ptr<TempFile>
1343 tempfile(new TempFile(fileName().onlyPath(),
1344 justname + "-XXXXXX.lyx"));
1345 bool const symlink = fileName().isSymLink();
1347 tempfile->setAutoRemove(false);
1349 FileName savefile(tempfile->name());
1350 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1351 if (!writeFile(savefile))
1354 // we will set this to false if we fail
1355 bool made_backup = true;
1357 FileName backupName(absFileName() + '~');
1358 if (lyxrc.make_backup) {
1359 if (!lyxrc.backupdir_path.empty()) {
1360 string const mangledName =
1361 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1362 backupName = FileName(addName(lyxrc.backupdir_path,
1366 LYXERR(Debug::FILES, "Backing up original file to " <<
1367 backupName.absFileName());
1368 // Except file is symlink do not copy because of #6587.
1369 // Hard links have bad luck.
1370 made_backup = symlink ?
1371 fileName().copyTo(backupName):
1372 fileName().moveTo(backupName);
1375 Alert::error(_("Backup failure"),
1376 bformat(_("Cannot create backup file %1$s.\n"
1377 "Please check whether the directory exists and is writable."),
1378 from_utf8(backupName.absFileName())));
1379 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1383 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1384 // Only do this if tempfile is not in autoremove mode
1387 // If we have no symlink, we can simply rename the temp file.
1388 // Otherwise, we need to copy it so the symlink stays intact.
1389 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1390 savefile.moveTo(fileName()))
1392 // saveCheckSum() was already called by writeFile(), but the
1393 // time stamp is invalidated by copying/moving
1398 // else we saved the file, but failed to move it to the right location.
1400 if (lyxrc.make_backup && made_backup && !symlink) {
1401 // the original file was moved to filename.lyx~, so it will look
1402 // to the user as if it was deleted. (see bug #9234.) we could try
1403 // to restore it, but that would basically mean trying to do again
1404 // what we just failed to do. better to leave things as they are.
1405 Alert::error(_("Write failure"),
1406 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1407 "But LyX could not move it to:\n %2$s.\n"
1408 "Your original file has been backed up to:\n %3$s"),
1409 from_utf8(savefile.absFileName()),
1410 from_utf8(fileName().absFileName()),
1411 from_utf8(backupName.absFileName())));
1413 // either we did not try to make a backup, or else we tried and failed,
1414 // or else the original file was a symlink, in which case it was copied,
1415 // not moved. so the original file is intact.
1416 Alert::error(_("Write failure"),
1417 bformat(_("Cannot move saved file to:\n %1$s.\n"
1418 "But the file has successfully been saved as:\n %2$s."),
1419 from_utf8(fileName().absFileName()),
1420 from_utf8(savefile.absFileName())));
1426 bool Buffer::writeFile(FileName const & fname) const
1428 if (d->read_only && fname == d->filename)
1431 bool retval = false;
1433 docstring const str = bformat(_("Saving document %1$s..."),
1434 makeDisplayPath(fname.absFileName()));
1437 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1439 if (params().compressed) {
1440 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1441 retval = ofs && write(ofs);
1443 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1444 retval = ofs && write(ofs);
1448 message(str + _(" could not write file!"));
1453 // removeAutosaveFile();
1456 message(str + _(" done."));
1462 docstring Buffer::emergencyWrite()
1464 // No need to save if the buffer has not changed.
1468 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1470 docstring user_message = bformat(
1471 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1473 // We try to save three places:
1474 // 1) Same place as document. Unless it is an unnamed doc.
1476 string s = absFileName();
1479 if (writeFile(FileName(s))) {
1481 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1482 return user_message;
1484 user_message += " " + _("Save failed! Trying again...\n");
1488 // 2) In HOME directory.
1489 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1491 lyxerr << ' ' << s << endl;
1492 if (writeFile(FileName(s))) {
1494 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1495 return user_message;
1498 user_message += " " + _("Save failed! Trying yet again...\n");
1500 // 3) In "/tmp" directory.
1501 // MakeAbsPath to prepend the current
1502 // drive letter on OS/2
1503 s = addName(package().temp_dir().absFileName(), absFileName());
1505 lyxerr << ' ' << s << endl;
1506 if (writeFile(FileName(s))) {
1508 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1509 return user_message;
1512 user_message += " " + _("Save failed! Bummer. Document is lost.");
1515 return user_message;
1519 bool Buffer::write(ostream & ofs) const
1522 // Use the standard "C" locale for file output.
1523 ofs.imbue(locale::classic());
1526 // The top of the file should not be written by params().
1528 // write out a comment in the top of the file
1529 // Important: Keep the version formatting in sync with lyx2lyx and
1530 // tex2lyx (bug 7951)
1531 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1532 << " created this file. For more info see http://www.lyx.org/\n"
1533 << "\\lyxformat " << LYX_FORMAT << "\n"
1534 << "\\begin_document\n";
1536 /// For each author, set 'used' to true if there is a change
1537 /// by this author in the document; otherwise set it to 'false'.
1538 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1539 AuthorList::Authors::const_iterator a_end = params().authors().end();
1540 for (; a_it != a_end; ++a_it)
1541 a_it->setUsed(false);
1543 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1544 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1545 for ( ; it != end; ++it)
1546 it->checkAuthors(params().authors());
1548 // now write out the buffer parameters.
1549 ofs << "\\begin_header\n";
1550 params().writeFile(ofs, this);
1551 ofs << "\\end_header\n";
1554 ofs << "\n\\begin_body\n";
1556 ofs << "\n\\end_body\n";
1558 // Write marker that shows file is complete
1559 ofs << "\\end_document" << endl;
1561 // Shouldn't really be needed....
1564 // how to check if close went ok?
1565 // Following is an attempt... (BE 20001011)
1567 // good() returns false if any error occurred, including some
1568 // formatting error.
1569 // bad() returns true if something bad happened in the buffer,
1570 // which should include file system full errors.
1575 lyxerr << "File was not closed properly." << endl;
1582 bool Buffer::makeLaTeXFile(FileName const & fname,
1583 string const & original_path,
1584 OutputParams const & runparams_in,
1585 OutputWhat output) const
1587 OutputParams runparams = runparams_in;
1589 // XeTeX with TeX fonts is only safe with ASCII encoding,
1590 // See #9740 and FIXME in BufferParams::encoding()
1591 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX))
1592 runparams.encoding = encodings.fromLyXName("ascii");
1594 string const encoding = runparams.encoding->iconvName();
1595 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1598 try { ofs.reset(encoding); }
1599 catch (iconv_codecvt_facet_exception const & e) {
1600 lyxerr << "Caught iconv exception: " << e.what() << endl;
1601 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1602 "verify that the support software for your encoding (%1$s) is "
1603 "properly installed"), from_ascii(encoding)));
1606 if (!openFileWrite(ofs, fname))
1609 ErrorList & errorList = d->errorLists["Export"];
1611 bool failed_export = false;
1612 otexstream os(ofs, d->texrow);
1614 // make sure we are ready to export
1615 // this needs to be done before we validate
1616 // FIXME Do we need to do this all the time? I.e., in children
1617 // of a master we are exporting?
1619 updateMacroInstances(OutputUpdate);
1622 os.texrow().reset();
1623 writeLaTeXSource(os, original_path, runparams, output);
1625 catch (EncodingException const & e) {
1626 docstring const failed(1, e.failed_char);
1628 oss << "0x" << hex << e.failed_char << dec;
1629 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1630 " (code point %2$s)"),
1631 failed, from_utf8(oss.str()));
1632 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1633 "representable in the chosen encoding.\n"
1634 "Changing the document encoding to utf8 could help."),
1635 e.par_id, e.pos, e.pos + 1));
1636 failed_export = true;
1638 catch (iconv_codecvt_facet_exception const & e) {
1639 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1640 _(e.what()), -1, 0, 0));
1641 failed_export = true;
1643 catch (exception const & e) {
1644 errorList.push_back(ErrorItem(_("conversion failed"),
1645 _(e.what()), -1, 0, 0));
1646 failed_export = true;
1649 lyxerr << "Caught some really weird exception..." << endl;
1655 failed_export = true;
1656 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1659 if (runparams_in.silent)
1663 return !failed_export;
1667 void Buffer::writeLaTeXSource(otexstream & os,
1668 string const & original_path,
1669 OutputParams const & runparams_in,
1670 OutputWhat output) const
1672 // The child documents, if any, shall be already loaded at this point.
1674 OutputParams runparams = runparams_in;
1676 // XeTeX with TeX fonts is only safe with ASCII encoding,
1677 // See #9740 and FIXME in BufferParams::encoding()
1678 if (params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX))
1679 runparams.encoding = encodings.fromLyXName("ascii");
1681 // If we are compiling a file standalone, even if this is the
1682 // child of some other buffer, let's cut the link here, so the
1683 // file is really independent and no concurring settings from
1684 // the master (e.g. branch state) interfere (see #8100).
1685 if (!runparams.is_child)
1686 d->ignore_parent = true;
1688 // Classify the unicode characters appearing in math insets
1689 BufferEncodings::initUnicodeMath(*this);
1691 // validate the buffer.
1692 LYXERR(Debug::LATEX, " Validating buffer...");
1693 LaTeXFeatures features(*this, params(), runparams);
1695 // This is only set once per document (in master)
1696 if (!runparams.is_child)
1697 runparams.use_polyglossia = features.usePolyglossia();
1698 LYXERR(Debug::LATEX, " Buffer validation done.");
1700 bool const output_preamble =
1701 output == FullSource || output == OnlyPreamble;
1702 bool const output_body =
1703 output == FullSource || output == OnlyBody;
1705 // The starting paragraph of the coming rows is the
1706 // first paragraph of the document. (Asger)
1707 if (output_preamble && runparams.nice) {
1708 os << "%% LyX " << lyx_version << " created this file. "
1709 "For more info, see http://www.lyx.org/.\n"
1710 "%% Do not edit unless you really know what "
1713 LYXERR(Debug::INFO, "lyx document header finished");
1715 // There are a few differences between nice LaTeX and usual files:
1716 // usual files have \batchmode and special input@path to allow
1717 // inclusion of figures specified by an explicitly relative path
1718 // (i.e., a path starting with './' or '../') with either \input or
1719 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1720 // input@path is set when the actual parameter original_path is set.
1721 // This is done for usual tex-file, but not for nice-latex-file.
1722 // (Matthias 250696)
1723 // Note that input@path is only needed for something the user does
1724 // in the preamble, included .tex files or ERT, files included by
1725 // LyX work without it.
1726 if (output_preamble) {
1727 if (!runparams.nice) {
1728 // code for usual, NOT nice-latex-file
1729 os << "\\batchmode\n"; // changed from \nonstopmode
1731 if (!original_path.empty()) {
1733 // We don't know the encoding of inputpath
1734 docstring const inputpath = from_utf8(original_path);
1735 docstring uncodable_glyphs;
1736 Encoding const * const enc = runparams.encoding;
1738 for (size_t n = 0; n < inputpath.size(); ++n) {
1739 if (!enc->encodable(inputpath[n])) {
1740 docstring const glyph(1, inputpath[n]);
1741 LYXERR0("Uncodable character '"
1743 << "' in input path!");
1744 uncodable_glyphs += glyph;
1749 // warn user if we found uncodable glyphs.
1750 if (!uncodable_glyphs.empty()) {
1751 frontend::Alert::warning(
1752 _("Uncodable character in file path"),
1754 _("The path of your document\n"
1756 "contains glyphs that are unknown "
1757 "in the current document encoding "
1758 "(namely %2$s). This may result in "
1759 "incomplete output, unless "
1760 "TEXINPUTS contains the document "
1761 "directory and you don't use "
1762 "explicitly relative paths (i.e., "
1763 "paths starting with './' or "
1764 "'../') in the preamble or in ERT."
1765 "\n\nIn case of problems, choose "
1766 "an appropriate document encoding\n"
1767 "(such as utf8) or change the "
1769 inputpath, uncodable_glyphs));
1772 support::latex_path(original_path);
1773 if (contains(docdir, '#')) {
1774 docdir = subst(docdir, "#", "\\#");
1775 os << "\\catcode`\\#=11"
1776 "\\def\\#{#}\\catcode`\\#=6\n";
1778 if (contains(docdir, '%')) {
1779 docdir = subst(docdir, "%", "\\%");
1780 os << "\\catcode`\\%=11"
1781 "\\def\\%{%}\\catcode`\\%=14\n";
1783 os << "\\makeatletter\n"
1784 << "\\def\\input@path{{"
1786 << "\\makeatother\n";
1790 // get parent macros (if this buffer has a parent) which will be
1791 // written at the document begin further down.
1792 MacroSet parentMacros;
1793 listParentMacros(parentMacros, features);
1795 // Write the preamble
1796 runparams.use_babel = params().writeLaTeX(os, features,
1797 d->filename.onlyPath());
1799 // Japanese might be required only in some children of a document,
1800 // but once required, we must keep use_japanese true.
1801 runparams.use_japanese |= features.isRequired("japanese");
1804 // Restore the parenthood if needed
1805 if (!runparams.is_child)
1806 d->ignore_parent = false;
1811 os << "\\begin{document}\n";
1813 // output the parent macros
1814 MacroSet::iterator it = parentMacros.begin();
1815 MacroSet::iterator end = parentMacros.end();
1816 for (; it != end; ++it) {
1817 int num_lines = (*it)->write(os.os(), true);
1818 os.texrow().newlines(num_lines);
1821 } // output_preamble
1823 os.texrow().start(paragraphs().begin()->id(), 0);
1825 LYXERR(Debug::INFO, "preamble finished, now the body.");
1828 latexParagraphs(*this, text(), os, runparams);
1830 // Restore the parenthood if needed
1831 if (!runparams.is_child)
1832 d->ignore_parent = false;
1834 // add this just in case after all the paragraphs
1837 if (output_preamble) {
1838 os << "\\end{document}\n";
1839 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1841 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1843 runparams_in.encoding = runparams.encoding;
1845 os.texrow().finalize();
1847 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1848 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1852 void Buffer::makeDocBookFile(FileName const & fname,
1853 OutputParams const & runparams,
1854 OutputWhat output) const
1856 LYXERR(Debug::LATEX, "makeDocBookFile...");
1859 if (!openFileWrite(ofs, fname))
1862 // make sure we are ready to export
1863 // this needs to be done before we validate
1865 updateMacroInstances(OutputUpdate);
1867 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1871 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1875 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1876 OutputParams const & runparams,
1877 OutputWhat output) const
1879 LaTeXFeatures features(*this, params(), runparams);
1882 d->texrow.reset(false);
1884 DocumentClass const & tclass = params().documentClass();
1885 string const & top_element = tclass.latexname();
1887 bool const output_preamble =
1888 output == FullSource || output == OnlyPreamble;
1889 bool const output_body =
1890 output == FullSource || output == OnlyBody;
1892 if (output_preamble) {
1893 if (runparams.flavor == OutputParams::XML)
1894 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1897 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1900 if (! tclass.class_header().empty())
1901 os << from_ascii(tclass.class_header());
1902 else if (runparams.flavor == OutputParams::XML)
1903 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1904 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1906 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1908 docstring preamble = from_utf8(params().preamble);
1909 if (runparams.flavor != OutputParams::XML ) {
1910 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1911 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1912 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1913 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1916 string const name = runparams.nice
1917 ? changeExtension(absFileName(), ".sgml") : fname;
1918 preamble += features.getIncludedFiles(name);
1919 preamble += features.getLyXSGMLEntities();
1921 if (!preamble.empty()) {
1922 os << "\n [ " << preamble << " ]";
1928 string top = top_element;
1930 if (runparams.flavor == OutputParams::XML)
1931 top += params().language->code();
1933 top += params().language->code().substr(0, 2);
1936 if (!params().options.empty()) {
1938 top += params().options;
1941 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1942 << " file was created by LyX " << lyx_version
1943 << "\n See http://www.lyx.org/ for more information -->\n";
1945 params().documentClass().counters().reset();
1947 sgml::openTag(os, top);
1949 docbookParagraphs(text(), *this, os, runparams);
1950 sgml::closeTag(os, top_element);
1955 void Buffer::makeLyXHTMLFile(FileName const & fname,
1956 OutputParams const & runparams) const
1958 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1961 if (!openFileWrite(ofs, fname))
1964 // make sure we are ready to export
1965 // this has to be done before we validate
1966 updateBuffer(UpdateMaster, OutputUpdate);
1967 updateMacroInstances(OutputUpdate);
1969 writeLyXHTMLSource(ofs, runparams, FullSource);
1973 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1977 void Buffer::writeLyXHTMLSource(odocstream & os,
1978 OutputParams const & runparams,
1979 OutputWhat output) const
1981 LaTeXFeatures features(*this, params(), runparams);
1983 d->bibinfo_.makeCitationLabels(*this);
1985 bool const output_preamble =
1986 output == FullSource || output == OnlyPreamble;
1987 bool const output_body =
1988 output == FullSource || output == OnlyBody || output == IncludedFile;
1990 if (output_preamble) {
1991 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1992 << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN\" \"http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd\">\n"
1993 // FIXME Language should be set properly.
1994 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
1996 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
1997 // FIXME Presumably need to set this right
1998 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2000 docstring const & doctitle = features.htmlTitle();
2002 << (doctitle.empty() ?
2003 from_ascii("LyX Document") :
2004 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2007 docstring styles = features.getTClassHTMLPreamble();
2008 if (!styles.empty())
2009 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2011 styles = from_utf8(features.getPreambleSnippets());
2012 if (!styles.empty())
2013 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2015 // we will collect CSS information in a stream, and then output it
2016 // either here, as part of the header, or else in a separate file.
2017 odocstringstream css;
2018 styles = from_utf8(features.getCSSSnippets());
2019 if (!styles.empty())
2020 css << "/* LyX Provided Styles */\n" << styles << '\n';
2022 styles = features.getTClassHTMLStyles();
2023 if (!styles.empty())
2024 css << "/* Layout-provided Styles */\n" << styles << '\n';
2026 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2027 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2028 if (needfg || needbg) {
2029 css << "\nbody {\n";
2032 << from_ascii(X11hexname(params().fontcolor))
2035 css << " background-color: "
2036 << from_ascii(X11hexname(params().backgroundcolor))
2041 docstring const dstyles = css.str();
2042 if (!dstyles.empty()) {
2043 bool written = false;
2044 if (params().html_css_as_file) {
2045 // open a file for CSS info
2047 string const fcssname = addName(temppath(), "docstyle.css");
2048 FileName const fcssfile = FileName(fcssname);
2049 if (openFileWrite(ocss, fcssfile)) {
2053 // write link to header
2054 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2056 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2059 // we are here if the CSS is supposed to be written to the header
2060 // or if we failed to write it to an external file.
2062 os << "<style type='text/css'>\n"
2071 bool const output_body_tag = (output != IncludedFile);
2072 if (output_body_tag)
2075 if (output != IncludedFile)
2076 // if we're an included file, the counters are in the master.
2077 params().documentClass().counters().reset();
2078 xhtmlParagraphs(text(), *this, xs, runparams);
2079 if (output_body_tag)
2083 if (output_preamble)
2088 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2089 // Other flags: -wall -v0 -x
2090 int Buffer::runChktex()
2094 // get LaTeX-Filename
2095 FileName const path(temppath());
2096 string const name = addName(path.absFileName(), latexName());
2097 string const org_path = filePath();
2099 PathChanger p(path); // path to LaTeX file
2100 message(_("Running chktex..."));
2102 // Generate the LaTeX file if neccessary
2103 OutputParams runparams(¶ms().encoding());
2104 runparams.flavor = OutputParams::LATEX;
2105 runparams.nice = false;
2106 runparams.linelen = lyxrc.plaintext_linelen;
2107 makeLaTeXFile(FileName(name), org_path, runparams);
2110 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2111 int const res = chktex.run(terr); // run chktex
2114 Alert::error(_("chktex failure"),
2115 _("Could not run chktex successfully."));
2117 ErrorList & errlist = d->errorLists["ChkTeX"];
2119 bufferErrors(terr, errlist);
2124 if (runparams.silent)
2125 d->errorLists["ChkTeX"].clear();
2133 void Buffer::validate(LaTeXFeatures & features) const
2135 // Validate the buffer params, but not for included
2136 // files, since they also use the parent buffer's
2138 if (!features.runparams().is_child)
2139 params().validate(features);
2141 for_each(paragraphs().begin(), paragraphs().end(),
2142 bind(&Paragraph::validate, _1, ref(features)));
2144 if (lyxerr.debugging(Debug::LATEX)) {
2145 features.showStruct();
2150 void Buffer::getLabelList(vector<docstring> & list) const
2152 // If this is a child document, use the master's list instead.
2154 masterBuffer()->getLabelList(list);
2159 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2160 TocIterator toc_it = toc->begin();
2161 TocIterator end = toc->end();
2162 for (; toc_it != end; ++toc_it) {
2163 if (toc_it->depth() == 0)
2164 list.push_back(toc_it->str());
2169 void Buffer::updateBibfilesCache(UpdateScope scope) const
2171 // FIXME This is probably unnecssary, given where we call this.
2172 // If this is a child document, use the parent's cache instead.
2173 if (parent() && scope != UpdateChildOnly) {
2174 masterBuffer()->updateBibfilesCache();
2178 d->bibfiles_cache_.clear();
2179 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2180 if (it->lyxCode() == BIBTEX_CODE) {
2181 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2182 support::FileNameList const bibfiles = inset.getBibFiles();
2183 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2186 } else if (it->lyxCode() == INCLUDE_CODE) {
2187 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2188 Buffer const * const incbuf = inset.getChildBuffer();
2191 support::FileNameList const & bibfiles =
2192 incbuf->getBibfilesCache(UpdateChildOnly);
2193 if (!bibfiles.empty()) {
2194 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2200 d->bibfile_cache_valid_ = true;
2201 d->bibinfo_cache_valid_ = false;
2202 d->cite_labels_valid_ = false;
2206 void Buffer::invalidateBibinfoCache() const
2208 d->bibinfo_cache_valid_ = false;
2209 d->cite_labels_valid_ = false;
2210 // also invalidate the cache for the parent buffer
2211 Buffer const * const pbuf = d->parent();
2213 pbuf->invalidateBibinfoCache();
2217 void Buffer::invalidateBibfileCache() const
2219 d->bibfile_cache_valid_ = false;
2220 d->bibinfo_cache_valid_ = false;
2221 d->cite_labels_valid_ = false;
2222 // also invalidate the cache for the parent buffer
2223 Buffer const * const pbuf = d->parent();
2225 pbuf->invalidateBibfileCache();
2229 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2231 // FIXME This is probably unnecessary, given where we call this.
2232 // If this is a child document, use the master's cache instead.
2233 Buffer const * const pbuf = masterBuffer();
2234 if (pbuf != this && scope != UpdateChildOnly)
2235 return pbuf->getBibfilesCache();
2237 if (!d->bibfile_cache_valid_)
2238 this->updateBibfilesCache(scope);
2240 return d->bibfiles_cache_;
2244 BiblioInfo const & Buffer::masterBibInfo() const
2246 Buffer const * const tmp = masterBuffer();
2248 return tmp->masterBibInfo();
2253 void Buffer::checkIfBibInfoCacheIsValid() const
2255 // use the master's cache
2256 Buffer const * const tmp = masterBuffer();
2258 tmp->checkIfBibInfoCacheIsValid();
2262 // compare the cached timestamps with the actual ones.
2263 FileNameList const & bibfiles_cache = getBibfilesCache();
2264 FileNameList::const_iterator ei = bibfiles_cache.begin();
2265 FileNameList::const_iterator en = bibfiles_cache.end();
2266 for (; ei != en; ++ ei) {
2267 time_t lastw = ei->lastModified();
2268 time_t prevw = d->bibfile_status_[*ei];
2269 if (lastw != prevw) {
2270 d->bibinfo_cache_valid_ = false;
2271 d->cite_labels_valid_ = false;
2272 d->bibfile_status_[*ei] = lastw;
2278 void Buffer::reloadBibInfoCache() const
2280 // use the master's cache
2281 Buffer const * const tmp = masterBuffer();
2283 tmp->reloadBibInfoCache();
2287 checkIfBibInfoCacheIsValid();
2288 if (d->bibinfo_cache_valid_)
2291 d->bibinfo_.clear();
2293 d->bibinfo_cache_valid_ = true;
2297 void Buffer::collectBibKeys() const
2299 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2300 it->collectBibKeys(it);
2304 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2306 Buffer const * tmp = masterBuffer();
2307 BiblioInfo & masterbi = (tmp == this) ?
2308 d->bibinfo_ : tmp->d->bibinfo_;
2309 masterbi.mergeBiblioInfo(bi);
2313 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2315 Buffer const * tmp = masterBuffer();
2316 BiblioInfo & masterbi = (tmp == this) ?
2317 d->bibinfo_ : tmp->d->bibinfo_;
2322 void Buffer::makeCitationLabels() const
2324 Buffer const * const master = masterBuffer();
2325 return d->bibinfo_.makeCitationLabels(*master);
2329 bool Buffer::citeLabelsValid() const
2331 return masterBuffer()->d->cite_labels_valid_;
2335 void Buffer::removeBiblioTempFiles() const
2337 // We remove files that contain LaTeX commands specific to the
2338 // particular bibliographic style being used, in order to avoid
2339 // LaTeX errors when we switch style.
2340 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2341 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2342 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2343 aux_file.removeFile();
2344 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2345 bbl_file.removeFile();
2346 // Also for the parent buffer
2347 Buffer const * const pbuf = parent();
2349 pbuf->removeBiblioTempFiles();
2353 bool Buffer::isDepClean(string const & name) const
2355 DepClean::const_iterator const it = d->dep_clean.find(name);
2356 if (it == d->dep_clean.end())
2362 void Buffer::markDepClean(string const & name)
2364 d->dep_clean[name] = true;
2368 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2371 // FIXME? if there is an Buffer LFUN that can be dispatched even
2372 // if internal, put a switch '(cmd.action)' here.
2378 switch (cmd.action()) {
2380 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2381 flag.setOnOff(isReadonly());
2384 // FIXME: There is need for a command-line import.
2385 //case LFUN_BUFFER_IMPORT:
2387 case LFUN_BUFFER_AUTO_SAVE:
2390 case LFUN_BUFFER_EXPORT_CUSTOM:
2391 // FIXME: Nothing to check here?
2394 case LFUN_BUFFER_EXPORT: {
2395 docstring const arg = cmd.argument();
2396 if (arg == "custom") {
2400 string format = to_utf8(arg);
2401 size_t pos = format.find(' ');
2402 if (pos != string::npos)
2403 format = format.substr(0, pos);
2404 enable = params().isExportable(format);
2406 flag.message(bformat(
2407 _("Don't know how to export to format: %1$s"), arg));
2411 case LFUN_BUFFER_CHKTEX:
2412 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2415 case LFUN_BUILD_PROGRAM:
2416 enable = params().isExportable("program");
2419 case LFUN_BRANCH_ACTIVATE:
2420 case LFUN_BRANCH_DEACTIVATE:
2421 case LFUN_BRANCH_MASTER_ACTIVATE:
2422 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2423 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2424 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2425 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2426 : params().branchlist();
2427 docstring const branchName = cmd.argument();
2428 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2432 case LFUN_BRANCH_ADD:
2433 case LFUN_BRANCHES_RENAME:
2434 // if no Buffer is present, then of course we won't be called!
2437 case LFUN_BUFFER_LANGUAGE:
2438 enable = !isReadonly();
2441 case LFUN_BUFFER_VIEW_CACHE:
2442 (d->preview_file_).refresh();
2443 enable = (d->preview_file_).exists();
2449 flag.setEnabled(enable);
2454 void Buffer::dispatch(string const & command, DispatchResult & result)
2456 return dispatch(lyxaction.lookupFunc(command), result);
2460 // NOTE We can end up here even if we have no GUI, because we are called
2461 // by LyX::exec to handled command-line requests. So we may need to check
2462 // whether we have a GUI or not. The boolean use_gui holds this information.
2463 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2466 // FIXME? if there is an Buffer LFUN that can be dispatched even
2467 // if internal, put a switch '(cmd.action())' here.
2468 dr.dispatched(false);
2471 string const argument = to_utf8(func.argument());
2472 // We'll set this back to false if need be.
2473 bool dispatched = true;
2474 undo().beginUndoGroup();
2476 switch (func.action()) {
2477 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2478 if (lyxvc().inUse()) {
2479 string log = lyxvc().toggleReadOnly();
2484 setReadonly(!isReadonly());
2487 case LFUN_BUFFER_EXPORT: {
2488 ExportStatus const status = doExport(argument, false);
2489 dr.setError(status != ExportSuccess);
2490 if (status != ExportSuccess)
2491 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2496 case LFUN_BUILD_PROGRAM: {
2497 ExportStatus const status = doExport("program", true);
2498 dr.setError(status != ExportSuccess);
2499 if (status != ExportSuccess)
2500 dr.setMessage(_("Error generating literate programming code."));
2504 case LFUN_BUFFER_CHKTEX:
2508 case LFUN_BUFFER_EXPORT_CUSTOM: {
2510 string command = split(argument, format_name, ' ');
2511 Format const * format = formats.getFormat(format_name);
2513 lyxerr << "Format \"" << format_name
2514 << "\" not recognized!"
2519 // The name of the file created by the conversion process
2522 // Output to filename
2523 if (format->name() == "lyx") {
2524 string const latexname = latexName(false);
2525 filename = changeExtension(latexname,
2526 format->extension());
2527 filename = addName(temppath(), filename);
2529 if (!writeFile(FileName(filename)))
2533 doExport(format_name, true, filename);
2536 // Substitute $$FName for filename
2537 if (!contains(command, "$$FName"))
2538 command = "( " + command + " ) < $$FName";
2539 command = subst(command, "$$FName", filename);
2541 // Execute the command in the background
2543 call.startscript(Systemcall::DontWait, command,
2544 filePath(), layoutPos());
2548 // FIXME: There is need for a command-line import.
2550 case LFUN_BUFFER_IMPORT:
2555 case LFUN_BUFFER_AUTO_SAVE:
2557 resetAutosaveTimers();
2560 case LFUN_BRANCH_ACTIVATE:
2561 case LFUN_BRANCH_DEACTIVATE:
2562 case LFUN_BRANCH_MASTER_ACTIVATE:
2563 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2564 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2565 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2566 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2569 docstring const branch_name = func.argument();
2570 // the case without a branch name is handled elsewhere
2571 if (branch_name.empty()) {
2575 Branch * branch = buf->params().branchlist().find(branch_name);
2577 LYXERR0("Branch " << branch_name << " does not exist.");
2579 docstring const msg =
2580 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2584 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2585 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2586 if (branch->isSelected() != activate) {
2587 buf->undo().recordUndoBufferParams(CursorData());
2588 branch->setSelected(activate);
2590 dr.screenUpdate(Update::Force);
2591 dr.forceBufferUpdate();
2596 case LFUN_BRANCH_ADD: {
2597 docstring branch_name = func.argument();
2598 if (branch_name.empty()) {
2602 BranchList & branch_list = params().branchlist();
2603 vector<docstring> const branches =
2604 getVectorFromString(branch_name, branch_list.separator());
2606 for (vector<docstring>::const_iterator it = branches.begin();
2607 it != branches.end(); ++it) {
2609 Branch * branch = branch_list.find(branch_name);
2611 LYXERR0("Branch " << branch_name << " already exists.");
2615 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2617 undo().recordUndoBufferParams(CursorData());
2618 branch_list.add(branch_name);
2619 branch = branch_list.find(branch_name);
2620 string const x11hexname = X11hexname(branch->color());
2621 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2622 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2624 dr.screenUpdate(Update::Force);
2632 case LFUN_BRANCHES_RENAME: {
2633 if (func.argument().empty())
2636 docstring const oldname = from_utf8(func.getArg(0));
2637 docstring const newname = from_utf8(func.getArg(1));
2638 InsetIterator it = inset_iterator_begin(inset());
2639 InsetIterator const end = inset_iterator_end(inset());
2640 bool success = false;
2641 for (; it != end; ++it) {
2642 if (it->lyxCode() == BRANCH_CODE) {
2643 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2644 if (ins.branch() == oldname) {
2645 undo().recordUndo(CursorData(it));
2646 ins.rename(newname);
2651 if (it->lyxCode() == INCLUDE_CODE) {
2652 // get buffer of external file
2653 InsetInclude const & ins =
2654 static_cast<InsetInclude const &>(*it);
2655 Buffer * child = ins.getChildBuffer();
2658 child->dispatch(func, dr);
2663 dr.screenUpdate(Update::Force);
2664 dr.forceBufferUpdate();
2669 case LFUN_BUFFER_VIEW_CACHE:
2670 if (!formats.view(*this, d->preview_file_,
2671 d->preview_format_))
2672 dr.setMessage(_("Error viewing the output file."));
2679 dr.dispatched(dispatched);
2680 undo().endUndoGroup();
2684 void Buffer::changeLanguage(Language const * from, Language const * to)
2686 LASSERT(from, return);
2687 LASSERT(to, return);
2689 for_each(par_iterator_begin(),
2691 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2695 bool Buffer::isMultiLingual() const
2697 ParConstIterator end = par_iterator_end();
2698 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2699 if (it->isMultiLingual(params()))
2706 std::set<Language const *> Buffer::getLanguages() const
2708 std::set<Language const *> languages;
2709 getLanguages(languages);
2714 void Buffer::getLanguages(std::set<Language const *> & languages) const
2716 ParConstIterator end = par_iterator_end();
2717 // add the buffer language, even if it's not actively used
2718 languages.insert(language());
2719 // iterate over the paragraphs
2720 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2721 it->getLanguages(languages);
2723 ListOfBuffers clist = getDescendents();
2724 ListOfBuffers::const_iterator cit = clist.begin();
2725 ListOfBuffers::const_iterator const cen = clist.end();
2726 for (; cit != cen; ++cit)
2727 (*cit)->getLanguages(languages);
2731 DocIterator Buffer::getParFromID(int const id) const
2733 Buffer * buf = const_cast<Buffer *>(this);
2735 // John says this is called with id == -1 from undo
2736 lyxerr << "getParFromID(), id: " << id << endl;
2737 return doc_iterator_end(buf);
2740 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2741 if (it.paragraph().id() == id)
2744 return doc_iterator_end(buf);
2748 bool Buffer::hasParWithID(int const id) const
2750 return !getParFromID(id).atEnd();
2754 ParIterator Buffer::par_iterator_begin()
2756 return ParIterator(doc_iterator_begin(this));
2760 ParIterator Buffer::par_iterator_end()
2762 return ParIterator(doc_iterator_end(this));
2766 ParConstIterator Buffer::par_iterator_begin() const
2768 return ParConstIterator(doc_iterator_begin(this));
2772 ParConstIterator Buffer::par_iterator_end() const
2774 return ParConstIterator(doc_iterator_end(this));
2778 Language const * Buffer::language() const
2780 return params().language;
2784 docstring const Buffer::B_(string const & l10n) const
2786 return params().B_(l10n);
2790 bool Buffer::isClean() const
2792 return d->lyx_clean;
2796 bool Buffer::isExternallyModified(CheckMethod method) const
2798 LASSERT(d->filename.exists(), return false);
2799 // if method == timestamp, check timestamp before checksum
2800 return (method == checksum_method
2801 || d->timestamp_ != d->filename.lastModified())
2802 && d->checksum_ != d->filename.checksum();
2806 void Buffer::saveCheckSum() const
2808 FileName const & file = d->filename;
2811 if (file.exists()) {
2812 d->timestamp_ = file.lastModified();
2813 d->checksum_ = file.checksum();
2815 // in the case of save to a new file.
2822 void Buffer::markClean() const
2824 if (!d->lyx_clean) {
2825 d->lyx_clean = true;
2828 // if the .lyx file has been saved, we don't need an
2830 d->bak_clean = true;
2831 d->undo_.markDirty();
2835 void Buffer::setUnnamed(bool flag)
2841 bool Buffer::isUnnamed() const
2848 /// Don't check unnamed, here: isInternal() is used in
2849 /// newBuffer(), where the unnamed flag has not been set by anyone
2850 /// yet. Also, for an internal buffer, there should be no need for
2851 /// retrieving fileName() nor for checking if it is unnamed or not.
2852 bool Buffer::isInternal() const
2854 return d->internal_buffer;
2858 void Buffer::setInternal(bool flag)
2860 d->internal_buffer = flag;
2864 void Buffer::markDirty()
2867 d->lyx_clean = false;
2870 d->bak_clean = false;
2872 DepClean::iterator it = d->dep_clean.begin();
2873 DepClean::const_iterator const end = d->dep_clean.end();
2875 for (; it != end; ++it)
2880 FileName Buffer::fileName() const
2886 string Buffer::absFileName() const
2888 return d->filename.absFileName();
2892 string Buffer::filePath() const
2894 string const abs = d->filename.onlyPath().absFileName();
2897 int last = abs.length() - 1;
2899 return abs[last] == '/' ? abs : abs + '/';
2903 string Buffer::originFilePath() const
2905 if (FileName::isAbsolute(params().origin))
2906 return params().origin;
2912 string Buffer::layoutPos() const
2914 return d->layout_position;
2918 void Buffer::setLayoutPos(string const & path)
2921 d->layout_position.clear();
2925 LATTEST(FileName::isAbsolute(path));
2927 d->layout_position =
2928 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
2930 if (d->layout_position.empty())
2931 d->layout_position = ".";
2935 bool Buffer::isReadonly() const
2937 return d->read_only;
2941 void Buffer::setParent(Buffer const * buffer)
2943 // Avoids recursive include.
2944 d->setParent(buffer == this ? 0 : buffer);
2949 Buffer const * Buffer::parent() const
2955 ListOfBuffers Buffer::allRelatives() const
2957 ListOfBuffers lb = masterBuffer()->getDescendents();
2958 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2963 Buffer const * Buffer::masterBuffer() const
2965 // FIXME Should be make sure we are not in some kind
2966 // of recursive include? A -> B -> A will crash this.
2967 Buffer const * const pbuf = d->parent();
2971 return pbuf->masterBuffer();
2975 bool Buffer::isChild(Buffer * child) const
2977 return d->children_positions.find(child) != d->children_positions.end();
2981 DocIterator Buffer::firstChildPosition(Buffer const * child)
2983 Impl::BufferPositionMap::iterator it;
2984 it = d->children_positions.find(child);
2985 if (it == d->children_positions.end())
2986 return DocIterator(this);
2991 bool Buffer::hasChildren() const
2993 return !d->children_positions.empty();
2997 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
2999 // loop over children
3000 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3001 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3002 for (; it != end; ++it) {
3003 Buffer * child = const_cast<Buffer *>(it->first);
3005 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3006 if (bit != clist.end())
3008 clist.push_back(child);
3010 // there might be grandchildren
3011 child->collectChildren(clist, true);
3016 ListOfBuffers Buffer::getChildren() const
3019 collectChildren(v, false);
3020 // Make sure we have not included ourselves.
3021 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3022 if (bit != v.end()) {
3023 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3030 ListOfBuffers Buffer::getDescendents() const
3033 collectChildren(v, true);
3034 // Make sure we have not included ourselves.
3035 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3036 if (bit != v.end()) {
3037 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3044 template<typename M>
3045 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3050 typename M::const_iterator it = m.lower_bound(x);
3051 if (it == m.begin())
3059 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3060 DocIterator const & pos) const
3062 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3064 // if paragraphs have no macro context set, pos will be empty
3068 // we haven't found anything yet
3069 DocIterator bestPos = owner_->par_iterator_begin();
3070 MacroData const * bestData = 0;
3072 // find macro definitions for name
3073 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3074 if (nameIt != macros.end()) {
3075 // find last definition in front of pos or at pos itself
3076 PositionScopeMacroMap::const_iterator it
3077 = greatest_below(nameIt->second, pos);
3078 if (it != nameIt->second.end()) {
3080 // scope ends behind pos?
3081 if (pos < it->second.scope) {
3082 // Looks good, remember this. If there
3083 // is no external macro behind this,
3084 // we found the right one already.
3085 bestPos = it->first;
3086 bestData = &it->second.macro;
3090 // try previous macro if there is one
3091 if (it == nameIt->second.begin())
3098 // find macros in included files
3099 PositionScopeBufferMap::const_iterator it
3100 = greatest_below(position_to_children, pos);
3101 if (it == position_to_children.end())
3102 // no children before
3106 // do we know something better (i.e. later) already?
3107 if (it->first < bestPos )
3110 // scope ends behind pos?
3111 if (pos < it->second.scope
3112 && (cloned_buffer_ ||
3113 theBufferList().isLoaded(it->second.buffer))) {
3114 // look for macro in external file
3116 MacroData const * data
3117 = it->second.buffer->getMacro(name, false);
3120 bestPos = it->first;
3126 // try previous file if there is one
3127 if (it == position_to_children.begin())
3132 // return the best macro we have found
3137 MacroData const * Buffer::getMacro(docstring const & name,
3138 DocIterator const & pos, bool global) const
3143 // query buffer macros
3144 MacroData const * data = d->getBufferMacro(name, pos);
3148 // If there is a master buffer, query that
3149 Buffer const * const pbuf = d->parent();
3151 d->macro_lock = true;
3152 MacroData const * macro = pbuf->getMacro(
3153 name, *this, false);
3154 d->macro_lock = false;
3160 data = MacroTable::globalMacros().get(name);
3169 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3171 // set scope end behind the last paragraph
3172 DocIterator scope = par_iterator_begin();
3173 scope.pit() = scope.lastpit() + 1;
3175 return getMacro(name, scope, global);
3179 MacroData const * Buffer::getMacro(docstring const & name,
3180 Buffer const & child, bool global) const
3182 // look where the child buffer is included first
3183 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3184 if (it == d->children_positions.end())
3187 // check for macros at the inclusion position
3188 return getMacro(name, it->second, global);
3192 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3194 pit_type const lastpit = it.lastpit();
3196 // look for macros in each paragraph
3197 while (it.pit() <= lastpit) {
3198 Paragraph & par = it.paragraph();
3200 // iterate over the insets of the current paragraph
3201 InsetList const & insets = par.insetList();
3202 InsetList::const_iterator iit = insets.begin();
3203 InsetList::const_iterator end = insets.end();
3204 for (; iit != end; ++iit) {
3205 it.pos() = iit->pos;
3207 // is it a nested text inset?
3208 if (iit->inset->asInsetText()) {
3209 // Inset needs its own scope?
3210 InsetText const * itext = iit->inset->asInsetText();
3211 bool newScope = itext->isMacroScope();
3213 // scope which ends just behind the inset
3214 DocIterator insetScope = it;
3217 // collect macros in inset
3218 it.push_back(CursorSlice(*iit->inset));
3219 updateMacros(it, newScope ? insetScope : scope);
3224 if (iit->inset->asInsetTabular()) {
3225 CursorSlice slice(*iit->inset);
3226 size_t const numcells = slice.nargs();
3227 for (; slice.idx() < numcells; slice.forwardIdx()) {
3228 it.push_back(slice);
3229 updateMacros(it, scope);
3235 // is it an external file?
3236 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3237 // get buffer of external file
3238 InsetInclude const & inset =
3239 static_cast<InsetInclude const &>(*iit->inset);
3241 Buffer * child = inset.getChildBuffer();
3246 // register its position, but only when it is
3247 // included first in the buffer
3248 if (children_positions.find(child) ==
3249 children_positions.end())
3250 children_positions[child] = it;
3252 // register child with its scope
3253 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3257 InsetMath * im = iit->inset->asInsetMath();
3258 if (doing_export && im) {
3259 InsetMathHull * hull = im->asHullInset();
3261 hull->recordLocation(it);
3264 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3268 MathMacroTemplate & macroTemplate =
3269 *iit->inset->asInsetMath()->asMacroTemplate();
3270 MacroContext mc(owner_, it);
3271 macroTemplate.updateToContext(mc);
3274 bool valid = macroTemplate.validMacro();
3275 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3276 // then the BufferView's cursor will be invalid in
3277 // some cases which leads to crashes.
3282 // FIXME (Abdel), I don't understand why we pass 'it' here
3283 // instead of 'macroTemplate' defined above... is this correct?
3284 macros[macroTemplate.name()][it] =
3285 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3295 void Buffer::updateMacros() const
3300 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3302 // start with empty table
3304 d->children_positions.clear();
3305 d->position_to_children.clear();
3307 // Iterate over buffer, starting with first paragraph
3308 // The scope must be bigger than any lookup DocIterator
3309 // later. For the global lookup, lastpit+1 is used, hence
3310 // we use lastpit+2 here.
3311 DocIterator it = par_iterator_begin();
3312 DocIterator outerScope = it;
3313 outerScope.pit() = outerScope.lastpit() + 2;
3314 d->updateMacros(it, outerScope);
3318 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3320 InsetIterator it = inset_iterator_begin(inset());
3321 InsetIterator const end = inset_iterator_end(inset());
3322 for (; it != end; ++it) {
3323 if (it->lyxCode() == BRANCH_CODE) {
3324 InsetBranch & br = static_cast<InsetBranch &>(*it);
3325 docstring const name = br.branch();
3326 if (!from_master && !params().branchlist().find(name))
3327 result.push_back(name);
3328 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3329 result.push_back(name);
3332 if (it->lyxCode() == INCLUDE_CODE) {
3333 // get buffer of external file
3334 InsetInclude const & ins =
3335 static_cast<InsetInclude const &>(*it);
3336 Buffer * child = ins.getChildBuffer();
3339 child->getUsedBranches(result, true);
3342 // remove duplicates
3347 void Buffer::updateMacroInstances(UpdateType utype) const
3349 LYXERR(Debug::MACROS, "updateMacroInstances for "
3350 << d->filename.onlyFileName());
3351 DocIterator it = doc_iterator_begin(this);
3353 DocIterator const end = doc_iterator_end(this);
3354 for (; it != end; it.forwardInset()) {
3355 // look for MathData cells in InsetMathNest insets
3356 InsetMath * minset = it.nextInset()->asInsetMath();
3360 // update macro in all cells of the InsetMathNest
3361 DocIterator::idx_type n = minset->nargs();
3362 MacroContext mc = MacroContext(this, it);
3363 for (DocIterator::idx_type i = 0; i < n; ++i) {
3364 MathData & data = minset->cell(i);
3365 data.updateMacros(0, mc, utype);
3371 void Buffer::listMacroNames(MacroNameSet & macros) const
3376 d->macro_lock = true;
3378 // loop over macro names
3379 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3380 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3381 for (; nameIt != nameEnd; ++nameIt)
3382 macros.insert(nameIt->first);
3384 // loop over children
3385 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3386 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3387 for (; it != end; ++it)
3388 it->first->listMacroNames(macros);
3391 Buffer const * const pbuf = d->parent();
3393 pbuf->listMacroNames(macros);
3395 d->macro_lock = false;
3399 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3401 Buffer const * const pbuf = d->parent();
3406 pbuf->listMacroNames(names);
3409 MacroNameSet::iterator it = names.begin();
3410 MacroNameSet::iterator end = names.end();
3411 for (; it != end; ++it) {
3413 MacroData const * data =
3414 pbuf->getMacro(*it, *this, false);
3416 macros.insert(data);
3418 // we cannot access the original MathMacroTemplate anymore
3419 // here to calls validate method. So we do its work here manually.
3420 // FIXME: somehow make the template accessible here.
3421 if (data->optionals() > 0)
3422 features.require("xargs");
3428 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3431 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3433 RefCache::iterator it = d->ref_cache_.find(label);
3434 if (it != d->ref_cache_.end())
3435 return it->second.second;
3437 static InsetLabel const * dummy_il = 0;
3438 static References const dummy_refs;
3439 it = d->ref_cache_.insert(
3440 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3441 return it->second.second;
3445 Buffer::References const & Buffer::references(docstring const & label) const
3447 return const_cast<Buffer *>(this)->getReferenceCache(label);
3451 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3453 References & refs = getReferenceCache(label);
3454 refs.push_back(make_pair(inset, it));
3458 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3460 masterBuffer()->d->ref_cache_[label].first = il;
3464 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3466 return masterBuffer()->d->ref_cache_[label].first;
3470 void Buffer::clearReferenceCache() const
3473 d->ref_cache_.clear();
3477 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3479 //FIXME: This does not work for child documents yet.
3480 reloadBibInfoCache();
3482 // Check if the label 'from' appears more than once
3483 BiblioInfo const & keys = masterBibInfo();
3484 BiblioInfo::const_iterator bit = keys.begin();
3485 BiblioInfo::const_iterator bend = keys.end();
3486 vector<docstring> labels;
3488 for (; bit != bend; ++bit)
3490 labels.push_back(bit->first);
3492 if (count(labels.begin(), labels.end(), from) > 1)
3495 string const paramName = "key";
3496 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3497 if (it->lyxCode() != CITE_CODE)
3499 InsetCommand * inset = it->asInsetCommand();
3500 docstring const oldValue = inset->getParam(paramName);
3501 if (oldValue == from)
3502 inset->setParam(paramName, to);
3506 // returns NULL if id-to-row conversion is unsupported
3507 auto_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3508 pit_type par_begin, pit_type par_end,
3509 OutputWhat output, bool master) const
3511 auto_ptr<TexRow> texrow(NULL);
3512 OutputParams runparams(¶ms().encoding());
3513 runparams.nice = true;
3514 runparams.flavor = params().getOutputFlavor(format);
3515 runparams.linelen = lyxrc.plaintext_linelen;
3516 // No side effect of file copying and image conversion
3517 runparams.dryrun = true;
3519 if (output == CurrentParagraph) {
3520 runparams.par_begin = par_begin;
3521 runparams.par_end = par_end;
3522 if (par_begin + 1 == par_end) {
3524 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3528 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3529 convert<docstring>(par_begin),
3530 convert<docstring>(par_end - 1))
3533 // output paragraphs
3534 if (runparams.flavor == OutputParams::LYX) {
3535 Paragraph const & par = text().paragraphs()[par_begin];
3537 depth_type dt = par.getDepth();
3538 par.write(ods, params(), dt);
3539 os << from_utf8(ods.str());
3540 } else if (runparams.flavor == OutputParams::HTML) {
3542 setMathFlavor(runparams);
3543 xhtmlParagraphs(text(), *this, xs, runparams);
3544 } else if (runparams.flavor == OutputParams::TEXT) {
3546 // FIXME Handles only one paragraph, unlike the others.
3547 // Probably should have some routine with a signature like them.
3548 writePlaintextParagraph(*this,
3549 text().paragraphs()[par_begin], os, runparams, dummy);
3550 } else if (params().isDocBook()) {
3551 docbookParagraphs(text(), *this, os, runparams);
3553 // If we are previewing a paragraph, even if this is the
3554 // child of some other buffer, let's cut the link here,
3555 // so that no concurring settings from the master
3556 // (e.g. branch state) interfere (see #8101).
3558 d->ignore_parent = true;
3559 // We need to validate the Buffer params' features here
3560 // in order to know if we should output polyglossia
3561 // macros (instead of babel macros)
3562 LaTeXFeatures features(*this, params(), runparams);
3563 params().validate(features);
3564 runparams.use_polyglossia = features.usePolyglossia();
3565 texrow.reset(new TexRow());
3568 // latex or literate
3569 otexstream ots(os, *texrow);
3572 latexParagraphs(*this, text(), ots, runparams);
3575 // Restore the parenthood
3577 d->ignore_parent = false;
3581 if (output == FullSource)
3582 os << _("Preview source code");
3583 else if (output == OnlyPreamble)
3584 os << _("Preview preamble");
3585 else if (output == OnlyBody)
3586 os << _("Preview body");
3588 if (runparams.flavor == OutputParams::LYX) {
3590 if (output == FullSource)
3592 else if (output == OnlyPreamble)
3593 params().writeFile(ods, this);
3594 else if (output == OnlyBody)
3596 os << from_utf8(ods.str());
3597 } else if (runparams.flavor == OutputParams::HTML) {
3598 writeLyXHTMLSource(os, runparams, output);
3599 } else if (runparams.flavor == OutputParams::TEXT) {
3600 if (output == OnlyPreamble) {
3601 os << "% "<< _("Plain text does not have a preamble.");
3603 writePlaintextFile(*this, os, runparams);
3604 } else if (params().isDocBook()) {
3605 writeDocBookSource(os, absFileName(), runparams, output);
3607 // latex or literate
3608 texrow.reset(new TexRow());
3611 otexstream ots(os, *texrow);
3613 runparams.is_child = true;
3614 writeLaTeXSource(ots, string(), runparams, output);
3622 ErrorList & Buffer::errorList(string const & type) const
3624 return d->errorLists[type];
3628 void Buffer::updateTocItem(std::string const & type,
3629 DocIterator const & dit) const
3632 d->gui_->updateTocItem(type, dit);
3636 void Buffer::structureChanged() const
3639 d->gui_->structureChanged();
3643 void Buffer::errors(string const & err, bool from_master) const
3646 d->gui_->errors(err, from_master);
3650 void Buffer::message(docstring const & msg) const
3653 d->gui_->message(msg);
3657 void Buffer::setBusy(bool on) const
3660 d->gui_->setBusy(on);
3664 void Buffer::updateTitles() const
3667 d->wa_->updateTitles();
3671 void Buffer::resetAutosaveTimers() const
3674 d->gui_->resetAutosaveTimers();
3678 bool Buffer::hasGuiDelegate() const
3684 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3693 class AutoSaveBuffer : public ForkedProcess {
3696 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3697 : buffer_(buffer), fname_(fname) {}
3699 virtual shared_ptr<ForkedProcess> clone() const
3701 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3706 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3707 from_utf8(fname_.absFileName())));
3708 return run(DontWait);
3712 virtual int generateChild();
3714 Buffer const & buffer_;
3719 int AutoSaveBuffer::generateChild()
3721 #if defined(__APPLE__)
3722 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3723 * We should use something else like threads.
3725 * Since I do not know how to determine at run time what is the OS X
3726 * version, I just disable forking altogether for now (JMarc)
3728 pid_t const pid = -1;
3730 // tmp_ret will be located (usually) in /tmp
3731 // will that be a problem?
3732 // Note that this calls ForkedCalls::fork(), so it's
3733 // ok cross-platform.
3734 pid_t const pid = fork();
3735 // If you want to debug the autosave
3736 // you should set pid to -1, and comment out the fork.
3737 if (pid != 0 && pid != -1)
3741 // pid = -1 signifies that lyx was unable
3742 // to fork. But we will do the save
3744 bool failed = false;
3745 TempFile tempfile("lyxautoXXXXXX.lyx");
3746 tempfile.setAutoRemove(false);
3747 FileName const tmp_ret = tempfile.name();
3748 if (!tmp_ret.empty()) {
3749 if (!buffer_.writeFile(tmp_ret))
3751 else if (!tmp_ret.moveTo(fname_))
3757 // failed to write/rename tmp_ret so try writing direct
3758 if (!buffer_.writeFile(fname_)) {
3759 // It is dangerous to do this in the child,
3760 // but safe in the parent, so...
3761 if (pid == -1) // emit message signal.
3762 buffer_.message(_("Autosave failed!"));
3766 if (pid == 0) // we are the child so...
3775 FileName Buffer::getEmergencyFileName() const
3777 return FileName(d->filename.absFileName() + ".emergency");
3781 FileName Buffer::getAutosaveFileName() const
3783 // if the document is unnamed try to save in the backup dir, else
3784 // in the default document path, and as a last try in the filePath,
3785 // which will most often be the temporary directory
3788 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3789 : lyxrc.backupdir_path;
3790 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3793 string const fname = "#" + d->filename.onlyFileName() + "#";
3795 return makeAbsPath(fname, fpath);
3799 void Buffer::removeAutosaveFile() const
3801 FileName const f = getAutosaveFileName();
3807 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3809 FileName const newauto = getAutosaveFileName();
3811 if (newauto != oldauto && oldauto.exists())
3812 if (!oldauto.moveTo(newauto))
3813 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3817 bool Buffer::autoSave() const
3819 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3820 if (buf->d->bak_clean || isReadonly())
3823 message(_("Autosaving current document..."));
3824 buf->d->bak_clean = true;
3826 FileName const fname = getAutosaveFileName();
3827 LASSERT(d->cloned_buffer_, return false);
3829 // If this buffer is cloned, we assume that
3830 // we are running in a separate thread already.
3831 TempFile tempfile("lyxautoXXXXXX.lyx");
3832 tempfile.setAutoRemove(false);
3833 FileName const tmp_ret = tempfile.name();
3834 if (!tmp_ret.empty()) {
3836 // assume successful write of tmp_ret
3837 if (tmp_ret.moveTo(fname))
3840 // failed to write/rename tmp_ret so try writing direct
3841 return writeFile(fname);
3845 void Buffer::setExportStatus(bool e) const
3847 d->doing_export = e;
3848 ListOfBuffers clist = getDescendents();
3849 ListOfBuffers::const_iterator cit = clist.begin();
3850 ListOfBuffers::const_iterator const cen = clist.end();
3851 for (; cit != cen; ++cit)
3852 (*cit)->d->doing_export = e;
3856 bool Buffer::isExporting() const
3858 return d->doing_export;
3862 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3866 return doExport(target, put_in_tempdir, result_file);
3869 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3870 string & result_file) const
3872 bool const update_unincluded =
3873 params().maintain_unincluded_children
3874 && !params().getIncludedChildren().empty();
3876 // (1) export with all included children (omit \includeonly)
3877 if (update_unincluded) {
3878 ExportStatus const status =
3879 doExport(target, put_in_tempdir, true, result_file);
3880 if (status != ExportSuccess)
3883 // (2) export with included children only
3884 return doExport(target, put_in_tempdir, false, result_file);
3888 void Buffer::setMathFlavor(OutputParams & op) const
3890 switch (params().html_math_output) {
3891 case BufferParams::MathML:
3892 op.math_flavor = OutputParams::MathAsMathML;
3894 case BufferParams::HTML:
3895 op.math_flavor = OutputParams::MathAsHTML;
3897 case BufferParams::Images:
3898 op.math_flavor = OutputParams::MathAsImages;
3900 case BufferParams::LaTeX:
3901 op.math_flavor = OutputParams::MathAsLaTeX;
3907 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3908 bool includeall, string & result_file) const
3910 LYXERR(Debug::FILES, "target=" << target);
3911 OutputParams runparams(¶ms().encoding());
3912 string format = target;
3913 string dest_filename;
3914 size_t pos = target.find(' ');
3915 if (pos != string::npos) {
3916 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3917 format = target.substr(0, pos);
3918 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3919 FileName(dest_filename).onlyPath().createPath();
3920 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3922 MarkAsExporting exporting(this);
3923 string backend_format;
3924 runparams.flavor = OutputParams::LATEX;
3925 runparams.linelen = lyxrc.plaintext_linelen;
3926 runparams.includeall = includeall;
3927 vector<string> backs = params().backends();
3928 Converters converters = theConverters();
3929 bool need_nice_file = false;
3930 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3931 // Get shortest path to format
3932 converters.buildGraph();
3933 Graph::EdgePath path;
3934 for (vector<string>::const_iterator it = backs.begin();
3935 it != backs.end(); ++it) {
3936 Graph::EdgePath p = converters.getPath(*it, format);
3937 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3938 backend_format = *it;
3943 if (!put_in_tempdir) {
3944 // Only show this alert if this is an export to a non-temporary
3945 // file (not for previewing).
3946 Alert::error(_("Couldn't export file"), bformat(
3947 _("No information for exporting the format %1$s."),
3948 formats.prettyName(format)));
3950 return ExportNoPathToFormat;
3952 runparams.flavor = converters.getFlavor(path, this);
3953 Graph::EdgePath::const_iterator it = path.begin();
3954 Graph::EdgePath::const_iterator en = path.end();
3955 for (; it != en; ++it)
3956 if (theConverters().get(*it).nice()) {
3957 need_nice_file = true;
3962 backend_format = format;
3963 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3964 // FIXME: Don't hardcode format names here, but use a flag
3965 if (backend_format == "pdflatex")
3966 runparams.flavor = OutputParams::PDFLATEX;
3967 else if (backend_format == "luatex")
3968 runparams.flavor = OutputParams::LUATEX;
3969 else if (backend_format == "dviluatex")
3970 runparams.flavor = OutputParams::DVILUATEX;
3971 else if (backend_format == "xetex")
3972 runparams.flavor = OutputParams::XETEX;
3975 string filename = latexName(false);
3976 filename = addName(temppath(), filename);
3977 filename = changeExtension(filename,
3978 formats.extension(backend_format));
3979 LYXERR(Debug::FILES, "filename=" << filename);
3981 // Plain text backend
3982 if (backend_format == "text") {
3983 runparams.flavor = OutputParams::TEXT;
3984 writePlaintextFile(*this, FileName(filename), runparams);
3987 else if (backend_format == "xhtml") {
3988 runparams.flavor = OutputParams::HTML;
3989 setMathFlavor(runparams);
3990 makeLyXHTMLFile(FileName(filename), runparams);
3991 } else if (backend_format == "lyx")
3992 writeFile(FileName(filename));
3994 else if (params().isDocBook()) {
3995 runparams.nice = !put_in_tempdir;
3996 makeDocBookFile(FileName(filename), runparams);
3999 else if (backend_format == format || need_nice_file) {
4000 runparams.nice = true;
4001 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4002 if (d->cloned_buffer_)
4003 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4006 } else if (!lyxrc.tex_allows_spaces
4007 && contains(filePath(), ' ')) {
4008 Alert::error(_("File name error"),
4009 _("The directory path to the document cannot contain spaces."));
4010 return ExportTexPathHasSpaces;
4012 runparams.nice = false;
4013 bool const success = makeLaTeXFile(
4014 FileName(filename), filePath(), runparams);
4015 if (d->cloned_buffer_)
4016 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4021 string const error_type = (format == "program")
4022 ? "Build" : params().bufferFormat();
4023 ErrorList & error_list = d->errorLists[error_type];
4024 string const ext = formats.extension(format);
4025 FileName const tmp_result_file(changeExtension(filename, ext));
4026 bool const success = converters.convert(this, FileName(filename),
4027 tmp_result_file, FileName(absFileName()), backend_format, format,
4030 // Emit the signal to show the error list or copy it back to the
4031 // cloned Buffer so that it can be emitted afterwards.
4032 if (format != backend_format) {
4033 if (runparams.silent)
4035 else if (d->cloned_buffer_)
4036 d->cloned_buffer_->d->errorLists[error_type] =
4037 d->errorLists[error_type];
4040 // also to the children, in case of master-buffer-view
4041 ListOfBuffers clist = getDescendents();
4042 ListOfBuffers::const_iterator cit = clist.begin();
4043 ListOfBuffers::const_iterator const cen = clist.end();
4044 for (; cit != cen; ++cit) {
4045 if (runparams.silent)
4046 (*cit)->d->errorLists[error_type].clear();
4047 else if (d->cloned_buffer_) {
4048 // Enable reverse search by copying back the
4049 // texrow object to the cloned buffer.
4050 // FIXME: this is not thread safe.
4051 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4052 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4053 (*cit)->d->errorLists[error_type];
4055 (*cit)->errors(error_type, true);
4059 if (d->cloned_buffer_) {
4060 // Enable reverse dvi or pdf to work by copying back the texrow
4061 // object to the cloned buffer.
4062 // FIXME: There is a possibility of concurrent access to texrow
4063 // here from the main GUI thread that should be securized.
4064 d->cloned_buffer_->d->texrow = d->texrow;
4065 string const error_type = params().bufferFormat();
4066 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4070 if (put_in_tempdir) {
4071 result_file = tmp_result_file.absFileName();
4072 return success ? ExportSuccess : ExportConverterError;
4075 if (dest_filename.empty())
4076 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4078 result_file = dest_filename;
4079 // We need to copy referenced files (e. g. included graphics
4080 // if format == "dvi") to the result dir.
4081 vector<ExportedFile> const files =
4082 runparams.exportdata->externalFiles(format);
4083 string const dest = runparams.export_folder.empty() ?
4084 onlyPath(result_file) : runparams.export_folder;
4085 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4086 : force_overwrite == ALL_FILES;
4087 CopyStatus status = use_force ? FORCE : SUCCESS;
4089 vector<ExportedFile>::const_iterator it = files.begin();
4090 vector<ExportedFile>::const_iterator const en = files.end();
4091 for (; it != en && status != CANCEL; ++it) {
4092 string const fmt = formats.getFormatFromFile(it->sourceName);
4093 string fixedName = it->exportName;
4094 if (!runparams.export_folder.empty()) {
4095 // Relative pathnames starting with ../ will be sanitized
4096 // if exporting to a different folder
4097 while (fixedName.substr(0, 3) == "../")
4098 fixedName = fixedName.substr(3, fixedName.length() - 3);
4100 FileName fixedFileName = makeAbsPath(fixedName, dest);
4101 fixedFileName.onlyPath().createPath();
4102 status = copyFile(fmt, it->sourceName,
4104 it->exportName, status == FORCE,
4105 runparams.export_folder.empty());
4108 if (status == CANCEL) {
4109 message(_("Document export cancelled."));
4110 return ExportCancel;
4113 if (tmp_result_file.exists()) {
4114 // Finally copy the main file
4115 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4116 : force_overwrite != NO_FILES;
4117 if (status == SUCCESS && use_force)
4119 status = copyFile(format, tmp_result_file,
4120 FileName(result_file), result_file,
4122 if (status == CANCEL) {
4123 message(_("Document export cancelled."));
4124 return ExportCancel;
4126 message(bformat(_("Document exported as %1$s "
4128 formats.prettyName(format),
4129 makeDisplayPath(result_file)));
4132 // This must be a dummy converter like fax (bug 1888)
4133 message(bformat(_("Document exported as %1$s"),
4134 formats.prettyName(format)));
4137 return success ? ExportSuccess : ExportConverterError;
4141 Buffer::ExportStatus Buffer::preview(string const & format) const
4143 bool const update_unincluded =
4144 params().maintain_unincluded_children
4145 && !params().getIncludedChildren().empty();
4146 return preview(format, update_unincluded);
4150 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4152 MarkAsExporting exporting(this);
4154 // (1) export with all included children (omit \includeonly)
4156 ExportStatus const status = doExport(format, true, true, result_file);
4157 if (status != ExportSuccess)
4160 // (2) export with included children only
4161 ExportStatus const status = doExport(format, true, false, result_file);
4162 FileName const previewFile(result_file);
4164 LATTEST (isClone());
4165 d->cloned_buffer_->d->preview_file_ = previewFile;
4166 d->cloned_buffer_->d->preview_format_ = format;
4167 d->cloned_buffer_->d->preview_error_ = (status != ExportSuccess);
4169 if (status != ExportSuccess)
4171 if (previewFile.exists()) {
4172 if (!formats.view(*this, previewFile, format))
4173 return PreviewError;
4175 return PreviewSuccess;
4178 // Successful export but no output file?
4179 // Probably a bug in error detection.
4180 LATTEST (status != ExportSuccess);
4187 Buffer::ReadStatus Buffer::extractFromVC()
4189 bool const found = LyXVC::file_not_found_hook(d->filename);
4191 return ReadFileNotFound;
4192 if (!d->filename.isReadableFile())
4198 Buffer::ReadStatus Buffer::loadEmergency()
4200 FileName const emergencyFile = getEmergencyFileName();
4201 if (!emergencyFile.exists()
4202 || emergencyFile.lastModified() <= d->filename.lastModified())
4203 return ReadFileNotFound;
4205 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4206 docstring const text = bformat(_("An emergency save of the document "
4207 "%1$s exists.\n\nRecover emergency save?"), file);
4209 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4210 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4216 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4217 bool const success = (ret_llf == ReadSuccess);
4220 Alert::warning(_("File is read-only"),
4221 bformat(_("An emergency file is successfully loaded, "
4222 "but the original file %1$s is marked read-only. "
4223 "Please make sure to save the document as a different "
4224 "file."), from_utf8(d->filename.absFileName())));
4227 lyxvc().file_found_hook(d->filename);
4228 str = _("Document was successfully recovered.");
4230 str = _("Document was NOT successfully recovered.");
4231 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4232 makeDisplayPath(emergencyFile.absFileName()));
4234 int const del_emerg =
4235 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4236 _("&Remove"), _("&Keep"));
4237 if (del_emerg == 0) {
4238 emergencyFile.removeFile();
4240 Alert::warning(_("Emergency file deleted"),
4241 _("Do not forget to save your file now!"), true);
4243 return success ? ReadSuccess : ReadEmergencyFailure;
4246 int const del_emerg =
4247 Alert::prompt(_("Delete emergency file?"),
4248 _("Remove emergency file now?"), 1, 1,
4249 _("&Remove"), _("&Keep"));
4251 emergencyFile.removeFile();
4252 return ReadOriginal;
4262 Buffer::ReadStatus Buffer::loadAutosave()
4264 // Now check if autosave file is newer.
4265 FileName const autosaveFile = getAutosaveFileName();
4266 if (!autosaveFile.exists()
4267 || autosaveFile.lastModified() <= d->filename.lastModified())
4268 return ReadFileNotFound;
4270 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4271 docstring const text = bformat(_("The backup of the document %1$s "
4272 "is newer.\n\nLoad the backup instead?"), file);
4273 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4274 _("&Load backup"), _("Load &original"), _("&Cancel"));
4279 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4280 // the file is not saved if we load the autosave file.
4281 if (ret_llf == ReadSuccess) {
4283 Alert::warning(_("File is read-only"),
4284 bformat(_("A backup file is successfully loaded, "
4285 "but the original file %1$s is marked read-only. "
4286 "Please make sure to save the document as a "
4288 from_utf8(d->filename.absFileName())));
4291 lyxvc().file_found_hook(d->filename);
4294 return ReadAutosaveFailure;
4297 // Here we delete the autosave
4298 autosaveFile.removeFile();
4299 return ReadOriginal;
4307 Buffer::ReadStatus Buffer::loadLyXFile()
4309 if (!d->filename.isReadableFile()) {
4310 ReadStatus const ret_rvc = extractFromVC();
4311 if (ret_rvc != ReadSuccess)
4315 ReadStatus const ret_re = loadEmergency();
4316 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4319 ReadStatus const ret_ra = loadAutosave();
4320 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4323 return loadThisLyXFile(d->filename);
4327 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4329 return readFile(fn);
4333 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4335 TeXErrors::Errors::const_iterator it = terr.begin();
4336 TeXErrors::Errors::const_iterator end = terr.end();
4337 ListOfBuffers clist = getDescendents();
4338 ListOfBuffers::const_iterator cen = clist.end();
4340 for (; it != end; ++it) {
4343 int errorRow = it->error_in_line;
4344 Buffer const * buf = 0;
4346 if (it->child_name.empty())
4347 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4349 // The error occurred in a child
4350 ListOfBuffers::const_iterator cit = clist.begin();
4351 for (; cit != cen; ++cit) {
4352 string const child_name =
4353 DocFileName(changeExtension(
4354 (*cit)->absFileName(), "tex")).
4356 if (it->child_name != child_name)
4358 (*cit)->d->texrow.getIdFromRow(errorRow,
4359 id_start, pos_start);
4360 if (id_start != -1) {
4361 buf = d->cloned_buffer_
4362 ? (*cit)->d->cloned_buffer_->d->owner_
4363 : (*cit)->d->owner_;
4374 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4375 } while (found && id_start == id_end && pos_start == pos_end);
4377 if (id_start != id_end) {
4378 // Next registered position is outside the inset where
4379 // the error occurred, so signal end-of-paragraph
4383 errorList.push_back(ErrorItem(it->error_desc,
4384 it->error_text, id_start, pos_start, pos_end, buf));
4389 void Buffer::setBuffersForInsets() const
4391 inset().setBuffer(const_cast<Buffer &>(*this));
4395 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4397 LBUFERR(!text().paragraphs().empty());
4399 // Use the master text class also for child documents
4400 Buffer const * const master = masterBuffer();
4401 DocumentClass const & textclass = master->params().documentClass();
4403 // do this only if we are the top-level Buffer
4404 if (master == this) {
4405 textclass.counters().reset(from_ascii("bibitem"));
4406 reloadBibInfoCache();
4409 // keep the buffers to be children in this set. If the call from the
4410 // master comes back we can see which of them were actually seen (i.e.
4411 // via an InsetInclude). The remaining ones in the set need still be updated.
4412 static std::set<Buffer const *> bufToUpdate;
4413 if (scope == UpdateMaster) {
4414 // If this is a child document start with the master
4415 if (master != this) {
4416 bufToUpdate.insert(this);
4417 master->updateBuffer(UpdateMaster, utype);
4418 // If the master buffer has no gui associated with it, then the TocModel is
4419 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4420 // (bug 5699). The same happens if the master buffer is open in a different
4421 // window. This test catches both possibilities.
4422 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4423 // There remains a problem here: If there is another child open in yet a third
4424 // window, that TOC is not updated. So some more general solution is needed at
4426 if (master->d->gui_ != d->gui_)
4429 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4430 if (bufToUpdate.find(this) == bufToUpdate.end())
4434 // start over the counters in the master
4435 textclass.counters().reset();
4438 // update will be done below for this buffer
4439 bufToUpdate.erase(this);
4441 // update all caches
4442 clearReferenceCache();
4445 Buffer & cbuf = const_cast<Buffer &>(*this);
4448 ParIterator parit = cbuf.par_iterator_begin();
4449 updateBuffer(parit, utype);
4452 // TocBackend update will be done later.
4455 d->bibinfo_cache_valid_ = true;
4456 d->cite_labels_valid_ = true;
4458 cbuf.tocBackend().update(true, utype);
4459 if (scope == UpdateMaster)
4460 cbuf.structureChanged();
4464 static depth_type getDepth(DocIterator const & it)
4466 depth_type depth = 0;
4467 for (size_t i = 0 ; i < it.depth() ; ++i)
4468 if (!it[i].inset().inMathed())
4469 depth += it[i].paragraph().getDepth() + 1;
4470 // remove 1 since the outer inset does not count
4474 static depth_type getItemDepth(ParIterator const & it)
4476 Paragraph const & par = *it;
4477 LabelType const labeltype = par.layout().labeltype;
4479 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4482 // this will hold the lowest depth encountered up to now.
4483 depth_type min_depth = getDepth(it);
4484 ParIterator prev_it = it;
4487 --prev_it.top().pit();
4489 // start of nested inset: go to outer par
4491 if (prev_it.empty()) {
4492 // start of document: nothing to do
4497 // We search for the first paragraph with same label
4498 // that is not more deeply nested.
4499 Paragraph & prev_par = *prev_it;
4500 depth_type const prev_depth = getDepth(prev_it);
4501 if (labeltype == prev_par.layout().labeltype) {
4502 if (prev_depth < min_depth)
4503 return prev_par.itemdepth + 1;
4504 if (prev_depth == min_depth)
4505 return prev_par.itemdepth;
4507 min_depth = min(min_depth, prev_depth);
4508 // small optimization: if we are at depth 0, we won't
4509 // find anything else
4510 if (prev_depth == 0)
4516 static bool needEnumCounterReset(ParIterator const & it)
4518 Paragraph const & par = *it;
4519 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4520 depth_type const cur_depth = par.getDepth();
4521 ParIterator prev_it = it;
4522 while (prev_it.pit()) {
4523 --prev_it.top().pit();
4524 Paragraph const & prev_par = *prev_it;
4525 if (prev_par.getDepth() <= cur_depth)
4526 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4528 // start of nested inset: reset
4533 // set the label of a paragraph. This includes the counters.
4534 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4536 BufferParams const & bp = owner_->masterBuffer()->params();
4537 DocumentClass const & textclass = bp.documentClass();
4538 Paragraph & par = it.paragraph();
4539 Layout const & layout = par.layout();
4540 Counters & counters = textclass.counters();
4542 if (par.params().startOfAppendix()) {
4543 // We want to reset the counter corresponding to toplevel sectioning
4544 Layout const & lay = textclass.getTOCLayout();
4545 docstring const cnt = lay.counter;
4547 counters.reset(cnt);
4548 counters.appendix(true);
4550 par.params().appendix(counters.appendix());
4552 // Compute the item depth of the paragraph
4553 par.itemdepth = getItemDepth(it);
4555 if (layout.margintype == MARGIN_MANUAL) {
4556 if (par.params().labelWidthString().empty())
4557 par.params().labelWidthString(par.expandLabel(layout, bp));
4558 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4559 // we do not need to do anything here, since the empty case is
4560 // handled during export.
4562 par.params().labelWidthString(docstring());
4565 switch(layout.labeltype) {
4566 case LABEL_ITEMIZE: {
4567 // At some point of time we should do something more
4568 // clever here, like:
4569 // par.params().labelString(
4570 // bp.user_defined_bullet(par.itemdepth).getText());
4571 // for now, use a simple hardcoded label
4572 docstring itemlabel;
4573 switch (par.itemdepth) {
4575 itemlabel = char_type(0x2022);
4578 itemlabel = char_type(0x2013);
4581 itemlabel = char_type(0x2217);
4584 itemlabel = char_type(0x2219); // or 0x00b7
4587 par.params().labelString(itemlabel);
4591 case LABEL_ENUMERATE: {
4592 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4594 switch (par.itemdepth) {
4603 enumcounter += "iv";
4606 // not a valid enumdepth...
4610 // Maybe we have to reset the enumeration counter.
4611 if (needEnumCounterReset(it))
4612 counters.reset(enumcounter);
4613 counters.step(enumcounter, utype);
4615 string const & lang = par.getParLanguage(bp)->code();
4616 par.params().labelString(counters.theCounter(enumcounter, lang));
4621 case LABEL_SENSITIVE: {
4622 string const & type = counters.current_float();
4623 docstring full_label;
4625 full_label = owner_->B_("Senseless!!! ");
4627 docstring name = owner_->B_(textclass.floats().getType(type).name());
4628 if (counters.hasCounter(from_utf8(type))) {
4629 string const & lang = par.getParLanguage(bp)->code();
4630 counters.step(from_utf8(type), utype);
4631 full_label = bformat(from_ascii("%1$s %2$s:"),
4633 counters.theCounter(from_utf8(type), lang));
4635 full_label = bformat(from_ascii("%1$s #:"), name);
4637 par.params().labelString(full_label);
4641 case LABEL_NO_LABEL:
4642 par.params().labelString(docstring());
4646 case LABEL_CENTERED:
4647 case LABEL_STATIC: {
4648 docstring const & lcounter = layout.counter;
4649 if (!lcounter.empty()) {
4650 if (layout.toclevel <= bp.secnumdepth
4651 && (layout.latextype != LATEX_ENVIRONMENT
4652 || it.text()->isFirstInSequence(it.pit()))) {
4653 if (counters.hasCounter(lcounter))
4654 counters.step(lcounter, utype);
4655 par.params().labelString(par.expandLabel(layout, bp));
4657 par.params().labelString(docstring());
4659 par.params().labelString(par.expandLabel(layout, bp));
4665 par.params().labelString(par.expandLabel(layout, bp));
4670 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4672 // LASSERT: Is it safe to continue here, or should we just return?
4673 LASSERT(parit.pit() == 0, /**/);
4675 // Set the position of the text in the buffer to be able
4676 // to resolve macros in it.
4677 parit.text()->setMacrocontextPosition(parit);
4679 depth_type maxdepth = 0;
4680 pit_type const lastpit = parit.lastpit();
4681 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4682 // reduce depth if necessary
4683 if (parit->params().depth() > maxdepth) {
4684 /** FIXME: this function is const, but
4685 * nevertheless it modifies the buffer. To be
4686 * cleaner, one should modify the buffer in
4687 * another function, which is actually
4688 * non-const. This would however be costly in
4689 * terms of code duplication.
4691 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4692 parit->params().depth(maxdepth);
4694 maxdepth = parit->getMaxDepthAfter();
4696 if (utype == OutputUpdate) {
4697 // track the active counters
4698 // we have to do this for the master buffer, since the local
4699 // buffer isn't tracking anything.
4700 masterBuffer()->params().documentClass().counters().
4701 setActiveLayout(parit->layout());
4704 // set the counter for this paragraph
4705 d->setLabel(parit, utype);
4708 InsetList::const_iterator iit = parit->insetList().begin();
4709 InsetList::const_iterator end = parit->insetList().end();
4710 for (; iit != end; ++iit) {
4711 parit.pos() = iit->pos;
4712 iit->inset->updateBuffer(parit, utype);
4718 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4719 WordLangTuple & word_lang, docstring_list & suggestions) const
4723 suggestions.clear();
4724 word_lang = WordLangTuple();
4725 bool const to_end = to.empty();
4726 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4727 // OK, we start from here.
4728 for (; from != end; from.forwardPos()) {
4729 // This skips all insets with spell check disabled.
4730 while (!from.allowSpellCheck()) {
4734 // If from is at the end of the document (which is possible
4735 // when "from" was changed above) LyX will crash later otherwise.
4736 if (from.atEnd() || (!to_end && from >= end))
4739 from.paragraph().spellCheck();
4740 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4741 if (SpellChecker::misspelled(res)) {
4745 // Do not increase progress when from == to, otherwise the word
4746 // count will be wrong.
4756 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4758 bool inword = false;
4763 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4764 if (!dit.inTexted()) {
4769 Paragraph const & par = dit.paragraph();
4770 pos_type const pos = dit.pos();
4772 // Copied and adapted from isWordSeparator() in Paragraph
4773 if (pos == dit.lastpos()) {
4776 Inset const * ins = par.getInset(pos);
4777 if (ins && skipNoOutput && !ins->producesOutput()) {
4780 // stop if end of range was skipped
4781 if (!to.atEnd() && dit >= to)
4784 } else if (!par.isDeleted(pos)) {
4785 if (par.isWordSeparator(pos))
4791 if (ins && ins->isLetter())
4793 else if (ins && ins->isSpace())
4796 char_type const c = par.getChar(pos);
4797 if (isPrintableNonspace(c))
4799 else if (isSpace(c))
4809 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4811 d->updateStatistics(from, to, skipNoOutput);
4815 int Buffer::wordCount() const
4817 return d->wordCount();
4821 int Buffer::charCount(bool with_blanks) const
4823 return d->charCount(with_blanks);
4827 Buffer::ReadStatus Buffer::reload()
4830 // c.f. bug http://www.lyx.org/trac/ticket/6587
4831 removeAutosaveFile();
4832 // e.g., read-only status could have changed due to version control
4833 d->filename.refresh();
4834 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4836 // clear parent. this will get reset if need be.
4838 ReadStatus const status = loadLyXFile();
4839 if (status == ReadSuccess) {
4844 message(bformat(_("Document %1$s reloaded."), disp_fn));
4847 message(bformat(_("Could not reload document %1$s."), disp_fn));
4857 bool Buffer::saveAs(FileName const & fn)
4859 FileName const old_name = fileName();
4860 FileName const old_auto = getAutosaveFileName();
4861 bool const old_unnamed = isUnnamed();
4862 bool success = true;
4863 d->old_position = filePath();
4870 // bring the autosave file with us, just in case.
4871 moveAutosaveFile(old_auto);
4872 // validate version control data and
4873 // correct buffer title
4874 lyxvc().file_found_hook(fileName());
4876 // the file has now been saved to the new location.
4877 // we need to check that the locations of child buffers
4879 checkChildBuffers();
4880 checkMasterBuffer();
4883 // reset the old filename and unnamed state
4884 setFileName(old_name);
4885 setUnnamed(old_unnamed);
4889 d->old_position.clear();
4894 void Buffer::checkChildBuffers()
4896 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4897 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4898 for (; it != en; ++it) {
4899 DocIterator dit = it->second;
4900 Buffer * cbuf = const_cast<Buffer *>(it->first);
4901 if (!cbuf || !theBufferList().isLoaded(cbuf))
4903 Inset * inset = dit.nextInset();
4904 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4905 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4906 docstring const & incfile = inset_inc->getParam("filename");
4907 string oldloc = cbuf->absFileName();
4908 string newloc = makeAbsPath(to_utf8(incfile),
4909 onlyPath(absFileName())).absFileName();
4910 if (oldloc == newloc)
4912 // the location of the child file is incorrect.
4914 inset_inc->setChildBuffer(0);
4916 // invalidate cache of children
4917 d->children_positions.clear();
4918 d->position_to_children.clear();
4922 // If a child has been saved under a different name/path, it might have been
4923 // orphaned. Therefore the master needs to be reset (bug 8161).
4924 void Buffer::checkMasterBuffer()
4926 Buffer const * const master = masterBuffer();
4930 // necessary to re-register the child (bug 5873)
4931 // FIXME: clean up updateMacros (here, only
4932 // child registering is needed).
4933 master->updateMacros();
4934 // (re)set master as master buffer, but only
4935 // if we are a real child
4936 if (master->isChild(this))
4943 string Buffer::includedFilePath(string const & name, string const & ext) const
4945 bool isabsolute = FileName::isAbsolute(name);
4946 // old_position already contains a trailing path separator
4947 string const absname = isabsolute ? name : d->old_position + name;
4949 if (d->old_position.empty()
4950 || equivalent(FileName(d->old_position), FileName(filePath()))
4951 || !FileName(addExtension(absname, ext)).exists())
4955 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
4957 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
4958 from_utf8(filePath())));