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 /// original format of loaded file
210 /// if the file was originally loaded from an older format, do
211 /// we need to back it up still?
212 bool need_format_backup;
214 /// Ignore the parent (e.g. when exporting a child standalone)?
218 mutable TocBackend toc_backend;
223 ScopeMacro(DocIterator const & s, MacroData const & m)
224 : scope(s), macro(m) {}
228 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
229 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
230 /// map from the macro name to the position map,
231 /// which maps the macro definition position to the scope and the MacroData.
232 NamePositionScopeMacroMap macros;
233 /// This seem to change the way Buffer::getMacro() works
234 mutable bool macro_lock;
236 /// positions of child buffers in the buffer
237 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
240 ScopeBuffer(DocIterator const & s,Buffer const * b)
241 : scope(s), buffer(b) {}
243 Buffer const * buffer;
245 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
246 /// position of children buffers in this buffer
247 BufferPositionMap children_positions;
248 /// map from children inclusion positions to their scope and their buffer
249 PositionScopeBufferMap position_to_children;
251 /// Contains the old buffer filePath() while saving-as, or the
252 /// directory where the document was last saved while loading.
255 /** Keeps track of the path of local layout files.
256 * If possible, it is always relative to the buffer path.
257 * Empty for layouts in system or user directory.
259 string layout_position;
261 /// Container for all sort of Buffer dependant errors.
262 map<string, ErrorList> errorLists;
264 /// timestamp and checksum used to test if the file has been externally
265 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
267 unsigned long checksum_;
270 frontend::WorkAreaManager * wa_;
272 frontend::GuiBufferDelegate * gui_;
277 /// A cache for the bibfiles (including bibfiles of loaded child
278 /// documents), needed for appropriate update of natbib labels.
279 mutable support::FileNameList bibfiles_cache_;
281 // FIXME The caching mechanism could be improved. At present, we have a
282 // cache for each Buffer, that caches all the bibliography info for that
283 // Buffer. A more efficient solution would be to have a global cache per
284 // file, and then to construct the Buffer's bibinfo from that.
285 /// A cache for bibliography info
286 mutable BiblioInfo bibinfo_;
287 /// whether the bibinfo cache is valid
288 mutable bool bibinfo_cache_valid_;
289 /// whether the bibfile cache is valid
290 mutable bool bibfile_cache_valid_;
291 /// Cache of timestamps of .bib files
292 map<FileName, time_t> bibfile_status_;
293 /// Indicates whether the bibinfo has changed since the last time
294 /// we ran updateBuffer(), i.e., whether citation labels may need
296 mutable bool cite_labels_valid_;
298 /// These two hold the file name and format, written to by
299 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
300 FileName preview_file_;
301 string preview_format_;
302 /// If there was an error when previewing, on the next preview we do
303 /// a fresh compile (e.g. in case the user installed a package that
307 mutable RefCache ref_cache_;
309 /// our Text that should be wrapped in an InsetText
313 PreviewLoader * preview_loader_;
315 /// This is here to force the test to be done whenever parent_buffer
317 Buffer const * parent() const
319 // ignore_parent temporarily "orphans" a buffer
320 // (e.g. if a child is compiled standalone)
323 // if parent_buffer is not loaded, then it has been unloaded,
324 // which means that parent_buffer is an invalid pointer. So we
325 // set it to null in that case.
326 // however, the BufferList doesn't know about cloned buffers, so
327 // they will always be regarded as unloaded. in that case, we hope
329 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
331 return parent_buffer;
335 void setParent(Buffer const * pb)
337 if (parent_buffer == pb)
340 if (!cloned_buffer_ && parent_buffer && pb)
341 LYXERR0("Warning: a buffer should not have two parents!");
343 if (!cloned_buffer_ && parent_buffer) {
344 parent_buffer->invalidateBibfileCache();
345 parent_buffer->invalidateBibinfoCache();
349 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
350 /// This one is useful for preview detached in a thread.
351 Buffer const * cloned_buffer_;
353 CloneList * clone_list_;
354 /// are we in the process of exporting this buffer?
355 mutable bool doing_export;
357 /// compute statistics
358 /// \p from initial position
359 /// \p to points to the end position
360 void updateStatistics(DocIterator & from, DocIterator & to,
361 bool skipNoOutput = true);
362 /// statistics accessor functions
363 int wordCount() const
367 int charCount(bool with_blanks) const
370 + (with_blanks ? blank_count_ : 0);
373 // does the buffer contain tracked changes? (if so, we automatically
374 // display the review toolbar, for instance)
375 mutable bool tracked_changes_present_;
378 /// So we can force access via the accessors.
379 mutable Buffer const * parent_buffer;
388 /// Creates the per buffer temporary directory
389 static FileName createBufferTmpDir()
391 // FIXME This would be the ideal application for a TempDir class (like
392 // TempFile but for directories)
397 Mutex::Locker locker(&mutex);
398 counter = convert<string>(count++);
400 // We are in our own directory. Why bother to mangle name?
401 // In fact I wrote this code to circumvent a problematic behaviour
402 // (bug?) of EMX mkstemp().
403 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
406 if (!tmpfl.createDirectory(0777)) {
407 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
408 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
409 from_utf8(tmpfl.absFileName())));
415 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
416 Buffer const * cloned_buffer)
417 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
418 internal_buffer(false), read_only(readonly_), filename(file),
419 file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
420 ignore_parent(false), toc_backend(owner), macro_lock(false), timestamp_(0),
421 checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
422 bibfile_cache_valid_(false), cite_labels_valid_(false), inset(0),
423 preview_loader_(0), cloned_buffer_(cloned_buffer), clone_list_(0),
424 doing_export(false), parent_buffer(0),
425 word_count_(0), char_count_(0), blank_count_(0)
427 if (!cloned_buffer_) {
428 temppath = createBufferTmpDir();
429 lyxvc.setBuffer(owner_);
431 wa_ = new frontend::WorkAreaManager;
434 temppath = cloned_buffer_->d->temppath;
435 file_fully_loaded = true;
436 params = cloned_buffer_->d->params;
437 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
438 bibinfo_ = cloned_buffer_->d->bibinfo_;
439 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
440 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
441 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
442 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
443 unnamed = cloned_buffer_->d->unnamed;
444 internal_buffer = cloned_buffer_->d->internal_buffer;
445 layout_position = cloned_buffer_->d->layout_position;
446 preview_file_ = cloned_buffer_->d->preview_file_;
447 preview_format_ = cloned_buffer_->d->preview_format_;
448 preview_error_ = cloned_buffer_->d->preview_error_;
449 tracked_changes_present_ = cloned_buffer_->d->tracked_changes_present_;
453 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
454 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
456 LYXERR(Debug::INFO, "Buffer::Buffer()");
458 d->inset = new InsetText(*cloned_buffer->d->inset);
459 d->inset->setBuffer(*this);
460 // FIXME: optimize this loop somewhat, maybe by creating a new
461 // general recursive Inset::setId().
462 DocIterator it = doc_iterator_begin(this);
463 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
464 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
465 it.paragraph().setId(cloned_it.paragraph().id());
467 d->inset = new InsetText(this);
468 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
474 LYXERR(Debug::INFO, "Buffer::~Buffer()");
475 // here the buffer should take care that it is
476 // saved properly, before it goes into the void.
478 // GuiView already destroyed
482 // No need to do additional cleanups for internal buffer.
488 // this is in case of recursive includes: we won't try to delete
489 // ourselves as a child.
490 d->clone_list_->erase(this);
491 // loop over children
492 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
493 Impl::BufferPositionMap::iterator end = d->children_positions.end();
494 for (; it != end; ++it) {
495 Buffer * child = const_cast<Buffer *>(it->first);
496 if (d->clone_list_->erase(child))
499 // if we're the master buffer, then we should get rid of the list
502 // If this is not empty, we have leaked something. Worse, one of the
503 // children still has a reference to this list. But we will try to
504 // continue, rather than shut down.
505 LATTEST(d->clone_list_->empty());
506 list<CloneList *>::iterator it =
507 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
508 if (it == cloned_buffers.end()) {
509 // We will leak in this case, but it is safe to continue.
512 cloned_buffers.erase(it);
513 delete d->clone_list_;
515 // FIXME Do we really need to do this right before we delete d?
516 // clear references to children in macro tables
517 d->children_positions.clear();
518 d->position_to_children.clear();
520 // loop over children
521 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
522 Impl::BufferPositionMap::iterator end = d->children_positions.end();
523 for (; it != end; ++it) {
524 Buffer * child = const_cast<Buffer *>(it->first);
525 if (theBufferList().isLoaded(child)) {
526 if (theBufferList().isOthersChild(this, child))
529 theBufferList().release(child);
534 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
535 msg += emergencyWrite();
536 Alert::warning(_("Attempting to close changed document!"), msg);
539 // FIXME Do we really need to do this right before we delete d?
540 // clear references to children in macro tables
541 d->children_positions.clear();
542 d->position_to_children.clear();
544 if (!d->temppath.destroyDirectory()) {
545 LYXERR0(bformat(_("Could not remove the temporary directory %1$s"),
546 from_utf8(d->temppath.absFileName())));
555 Buffer * Buffer::cloneFromMaster() const
558 cloned_buffers.push_back(new CloneList);
559 CloneList * clones = cloned_buffers.back();
561 masterBuffer()->cloneWithChildren(bufmap, clones);
563 // make sure we got cloned
564 BufferMap::const_iterator bit = bufmap.find(this);
565 LASSERT(bit != bufmap.end(), return 0);
566 Buffer * cloned_buffer = bit->second;
568 return cloned_buffer;
572 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
574 // have we already been cloned?
575 if (bufmap.find(this) != bufmap.end())
578 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
580 // The clone needs its own DocumentClass, since running updateBuffer() will
581 // modify it, and we would otherwise be sharing it with the original Buffer.
582 buffer_clone->params().makeDocumentClass(true);
584 cap::switchBetweenClasses(
585 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
586 static_cast<InsetText &>(buffer_clone->inset()), el);
588 bufmap[this] = buffer_clone;
589 clones->insert(buffer_clone);
590 buffer_clone->d->clone_list_ = clones;
591 buffer_clone->d->macro_lock = true;
592 buffer_clone->d->children_positions.clear();
594 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
595 // math macro caches need to be rethought and simplified.
596 // I am not sure wether we should handle Buffer cloning here or in BufferList.
597 // Right now BufferList knows nothing about buffer clones.
598 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
599 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
600 for (; it != end; ++it) {
601 DocIterator dit = it->first.clone(buffer_clone);
602 dit.setBuffer(buffer_clone);
603 Buffer * child = const_cast<Buffer *>(it->second.buffer);
605 child->cloneWithChildren(bufmap, clones);
606 BufferMap::iterator const bit = bufmap.find(child);
607 LASSERT(bit != bufmap.end(), continue);
608 Buffer * child_clone = bit->second;
610 Inset * inset = dit.nextInset();
611 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
612 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
613 inset_inc->setChildBuffer(child_clone);
614 child_clone->d->setParent(buffer_clone);
615 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
616 buffer_clone->setChild(dit, child_clone);
618 buffer_clone->d->macro_lock = false;
623 Buffer * Buffer::cloneBufferOnly() const {
624 cloned_buffers.push_back(new CloneList);
625 CloneList * clones = cloned_buffers.back();
626 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
628 // The clone needs its own DocumentClass, since running updateBuffer() will
629 // modify it, and we would otherwise be sharing it with the original Buffer.
630 buffer_clone->params().makeDocumentClass(true);
632 cap::switchBetweenClasses(
633 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
634 static_cast<InsetText &>(buffer_clone->inset()), el);
636 clones->insert(buffer_clone);
637 buffer_clone->d->clone_list_ = clones;
639 // we won't be cloning the children
640 buffer_clone->d->children_positions.clear();
645 bool Buffer::isClone() const
647 return d->cloned_buffer_;
651 void Buffer::changed(bool update_metrics) const
654 d->wa_->redrawAll(update_metrics);
658 frontend::WorkAreaManager & Buffer::workAreaManager() const
665 Text & Buffer::text() const
667 return d->inset->text();
671 Inset & Buffer::inset() const
677 BufferParams & Buffer::params()
683 BufferParams const & Buffer::params() const
689 BufferParams const & Buffer::masterParams() const
691 if (masterBuffer() == this)
694 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
695 // Copy child authors to the params. We need those pointers.
696 AuthorList const & child_authors = params().authors();
697 AuthorList::Authors::const_iterator it = child_authors.begin();
698 for (; it != child_authors.end(); ++it)
699 mparams.authors().record(*it);
704 double Buffer::fontScalingFactor() const
706 return isExporting() ? 75.0 * params().html_math_img_scale
707 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
711 ParagraphList & Buffer::paragraphs()
713 return text().paragraphs();
717 ParagraphList const & Buffer::paragraphs() const
719 return text().paragraphs();
723 LyXVC & Buffer::lyxvc()
729 LyXVC const & Buffer::lyxvc() const
735 string const Buffer::temppath() const
737 return d->temppath.absFileName();
741 TexRow & Buffer::texrow()
747 TexRow const & Buffer::texrow() const
753 TocBackend & Buffer::tocBackend() const
755 return d->toc_backend;
759 Undo & Buffer::undo()
765 void Buffer::setChild(DocIterator const & dit, Buffer * child)
767 d->children_positions[child] = dit;
771 string Buffer::latexName(bool const no_path) const
773 FileName latex_name =
774 makeLatexName(d->exportFileName());
775 return no_path ? latex_name.onlyFileName()
776 : latex_name.absFileName();
780 FileName Buffer::Impl::exportFileName() const
782 docstring const branch_suffix =
783 params.branchlist().getFileNameSuffix();
784 if (branch_suffix.empty())
787 string const name = filename.onlyFileNameWithoutExt()
788 + to_utf8(branch_suffix);
789 FileName res(filename.onlyPath().absFileName() + "/" + name);
790 res.changeExtension(filename.extension());
796 string Buffer::logName(LogType * type) const
798 string const filename = latexName(false);
800 if (filename.empty()) {
806 string const path = temppath();
808 FileName const fname(addName(temppath(),
809 onlyFileName(changeExtension(filename,
812 // FIXME: how do we know this is the name of the build log?
813 FileName const bname(
814 addName(path, onlyFileName(
815 changeExtension(filename,
816 formats.extension(params().bufferFormat()) + ".out"))));
818 // Also consider the master buffer log file
819 FileName masterfname = fname;
820 LogType mtype = latexlog;
821 if (masterBuffer() != this) {
822 string const mlogfile = masterBuffer()->logName(&mtype);
823 masterfname = FileName(mlogfile);
826 // If no Latex log or Build log is newer, show Build log
827 if (bname.exists() &&
828 ((!fname.exists() && !masterfname.exists())
829 || (fname.lastModified() < bname.lastModified()
830 && masterfname.lastModified() < bname.lastModified()))) {
831 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
834 return bname.absFileName();
835 // If we have a newer master file log or only a master log, show this
836 } else if (fname != masterfname
837 && (!fname.exists() && (masterfname.exists()
838 || fname.lastModified() < masterfname.lastModified()))) {
839 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
842 return masterfname.absFileName();
844 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
847 return fname.absFileName();
851 void Buffer::setReadonly(bool const flag)
853 if (d->read_only != flag) {
860 void Buffer::setFileName(FileName const & fname)
862 bool const changed = fname != d->filename;
865 lyxvc().file_found_hook(fname);
866 setReadonly(d->filename.isReadOnly());
872 int Buffer::readHeader(Lexer & lex)
874 int unknown_tokens = 0;
876 int begin_header_line = -1;
878 // Initialize parameters that may be/go lacking in header:
879 params().branchlist().clear();
880 params().preamble.erase();
881 params().options.erase();
882 params().master.erase();
883 params().float_placement.erase();
884 params().paperwidth.erase();
885 params().paperheight.erase();
886 params().leftmargin.erase();
887 params().rightmargin.erase();
888 params().topmargin.erase();
889 params().bottommargin.erase();
890 params().headheight.erase();
891 params().headsep.erase();
892 params().footskip.erase();
893 params().columnsep.erase();
894 params().fonts_cjk.erase();
895 params().listings_params.clear();
896 params().clearLayoutModules();
897 params().clearRemovedModules();
898 params().clearIncludedChildren();
899 params().pdfoptions().clear();
900 params().indiceslist().clear();
901 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
902 params().isbackgroundcolor = false;
903 params().fontcolor = RGBColor(0, 0, 0);
904 params().isfontcolor = false;
905 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
906 params().boxbgcolor = RGBColor(0xFF, 0, 0);
907 params().html_latex_start.clear();
908 params().html_latex_end.clear();
909 params().html_math_img_scale = 1.0;
910 params().output_sync_macro.erase();
911 params().setLocalLayout(string(), false);
912 params().setLocalLayout(string(), true);
914 for (int i = 0; i < 4; ++i) {
915 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
916 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
919 ErrorList & errorList = d->errorLists["Parse"];
928 if (token == "\\end_header")
932 if (token == "\\begin_header") {
933 begin_header_line = line;
937 LYXERR(Debug::PARSER, "Handling document header token: `"
940 string const result =
941 params().readToken(lex, token, d->filename.onlyPath());
942 if (!result.empty()) {
943 if (token == "\\textclass") {
944 d->layout_position = result;
947 docstring const s = bformat(_("Unknown token: "
951 errorList.push_back(ErrorItem(_("Document header error"),
956 if (begin_header_line) {
957 docstring const s = _("\\begin_header is missing");
958 errorList.push_back(ErrorItem(_("Document header error"),
962 params().makeDocumentClass();
964 return unknown_tokens;
969 // changed to be public and have one parameter
970 // Returns true if "\end_document" is not read (Asger)
971 bool Buffer::readDocument(Lexer & lex)
973 ErrorList & errorList = d->errorLists["Parse"];
976 // remove dummy empty par
977 paragraphs().clear();
979 if (!lex.checkFor("\\begin_document")) {
980 docstring const s = _("\\begin_document is missing");
981 errorList.push_back(ErrorItem(_("Document header error"),
987 if (params().output_changes) {
988 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
989 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
990 LaTeXFeatures::isAvailable("xcolor");
992 if (!dvipost && !xcolorulem) {
993 Alert::warning(_("Changes not shown in LaTeX output"),
994 _("Changes will not be highlighted in LaTeX output, "
995 "because neither dvipost nor xcolor/ulem are installed.\n"
996 "Please install these packages or redefine "
997 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
998 } else if (!xcolorulem) {
999 Alert::warning(_("Changes not shown in LaTeX output"),
1000 _("Changes will not be highlighted in LaTeX output "
1001 "when using pdflatex, because xcolor and ulem are not installed.\n"
1002 "Please install both packages or redefine "
1003 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
1007 if (!parent() && !params().master.empty()) {
1008 FileName const master_file = makeAbsPath(params().master,
1009 onlyPath(absFileName()));
1010 if (isLyXFileName(master_file.absFileName())) {
1012 checkAndLoadLyXFile(master_file, true);
1014 // necessary e.g. after a reload
1015 // to re-register the child (bug 5873)
1016 // FIXME: clean up updateMacros (here, only
1017 // child registering is needed).
1018 master->updateMacros();
1019 // set master as master buffer, but only
1020 // if we are a real child
1021 if (master->isChild(this))
1023 // if the master is not fully loaded
1024 // it is probably just loading this
1025 // child. No warning needed then.
1026 else if (master->isFullyLoaded())
1027 LYXERR0("The master '"
1029 << "' assigned to this document ("
1031 << ") does not include "
1032 "this document. Ignoring the master assignment.");
1037 // assure we have a default index
1038 params().indiceslist().addDefault(B_("Index"));
1041 if (FileName::isAbsolute(params().origin))
1042 d->old_position = params().origin;
1044 d->old_position = filePath();
1045 bool const res = text().read(lex, errorList, d->inset);
1046 d->old_position.clear();
1048 // inform parent buffer about local macros
1050 Buffer const * pbuf = parent();
1051 UserMacroSet::const_iterator cit = usermacros.begin();
1052 UserMacroSet::const_iterator end = usermacros.end();
1053 for (; cit != end; ++cit)
1054 pbuf->usermacros.insert(*cit);
1058 updateMacroInstances(InternalUpdate);
1063 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1065 Format const * fmt = formats.getFormat(format);
1068 // It is important to use the correct extension here, since some
1069 // converters create a wrong output file otherwise (e.g. html2latex)
1070 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1071 FileName const name(tempfile.name());
1072 ofdocstream os(name.toFilesystemEncoding().c_str());
1073 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1074 bool const success = !(os << contents).fail();
1077 bool converted = false;
1079 params().compressed = false;
1081 // remove dummy empty par
1082 paragraphs().clear();
1084 converted = importFile(format, name, errorList);
1093 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1095 if (!theConverters().isReachable(format, "lyx"))
1098 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1099 FileName const lyx(tempfile.name());
1100 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1101 return readFile(lyx) == ReadSuccess;
1107 bool Buffer::readString(string const & s)
1109 params().compressed = false;
1112 istringstream is(s);
1114 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1115 FileName const fn = tempfile.name();
1118 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1120 if (success && file_format != LYX_FORMAT) {
1121 // We need to call lyx2lyx, so write the input to a file
1122 ofstream os(fn.toFilesystemEncoding().c_str());
1125 // lyxvc in readFile
1126 if (readFile(fn) != ReadSuccess)
1130 if (readDocument(lex))
1136 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1140 if (!lex.setFile(fname)) {
1141 Alert::error(_("File Not Found"),
1142 bformat(_("Unable to open file `%1$s'."),
1143 from_utf8(fn.absFileName())));
1144 return ReadFileNotFound;
1148 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1149 if (ret_plf != ReadSuccess)
1152 if (file_format != LYX_FORMAT) {
1154 ReadStatus ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1155 if (ret_clf != ReadSuccess)
1157 ret_clf = readFile(tmpFile);
1158 if (ret_clf == ReadSuccess) {
1159 d->file_format = file_format;
1160 d->need_format_backup = true;
1165 // FIXME: InsetInfo needs to know whether the file is under VCS
1166 // during the parse process, so this has to be done before.
1167 lyxvc().file_found_hook(d->filename);
1169 if (readDocument(lex)) {
1170 Alert::error(_("Document format failure"),
1171 bformat(_("%1$s ended unexpectedly, which means"
1172 " that it is probably corrupted."),
1173 from_utf8(fn.absFileName())));
1174 return ReadDocumentFailure;
1177 d->file_fully_loaded = true;
1178 d->read_only = !d->filename.isWritable();
1179 params().compressed = formats.isZippedFile(d->filename);
1185 bool Buffer::isFullyLoaded() const
1187 return d->file_fully_loaded;
1191 void Buffer::setFullyLoaded(bool value)
1193 d->file_fully_loaded = value;
1197 bool Buffer::lastPreviewError() const
1199 return d->preview_error_;
1203 PreviewLoader * Buffer::loader() const
1205 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1207 if (!d->preview_loader_)
1208 d->preview_loader_ = new PreviewLoader(*this);
1209 return d->preview_loader_;
1213 void Buffer::removePreviews() const
1215 delete d->preview_loader_;
1216 d->preview_loader_ = 0;
1220 void Buffer::updatePreviews() const
1222 PreviewLoader * ploader = loader();
1226 InsetIterator it = inset_iterator_begin(*d->inset);
1227 InsetIterator const end = inset_iterator_end(*d->inset);
1228 for (; it != end; ++it)
1229 it->addPreview(it, *ploader);
1231 ploader->startLoading();
1235 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1236 FileName const & fn, int & file_format) const
1238 if(!lex.checkFor("\\lyxformat")) {
1239 Alert::error(_("Document format failure"),
1240 bformat(_("%1$s is not a readable LyX document."),
1241 from_utf8(fn.absFileName())));
1242 return ReadNoLyXFormat;
1248 // LyX formats 217 and earlier were written as 2.17. This corresponds
1249 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1250 // these cases. See also: www.lyx.org/trac/changeset/1313.
1251 size_t dot = tmp_format.find_first_of(".,");
1252 if (dot != string::npos)
1253 tmp_format.erase(dot, 1);
1255 file_format = convert<int>(tmp_format);
1260 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1261 FileName & tmpfile, int from_format)
1263 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1264 tempfile.setAutoRemove(false);
1265 tmpfile = tempfile.name();
1266 if(tmpfile.empty()) {
1267 Alert::error(_("Conversion failed"),
1268 bformat(_("%1$s is from a different"
1269 " version of LyX, but a temporary"
1270 " file for converting it could"
1271 " not be created."),
1272 from_utf8(fn.absFileName())));
1273 return LyX2LyXNoTempFile;
1276 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1277 if (lyx2lyx.empty()) {
1278 Alert::error(_("Conversion script not found"),
1279 bformat(_("%1$s is from a different"
1280 " version of LyX, but the"
1281 " conversion script lyx2lyx"
1282 " could not be found."),
1283 from_utf8(fn.absFileName())));
1284 return LyX2LyXNotFound;
1288 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1289 ostringstream command;
1290 command << os::python()
1291 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1292 << " -t " << convert<string>(LYX_FORMAT)
1293 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1294 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1295 string const command_str = command.str();
1297 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1299 cmd_ret const ret = runCommand(command_str);
1300 if (ret.first != 0) {
1301 if (from_format < LYX_FORMAT) {
1302 Alert::error(_("Conversion script failed"),
1303 bformat(_("%1$s is from an older version"
1304 " of LyX and the lyx2lyx script"
1305 " failed to convert it."),
1306 from_utf8(fn.absFileName())));
1307 return LyX2LyXOlderFormat;
1309 Alert::error(_("Conversion script failed"),
1310 bformat(_("%1$s is from a newer version"
1311 " of LyX and the lyx2lyx script"
1312 " failed to convert it."),
1313 from_utf8(fn.absFileName())));
1314 return LyX2LyXNewerFormat;
1321 FileName Buffer::getBackupName() const {
1322 FileName const & fn = fileName();
1323 string const fname = fn.onlyFileNameWithoutExt();
1324 string const fext = fn.extension();
1325 string const fpath = lyxrc.backupdir_path.empty() ?
1326 fn.onlyPath().absFileName() :
1327 lyxrc.backupdir_path;
1328 string const fform = convert<string>(d->file_format);
1329 string const backname = fname + "-lyxformat-" + fform;
1330 FileName backup(addName(fpath, addExtension(backname, fext)));
1332 // limit recursion, just in case
1334 unsigned long orig_checksum = 0;
1335 while (backup.exists() && v < 100) {
1336 if (orig_checksum == 0)
1337 orig_checksum = fn.checksum();
1338 unsigned long new_checksum = backup.checksum();
1339 if (orig_checksum == new_checksum) {
1340 LYXERR(Debug::FILES, "Not backing up " << fn <<
1341 "since " << backup << "has the same checksum.");
1342 // a bit of a hack, but we have to check this anyway
1343 // below, and setting this is simpler than introducing
1344 // a special boolean for this purpose.
1348 string const newbackname = backname + "-" + convert<string>(v);
1349 backup.set(addName(fpath, addExtension(newbackname, fext)));
1352 return v < 100 ? backup : FileName();
1356 // Should probably be moved to somewhere else: BufferView? GuiView?
1357 bool Buffer::save() const
1359 docstring const file = makeDisplayPath(absFileName(), 20);
1360 d->filename.refresh();
1362 // check the read-only status before moving the file as a backup
1363 if (d->filename.exists()) {
1364 bool const read_only = !d->filename.isWritable();
1366 Alert::warning(_("File is read-only"),
1367 bformat(_("The file %1$s cannot be written because it "
1368 "is marked as read-only."), file));
1373 // ask if the disk file has been externally modified (use checksum method)
1374 if (fileName().exists() && isExternallyModified(checksum_method)) {
1376 bformat(_("Document %1$s has been externally modified. "
1377 "Are you sure you want to overwrite this file?"), file);
1378 int const ret = Alert::prompt(_("Overwrite modified file?"),
1379 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1384 // We don't need autosaves in the immediate future. (Asger)
1385 resetAutosaveTimers();
1387 // if the file does not yet exist, none of the backup activity
1388 // that follows is necessary
1389 if (!fileName().exists()) {
1390 if (!writeFile(fileName()))
1396 // we first write the file to a new name, then move it to its
1397 // proper location once that has been done successfully. that
1398 // way we preserve the original file if something goes wrong.
1399 string const justname = fileName().onlyFileNameWithoutExt();
1400 boost::scoped_ptr<TempFile>
1401 tempfile(new TempFile(fileName().onlyPath(),
1402 justname + "-XXXXXX.lyx"));
1403 bool const symlink = fileName().isSymLink();
1405 tempfile->setAutoRemove(false);
1407 FileName savefile(tempfile->name());
1408 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1409 if (!writeFile(savefile))
1412 // we will set this to false if we fail
1413 bool made_backup = true;
1415 FileName backupName;
1416 bool const needBackup = lyxrc.make_backup || d->need_format_backup;
1418 if (d->need_format_backup)
1419 backupName = getBackupName();
1421 // If we for some reason failed to find a backup name in case of
1422 // a format change, this will still set one. It's the best we can
1424 if (backupName.empty()) {
1425 backupName.set(fileName().absFileName() + "~");
1426 if (!lyxrc.backupdir_path.empty()) {
1427 string const mangledName =
1428 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1429 backupName.set(addName(lyxrc.backupdir_path, mangledName));
1433 LYXERR(Debug::FILES, "Backing up original file to " <<
1434 backupName.absFileName());
1435 // Except file is symlink do not copy because of #6587.
1436 // Hard links have bad luck.
1437 made_backup = symlink ?
1438 fileName().copyTo(backupName):
1439 fileName().moveTo(backupName);
1442 Alert::error(_("Backup failure"),
1443 bformat(_("Cannot create backup file %1$s.\n"
1444 "Please check whether the directory exists and is writable."),
1445 from_utf8(backupName.absFileName())));
1446 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1447 } else if (d->need_format_backup) {
1448 // the original file has been backed up successfully, so we
1449 // will not need to do that again
1450 d->need_format_backup = false;
1454 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1455 // Only do this if tempfile is not in autoremove mode
1458 // If we have no symlink, we can simply rename the temp file.
1459 // Otherwise, we need to copy it so the symlink stays intact.
1460 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1461 savefile.moveTo(fileName()))
1463 // saveCheckSum() was already called by writeFile(), but the
1464 // time stamp is invalidated by copying/moving
1467 if (d->file_format != LYX_FORMAT)
1468 // the file associated with this buffer is now in the current format
1469 d->file_format = LYX_FORMAT;
1472 // else we saved the file, but failed to move it to the right location.
1474 if (needBackup && made_backup && !symlink) {
1475 // the original file was moved to some new location, so it will look
1476 // to the user as if it was deleted. (see bug #9234.) we could try
1477 // to restore it, but that would basically mean trying to do again
1478 // what we just failed to do. better to leave things as they are.
1479 Alert::error(_("Write failure"),
1480 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1481 "But LyX could not move it to:\n %2$s.\n"
1482 "Your original file has been backed up to:\n %3$s"),
1483 from_utf8(savefile.absFileName()),
1484 from_utf8(fileName().absFileName()),
1485 from_utf8(backupName.absFileName())));
1487 // either we did not try to make a backup, or else we tried and failed,
1488 // or else the original file was a symlink, in which case it was copied,
1489 // not moved. so the original file is intact.
1490 Alert::error(_("Write failure"),
1491 bformat(_("Cannot move saved file to:\n %1$s.\n"
1492 "But the file has successfully been saved as:\n %2$s."),
1493 from_utf8(fileName().absFileName()),
1494 from_utf8(savefile.absFileName())));
1500 bool Buffer::writeFile(FileName const & fname) const
1502 if (d->read_only && fname == d->filename)
1505 bool retval = false;
1507 docstring const str = bformat(_("Saving document %1$s..."),
1508 makeDisplayPath(fname.absFileName()));
1511 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1513 if (params().compressed) {
1514 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1515 retval = ofs && write(ofs);
1517 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1518 retval = ofs && write(ofs);
1522 message(str + _(" could not write file!"));
1527 // removeAutosaveFile();
1530 message(str + _(" done."));
1536 docstring Buffer::emergencyWrite()
1538 // No need to save if the buffer has not changed.
1542 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1544 docstring user_message = bformat(
1545 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1547 // We try to save three places:
1548 // 1) Same place as document. Unless it is an unnamed doc.
1550 string s = absFileName();
1553 if (writeFile(FileName(s))) {
1555 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1556 return user_message;
1558 user_message += " " + _("Save failed! Trying again...\n");
1562 // 2) In HOME directory.
1563 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1565 lyxerr << ' ' << s << endl;
1566 if (writeFile(FileName(s))) {
1568 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1569 return user_message;
1572 user_message += " " + _("Save failed! Trying yet again...\n");
1574 // 3) In "/tmp" directory.
1575 // MakeAbsPath to prepend the current
1576 // drive letter on OS/2
1577 s = addName(package().temp_dir().absFileName(), absFileName());
1579 lyxerr << ' ' << s << endl;
1580 if (writeFile(FileName(s))) {
1582 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1583 return user_message;
1586 user_message += " " + _("Save failed! Bummer. Document is lost.");
1589 return user_message;
1593 bool Buffer::write(ostream & ofs) const
1596 // Use the standard "C" locale for file output.
1597 ofs.imbue(locale::classic());
1600 // The top of the file should not be written by params().
1602 // write out a comment in the top of the file
1603 // Important: Keep the version formatting in sync with lyx2lyx and
1604 // tex2lyx (bug 7951)
1605 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1606 << " created this file. For more info see http://www.lyx.org/\n"
1607 << "\\lyxformat " << LYX_FORMAT << "\n"
1608 << "\\begin_document\n";
1610 /// For each author, set 'used' to true if there is a change
1611 /// by this author in the document; otherwise set it to 'false'.
1612 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1613 AuthorList::Authors::const_iterator a_end = params().authors().end();
1614 for (; a_it != a_end; ++a_it)
1615 a_it->setUsed(false);
1617 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1618 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1619 for ( ; it != end; ++it)
1620 it->checkAuthors(params().authors());
1622 // now write out the buffer parameters.
1623 ofs << "\\begin_header\n";
1624 params().writeFile(ofs, this);
1625 ofs << "\\end_header\n";
1628 ofs << "\n\\begin_body\n";
1630 ofs << "\n\\end_body\n";
1632 // Write marker that shows file is complete
1633 ofs << "\\end_document" << endl;
1635 // Shouldn't really be needed....
1638 // how to check if close went ok?
1639 // Following is an attempt... (BE 20001011)
1641 // good() returns false if any error occurred, including some
1642 // formatting error.
1643 // bad() returns true if something bad happened in the buffer,
1644 // which should include file system full errors.
1649 lyxerr << "File was not closed properly." << endl;
1656 bool Buffer::makeLaTeXFile(FileName const & fname,
1657 string const & original_path,
1658 OutputParams const & runparams_in,
1659 OutputWhat output) const
1661 OutputParams runparams = runparams_in;
1663 // XeTeX with TeX fonts is only safe with ASCII encoding,
1664 // but the "flavor" is not known in BufferParams::encoding().
1665 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX))
1666 runparams.encoding = encodings.fromLyXName("ascii");
1668 string const encoding = runparams.encoding->iconvName();
1669 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1672 try { ofs.reset(encoding); }
1673 catch (iconv_codecvt_facet_exception const & e) {
1674 lyxerr << "Caught iconv exception: " << e.what() << endl;
1675 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1676 "verify that the support software for your encoding (%1$s) is "
1677 "properly installed"), from_ascii(encoding)));
1680 if (!openFileWrite(ofs, fname))
1683 ErrorList & errorList = d->errorLists["Export"];
1685 bool failed_export = false;
1686 otexstream os(ofs, d->texrow);
1688 // make sure we are ready to export
1689 // this needs to be done before we validate
1690 // FIXME Do we need to do this all the time? I.e., in children
1691 // of a master we are exporting?
1693 updateMacroInstances(OutputUpdate);
1696 os.texrow().reset();
1697 writeLaTeXSource(os, original_path, runparams, output);
1699 catch (EncodingException const & e) {
1700 docstring const failed(1, e.failed_char);
1702 oss << "0x" << hex << e.failed_char << dec;
1703 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1704 " (code point %2$s)"),
1705 failed, from_utf8(oss.str()));
1706 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1707 "representable in the chosen encoding.\n"
1708 "Changing the document encoding to utf8 could help."),
1709 e.par_id, e.pos, e.pos + 1));
1710 failed_export = true;
1712 catch (iconv_codecvt_facet_exception const & e) {
1713 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1714 _(e.what()), -1, 0, 0));
1715 failed_export = true;
1717 catch (exception const & e) {
1718 errorList.push_back(ErrorItem(_("conversion failed"),
1719 _(e.what()), -1, 0, 0));
1720 failed_export = true;
1723 lyxerr << "Caught some really weird exception..." << endl;
1729 failed_export = true;
1730 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1733 if (runparams_in.silent)
1737 return !failed_export;
1741 void Buffer::writeLaTeXSource(otexstream & os,
1742 string const & original_path,
1743 OutputParams const & runparams_in,
1744 OutputWhat output) const
1746 // The child documents, if any, shall be already loaded at this point.
1748 OutputParams runparams = runparams_in;
1750 // XeTeX with TeX fonts is only safe with ASCII encoding,
1751 // but the "flavor" is not known in BufferParams::encoding().
1752 if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX))
1753 runparams.encoding = encodings.fromLyXName("ascii");
1754 // FIXME: when only the current paragraph is shown, this is ignored
1755 // (or not reached) and characters encodable in the current
1756 // encoding are not converted to ASCII-representation.
1758 // If we are compiling a file standalone, even if this is the
1759 // child of some other buffer, let's cut the link here, so the
1760 // file is really independent and no concurring settings from
1761 // the master (e.g. branch state) interfere (see #8100).
1762 if (!runparams.is_child)
1763 d->ignore_parent = true;
1765 // Classify the unicode characters appearing in math insets
1766 BufferEncodings::initUnicodeMath(*this);
1768 // validate the buffer.
1769 LYXERR(Debug::LATEX, " Validating buffer...");
1770 LaTeXFeatures features(*this, params(), runparams);
1772 // This is only set once per document (in master)
1773 if (!runparams.is_child)
1774 runparams.use_polyglossia = features.usePolyglossia();
1775 LYXERR(Debug::LATEX, " Buffer validation done.");
1777 bool const output_preamble =
1778 output == FullSource || output == OnlyPreamble;
1779 bool const output_body =
1780 output == FullSource || output == OnlyBody;
1782 // The starting paragraph of the coming rows is the
1783 // first paragraph of the document. (Asger)
1784 if (output_preamble && runparams.nice) {
1785 os << "%% LyX " << lyx_version << " created this file. "
1786 "For more info, see http://www.lyx.org/.\n"
1787 "%% Do not edit unless you really know what "
1790 LYXERR(Debug::INFO, "lyx document header finished");
1792 // There are a few differences between nice LaTeX and usual files:
1793 // usual files have \batchmode and special input@path to allow
1794 // inclusion of figures specified by an explicitly relative path
1795 // (i.e., a path starting with './' or '../') with either \input or
1796 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1797 // input@path is set when the actual parameter original_path is set.
1798 // This is done for usual tex-file, but not for nice-latex-file.
1799 // (Matthias 250696)
1800 // Note that input@path is only needed for something the user does
1801 // in the preamble, included .tex files or ERT, files included by
1802 // LyX work without it.
1803 if (output_preamble) {
1804 if (!runparams.nice) {
1805 // code for usual, NOT nice-latex-file
1806 os << "\\batchmode\n"; // changed from \nonstopmode
1808 if (!original_path.empty()) {
1810 // We don't know the encoding of inputpath
1811 docstring const inputpath = from_utf8(original_path);
1812 docstring uncodable_glyphs;
1813 Encoding const * const enc = runparams.encoding;
1815 for (size_t n = 0; n < inputpath.size(); ++n) {
1816 if (!enc->encodable(inputpath[n])) {
1817 docstring const glyph(1, inputpath[n]);
1818 LYXERR0("Uncodable character '"
1820 << "' in input path!");
1821 uncodable_glyphs += glyph;
1826 // warn user if we found uncodable glyphs.
1827 if (!uncodable_glyphs.empty()) {
1828 frontend::Alert::warning(
1829 _("Uncodable character in file path"),
1831 _("The path of your document\n"
1833 "contains glyphs that are unknown "
1834 "in the current document encoding "
1835 "(namely %2$s). This may result in "
1836 "incomplete output, unless "
1837 "TEXINPUTS contains the document "
1838 "directory and you don't use "
1839 "explicitly relative paths (i.e., "
1840 "paths starting with './' or "
1841 "'../') in the preamble or in ERT."
1842 "\n\nIn case of problems, choose "
1843 "an appropriate document encoding\n"
1844 "(such as utf8) or change the "
1846 inputpath, uncodable_glyphs));
1849 support::latex_path(original_path);
1850 if (contains(docdir, '#')) {
1851 docdir = subst(docdir, "#", "\\#");
1852 os << "\\catcode`\\#=11"
1853 "\\def\\#{#}\\catcode`\\#=6\n";
1855 if (contains(docdir, '%')) {
1856 docdir = subst(docdir, "%", "\\%");
1857 os << "\\catcode`\\%=11"
1858 "\\def\\%{%}\\catcode`\\%=14\n";
1860 os << "\\makeatletter\n"
1861 << "\\def\\input@path{{"
1863 << "\\makeatother\n";
1867 // get parent macros (if this buffer has a parent) which will be
1868 // written at the document begin further down.
1869 MacroSet parentMacros;
1870 listParentMacros(parentMacros, features);
1872 // Write the preamble
1873 runparams.use_babel = params().writeLaTeX(os, features,
1874 d->filename.onlyPath());
1876 // Japanese might be required only in some children of a document,
1877 // but once required, we must keep use_japanese true.
1878 runparams.use_japanese |= features.isRequired("japanese");
1881 // Restore the parenthood if needed
1882 if (!runparams.is_child)
1883 d->ignore_parent = false;
1888 os << "\\begin{document}\n";
1890 // output the parent macros
1891 MacroSet::iterator it = parentMacros.begin();
1892 MacroSet::iterator end = parentMacros.end();
1893 for (; it != end; ++it) {
1894 int num_lines = (*it)->write(os.os(), true);
1895 os.texrow().newlines(num_lines);
1898 } // output_preamble
1900 os.texrow().start(paragraphs().begin()->id(), 0);
1902 LYXERR(Debug::INFO, "preamble finished, now the body.");
1905 latexParagraphs(*this, text(), os, runparams);
1907 // Restore the parenthood if needed
1908 if (!runparams.is_child)
1909 d->ignore_parent = false;
1911 // add this just in case after all the paragraphs
1914 if (output_preamble) {
1915 os << "\\end{document}\n";
1916 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1918 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1920 runparams_in.encoding = runparams.encoding;
1922 os.texrow().finalize();
1924 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1925 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1929 void Buffer::makeDocBookFile(FileName const & fname,
1930 OutputParams const & runparams,
1931 OutputWhat output) const
1933 LYXERR(Debug::LATEX, "makeDocBookFile...");
1936 if (!openFileWrite(ofs, fname))
1939 // make sure we are ready to export
1940 // this needs to be done before we validate
1942 updateMacroInstances(OutputUpdate);
1944 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1948 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1952 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1953 OutputParams const & runparams,
1954 OutputWhat output) const
1956 LaTeXFeatures features(*this, params(), runparams);
1959 d->texrow.reset(false);
1961 DocumentClass const & tclass = params().documentClass();
1962 string const & top_element = tclass.latexname();
1964 bool const output_preamble =
1965 output == FullSource || output == OnlyPreamble;
1966 bool const output_body =
1967 output == FullSource || output == OnlyBody;
1969 if (output_preamble) {
1970 if (runparams.flavor == OutputParams::XML)
1971 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1974 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1977 if (! tclass.class_header().empty())
1978 os << from_ascii(tclass.class_header());
1979 else if (runparams.flavor == OutputParams::XML)
1980 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1981 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1983 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1985 docstring preamble = from_utf8(params().preamble);
1986 if (runparams.flavor != OutputParams::XML ) {
1987 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1988 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1989 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1990 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1993 string const name = runparams.nice
1994 ? changeExtension(absFileName(), ".sgml") : fname;
1995 preamble += features.getIncludedFiles(name);
1996 preamble += features.getLyXSGMLEntities();
1998 if (!preamble.empty()) {
1999 os << "\n [ " << preamble << " ]";
2005 string top = top_element;
2007 if (runparams.flavor == OutputParams::XML)
2008 top += params().language->code();
2010 top += params().language->code().substr(0, 2);
2013 if (!params().options.empty()) {
2015 top += params().options;
2018 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
2019 << " file was created by LyX " << lyx_version
2020 << "\n See http://www.lyx.org/ for more information -->\n";
2022 params().documentClass().counters().reset();
2024 sgml::openTag(os, top);
2026 docbookParagraphs(text(), *this, os, runparams);
2027 sgml::closeTag(os, top_element);
2032 void Buffer::makeLyXHTMLFile(FileName const & fname,
2033 OutputParams const & runparams) const
2035 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
2038 if (!openFileWrite(ofs, fname))
2041 // make sure we are ready to export
2042 // this has to be done before we validate
2043 updateBuffer(UpdateMaster, OutputUpdate);
2044 updateMacroInstances(OutputUpdate);
2046 writeLyXHTMLSource(ofs, runparams, FullSource);
2050 lyxerr << "File '" << fname << "' was not closed properly." << endl;
2054 void Buffer::writeLyXHTMLSource(odocstream & os,
2055 OutputParams const & runparams,
2056 OutputWhat output) const
2058 LaTeXFeatures features(*this, params(), runparams);
2060 d->bibinfo_.makeCitationLabels(*this);
2062 bool const output_preamble =
2063 output == FullSource || output == OnlyPreamble;
2064 bool const output_body =
2065 output == FullSource || output == OnlyBody || output == IncludedFile;
2067 if (output_preamble) {
2068 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
2069 << "<!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"
2070 // FIXME Language should be set properly.
2071 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2073 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2074 // FIXME Presumably need to set this right
2075 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2077 docstring const & doctitle = features.htmlTitle();
2079 << (doctitle.empty() ?
2080 from_ascii("LyX Document") :
2081 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2084 docstring styles = features.getTClassHTMLPreamble();
2085 if (!styles.empty())
2086 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2088 styles = from_utf8(features.getPreambleSnippets());
2089 if (!styles.empty())
2090 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2092 // we will collect CSS information in a stream, and then output it
2093 // either here, as part of the header, or else in a separate file.
2094 odocstringstream css;
2095 styles = from_utf8(features.getCSSSnippets());
2096 if (!styles.empty())
2097 css << "/* LyX Provided Styles */\n" << styles << '\n';
2099 styles = features.getTClassHTMLStyles();
2100 if (!styles.empty())
2101 css << "/* Layout-provided Styles */\n" << styles << '\n';
2103 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2104 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2105 if (needfg || needbg) {
2106 css << "\nbody {\n";
2109 << from_ascii(X11hexname(params().fontcolor))
2112 css << " background-color: "
2113 << from_ascii(X11hexname(params().backgroundcolor))
2118 docstring const dstyles = css.str();
2119 if (!dstyles.empty()) {
2120 bool written = false;
2121 if (params().html_css_as_file) {
2122 // open a file for CSS info
2124 string const fcssname = addName(temppath(), "docstyle.css");
2125 FileName const fcssfile = FileName(fcssname);
2126 if (openFileWrite(ocss, fcssfile)) {
2130 // write link to header
2131 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2133 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2136 // we are here if the CSS is supposed to be written to the header
2137 // or if we failed to write it to an external file.
2139 os << "<style type='text/css'>\n"
2148 bool const output_body_tag = (output != IncludedFile);
2149 if (output_body_tag)
2152 if (output != IncludedFile)
2153 // if we're an included file, the counters are in the master.
2154 params().documentClass().counters().reset();
2155 xhtmlParagraphs(text(), *this, xs, runparams);
2156 if (output_body_tag)
2160 if (output_preamble)
2165 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2166 // Other flags: -wall -v0 -x
2167 int Buffer::runChktex()
2171 // get LaTeX-Filename
2172 FileName const path(temppath());
2173 string const name = addName(path.absFileName(), latexName());
2174 string const org_path = filePath();
2176 PathChanger p(path); // path to LaTeX file
2177 message(_("Running chktex..."));
2179 // Generate the LaTeX file if neccessary
2180 OutputParams runparams(¶ms().encoding());
2181 runparams.flavor = OutputParams::LATEX;
2182 runparams.nice = false;
2183 runparams.linelen = lyxrc.plaintext_linelen;
2184 makeLaTeXFile(FileName(name), org_path, runparams);
2187 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2188 int const res = chktex.run(terr); // run chktex
2191 Alert::error(_("chktex failure"),
2192 _("Could not run chktex successfully."));
2194 ErrorList & errlist = d->errorLists["ChkTeX"];
2196 bufferErrors(terr, errlist);
2201 if (runparams.silent)
2202 d->errorLists["ChkTeX"].clear();
2210 void Buffer::validate(LaTeXFeatures & features) const
2212 // Validate the buffer params, but not for included
2213 // files, since they also use the parent buffer's
2215 if (!features.runparams().is_child)
2216 params().validate(features);
2218 for_each(paragraphs().begin(), paragraphs().end(),
2219 bind(&Paragraph::validate, _1, ref(features)));
2221 if (lyxerr.debugging(Debug::LATEX)) {
2222 features.showStruct();
2227 void Buffer::getLabelList(vector<docstring> & list) const
2229 // If this is a child document, use the master's list instead.
2231 masterBuffer()->getLabelList(list);
2236 shared_ptr<Toc> toc = d->toc_backend.toc("label");
2237 Toc::const_iterator toc_it = toc->begin();
2238 Toc::const_iterator end = toc->end();
2239 for (; toc_it != end; ++toc_it) {
2240 if (toc_it->depth() == 0)
2241 list.push_back(toc_it->str());
2246 void Buffer::updateBibfilesCache(UpdateScope scope) const
2248 // FIXME This is probably unnecssary, given where we call this.
2249 // If this is a child document, use the parent's cache instead.
2250 if (parent() && scope != UpdateChildOnly) {
2251 masterBuffer()->updateBibfilesCache();
2255 d->bibfiles_cache_.clear();
2256 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2257 if (it->lyxCode() == BIBTEX_CODE) {
2258 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2259 support::FileNameList const bibfiles = inset.getBibFiles();
2260 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2263 } else if (it->lyxCode() == INCLUDE_CODE) {
2264 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2265 Buffer const * const incbuf = inset.getChildBuffer();
2268 support::FileNameList const & bibfiles =
2269 incbuf->getBibfilesCache(UpdateChildOnly);
2270 if (!bibfiles.empty()) {
2271 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2277 d->bibfile_cache_valid_ = true;
2278 d->bibinfo_cache_valid_ = false;
2279 d->cite_labels_valid_ = false;
2283 void Buffer::invalidateBibinfoCache() const
2285 d->bibinfo_cache_valid_ = false;
2286 d->cite_labels_valid_ = false;
2287 // also invalidate the cache for the parent buffer
2288 Buffer const * const pbuf = d->parent();
2290 pbuf->invalidateBibinfoCache();
2294 void Buffer::invalidateBibfileCache() const
2296 d->bibfile_cache_valid_ = false;
2297 d->bibinfo_cache_valid_ = false;
2298 d->cite_labels_valid_ = false;
2299 // also invalidate the cache for the parent buffer
2300 Buffer const * const pbuf = d->parent();
2302 pbuf->invalidateBibfileCache();
2306 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2308 // FIXME This is probably unnecessary, given where we call this.
2309 // If this is a child document, use the master's cache instead.
2310 Buffer const * const pbuf = masterBuffer();
2311 if (pbuf != this && scope != UpdateChildOnly)
2312 return pbuf->getBibfilesCache();
2314 if (!d->bibfile_cache_valid_)
2315 this->updateBibfilesCache(scope);
2317 return d->bibfiles_cache_;
2321 BiblioInfo const & Buffer::masterBibInfo() const
2323 Buffer const * const tmp = masterBuffer();
2325 return tmp->masterBibInfo();
2330 void Buffer::checkIfBibInfoCacheIsValid() const
2332 // use the master's cache
2333 Buffer const * const tmp = masterBuffer();
2335 tmp->checkIfBibInfoCacheIsValid();
2339 // compare the cached timestamps with the actual ones.
2340 FileNameList const & bibfiles_cache = getBibfilesCache();
2341 FileNameList::const_iterator ei = bibfiles_cache.begin();
2342 FileNameList::const_iterator en = bibfiles_cache.end();
2343 for (; ei != en; ++ ei) {
2344 time_t lastw = ei->lastModified();
2345 time_t prevw = d->bibfile_status_[*ei];
2346 if (lastw != prevw) {
2347 d->bibinfo_cache_valid_ = false;
2348 d->cite_labels_valid_ = false;
2349 d->bibfile_status_[*ei] = lastw;
2355 void Buffer::reloadBibInfoCache() const
2357 // use the master's cache
2358 Buffer const * const tmp = masterBuffer();
2360 tmp->reloadBibInfoCache();
2364 checkIfBibInfoCacheIsValid();
2365 if (d->bibinfo_cache_valid_)
2368 d->bibinfo_.clear();
2370 d->bibinfo_cache_valid_ = true;
2374 void Buffer::collectBibKeys() const
2376 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2377 it->collectBibKeys(it);
2381 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2383 Buffer const * tmp = masterBuffer();
2384 BiblioInfo & masterbi = (tmp == this) ?
2385 d->bibinfo_ : tmp->d->bibinfo_;
2386 masterbi.mergeBiblioInfo(bi);
2390 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2392 Buffer const * tmp = masterBuffer();
2393 BiblioInfo & masterbi = (tmp == this) ?
2394 d->bibinfo_ : tmp->d->bibinfo_;
2399 void Buffer::makeCitationLabels() const
2401 Buffer const * const master = masterBuffer();
2402 return d->bibinfo_.makeCitationLabels(*master);
2406 bool Buffer::citeLabelsValid() const
2408 return masterBuffer()->d->cite_labels_valid_;
2412 void Buffer::removeBiblioTempFiles() const
2414 // We remove files that contain LaTeX commands specific to the
2415 // particular bibliographic style being used, in order to avoid
2416 // LaTeX errors when we switch style.
2417 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2418 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2419 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2420 aux_file.removeFile();
2421 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2422 bbl_file.removeFile();
2423 // Also for the parent buffer
2424 Buffer const * const pbuf = parent();
2426 pbuf->removeBiblioTempFiles();
2430 bool Buffer::isDepClean(string const & name) const
2432 DepClean::const_iterator const it = d->dep_clean.find(name);
2433 if (it == d->dep_clean.end())
2439 void Buffer::markDepClean(string const & name)
2441 d->dep_clean[name] = true;
2445 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2448 // FIXME? if there is an Buffer LFUN that can be dispatched even
2449 // if internal, put a switch '(cmd.action)' here.
2455 switch (cmd.action()) {
2457 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2458 flag.setOnOff(isReadonly());
2461 // FIXME: There is need for a command-line import.
2462 //case LFUN_BUFFER_IMPORT:
2464 case LFUN_BUFFER_AUTO_SAVE:
2467 case LFUN_BUFFER_EXPORT_CUSTOM:
2468 // FIXME: Nothing to check here?
2471 case LFUN_BUFFER_EXPORT: {
2472 docstring const arg = cmd.argument();
2473 if (arg == "custom") {
2477 string format = to_utf8(arg);
2478 size_t pos = format.find(' ');
2479 if (pos != string::npos)
2480 format = format.substr(0, pos);
2481 enable = params().isExportable(format);
2483 flag.message(bformat(
2484 _("Don't know how to export to format: %1$s"), arg));
2488 case LFUN_BUFFER_CHKTEX:
2489 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2492 case LFUN_BUILD_PROGRAM:
2493 enable = params().isExportable("program");
2496 case LFUN_BRANCH_ACTIVATE:
2497 case LFUN_BRANCH_DEACTIVATE:
2498 case LFUN_BRANCH_MASTER_ACTIVATE:
2499 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2500 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2501 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2502 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2503 : params().branchlist();
2504 docstring const branchName = cmd.argument();
2505 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2509 case LFUN_BRANCH_ADD:
2510 case LFUN_BRANCHES_RENAME:
2511 // if no Buffer is present, then of course we won't be called!
2514 case LFUN_BUFFER_LANGUAGE:
2515 enable = !isReadonly();
2518 case LFUN_BUFFER_VIEW_CACHE:
2519 (d->preview_file_).refresh();
2520 enable = (d->preview_file_).exists() && !(d->preview_file_).isFileEmpty();
2523 case LFUN_CHANGES_TRACK:
2524 flag.setEnabled(true);
2525 flag.setOnOff(params().track_changes);
2528 case LFUN_CHANGES_OUTPUT:
2529 flag.setEnabled(true);
2530 flag.setOnOff(params().output_changes);
2533 case LFUN_BUFFER_TOGGLE_COMPRESSION: {
2534 flag.setOnOff(params().compressed);
2538 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC: {
2539 flag.setOnOff(params().output_sync);
2546 flag.setEnabled(enable);
2551 void Buffer::dispatch(string const & command, DispatchResult & result)
2553 return dispatch(lyxaction.lookupFunc(command), result);
2557 // NOTE We can end up here even if we have no GUI, because we are called
2558 // by LyX::exec to handled command-line requests. So we may need to check
2559 // whether we have a GUI or not. The boolean use_gui holds this information.
2560 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2563 // FIXME? if there is an Buffer LFUN that can be dispatched even
2564 // if internal, put a switch '(cmd.action())' here.
2565 dr.dispatched(false);
2568 string const argument = to_utf8(func.argument());
2569 // We'll set this back to false if need be.
2570 bool dispatched = true;
2571 undo().beginUndoGroup();
2573 switch (func.action()) {
2574 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2575 if (lyxvc().inUse()) {
2576 string log = lyxvc().toggleReadOnly();
2581 setReadonly(!isReadonly());
2584 case LFUN_BUFFER_EXPORT: {
2585 ExportStatus const status = doExport(argument, false);
2586 dr.setError(status != ExportSuccess);
2587 if (status != ExportSuccess)
2588 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2593 case LFUN_BUILD_PROGRAM: {
2594 ExportStatus const status = doExport("program", true);
2595 dr.setError(status != ExportSuccess);
2596 if (status != ExportSuccess)
2597 dr.setMessage(_("Error generating literate programming code."));
2601 case LFUN_BUFFER_CHKTEX:
2605 case LFUN_BUFFER_EXPORT_CUSTOM: {
2607 string command = split(argument, format_name, ' ');
2608 Format const * format = formats.getFormat(format_name);
2610 lyxerr << "Format \"" << format_name
2611 << "\" not recognized!"
2616 // The name of the file created by the conversion process
2619 // Output to filename
2620 if (format->name() == "lyx") {
2621 string const latexname = latexName(false);
2622 filename = changeExtension(latexname,
2623 format->extension());
2624 filename = addName(temppath(), filename);
2626 if (!writeFile(FileName(filename)))
2630 doExport(format_name, true, filename);
2633 // Substitute $$FName for filename
2634 if (!contains(command, "$$FName"))
2635 command = "( " + command + " ) < $$FName";
2636 command = subst(command, "$$FName", filename);
2638 // Execute the command in the background
2640 call.startscript(Systemcall::DontWait, command,
2641 filePath(), layoutPos());
2645 // FIXME: There is need for a command-line import.
2647 case LFUN_BUFFER_IMPORT:
2652 case LFUN_BUFFER_AUTO_SAVE:
2654 resetAutosaveTimers();
2657 case LFUN_BRANCH_ACTIVATE:
2658 case LFUN_BRANCH_DEACTIVATE:
2659 case LFUN_BRANCH_MASTER_ACTIVATE:
2660 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2661 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2662 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2663 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2666 docstring const branch_name = func.argument();
2667 // the case without a branch name is handled elsewhere
2668 if (branch_name.empty()) {
2672 Branch * branch = buf->params().branchlist().find(branch_name);
2674 LYXERR0("Branch " << branch_name << " does not exist.");
2676 docstring const msg =
2677 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2681 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2682 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2683 if (branch->isSelected() != activate) {
2684 buf->undo().recordUndoBufferParams(CursorData());
2685 branch->setSelected(activate);
2687 dr.screenUpdate(Update::Force);
2688 dr.forceBufferUpdate();
2693 case LFUN_BRANCH_ADD: {
2694 docstring branch_name = func.argument();
2695 if (branch_name.empty()) {
2699 BranchList & branch_list = params().branchlist();
2700 vector<docstring> const branches =
2701 getVectorFromString(branch_name, branch_list.separator());
2703 for (vector<docstring>::const_iterator it = branches.begin();
2704 it != branches.end(); ++it) {
2706 Branch * branch = branch_list.find(branch_name);
2708 LYXERR0("Branch " << branch_name << " already exists.");
2712 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2714 undo().recordUndoBufferParams(CursorData());
2715 branch_list.add(branch_name);
2716 branch = branch_list.find(branch_name);
2717 string const x11hexname = X11hexname(branch->color());
2718 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2719 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2721 dr.screenUpdate(Update::Force);
2729 case LFUN_BRANCHES_RENAME: {
2730 if (func.argument().empty())
2733 docstring const oldname = from_utf8(func.getArg(0));
2734 docstring const newname = from_utf8(func.getArg(1));
2735 InsetIterator it = inset_iterator_begin(inset());
2736 InsetIterator const end = inset_iterator_end(inset());
2737 bool success = false;
2738 for (; it != end; ++it) {
2739 if (it->lyxCode() == BRANCH_CODE) {
2740 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2741 if (ins.branch() == oldname) {
2742 undo().recordUndo(CursorData(it));
2743 ins.rename(newname);
2748 if (it->lyxCode() == INCLUDE_CODE) {
2749 // get buffer of external file
2750 InsetInclude const & ins =
2751 static_cast<InsetInclude const &>(*it);
2752 Buffer * child = ins.getChildBuffer();
2755 child->dispatch(func, dr);
2760 dr.screenUpdate(Update::Force);
2761 dr.forceBufferUpdate();
2766 case LFUN_BUFFER_VIEW_CACHE:
2767 if (!formats.view(*this, d->preview_file_,
2768 d->preview_format_))
2769 dr.setMessage(_("Error viewing the output file."));
2772 case LFUN_CHANGES_TRACK:
2773 if (params().save_transient_properties)
2774 undo().recordUndoBufferParams(CursorData());
2775 params().track_changes = !params().track_changes;
2776 if (!params().track_changes)
2777 dr.forceChangesUpdate();
2780 case LFUN_CHANGES_OUTPUT:
2781 if (params().save_transient_properties)
2782 undo().recordUndoBufferParams(CursorData());
2783 params().output_changes = !params().output_changes;
2784 if (params().output_changes) {
2785 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
2786 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
2787 LaTeXFeatures::isAvailable("xcolor");
2789 if (!dvipost && !xcolorulem) {
2790 Alert::warning(_("Changes not shown in LaTeX output"),
2791 _("Changes will not be highlighted in LaTeX output, "
2792 "because neither dvipost nor xcolor/ulem are installed.\n"
2793 "Please install these packages or redefine "
2794 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2795 } else if (!xcolorulem) {
2796 Alert::warning(_("Changes not shown in LaTeX output"),
2797 _("Changes will not be highlighted in LaTeX output "
2798 "when using pdflatex, because xcolor and ulem are not installed.\n"
2799 "Please install both packages or redefine "
2800 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
2805 case LFUN_BUFFER_TOGGLE_COMPRESSION:
2806 // turn compression on/off
2807 undo().recordUndoBufferParams(CursorData());
2808 params().compressed = !params().compressed;
2811 case LFUN_BUFFER_TOGGLE_OUTPUT_SYNC:
2812 undo().recordUndoBufferParams(CursorData());
2813 params().output_sync = !params().output_sync;
2820 dr.dispatched(dispatched);
2821 undo().endUndoGroup();
2825 void Buffer::changeLanguage(Language const * from, Language const * to)
2827 LASSERT(from, return);
2828 LASSERT(to, return);
2830 for_each(par_iterator_begin(),
2832 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2836 bool Buffer::isMultiLingual() const
2838 ParConstIterator end = par_iterator_end();
2839 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2840 if (it->isMultiLingual(params()))
2847 std::set<Language const *> Buffer::getLanguages() const
2849 std::set<Language const *> languages;
2850 getLanguages(languages);
2855 void Buffer::getLanguages(std::set<Language const *> & languages) const
2857 ParConstIterator end = par_iterator_end();
2858 // add the buffer language, even if it's not actively used
2859 languages.insert(language());
2860 // iterate over the paragraphs
2861 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2862 it->getLanguages(languages);
2864 ListOfBuffers clist = getDescendents();
2865 ListOfBuffers::const_iterator cit = clist.begin();
2866 ListOfBuffers::const_iterator const cen = clist.end();
2867 for (; cit != cen; ++cit)
2868 (*cit)->getLanguages(languages);
2872 DocIterator Buffer::getParFromID(int const id) const
2874 Buffer * buf = const_cast<Buffer *>(this);
2876 // John says this is called with id == -1 from undo
2877 lyxerr << "getParFromID(), id: " << id << endl;
2878 return doc_iterator_end(buf);
2881 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2882 if (it.paragraph().id() == id)
2885 return doc_iterator_end(buf);
2889 bool Buffer::hasParWithID(int const id) const
2891 return !getParFromID(id).atEnd();
2895 ParIterator Buffer::par_iterator_begin()
2897 return ParIterator(doc_iterator_begin(this));
2901 ParIterator Buffer::par_iterator_end()
2903 return ParIterator(doc_iterator_end(this));
2907 ParConstIterator Buffer::par_iterator_begin() const
2909 return ParConstIterator(doc_iterator_begin(this));
2913 ParConstIterator Buffer::par_iterator_end() const
2915 return ParConstIterator(doc_iterator_end(this));
2919 Language const * Buffer::language() const
2921 return params().language;
2925 docstring const Buffer::B_(string const & l10n) const
2927 return params().B_(l10n);
2931 bool Buffer::isClean() const
2933 return d->lyx_clean;
2937 bool Buffer::isExternallyModified(CheckMethod method) const
2939 LASSERT(d->filename.exists(), return false);
2940 // if method == timestamp, check timestamp before checksum
2941 return (method == checksum_method
2942 || d->timestamp_ != d->filename.lastModified())
2943 && d->checksum_ != d->filename.checksum();
2947 void Buffer::saveCheckSum() const
2949 FileName const & file = d->filename;
2952 if (file.exists()) {
2953 d->timestamp_ = file.lastModified();
2954 d->checksum_ = file.checksum();
2956 // in the case of save to a new file.
2963 void Buffer::markClean() const
2965 if (!d->lyx_clean) {
2966 d->lyx_clean = true;
2969 // if the .lyx file has been saved, we don't need an
2971 d->bak_clean = true;
2972 d->undo_.markDirty();
2976 void Buffer::setUnnamed(bool flag)
2982 bool Buffer::isUnnamed() const
2989 /// Don't check unnamed, here: isInternal() is used in
2990 /// newBuffer(), where the unnamed flag has not been set by anyone
2991 /// yet. Also, for an internal buffer, there should be no need for
2992 /// retrieving fileName() nor for checking if it is unnamed or not.
2993 bool Buffer::isInternal() const
2995 return d->internal_buffer;
2999 void Buffer::setInternal(bool flag)
3001 d->internal_buffer = flag;
3005 void Buffer::markDirty()
3008 d->lyx_clean = false;
3011 d->bak_clean = false;
3013 DepClean::iterator it = d->dep_clean.begin();
3014 DepClean::const_iterator const end = d->dep_clean.end();
3016 for (; it != end; ++it)
3021 FileName Buffer::fileName() const
3027 string Buffer::absFileName() const
3029 return d->filename.absFileName();
3033 string Buffer::filePath() const
3035 string const abs = d->filename.onlyPath().absFileName();
3038 int last = abs.length() - 1;
3040 return abs[last] == '/' ? abs : abs + '/';
3044 DocFileName Buffer::getReferencedFileName(string const & fn) const
3047 if (FileName::isAbsolute(fn) || !FileName::isAbsolute(params().origin))
3048 result.set(fn, filePath());
3050 // filePath() ends with a path separator
3051 FileName const test(filePath() + fn);
3053 result.set(fn, filePath());
3055 result.set(fn, params().origin);
3062 string Buffer::layoutPos() const
3064 return d->layout_position;
3068 void Buffer::setLayoutPos(string const & path)
3071 d->layout_position.clear();
3075 LATTEST(FileName::isAbsolute(path));
3077 d->layout_position =
3078 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
3080 if (d->layout_position.empty())
3081 d->layout_position = ".";
3085 bool Buffer::isReadonly() const
3087 return d->read_only;
3091 void Buffer::setParent(Buffer const * buffer)
3093 // Avoids recursive include.
3094 d->setParent(buffer == this ? 0 : buffer);
3099 Buffer const * Buffer::parent() const
3105 ListOfBuffers Buffer::allRelatives() const
3107 ListOfBuffers lb = masterBuffer()->getDescendents();
3108 lb.push_front(const_cast<Buffer *>(masterBuffer()));
3113 Buffer const * Buffer::masterBuffer() const
3115 // FIXME Should be make sure we are not in some kind
3116 // of recursive include? A -> B -> A will crash this.
3117 Buffer const * const pbuf = d->parent();
3121 return pbuf->masterBuffer();
3125 bool Buffer::isChild(Buffer * child) const
3127 return d->children_positions.find(child) != d->children_positions.end();
3131 DocIterator Buffer::firstChildPosition(Buffer const * child)
3133 Impl::BufferPositionMap::iterator it;
3134 it = d->children_positions.find(child);
3135 if (it == d->children_positions.end())
3136 return DocIterator(this);
3141 bool Buffer::hasChildren() const
3143 return !d->children_positions.empty();
3147 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3149 // loop over children
3150 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3151 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3152 for (; it != end; ++it) {
3153 Buffer * child = const_cast<Buffer *>(it->first);
3155 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3156 if (bit != clist.end())
3158 clist.push_back(child);
3160 // there might be grandchildren
3161 child->collectChildren(clist, true);
3166 ListOfBuffers Buffer::getChildren() const
3169 collectChildren(v, false);
3170 // Make sure we have not included ourselves.
3171 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3172 if (bit != v.end()) {
3173 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3180 ListOfBuffers Buffer::getDescendents() const
3183 collectChildren(v, true);
3184 // Make sure we have not included ourselves.
3185 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3186 if (bit != v.end()) {
3187 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3194 template<typename M>
3195 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3200 typename M::const_iterator it = m.lower_bound(x);
3201 if (it == m.begin())
3209 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3210 DocIterator const & pos) const
3212 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3214 // if paragraphs have no macro context set, pos will be empty
3218 // we haven't found anything yet
3219 DocIterator bestPos = owner_->par_iterator_begin();
3220 MacroData const * bestData = 0;
3222 // find macro definitions for name
3223 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3224 if (nameIt != macros.end()) {
3225 // find last definition in front of pos or at pos itself
3226 PositionScopeMacroMap::const_iterator it
3227 = greatest_below(nameIt->second, pos);
3228 if (it != nameIt->second.end()) {
3230 // scope ends behind pos?
3231 if (pos < it->second.scope) {
3232 // Looks good, remember this. If there
3233 // is no external macro behind this,
3234 // we found the right one already.
3235 bestPos = it->first;
3236 bestData = &it->second.macro;
3240 // try previous macro if there is one
3241 if (it == nameIt->second.begin())
3248 // find macros in included files
3249 PositionScopeBufferMap::const_iterator it
3250 = greatest_below(position_to_children, pos);
3251 if (it == position_to_children.end())
3252 // no children before
3256 // do we know something better (i.e. later) already?
3257 if (it->first < bestPos )
3260 // scope ends behind pos?
3261 if (pos < it->second.scope
3262 && (cloned_buffer_ ||
3263 theBufferList().isLoaded(it->second.buffer))) {
3264 // look for macro in external file
3266 MacroData const * data
3267 = it->second.buffer->getMacro(name, false);
3270 bestPos = it->first;
3276 // try previous file if there is one
3277 if (it == position_to_children.begin())
3282 // return the best macro we have found
3287 MacroData const * Buffer::getMacro(docstring const & name,
3288 DocIterator const & pos, bool global) const
3293 // query buffer macros
3294 MacroData const * data = d->getBufferMacro(name, pos);
3298 // If there is a master buffer, query that
3299 Buffer const * const pbuf = d->parent();
3301 d->macro_lock = true;
3302 MacroData const * macro = pbuf->getMacro(
3303 name, *this, false);
3304 d->macro_lock = false;
3310 data = MacroTable::globalMacros().get(name);
3319 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3321 // set scope end behind the last paragraph
3322 DocIterator scope = par_iterator_begin();
3323 scope.pit() = scope.lastpit() + 1;
3325 return getMacro(name, scope, global);
3329 MacroData const * Buffer::getMacro(docstring const & name,
3330 Buffer const & child, bool global) const
3332 // look where the child buffer is included first
3333 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3334 if (it == d->children_positions.end())
3337 // check for macros at the inclusion position
3338 return getMacro(name, it->second, global);
3342 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3344 pit_type const lastpit = it.lastpit();
3346 // look for macros in each paragraph
3347 while (it.pit() <= lastpit) {
3348 Paragraph & par = it.paragraph();
3350 // iterate over the insets of the current paragraph
3351 InsetList const & insets = par.insetList();
3352 InsetList::const_iterator iit = insets.begin();
3353 InsetList::const_iterator end = insets.end();
3354 for (; iit != end; ++iit) {
3355 it.pos() = iit->pos;
3357 // is it a nested text inset?
3358 if (iit->inset->asInsetText()) {
3359 // Inset needs its own scope?
3360 InsetText const * itext = iit->inset->asInsetText();
3361 bool newScope = itext->isMacroScope();
3363 // scope which ends just behind the inset
3364 DocIterator insetScope = it;
3367 // collect macros in inset
3368 it.push_back(CursorSlice(*iit->inset));
3369 updateMacros(it, newScope ? insetScope : scope);
3374 if (iit->inset->asInsetTabular()) {
3375 CursorSlice slice(*iit->inset);
3376 size_t const numcells = slice.nargs();
3377 for (; slice.idx() < numcells; slice.forwardIdx()) {
3378 it.push_back(slice);
3379 updateMacros(it, scope);
3385 // is it an external file?
3386 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3387 // get buffer of external file
3388 InsetInclude const & inset =
3389 static_cast<InsetInclude const &>(*iit->inset);
3391 Buffer * child = inset.getChildBuffer();
3396 // register its position, but only when it is
3397 // included first in the buffer
3398 if (children_positions.find(child) ==
3399 children_positions.end())
3400 children_positions[child] = it;
3402 // register child with its scope
3403 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3407 InsetMath * im = iit->inset->asInsetMath();
3408 if (doing_export && im) {
3409 InsetMathHull * hull = im->asHullInset();
3411 hull->recordLocation(it);
3414 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3418 MathMacroTemplate & macroTemplate =
3419 *iit->inset->asInsetMath()->asMacroTemplate();
3420 MacroContext mc(owner_, it);
3421 macroTemplate.updateToContext(mc);
3424 bool valid = macroTemplate.validMacro();
3425 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3426 // then the BufferView's cursor will be invalid in
3427 // some cases which leads to crashes.
3432 // FIXME (Abdel), I don't understand why we pass 'it' here
3433 // instead of 'macroTemplate' defined above... is this correct?
3434 macros[macroTemplate.name()][it] =
3435 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3445 void Buffer::updateMacros() const
3450 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3452 // start with empty table
3454 d->children_positions.clear();
3455 d->position_to_children.clear();
3457 // Iterate over buffer, starting with first paragraph
3458 // The scope must be bigger than any lookup DocIterator
3459 // later. For the global lookup, lastpit+1 is used, hence
3460 // we use lastpit+2 here.
3461 DocIterator it = par_iterator_begin();
3462 DocIterator outerScope = it;
3463 outerScope.pit() = outerScope.lastpit() + 2;
3464 d->updateMacros(it, outerScope);
3468 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3470 InsetIterator it = inset_iterator_begin(inset());
3471 InsetIterator const end = inset_iterator_end(inset());
3472 for (; it != end; ++it) {
3473 if (it->lyxCode() == BRANCH_CODE) {
3474 InsetBranch & br = static_cast<InsetBranch &>(*it);
3475 docstring const name = br.branch();
3476 if (!from_master && !params().branchlist().find(name))
3477 result.push_back(name);
3478 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3479 result.push_back(name);
3482 if (it->lyxCode() == INCLUDE_CODE) {
3483 // get buffer of external file
3484 InsetInclude const & ins =
3485 static_cast<InsetInclude const &>(*it);
3486 Buffer * child = ins.getChildBuffer();
3489 child->getUsedBranches(result, true);
3492 // remove duplicates
3497 void Buffer::updateMacroInstances(UpdateType utype) const
3499 LYXERR(Debug::MACROS, "updateMacroInstances for "
3500 << d->filename.onlyFileName());
3501 DocIterator it = doc_iterator_begin(this);
3503 DocIterator const end = doc_iterator_end(this);
3504 for (; it != end; it.forwardInset()) {
3505 // look for MathData cells in InsetMathNest insets
3506 InsetMath * minset = it.nextInset()->asInsetMath();
3510 // update macro in all cells of the InsetMathNest
3511 DocIterator::idx_type n = minset->nargs();
3512 MacroContext mc = MacroContext(this, it);
3513 for (DocIterator::idx_type i = 0; i < n; ++i) {
3514 MathData & data = minset->cell(i);
3515 data.updateMacros(0, mc, utype);
3521 void Buffer::listMacroNames(MacroNameSet & macros) const
3526 d->macro_lock = true;
3528 // loop over macro names
3529 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3530 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3531 for (; nameIt != nameEnd; ++nameIt)
3532 macros.insert(nameIt->first);
3534 // loop over children
3535 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3536 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3537 for (; it != end; ++it)
3538 it->first->listMacroNames(macros);
3541 Buffer const * const pbuf = d->parent();
3543 pbuf->listMacroNames(macros);
3545 d->macro_lock = false;
3549 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3551 Buffer const * const pbuf = d->parent();
3556 pbuf->listMacroNames(names);
3559 MacroNameSet::iterator it = names.begin();
3560 MacroNameSet::iterator end = names.end();
3561 for (; it != end; ++it) {
3563 MacroData const * data =
3564 pbuf->getMacro(*it, *this, false);
3566 macros.insert(data);
3568 // we cannot access the original MathMacroTemplate anymore
3569 // here to calls validate method. So we do its work here manually.
3570 // FIXME: somehow make the template accessible here.
3571 if (data->optionals() > 0)
3572 features.require("xargs");
3578 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3581 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3583 RefCache::iterator it = d->ref_cache_.find(label);
3584 if (it != d->ref_cache_.end())
3585 return it->second.second;
3587 static InsetLabel const * dummy_il = 0;
3588 static References const dummy_refs = References();
3589 it = d->ref_cache_.insert(
3590 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3591 return it->second.second;
3595 Buffer::References const & Buffer::references(docstring const & label) const
3597 return const_cast<Buffer *>(this)->getReferenceCache(label);
3601 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3603 References & refs = getReferenceCache(label);
3604 refs.push_back(make_pair(inset, it));
3608 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3610 masterBuffer()->d->ref_cache_[label].first = il;
3614 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3616 return masterBuffer()->d->ref_cache_[label].first;
3620 void Buffer::clearReferenceCache() const
3623 d->ref_cache_.clear();
3627 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3629 //FIXME: This does not work for child documents yet.
3630 reloadBibInfoCache();
3632 // Check if the label 'from' appears more than once
3633 BiblioInfo const & keys = masterBibInfo();
3634 BiblioInfo::const_iterator bit = keys.begin();
3635 BiblioInfo::const_iterator bend = keys.end();
3636 vector<docstring> labels;
3638 for (; bit != bend; ++bit)
3640 labels.push_back(bit->first);
3642 if (count(labels.begin(), labels.end(), from) > 1)
3645 string const paramName = "key";
3646 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3647 if (it->lyxCode() != CITE_CODE)
3649 InsetCommand * inset = it->asInsetCommand();
3650 docstring const oldValue = inset->getParam(paramName);
3651 if (oldValue == from)
3652 inset->setParam(paramName, to);
3656 // returns NULL if id-to-row conversion is unsupported
3657 unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
3658 pit_type par_begin, pit_type par_end,
3659 OutputWhat output, bool master) const
3661 unique_ptr<TexRow> texrow;
3662 OutputParams runparams(¶ms().encoding());
3663 runparams.nice = true;
3664 runparams.flavor = params().getOutputFlavor(format);
3665 runparams.linelen = lyxrc.plaintext_linelen;
3666 // No side effect of file copying and image conversion
3667 runparams.dryrun = true;
3669 if (output == CurrentParagraph) {
3670 runparams.par_begin = par_begin;
3671 runparams.par_end = par_end;
3672 if (par_begin + 1 == par_end) {
3674 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3678 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3679 convert<docstring>(par_begin),
3680 convert<docstring>(par_end - 1))
3683 // output paragraphs
3684 if (runparams.flavor == OutputParams::LYX) {
3685 Paragraph const & par = text().paragraphs()[par_begin];
3687 depth_type dt = par.getDepth();
3688 par.write(ods, params(), dt);
3689 os << from_utf8(ods.str());
3690 } else if (runparams.flavor == OutputParams::HTML) {
3692 setMathFlavor(runparams);
3693 xhtmlParagraphs(text(), *this, xs, runparams);
3694 } else if (runparams.flavor == OutputParams::TEXT) {
3696 // FIXME Handles only one paragraph, unlike the others.
3697 // Probably should have some routine with a signature like them.
3698 writePlaintextParagraph(*this,
3699 text().paragraphs()[par_begin], os, runparams, dummy);
3700 } else if (params().isDocBook()) {
3701 docbookParagraphs(text(), *this, os, runparams);
3703 // If we are previewing a paragraph, even if this is the
3704 // child of some other buffer, let's cut the link here,
3705 // so that no concurring settings from the master
3706 // (e.g. branch state) interfere (see #8101).
3708 d->ignore_parent = true;
3709 // We need to validate the Buffer params' features here
3710 // in order to know if we should output polyglossia
3711 // macros (instead of babel macros)
3712 LaTeXFeatures features(*this, params(), runparams);
3713 params().validate(features);
3714 runparams.use_polyglossia = features.usePolyglossia();
3715 texrow = make_unique<TexRow>();
3718 // latex or literate
3719 otexstream ots(os, *texrow);
3722 latexParagraphs(*this, text(), ots, runparams);
3725 // Restore the parenthood
3727 d->ignore_parent = false;
3731 if (output == FullSource)
3732 os << _("Preview source code");
3733 else if (output == OnlyPreamble)
3734 os << _("Preview preamble");
3735 else if (output == OnlyBody)
3736 os << _("Preview body");
3738 if (runparams.flavor == OutputParams::LYX) {
3740 if (output == FullSource)
3742 else if (output == OnlyPreamble)
3743 params().writeFile(ods, this);
3744 else if (output == OnlyBody)
3746 os << from_utf8(ods.str());
3747 } else if (runparams.flavor == OutputParams::HTML) {
3748 writeLyXHTMLSource(os, runparams, output);
3749 } else if (runparams.flavor == OutputParams::TEXT) {
3750 if (output == OnlyPreamble) {
3751 os << "% "<< _("Plain text does not have a preamble.");
3753 writePlaintextFile(*this, os, runparams);
3754 } else if (params().isDocBook()) {
3755 writeDocBookSource(os, absFileName(), runparams, output);
3757 // latex or literate
3758 texrow = make_unique<TexRow>();
3761 otexstream ots(os, *texrow);
3763 runparams.is_child = true;
3764 writeLaTeXSource(ots, string(), runparams, output);
3772 ErrorList & Buffer::errorList(string const & type) const
3774 return d->errorLists[type];
3778 void Buffer::updateTocItem(std::string const & type,
3779 DocIterator const & dit) const
3782 d->gui_->updateTocItem(type, dit);
3786 void Buffer::structureChanged() const
3789 d->gui_->structureChanged();
3793 void Buffer::errors(string const & err, bool from_master) const
3796 d->gui_->errors(err, from_master);
3800 void Buffer::message(docstring const & msg) const
3803 d->gui_->message(msg);
3807 void Buffer::setBusy(bool on) const
3810 d->gui_->setBusy(on);
3814 void Buffer::updateTitles() const
3817 d->wa_->updateTitles();
3821 void Buffer::resetAutosaveTimers() const
3824 d->gui_->resetAutosaveTimers();
3828 bool Buffer::hasGuiDelegate() const
3834 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3843 class AutoSaveBuffer : public ForkedProcess {
3846 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3847 : buffer_(buffer), fname_(fname) {}
3849 virtual shared_ptr<ForkedProcess> clone() const
3851 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3856 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3857 from_utf8(fname_.absFileName())));
3858 return run(DontWait);
3862 virtual int generateChild();
3864 Buffer const & buffer_;
3869 int AutoSaveBuffer::generateChild()
3871 #if defined(__APPLE__)
3872 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3873 * We should use something else like threads.
3875 * Since I do not know how to determine at run time what is the OS X
3876 * version, I just disable forking altogether for now (JMarc)
3878 pid_t const pid = -1;
3880 // tmp_ret will be located (usually) in /tmp
3881 // will that be a problem?
3882 // Note that this calls ForkedCalls::fork(), so it's
3883 // ok cross-platform.
3884 pid_t const pid = fork();
3885 // If you want to debug the autosave
3886 // you should set pid to -1, and comment out the fork.
3887 if (pid != 0 && pid != -1)
3891 // pid = -1 signifies that lyx was unable
3892 // to fork. But we will do the save
3894 bool failed = false;
3895 TempFile tempfile("lyxautoXXXXXX.lyx");
3896 tempfile.setAutoRemove(false);
3897 FileName const tmp_ret = tempfile.name();
3898 if (!tmp_ret.empty()) {
3899 if (!buffer_.writeFile(tmp_ret))
3901 else if (!tmp_ret.moveTo(fname_))
3907 // failed to write/rename tmp_ret so try writing direct
3908 if (!buffer_.writeFile(fname_)) {
3909 // It is dangerous to do this in the child,
3910 // but safe in the parent, so...
3911 if (pid == -1) // emit message signal.
3912 buffer_.message(_("Autosave failed!"));
3916 if (pid == 0) // we are the child so...
3925 FileName Buffer::getEmergencyFileName() const
3927 return FileName(d->filename.absFileName() + ".emergency");
3931 FileName Buffer::getAutosaveFileName() const
3933 // if the document is unnamed try to save in the backup dir, else
3934 // in the default document path, and as a last try in the filePath,
3935 // which will most often be the temporary directory
3938 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3939 : lyxrc.backupdir_path;
3940 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3943 string const fname = "#" + d->filename.onlyFileName() + "#";
3945 return makeAbsPath(fname, fpath);
3949 void Buffer::removeAutosaveFile() const
3951 FileName const f = getAutosaveFileName();
3957 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3959 FileName const newauto = getAutosaveFileName();
3961 if (newauto != oldauto && oldauto.exists())
3962 if (!oldauto.moveTo(newauto))
3963 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3967 bool Buffer::autoSave() const
3969 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3970 if (buf->d->bak_clean || isReadonly())
3973 message(_("Autosaving current document..."));
3974 buf->d->bak_clean = true;
3976 FileName const fname = getAutosaveFileName();
3977 LASSERT(d->cloned_buffer_, return false);
3979 // If this buffer is cloned, we assume that
3980 // we are running in a separate thread already.
3981 TempFile tempfile("lyxautoXXXXXX.lyx");
3982 tempfile.setAutoRemove(false);
3983 FileName const tmp_ret = tempfile.name();
3984 if (!tmp_ret.empty()) {
3986 // assume successful write of tmp_ret
3987 if (tmp_ret.moveTo(fname))
3990 // failed to write/rename tmp_ret so try writing direct
3991 return writeFile(fname);
3995 void Buffer::setExportStatus(bool e) const
3997 d->doing_export = e;
3998 ListOfBuffers clist = getDescendents();
3999 ListOfBuffers::const_iterator cit = clist.begin();
4000 ListOfBuffers::const_iterator const cen = clist.end();
4001 for (; cit != cen; ++cit)
4002 (*cit)->d->doing_export = e;
4006 bool Buffer::isExporting() const
4008 return d->doing_export;
4012 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
4016 return doExport(target, put_in_tempdir, result_file);
4019 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4020 string & result_file) const
4022 bool const update_unincluded =
4023 params().maintain_unincluded_children
4024 && !params().getIncludedChildren().empty();
4026 // (1) export with all included children (omit \includeonly)
4027 if (update_unincluded) {
4028 ExportStatus const status =
4029 doExport(target, put_in_tempdir, true, result_file);
4030 if (status != ExportSuccess)
4033 // (2) export with included children only
4034 return doExport(target, put_in_tempdir, false, result_file);
4038 void Buffer::setMathFlavor(OutputParams & op) const
4040 switch (params().html_math_output) {
4041 case BufferParams::MathML:
4042 op.math_flavor = OutputParams::MathAsMathML;
4044 case BufferParams::HTML:
4045 op.math_flavor = OutputParams::MathAsHTML;
4047 case BufferParams::Images:
4048 op.math_flavor = OutputParams::MathAsImages;
4050 case BufferParams::LaTeX:
4051 op.math_flavor = OutputParams::MathAsLaTeX;
4057 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
4058 bool includeall, string & result_file) const
4060 LYXERR(Debug::FILES, "target=" << target);
4061 OutputParams runparams(¶ms().encoding());
4062 string format = target;
4063 string dest_filename;
4064 size_t pos = target.find(' ');
4065 if (pos != string::npos) {
4066 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
4067 format = target.substr(0, pos);
4068 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
4069 FileName(dest_filename).onlyPath().createPath();
4070 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
4072 MarkAsExporting exporting(this);
4073 string backend_format;
4074 runparams.flavor = OutputParams::LATEX;
4075 runparams.linelen = lyxrc.plaintext_linelen;
4076 runparams.includeall = includeall;
4077 vector<string> backs = params().backends();
4078 Converters converters = theConverters();
4079 bool need_nice_file = false;
4080 if (find(backs.begin(), backs.end(), format) == backs.end()) {
4081 // Get shortest path to format
4082 converters.buildGraph();
4083 Graph::EdgePath path;
4084 for (vector<string>::const_iterator it = backs.begin();
4085 it != backs.end(); ++it) {
4086 Graph::EdgePath p = converters.getPath(*it, format);
4087 if (!p.empty() && (path.empty() || p.size() < path.size())) {
4088 backend_format = *it;
4093 if (!put_in_tempdir) {
4094 // Only show this alert if this is an export to a non-temporary
4095 // file (not for previewing).
4096 Alert::error(_("Couldn't export file"), bformat(
4097 _("No information for exporting the format %1$s."),
4098 formats.prettyName(format)));
4100 return ExportNoPathToFormat;
4102 runparams.flavor = converters.getFlavor(path, this);
4103 Graph::EdgePath::const_iterator it = path.begin();
4104 Graph::EdgePath::const_iterator en = path.end();
4105 for (; it != en; ++it)
4106 if (theConverters().get(*it).nice()) {
4107 need_nice_file = true;
4112 backend_format = format;
4113 LYXERR(Debug::FILES, "backend_format=" << backend_format);
4114 // FIXME: Don't hardcode format names here, but use a flag
4115 if (backend_format == "pdflatex")
4116 runparams.flavor = OutputParams::PDFLATEX;
4117 else if (backend_format == "luatex")
4118 runparams.flavor = OutputParams::LUATEX;
4119 else if (backend_format == "dviluatex")
4120 runparams.flavor = OutputParams::DVILUATEX;
4121 else if (backend_format == "xetex")
4122 runparams.flavor = OutputParams::XETEX;
4125 string filename = latexName(false);
4126 filename = addName(temppath(), filename);
4127 filename = changeExtension(filename,
4128 formats.extension(backend_format));
4129 LYXERR(Debug::FILES, "filename=" << filename);
4131 // Plain text backend
4132 if (backend_format == "text") {
4133 runparams.flavor = OutputParams::TEXT;
4134 writePlaintextFile(*this, FileName(filename), runparams);
4137 else if (backend_format == "xhtml") {
4138 runparams.flavor = OutputParams::HTML;
4139 setMathFlavor(runparams);
4140 makeLyXHTMLFile(FileName(filename), runparams);
4141 } else if (backend_format == "lyx")
4142 writeFile(FileName(filename));
4144 else if (params().isDocBook()) {
4145 runparams.nice = !put_in_tempdir;
4146 makeDocBookFile(FileName(filename), runparams);
4149 else if (backend_format == format || need_nice_file) {
4150 runparams.nice = true;
4151 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4152 if (d->cloned_buffer_)
4153 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4156 } else if (!lyxrc.tex_allows_spaces
4157 && contains(filePath(), ' ')) {
4158 Alert::error(_("File name error"),
4159 _("The directory path to the document cannot contain spaces."));
4160 return ExportTexPathHasSpaces;
4162 runparams.nice = false;
4163 bool const success = makeLaTeXFile(
4164 FileName(filename), filePath(), runparams);
4165 if (d->cloned_buffer_)
4166 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4171 string const error_type = (format == "program")
4172 ? "Build" : params().bufferFormat();
4173 ErrorList & error_list = d->errorLists[error_type];
4174 string const ext = formats.extension(format);
4175 FileName const tmp_result_file(changeExtension(filename, ext));
4176 bool const success = converters.convert(this, FileName(filename),
4177 tmp_result_file, FileName(absFileName()), backend_format, format,
4180 // Emit the signal to show the error list or copy it back to the
4181 // cloned Buffer so that it can be emitted afterwards.
4182 if (format != backend_format) {
4183 if (runparams.silent)
4185 else if (d->cloned_buffer_)
4186 d->cloned_buffer_->d->errorLists[error_type] =
4187 d->errorLists[error_type];
4190 // also to the children, in case of master-buffer-view
4191 ListOfBuffers clist = getDescendents();
4192 ListOfBuffers::const_iterator cit = clist.begin();
4193 ListOfBuffers::const_iterator const cen = clist.end();
4194 for (; cit != cen; ++cit) {
4195 if (runparams.silent)
4196 (*cit)->d->errorLists[error_type].clear();
4197 else if (d->cloned_buffer_) {
4198 // Enable reverse search by copying back the
4199 // texrow object to the cloned buffer.
4200 // FIXME: this is not thread safe.
4201 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4202 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4203 (*cit)->d->errorLists[error_type];
4205 (*cit)->errors(error_type, true);
4209 if (d->cloned_buffer_) {
4210 // Enable reverse dvi or pdf to work by copying back the texrow
4211 // object to the cloned buffer.
4212 // FIXME: There is a possibility of concurrent access to texrow
4213 // here from the main GUI thread that should be securized.
4214 d->cloned_buffer_->d->texrow = d->texrow;
4215 string const error_type = params().bufferFormat();
4216 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4220 if (put_in_tempdir) {
4221 result_file = tmp_result_file.absFileName();
4222 return success ? ExportSuccess : ExportConverterError;
4225 if (dest_filename.empty())
4226 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4228 result_file = dest_filename;
4229 // We need to copy referenced files (e. g. included graphics
4230 // if format == "dvi") to the result dir.
4231 vector<ExportedFile> const files =
4232 runparams.exportdata->externalFiles(format);
4233 string const dest = runparams.export_folder.empty() ?
4234 onlyPath(result_file) : runparams.export_folder;
4235 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4236 : force_overwrite == ALL_FILES;
4237 CopyStatus status = use_force ? FORCE : SUCCESS;
4239 vector<ExportedFile>::const_iterator it = files.begin();
4240 vector<ExportedFile>::const_iterator const en = files.end();
4241 for (; it != en && status != CANCEL; ++it) {
4242 string const fmt = formats.getFormatFromFile(it->sourceName);
4243 string fixedName = it->exportName;
4244 if (!runparams.export_folder.empty()) {
4245 // Relative pathnames starting with ../ will be sanitized
4246 // if exporting to a different folder
4247 while (fixedName.substr(0, 3) == "../")
4248 fixedName = fixedName.substr(3, fixedName.length() - 3);
4250 FileName fixedFileName = makeAbsPath(fixedName, dest);
4251 fixedFileName.onlyPath().createPath();
4252 status = copyFile(fmt, it->sourceName,
4254 it->exportName, status == FORCE,
4255 runparams.export_folder.empty());
4258 if (status == CANCEL) {
4259 message(_("Document export cancelled."));
4260 return ExportCancel;
4263 if (tmp_result_file.exists()) {
4264 // Finally copy the main file
4265 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4266 : force_overwrite != NO_FILES;
4267 if (status == SUCCESS && use_force)
4269 status = copyFile(format, tmp_result_file,
4270 FileName(result_file), result_file,
4272 if (status == CANCEL) {
4273 message(_("Document export cancelled."));
4274 return ExportCancel;
4276 message(bformat(_("Document exported as %1$s "
4278 formats.prettyName(format),
4279 makeDisplayPath(result_file)));
4282 // This must be a dummy converter like fax (bug 1888)
4283 message(bformat(_("Document exported as %1$s"),
4284 formats.prettyName(format)));
4287 return success ? ExportSuccess : ExportConverterError;
4291 Buffer::ExportStatus Buffer::preview(string const & format) const
4293 bool const update_unincluded =
4294 params().maintain_unincluded_children
4295 && !params().getIncludedChildren().empty();
4296 return preview(format, update_unincluded);
4300 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4302 MarkAsExporting exporting(this);
4304 // (1) export with all included children (omit \includeonly)
4306 ExportStatus const status = doExport(format, true, true, result_file);
4307 if (status != ExportSuccess)
4310 // (2) export with included children only
4311 ExportStatus const status = doExport(format, true, false, result_file);
4312 FileName const previewFile(result_file);
4314 LATTEST (isClone());
4315 d->cloned_buffer_->d->preview_file_ = previewFile;
4316 d->cloned_buffer_->d->preview_format_ = format;
4317 d->cloned_buffer_->d->preview_error_ = (status != ExportSuccess);
4319 if (status != ExportSuccess)
4321 if (previewFile.exists()) {
4322 if (!formats.view(*this, previewFile, format))
4323 return PreviewError;
4325 return PreviewSuccess;
4328 // Successful export but no output file?
4329 // Probably a bug in error detection.
4330 LATTEST (status != ExportSuccess);
4337 Buffer::ReadStatus Buffer::extractFromVC()
4339 bool const found = LyXVC::file_not_found_hook(d->filename);
4341 return ReadFileNotFound;
4342 if (!d->filename.isReadableFile())
4348 Buffer::ReadStatus Buffer::loadEmergency()
4350 FileName const emergencyFile = getEmergencyFileName();
4351 if (!emergencyFile.exists()
4352 || emergencyFile.lastModified() <= d->filename.lastModified())
4353 return ReadFileNotFound;
4355 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4356 docstring const text = bformat(_("An emergency save of the document "
4357 "%1$s exists.\n\nRecover emergency save?"), file);
4359 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4360 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4366 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4367 bool const success = (ret_llf == ReadSuccess);
4370 Alert::warning(_("File is read-only"),
4371 bformat(_("An emergency file is successfully loaded, "
4372 "but the original file %1$s is marked read-only. "
4373 "Please make sure to save the document as a different "
4374 "file."), from_utf8(d->filename.absFileName())));
4377 lyxvc().file_found_hook(d->filename);
4378 str = _("Document was successfully recovered.");
4380 str = _("Document was NOT successfully recovered.");
4381 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4382 makeDisplayPath(emergencyFile.absFileName()));
4384 int const del_emerg =
4385 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4386 _("&Remove"), _("&Keep"));
4387 if (del_emerg == 0) {
4388 emergencyFile.removeFile();
4390 Alert::warning(_("Emergency file deleted"),
4391 _("Do not forget to save your file now!"), true);
4393 return success ? ReadSuccess : ReadEmergencyFailure;
4396 int const del_emerg =
4397 Alert::prompt(_("Delete emergency file?"),
4398 _("Remove emergency file now?"), 1, 1,
4399 _("&Remove"), _("&Keep"));
4401 emergencyFile.removeFile();
4402 return ReadOriginal;
4412 Buffer::ReadStatus Buffer::loadAutosave()
4414 // Now check if autosave file is newer.
4415 FileName const autosaveFile = getAutosaveFileName();
4416 if (!autosaveFile.exists()
4417 || autosaveFile.lastModified() <= d->filename.lastModified())
4418 return ReadFileNotFound;
4420 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4421 docstring const text = bformat(_("The backup of the document %1$s "
4422 "is newer.\n\nLoad the backup instead?"), file);
4423 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4424 _("&Load backup"), _("Load &original"), _("&Cancel"));
4429 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4430 // the file is not saved if we load the autosave file.
4431 if (ret_llf == ReadSuccess) {
4433 Alert::warning(_("File is read-only"),
4434 bformat(_("A backup file is successfully loaded, "
4435 "but the original file %1$s is marked read-only. "
4436 "Please make sure to save the document as a "
4438 from_utf8(d->filename.absFileName())));
4441 lyxvc().file_found_hook(d->filename);
4444 return ReadAutosaveFailure;
4447 // Here we delete the autosave
4448 autosaveFile.removeFile();
4449 return ReadOriginal;
4457 Buffer::ReadStatus Buffer::loadLyXFile()
4459 if (!d->filename.isReadableFile()) {
4460 ReadStatus const ret_rvc = extractFromVC();
4461 if (ret_rvc != ReadSuccess)
4465 ReadStatus const ret_re = loadEmergency();
4466 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4469 ReadStatus const ret_ra = loadAutosave();
4470 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4473 return loadThisLyXFile(d->filename);
4477 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4479 return readFile(fn);
4483 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4485 TeXErrors::Errors::const_iterator it = terr.begin();
4486 TeXErrors::Errors::const_iterator end = terr.end();
4487 ListOfBuffers clist = getDescendents();
4488 ListOfBuffers::const_iterator cen = clist.end();
4490 for (; it != end; ++it) {
4493 int errorRow = it->error_in_line;
4494 Buffer const * buf = 0;
4496 if (it->child_name.empty())
4497 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4499 // The error occurred in a child
4500 ListOfBuffers::const_iterator cit = clist.begin();
4501 for (; cit != cen; ++cit) {
4502 string const child_name =
4503 DocFileName(changeExtension(
4504 (*cit)->absFileName(), "tex")).
4506 if (it->child_name != child_name)
4508 (*cit)->d->texrow.getIdFromRow(errorRow,
4509 id_start, pos_start);
4510 if (id_start != -1) {
4511 buf = d->cloned_buffer_
4512 ? (*cit)->d->cloned_buffer_->d->owner_
4513 : (*cit)->d->owner_;
4524 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4525 } while (found && id_start == id_end && pos_start == pos_end);
4527 if (id_start != id_end) {
4528 // Next registered position is outside the inset where
4529 // the error occurred, so signal end-of-paragraph
4533 errorList.push_back(ErrorItem(it->error_desc,
4534 it->error_text, id_start, pos_start, pos_end, buf));
4539 void Buffer::setBuffersForInsets() const
4541 inset().setBuffer(const_cast<Buffer &>(*this));
4545 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4547 LBUFERR(!text().paragraphs().empty());
4549 // Use the master text class also for child documents
4550 Buffer const * const master = masterBuffer();
4551 DocumentClass const & textclass = master->params().documentClass();
4553 // do this only if we are the top-level Buffer
4554 if (master == this) {
4555 textclass.counters().reset(from_ascii("bibitem"));
4556 reloadBibInfoCache();
4559 // keep the buffers to be children in this set. If the call from the
4560 // master comes back we can see which of them were actually seen (i.e.
4561 // via an InsetInclude). The remaining ones in the set need still be updated.
4562 static std::set<Buffer const *> bufToUpdate;
4563 if (scope == UpdateMaster) {
4564 // If this is a child document start with the master
4565 if (master != this) {
4566 bufToUpdate.insert(this);
4567 master->updateBuffer(UpdateMaster, utype);
4568 // If the master buffer has no gui associated with it, then the TocModel is
4569 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4570 // (bug 5699). The same happens if the master buffer is open in a different
4571 // window. This test catches both possibilities.
4572 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4573 // There remains a problem here: If there is another child open in yet a third
4574 // window, that TOC is not updated. So some more general solution is needed at
4576 if (master->d->gui_ != d->gui_)
4579 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4580 if (bufToUpdate.find(this) == bufToUpdate.end())
4584 // start over the counters in the master
4585 textclass.counters().reset();
4588 // update will be done below for this buffer
4589 bufToUpdate.erase(this);
4591 // update all caches
4592 clearReferenceCache();
4594 setChangesPresent(false);
4596 Buffer & cbuf = const_cast<Buffer &>(*this);
4599 ParIterator parit = cbuf.par_iterator_begin();
4600 updateBuffer(parit, utype);
4603 // TocBackend update will be done later.
4606 d->bibinfo_cache_valid_ = true;
4607 d->cite_labels_valid_ = true;
4609 cbuf.tocBackend().update(true, utype);
4610 if (scope == UpdateMaster)
4611 cbuf.structureChanged();
4615 static depth_type getDepth(DocIterator const & it)
4617 depth_type depth = 0;
4618 for (size_t i = 0 ; i < it.depth() ; ++i)
4619 if (!it[i].inset().inMathed())
4620 depth += it[i].paragraph().getDepth() + 1;
4621 // remove 1 since the outer inset does not count
4625 static depth_type getItemDepth(ParIterator const & it)
4627 Paragraph const & par = *it;
4628 LabelType const labeltype = par.layout().labeltype;
4630 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4633 // this will hold the lowest depth encountered up to now.
4634 depth_type min_depth = getDepth(it);
4635 ParIterator prev_it = it;
4638 --prev_it.top().pit();
4640 // start of nested inset: go to outer par
4642 if (prev_it.empty()) {
4643 // start of document: nothing to do
4648 // We search for the first paragraph with same label
4649 // that is not more deeply nested.
4650 Paragraph & prev_par = *prev_it;
4651 depth_type const prev_depth = getDepth(prev_it);
4652 if (labeltype == prev_par.layout().labeltype) {
4653 if (prev_depth < min_depth)
4654 return prev_par.itemdepth + 1;
4655 if (prev_depth == min_depth)
4656 return prev_par.itemdepth;
4658 min_depth = min(min_depth, prev_depth);
4659 // small optimization: if we are at depth 0, we won't
4660 // find anything else
4661 if (prev_depth == 0)
4667 static bool needEnumCounterReset(ParIterator const & it)
4669 Paragraph const & par = *it;
4670 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4671 depth_type const cur_depth = par.getDepth();
4672 ParIterator prev_it = it;
4673 while (prev_it.pit()) {
4674 --prev_it.top().pit();
4675 Paragraph const & prev_par = *prev_it;
4676 if (prev_par.getDepth() <= cur_depth)
4677 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4679 // start of nested inset: reset
4684 // set the label of a paragraph. This includes the counters.
4685 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4687 BufferParams const & bp = owner_->masterBuffer()->params();
4688 DocumentClass const & textclass = bp.documentClass();
4689 Paragraph & par = it.paragraph();
4690 Layout const & layout = par.layout();
4691 Counters & counters = textclass.counters();
4693 if (par.params().startOfAppendix()) {
4694 // We want to reset the counter corresponding to toplevel sectioning
4695 Layout const & lay = textclass.getTOCLayout();
4696 docstring const cnt = lay.counter;
4698 counters.reset(cnt);
4699 counters.appendix(true);
4701 par.params().appendix(counters.appendix());
4703 // Compute the item depth of the paragraph
4704 par.itemdepth = getItemDepth(it);
4706 if (layout.margintype == MARGIN_MANUAL) {
4707 if (par.params().labelWidthString().empty())
4708 par.params().labelWidthString(par.expandLabel(layout, bp));
4709 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4710 // we do not need to do anything here, since the empty case is
4711 // handled during export.
4713 par.params().labelWidthString(docstring());
4716 switch(layout.labeltype) {
4717 case LABEL_ITEMIZE: {
4718 // At some point of time we should do something more
4719 // clever here, like:
4720 // par.params().labelString(
4721 // bp.user_defined_bullet(par.itemdepth).getText());
4722 // for now, use a simple hardcoded label
4723 docstring itemlabel;
4724 switch (par.itemdepth) {
4726 itemlabel = char_type(0x2022);
4729 itemlabel = char_type(0x2013);
4732 itemlabel = char_type(0x2217);
4735 itemlabel = char_type(0x2219); // or 0x00b7
4738 par.params().labelString(itemlabel);
4742 case LABEL_ENUMERATE: {
4743 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4745 switch (par.itemdepth) {
4754 enumcounter += "iv";
4757 // not a valid enumdepth...
4761 // Maybe we have to reset the enumeration counter.
4762 if (needEnumCounterReset(it))
4763 counters.reset(enumcounter);
4764 counters.step(enumcounter, utype);
4766 string const & lang = par.getParLanguage(bp)->code();
4767 par.params().labelString(counters.theCounter(enumcounter, lang));
4772 case LABEL_SENSITIVE: {
4773 string const & type = counters.current_float();
4774 docstring full_label;
4776 full_label = owner_->B_("Senseless!!! ");
4778 docstring name = owner_->B_(textclass.floats().getType(type).name());
4779 if (counters.hasCounter(from_utf8(type))) {
4780 string const & lang = par.getParLanguage(bp)->code();
4781 counters.step(from_utf8(type), utype);
4782 full_label = bformat(from_ascii("%1$s %2$s:"),
4784 counters.theCounter(from_utf8(type), lang));
4786 full_label = bformat(from_ascii("%1$s #:"), name);
4788 par.params().labelString(full_label);
4792 case LABEL_NO_LABEL:
4793 par.params().labelString(docstring());
4797 case LABEL_CENTERED:
4798 case LABEL_STATIC: {
4799 docstring const & lcounter = layout.counter;
4800 if (!lcounter.empty()) {
4801 if (layout.toclevel <= bp.secnumdepth
4802 && (layout.latextype != LATEX_ENVIRONMENT
4803 || it.text()->isFirstInSequence(it.pit()))) {
4804 if (counters.hasCounter(lcounter))
4805 counters.step(lcounter, utype);
4806 par.params().labelString(par.expandLabel(layout, bp));
4808 par.params().labelString(docstring());
4810 par.params().labelString(par.expandLabel(layout, bp));
4816 par.params().labelString(par.expandLabel(layout, bp));
4821 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4823 // LASSERT: Is it safe to continue here, or should we just return?
4824 LASSERT(parit.pit() == 0, /**/);
4826 // Set the position of the text in the buffer to be able
4827 // to resolve macros in it.
4828 parit.text()->setMacrocontextPosition(parit);
4830 depth_type maxdepth = 0;
4831 pit_type const lastpit = parit.lastpit();
4832 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4833 // reduce depth if necessary
4834 if (parit->params().depth() > maxdepth) {
4835 /** FIXME: this function is const, but
4836 * nevertheless it modifies the buffer. To be
4837 * cleaner, one should modify the buffer in
4838 * another function, which is actually
4839 * non-const. This would however be costly in
4840 * terms of code duplication.
4842 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4843 parit->params().depth(maxdepth);
4845 maxdepth = parit->getMaxDepthAfter();
4847 if (utype == OutputUpdate) {
4848 // track the active counters
4849 // we have to do this for the master buffer, since the local
4850 // buffer isn't tracking anything.
4851 masterBuffer()->params().documentClass().counters().
4852 setActiveLayout(parit->layout());
4855 // set the counter for this paragraph
4856 d->setLabel(parit, utype);
4858 // update change-tracking flag
4859 parit->addChangesToBuffer(*this);
4862 InsetList::const_iterator iit = parit->insetList().begin();
4863 InsetList::const_iterator end = parit->insetList().end();
4864 for (; iit != end; ++iit) {
4865 parit.pos() = iit->pos;
4866 iit->inset->updateBuffer(parit, utype);
4872 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4873 WordLangTuple & word_lang, docstring_list & suggestions) const
4877 suggestions.clear();
4878 word_lang = WordLangTuple();
4879 bool const to_end = to.empty();
4880 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4881 // OK, we start from here.
4882 for (; from != end; from.forwardPos()) {
4883 // This skips all insets with spell check disabled.
4884 while (!from.allowSpellCheck()) {
4888 // If from is at the end of the document (which is possible
4889 // when "from" was changed above) LyX will crash later otherwise.
4890 if (from.atEnd() || (!to_end && from >= end))
4893 from.paragraph().spellCheck();
4894 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4895 if (SpellChecker::misspelled(res)) {
4899 // Do not increase progress when from == to, otherwise the word
4900 // count will be wrong.
4910 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4912 bool inword = false;
4917 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4918 if (!dit.inTexted()) {
4923 Paragraph const & par = dit.paragraph();
4924 pos_type const pos = dit.pos();
4926 // Copied and adapted from isWordSeparator() in Paragraph
4927 if (pos == dit.lastpos()) {
4930 Inset const * ins = par.getInset(pos);
4931 if (ins && skipNoOutput && !ins->producesOutput()) {
4934 // stop if end of range was skipped
4935 if (!to.atEnd() && dit >= to)
4938 } else if (!par.isDeleted(pos)) {
4939 if (par.isWordSeparator(pos))
4945 if (ins && ins->isLetter())
4947 else if (ins && ins->isSpace())
4950 char_type const c = par.getChar(pos);
4951 if (isPrintableNonspace(c))
4953 else if (isSpace(c))
4963 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4965 d->updateStatistics(from, to, skipNoOutput);
4969 int Buffer::wordCount() const
4971 return d->wordCount();
4975 int Buffer::charCount(bool with_blanks) const
4977 return d->charCount(with_blanks);
4981 Buffer::ReadStatus Buffer::reload()
4984 // c.f. bug http://www.lyx.org/trac/ticket/6587
4985 removeAutosaveFile();
4986 // e.g., read-only status could have changed due to version control
4987 d->filename.refresh();
4988 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4990 // clear parent. this will get reset if need be.
4992 ReadStatus const status = loadLyXFile();
4993 if (status == ReadSuccess) {
4998 message(bformat(_("Document %1$s reloaded."), disp_fn));
5001 message(bformat(_("Could not reload document %1$s."), disp_fn));
5011 bool Buffer::saveAs(FileName const & fn)
5013 FileName const old_name = fileName();
5014 FileName const old_auto = getAutosaveFileName();
5015 bool const old_unnamed = isUnnamed();
5016 bool success = true;
5017 d->old_position = filePath();
5024 // bring the autosave file with us, just in case.
5025 moveAutosaveFile(old_auto);
5026 // validate version control data and
5027 // correct buffer title
5028 lyxvc().file_found_hook(fileName());
5030 // the file has now been saved to the new location.
5031 // we need to check that the locations of child buffers
5033 checkChildBuffers();
5034 checkMasterBuffer();
5037 // reset the old filename and unnamed state
5038 setFileName(old_name);
5039 setUnnamed(old_unnamed);
5043 d->old_position.clear();
5048 void Buffer::checkChildBuffers()
5050 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
5051 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
5052 for (; it != en; ++it) {
5053 DocIterator dit = it->second;
5054 Buffer * cbuf = const_cast<Buffer *>(it->first);
5055 if (!cbuf || !theBufferList().isLoaded(cbuf))
5057 Inset * inset = dit.nextInset();
5058 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
5059 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
5060 docstring const & incfile = inset_inc->getParam("filename");
5061 string oldloc = cbuf->absFileName();
5062 string newloc = makeAbsPath(to_utf8(incfile),
5063 onlyPath(absFileName())).absFileName();
5064 if (oldloc == newloc)
5066 // the location of the child file is incorrect.
5068 inset_inc->setChildBuffer(0);
5070 // invalidate cache of children
5071 d->children_positions.clear();
5072 d->position_to_children.clear();
5076 // If a child has been saved under a different name/path, it might have been
5077 // orphaned. Therefore the master needs to be reset (bug 8161).
5078 void Buffer::checkMasterBuffer()
5080 Buffer const * const master = masterBuffer();
5084 // necessary to re-register the child (bug 5873)
5085 // FIXME: clean up updateMacros (here, only
5086 // child registering is needed).
5087 master->updateMacros();
5088 // (re)set master as master buffer, but only
5089 // if we are a real child
5090 if (master->isChild(this))
5097 string Buffer::includedFilePath(string const & name, string const & ext) const
5099 if (d->old_position.empty() ||
5100 equivalent(FileName(d->old_position), FileName(filePath())))
5103 bool isabsolute = FileName::isAbsolute(name);
5104 // both old_position and filePath() end with a path separator
5105 string absname = isabsolute ? name : d->old_position + name;
5107 // if old_position is set to origin, we need to do the equivalent of
5108 // getReferencedFileName() (see readDocument())
5109 if (!isabsolute && d->old_position == params().origin) {
5110 FileName const test(addExtension(filePath() + name, ext));
5112 absname = filePath() + name;
5115 if (!FileName(addExtension(absname, ext)).exists())
5119 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
5121 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
5122 from_utf8(filePath())));
5126 void Buffer::setChangesPresent(bool b) const
5128 d->tracked_changes_present_ = b;
5132 bool Buffer::areChangesPresent() const
5134 return d->tracked_changes_present_;
5138 void Buffer::updateChangesPresent() const
5140 LYXERR(Debug::CHANGES, "Buffer::updateChangesPresent");
5141 setChangesPresent(false);
5142 ParConstIterator it = par_iterator_begin();
5143 ParConstIterator const end = par_iterator_end();
5144 for (; !areChangesPresent() && it != end; ++it)
5145 it->addChangesToBuffer(*this);