3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "DispatchResult.h"
30 #include "DocIterator.h"
31 #include "BufferEncodings.h"
32 #include "ErrorList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
37 #include "IndicesList.h"
38 #include "InsetIterator.h"
39 #include "InsetList.h"
41 #include "LaTeXFeatures.h"
45 #include "LyXAction.h"
49 #include "output_docbook.h"
51 #include "output_latex.h"
52 #include "output_xhtml.h"
53 #include "output_plaintext.h"
54 #include "Paragraph.h"
55 #include "ParagraphParameters.h"
56 #include "ParIterator.h"
57 #include "PDFOptions.h"
58 #include "SpellChecker.h"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetTabular.h"
74 #include "insets/InsetText.h"
76 #include "mathed/InsetMathHull.h"
77 #include "mathed/MacroTable.h"
78 #include "mathed/MathMacroTemplate.h"
79 #include "mathed/MathSupport.h"
81 #include "graphics/PreviewLoader.h"
83 #include "frontends/alert.h"
84 #include "frontends/Delegates.h"
85 #include "frontends/WorkAreaManager.h"
87 #include "support/lassert.h"
88 #include "support/convert.h"
89 #include "support/debug.h"
90 #include "support/docstring_list.h"
91 #include "support/ExceptionMessage.h"
92 #include "support/FileName.h"
93 #include "support/FileNameList.h"
94 #include "support/filetools.h"
95 #include "support/ForkedCalls.h"
96 #include "support/gettext.h"
97 #include "support/gzstream.h"
98 #include "support/lstrings.h"
99 #include "support/lyxalgo.h"
100 #include "support/mutex.h"
101 #include "support/os.h"
102 #include "support/Package.h"
103 #include "support/PathChanger.h"
104 #include "support/Systemcall.h"
105 #include "support/TempFile.h"
106 #include "support/textutils.h"
107 #include "support/types.h"
109 #include "support/bind.h"
110 #include "support/shared_ptr.h"
121 using namespace lyx::support;
122 using namespace lyx::graphics;
126 namespace Alert = frontend::Alert;
127 namespace os = support::os;
131 int const LYX_FORMAT = LYX_FORMAT_LYX;
133 typedef map<string, bool> DepClean;
134 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
139 // A storehouse for the cloned buffers.
140 list<CloneList *> cloned_buffers;
146 Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
150 delete preview_loader_;
158 /// search for macro in local (buffer) table or in children
159 MacroData const * getBufferMacro(docstring const & name,
160 DocIterator const & pos) const;
162 /// Update macro table starting with position of it \param it in some
164 void updateMacros(DocIterator & it, DocIterator & scope);
166 void setLabel(ParIterator & it, UpdateType utype) const;
168 /** If we have branches that use the file suffix
169 feature, return the file name with suffix appended.
171 support::FileName exportFileName() const;
178 mutable TexRow texrow;
180 /// need to regenerate .tex?
184 mutable bool lyx_clean;
186 /// is autosave needed?
187 mutable bool bak_clean;
189 /// is this an unnamed file (New...)?
192 /// is this an internal bufffer?
193 bool internal_buffer;
198 /// name of the file the buffer is associated with.
201 /** Set to true only when the file is fully loaded.
202 * Used to prevent the premature generation of previews
203 * and by the citation inset.
205 bool file_fully_loaded;
207 /// Ignore the parent (e.g. when exporting a child standalone)?
211 mutable TocBackend toc_backend;
216 ScopeMacro(DocIterator const & s, MacroData const & m)
217 : scope(s), macro(m) {}
221 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
222 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
223 /// map from the macro name to the position map,
224 /// which maps the macro definition position to the scope and the MacroData.
225 NamePositionScopeMacroMap macros;
226 /// This seem to change the way Buffer::getMacro() works
227 mutable bool macro_lock;
229 /// positions of child buffers in the buffer
230 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
233 ScopeBuffer(DocIterator const & s,Buffer const * b)
234 : scope(s), buffer(b) {}
236 Buffer const * buffer;
238 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
239 /// position of children buffers in this buffer
240 BufferPositionMap children_positions;
241 /// map from children inclusion positions to their scope and their buffer
242 PositionScopeBufferMap position_to_children;
244 /// Contains the old buffer filePath() while saving-as, or the
245 /// directory where the document was last saved while loading.
248 /** Keeps track of the path of local layout files.
249 * If possible, it is always relative to the buffer path.
250 * Empty for layouts in system or user directory.
252 string layout_position;
254 /// Container for all sort of Buffer dependant errors.
255 map<string, ErrorList> errorLists;
257 /// timestamp and checksum used to test if the file has been externally
258 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
260 unsigned long checksum_;
263 frontend::WorkAreaManager * wa_;
265 frontend::GuiBufferDelegate * gui_;
270 /// A cache for the bibfiles (including bibfiles of loaded child
271 /// documents), needed for appropriate update of natbib labels.
272 mutable support::FileNameList bibfiles_cache_;
274 // FIXME The caching mechanism could be improved. At present, we have a
275 // cache for each Buffer, that caches all the bibliography info for that
276 // Buffer. A more efficient solution would be to have a global cache per
277 // file, and then to construct the Buffer's bibinfo from that.
278 /// A cache for bibliography info
279 mutable BiblioInfo bibinfo_;
280 /// whether the bibinfo cache is valid
281 mutable bool bibinfo_cache_valid_;
282 /// whether the bibfile cache is valid
283 mutable bool bibfile_cache_valid_;
284 /// Cache of timestamps of .bib files
285 map<FileName, time_t> bibfile_status_;
286 /// Indicates whether the bibinfo has changed since the last time
287 /// we ran updateBuffer(), i.e., whether citation labels may need
289 mutable bool cite_labels_valid_;
291 /// These two hold the file name and format, written to by
292 /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
293 FileName preview_file_;
294 string preview_format_;
295 /// If there was an error when previewing, on the next preview we do
296 /// a fresh compile (e.g. in case the user installed a package that
300 mutable RefCache ref_cache_;
302 /// our Text that should be wrapped in an InsetText
306 PreviewLoader * preview_loader_;
308 /// This is here to force the test to be done whenever parent_buffer
310 Buffer const * parent() const
312 // ignore_parent temporarily "orphans" a buffer
313 // (e.g. if a child is compiled standalone)
316 // if parent_buffer is not loaded, then it has been unloaded,
317 // which means that parent_buffer is an invalid pointer. So we
318 // set it to null in that case.
319 // however, the BufferList doesn't know about cloned buffers, so
320 // they will always be regarded as unloaded. in that case, we hope
322 if (!cloned_buffer_ && !theBufferList().isLoaded(parent_buffer))
324 return parent_buffer;
328 void setParent(Buffer const * pb)
330 if (parent_buffer == pb)
333 if (!cloned_buffer_ && parent_buffer && pb)
334 LYXERR0("Warning: a buffer should not have two parents!");
336 if (!cloned_buffer_ && parent_buffer) {
337 parent_buffer->invalidateBibfileCache();
338 parent_buffer->invalidateBibinfoCache();
342 /// If non zero, this buffer is a clone of existing buffer \p cloned_buffer_
343 /// This one is useful for preview detached in a thread.
344 Buffer const * cloned_buffer_;
346 CloneList * clone_list_;
347 /// are we in the process of exporting this buffer?
348 mutable bool doing_export;
350 /// compute statistics
351 /// \p from initial position
352 /// \p to points to the end position
353 void updateStatistics(DocIterator & from, DocIterator & to,
354 bool skipNoOutput = true);
355 /// statistics accessor functions
356 int wordCount() const
360 int charCount(bool with_blanks) const
363 + (with_blanks ? blank_count_ : 0);
367 /// So we can force access via the accessors.
368 mutable Buffer const * parent_buffer;
377 /// Creates the per buffer temporary directory
378 static FileName createBufferTmpDir()
380 // FIXME This would be the ideal application for a TempDir class (like
381 // TempFile but for directories)
386 Mutex::Locker locker(&mutex);
387 counter = convert<string>(count++);
389 // We are in our own directory. Why bother to mangle name?
390 // In fact I wrote this code to circumvent a problematic behaviour
391 // (bug?) of EMX mkstemp().
392 FileName tmpfl(package().temp_dir().absFileName() + "/lyx_tmpbuf" +
395 if (!tmpfl.createDirectory(0777)) {
396 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
397 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
398 from_utf8(tmpfl.absFileName())));
404 Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
405 Buffer const * cloned_buffer)
406 : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
407 internal_buffer(false), read_only(readonly_), filename(file),
408 file_fully_loaded(false), ignore_parent(false), toc_backend(owner),
409 macro_lock(false), timestamp_(0), checksum_(0), wa_(0), gui_(0),
410 undo_(*owner), bibinfo_cache_valid_(false), bibfile_cache_valid_(false),
411 cite_labels_valid_(false), inset(0), preview_loader_(0),
412 cloned_buffer_(cloned_buffer), clone_list_(0),
413 doing_export(false), parent_buffer(0),
414 word_count_(0), char_count_(0), blank_count_(0)
416 if (!cloned_buffer_) {
417 temppath = createBufferTmpDir();
418 lyxvc.setBuffer(owner_);
420 wa_ = new frontend::WorkAreaManager;
423 temppath = cloned_buffer_->d->temppath;
424 file_fully_loaded = true;
425 params = cloned_buffer_->d->params;
426 bibfiles_cache_ = cloned_buffer_->d->bibfiles_cache_;
427 bibinfo_ = cloned_buffer_->d->bibinfo_;
428 bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_cache_valid_;
429 bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
430 bibfile_status_ = cloned_buffer_->d->bibfile_status_;
431 cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
432 unnamed = cloned_buffer_->d->unnamed;
433 internal_buffer = cloned_buffer_->d->internal_buffer;
434 layout_position = cloned_buffer_->d->layout_position;
435 preview_file_ = cloned_buffer_->d->preview_file_;
436 preview_format_ = cloned_buffer_->d->preview_format_;
437 preview_error_ = cloned_buffer_->d->preview_error_;
441 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
442 : d(new Impl(this, FileName(file), readonly, cloned_buffer))
444 LYXERR(Debug::INFO, "Buffer::Buffer()");
446 d->inset = new InsetText(*cloned_buffer->d->inset);
447 d->inset->setBuffer(*this);
448 // FIXME: optimize this loop somewhat, maybe by creating a new
449 // general recursive Inset::setId().
450 DocIterator it = doc_iterator_begin(this);
451 DocIterator cloned_it = doc_iterator_begin(cloned_buffer);
452 for (; !it.atEnd(); it.forwardPar(), cloned_it.forwardPar())
453 it.paragraph().setId(cloned_it.paragraph().id());
455 d->inset = new InsetText(this);
456 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
462 LYXERR(Debug::INFO, "Buffer::~Buffer()");
463 // here the buffer should take care that it is
464 // saved properly, before it goes into the void.
466 // GuiView already destroyed
470 // No need to do additional cleanups for internal buffer.
476 // this is in case of recursive includes: we won't try to delete
477 // ourselves as a child.
478 d->clone_list_->erase(this);
479 // loop over children
480 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
481 Impl::BufferPositionMap::iterator end = d->children_positions.end();
482 for (; it != end; ++it) {
483 Buffer * child = const_cast<Buffer *>(it->first);
484 if (d->clone_list_->erase(child))
487 // if we're the master buffer, then we should get rid of the list
490 // If this is not empty, we have leaked something. Worse, one of the
491 // children still has a reference to this list. But we will try to
492 // continue, rather than shut down.
493 LATTEST(d->clone_list_->empty());
494 list<CloneList *>::iterator it =
495 find(cloned_buffers.begin(), cloned_buffers.end(), d->clone_list_);
496 if (it == cloned_buffers.end()) {
497 // We will leak in this case, but it is safe to continue.
500 cloned_buffers.erase(it);
501 delete d->clone_list_;
503 // FIXME Do we really need to do this right before we delete d?
504 // clear references to children in macro tables
505 d->children_positions.clear();
506 d->position_to_children.clear();
508 // loop over children
509 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
510 Impl::BufferPositionMap::iterator end = d->children_positions.end();
511 for (; it != end; ++it) {
512 Buffer * child = const_cast<Buffer *>(it->first);
513 if (theBufferList().isLoaded(child))
514 theBufferList().releaseChild(this, child);
518 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
519 msg += emergencyWrite();
520 Alert::warning(_("Attempting to close changed document!"), msg);
523 // FIXME Do we really need to do this right before we delete d?
524 // clear references to children in macro tables
525 d->children_positions.clear();
526 d->position_to_children.clear();
528 if (!d->temppath.destroyDirectory()) {
529 Alert::warning(_("Could not remove temporary directory"),
530 bformat(_("Could not remove the temporary directory %1$s"),
531 from_utf8(d->temppath.absFileName())));
540 Buffer * Buffer::cloneFromMaster() const
543 cloned_buffers.push_back(new CloneList);
544 CloneList * clones = cloned_buffers.back();
546 masterBuffer()->cloneWithChildren(bufmap, clones);
548 // make sure we got cloned
549 BufferMap::const_iterator bit = bufmap.find(this);
550 LASSERT(bit != bufmap.end(), return 0);
551 Buffer * cloned_buffer = bit->second;
553 return cloned_buffer;
557 void Buffer::cloneWithChildren(BufferMap & bufmap, CloneList * clones) const
559 // have we already been cloned?
560 if (bufmap.find(this) != bufmap.end())
563 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
565 // The clone needs its own DocumentClass, since running updateBuffer() will
566 // modify it, and we would otherwise be sharing it with the original Buffer.
567 buffer_clone->params().makeDocumentClass(true);
569 cap::switchBetweenClasses(
570 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
571 static_cast<InsetText &>(buffer_clone->inset()), el);
573 bufmap[this] = buffer_clone;
574 clones->insert(buffer_clone);
575 buffer_clone->d->clone_list_ = clones;
576 buffer_clone->d->macro_lock = true;
577 buffer_clone->d->children_positions.clear();
579 // FIXME (Abdel 09/01/2010): this is too complicated. The whole children_positions and
580 // math macro caches need to be rethought and simplified.
581 // I am not sure wether we should handle Buffer cloning here or in BufferList.
582 // Right now BufferList knows nothing about buffer clones.
583 Impl::PositionScopeBufferMap::iterator it = d->position_to_children.begin();
584 Impl::PositionScopeBufferMap::iterator end = d->position_to_children.end();
585 for (; it != end; ++it) {
586 DocIterator dit = it->first.clone(buffer_clone);
587 dit.setBuffer(buffer_clone);
588 Buffer * child = const_cast<Buffer *>(it->second.buffer);
590 child->cloneWithChildren(bufmap, clones);
591 BufferMap::iterator const bit = bufmap.find(child);
592 LASSERT(bit != bufmap.end(), continue);
593 Buffer * child_clone = bit->second;
595 Inset * inset = dit.nextInset();
596 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
597 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
598 inset_inc->setChildBuffer(child_clone);
599 child_clone->d->setParent(buffer_clone);
600 // FIXME Do we need to do this now, or can we wait until we run updateMacros()?
601 buffer_clone->setChild(dit, child_clone);
603 buffer_clone->d->macro_lock = false;
608 Buffer * Buffer::cloneBufferOnly() const {
609 cloned_buffers.push_back(new CloneList);
610 CloneList * clones = cloned_buffers.back();
611 Buffer * buffer_clone = new Buffer(fileName().absFileName(), false, this);
613 // The clone needs its own DocumentClass, since running updateBuffer() will
614 // modify it, and we would otherwise be sharing it with the original Buffer.
615 buffer_clone->params().makeDocumentClass(true);
617 cap::switchBetweenClasses(
618 params().documentClassPtr(), buffer_clone->params().documentClassPtr(),
619 static_cast<InsetText &>(buffer_clone->inset()), el);
621 clones->insert(buffer_clone);
622 buffer_clone->d->clone_list_ = clones;
624 // we won't be cloning the children
625 buffer_clone->d->children_positions.clear();
630 bool Buffer::isClone() const
632 return d->cloned_buffer_;
636 void Buffer::changed(bool update_metrics) const
639 d->wa_->redrawAll(update_metrics);
643 frontend::WorkAreaManager & Buffer::workAreaManager() const
650 Text & Buffer::text() const
652 return d->inset->text();
656 Inset & Buffer::inset() const
662 BufferParams & Buffer::params()
668 BufferParams const & Buffer::params() const
674 BufferParams const & Buffer::masterParams() const
676 if (masterBuffer() == this)
679 BufferParams & mparams = const_cast<Buffer *>(masterBuffer())->params();
680 // Copy child authors to the params. We need those pointers.
681 AuthorList const & child_authors = params().authors();
682 AuthorList::Authors::const_iterator it = child_authors.begin();
683 for (; it != child_authors.end(); ++it)
684 mparams.authors().record(*it);
689 double Buffer::fontScalingFactor() const
691 return isExporting() ? 75.0 * params().html_math_img_scale
692 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
696 ParagraphList & Buffer::paragraphs()
698 return text().paragraphs();
702 ParagraphList const & Buffer::paragraphs() const
704 return text().paragraphs();
708 LyXVC & Buffer::lyxvc()
714 LyXVC const & Buffer::lyxvc() const
720 string const Buffer::temppath() const
722 return d->temppath.absFileName();
726 TexRow & Buffer::texrow()
732 TexRow const & Buffer::texrow() const
738 TocBackend & Buffer::tocBackend() const
740 return d->toc_backend;
744 Undo & Buffer::undo()
750 void Buffer::setChild(DocIterator const & dit, Buffer * child)
752 d->children_positions[child] = dit;
756 string Buffer::latexName(bool const no_path) const
758 FileName latex_name =
759 makeLatexName(d->exportFileName());
760 return no_path ? latex_name.onlyFileName()
761 : latex_name.absFileName();
765 FileName Buffer::Impl::exportFileName() const
767 docstring const branch_suffix =
768 params.branchlist().getFileNameSuffix();
769 if (branch_suffix.empty())
772 string const name = filename.onlyFileNameWithoutExt()
773 + to_utf8(branch_suffix);
774 FileName res(filename.onlyPath().absFileName() + "/" + name);
775 res.changeExtension(filename.extension());
781 string Buffer::logName(LogType * type) const
783 string const filename = latexName(false);
785 if (filename.empty()) {
791 string const path = temppath();
793 FileName const fname(addName(temppath(),
794 onlyFileName(changeExtension(filename,
797 // FIXME: how do we know this is the name of the build log?
798 FileName const bname(
799 addName(path, onlyFileName(
800 changeExtension(filename,
801 formats.extension(params().bufferFormat()) + ".out"))));
803 // Also consider the master buffer log file
804 FileName masterfname = fname;
805 LogType mtype = latexlog;
806 if (masterBuffer() != this) {
807 string const mlogfile = masterBuffer()->logName(&mtype);
808 masterfname = FileName(mlogfile);
811 // If no Latex log or Build log is newer, show Build log
812 if (bname.exists() &&
813 ((!fname.exists() && !masterfname.exists())
814 || (fname.lastModified() < bname.lastModified()
815 && masterfname.lastModified() < bname.lastModified()))) {
816 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
819 return bname.absFileName();
820 // If we have a newer master file log or only a master log, show this
821 } else if (fname != masterfname
822 && (!fname.exists() && (masterfname.exists()
823 || fname.lastModified() < masterfname.lastModified()))) {
824 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
827 return masterfname.absFileName();
829 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
832 return fname.absFileName();
836 void Buffer::setReadonly(bool const flag)
838 if (d->read_only != flag) {
845 void Buffer::setFileName(FileName const & fname)
847 bool const changed = fname != d->filename;
850 lyxvc().file_found_hook(fname);
851 setReadonly(d->filename.isReadOnly());
857 int Buffer::readHeader(Lexer & lex)
859 int unknown_tokens = 0;
861 int begin_header_line = -1;
863 // Initialize parameters that may be/go lacking in header:
864 params().branchlist().clear();
865 params().preamble.erase();
866 params().options.erase();
867 params().master.erase();
868 params().float_placement.erase();
869 params().paperwidth.erase();
870 params().paperheight.erase();
871 params().leftmargin.erase();
872 params().rightmargin.erase();
873 params().topmargin.erase();
874 params().bottommargin.erase();
875 params().headheight.erase();
876 params().headsep.erase();
877 params().footskip.erase();
878 params().columnsep.erase();
879 params().fonts_cjk.erase();
880 params().listings_params.clear();
881 params().clearLayoutModules();
882 params().clearRemovedModules();
883 params().clearIncludedChildren();
884 params().pdfoptions().clear();
885 params().indiceslist().clear();
886 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
887 params().isbackgroundcolor = false;
888 params().fontcolor = RGBColor(0, 0, 0);
889 params().isfontcolor = false;
890 params().notefontcolor = RGBColor(0xCC, 0xCC, 0xCC);
891 params().boxbgcolor = RGBColor(0xFF, 0, 0);
892 params().html_latex_start.clear();
893 params().html_latex_end.clear();
894 params().html_math_img_scale = 1.0;
895 params().output_sync_macro.erase();
896 params().setLocalLayout(string(), false);
897 params().setLocalLayout(string(), true);
899 for (int i = 0; i < 4; ++i) {
900 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
901 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
904 ErrorList & errorList = d->errorLists["Parse"];
913 if (token == "\\end_header")
917 if (token == "\\begin_header") {
918 begin_header_line = line;
922 LYXERR(Debug::PARSER, "Handling document header token: `"
925 string const result =
926 params().readToken(lex, token, d->filename.onlyPath());
927 if (!result.empty()) {
928 if (token == "\\textclass") {
929 d->layout_position = result;
932 docstring const s = bformat(_("Unknown token: "
936 errorList.push_back(ErrorItem(_("Document header error"),
941 if (begin_header_line) {
942 docstring const s = _("\\begin_header is missing");
943 errorList.push_back(ErrorItem(_("Document header error"),
947 params().makeDocumentClass();
949 return unknown_tokens;
954 // changed to be public and have one parameter
955 // Returns true if "\end_document" is not read (Asger)
956 bool Buffer::readDocument(Lexer & lex)
958 ErrorList & errorList = d->errorLists["Parse"];
961 // remove dummy empty par
962 paragraphs().clear();
964 if (!lex.checkFor("\\begin_document")) {
965 docstring const s = _("\\begin_document is missing");
966 errorList.push_back(ErrorItem(_("Document header error"),
972 if (params().output_changes) {
973 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
974 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
975 LaTeXFeatures::isAvailable("xcolor");
977 if (!dvipost && !xcolorulem) {
978 Alert::warning(_("Changes not shown in LaTeX output"),
979 _("Changes will not be highlighted in LaTeX output, "
980 "because neither dvipost nor xcolor/ulem are installed.\n"
981 "Please install these packages or redefine "
982 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
983 } else if (!xcolorulem) {
984 Alert::warning(_("Changes not shown in LaTeX output"),
985 _("Changes will not be highlighted in LaTeX output "
986 "when using pdflatex, because xcolor and ulem are not installed.\n"
987 "Please install both packages or redefine "
988 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
992 if (!parent() && !params().master.empty()) {
993 FileName const master_file = makeAbsPath(params().master,
994 onlyPath(absFileName()));
995 if (isLyXFileName(master_file.absFileName())) {
997 checkAndLoadLyXFile(master_file, true);
999 // necessary e.g. after a reload
1000 // to re-register the child (bug 5873)
1001 // FIXME: clean up updateMacros (here, only
1002 // child registering is needed).
1003 master->updateMacros();
1004 // set master as master buffer, but only
1005 // if we are a real child
1006 if (master->isChild(this))
1008 // if the master is not fully loaded
1009 // it is probably just loading this
1010 // child. No warning needed then.
1011 else if (master->isFullyLoaded())
1012 LYXERR0("The master '"
1014 << "' assigned to this document ("
1016 << ") does not include "
1017 "this document. Ignoring the master assignment.");
1022 // assure we have a default index
1023 params().indiceslist().addDefault(B_("Index"));
1026 d->old_position = originFilePath();
1027 bool const res = text().read(lex, errorList, d->inset);
1028 d->old_position.clear();
1030 // inform parent buffer about local macros
1032 Buffer const * pbuf = parent();
1033 UserMacroSet::const_iterator cit = usermacros.begin();
1034 UserMacroSet::const_iterator end = usermacros.end();
1035 for (; cit != end; ++cit)
1036 pbuf->usermacros.insert(*cit);
1040 updateMacroInstances(InternalUpdate);
1045 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
1047 Format const * fmt = formats.getFormat(format);
1050 // It is important to use the correct extension here, since some
1051 // converters create a wrong output file otherwise (e.g. html2latex)
1052 TempFile const tempfile("Buffer_importStringXXXXXX." + fmt->extension());
1053 FileName const name(tempfile.name());
1054 ofdocstream os(name.toFilesystemEncoding().c_str());
1055 // Do not convert os implicitly to bool, since that is forbidden in C++11.
1056 bool const success = !(os << contents).fail();
1059 bool converted = false;
1061 params().compressed = false;
1063 // remove dummy empty par
1064 paragraphs().clear();
1066 converted = importFile(format, name, errorList);
1075 bool Buffer::importFile(string const & format, FileName const & name, ErrorList & errorList)
1077 if (!theConverters().isReachable(format, "lyx"))
1080 TempFile const tempfile("Buffer_importFileXXXXXX.lyx");
1081 FileName const lyx(tempfile.name());
1082 if (theConverters().convert(0, name, lyx, name, format, "lyx", errorList))
1083 return readFile(lyx) == ReadSuccess;
1089 bool Buffer::readString(string const & s)
1091 params().compressed = false;
1094 istringstream is(s);
1096 TempFile tempfile("Buffer_readStringXXXXXX.lyx");
1097 FileName const fn = tempfile.name();
1100 bool success = parseLyXFormat(lex, fn, file_format) == ReadSuccess;
1102 if (success && file_format != LYX_FORMAT) {
1103 // We need to call lyx2lyx, so write the input to a file
1104 ofstream os(fn.toFilesystemEncoding().c_str());
1107 // lyxvc in readFile
1108 if (readFile(fn) != ReadSuccess)
1112 if (readDocument(lex))
1118 Buffer::ReadStatus Buffer::readFile(FileName const & fn)
1122 if (!lex.setFile(fname)) {
1123 Alert::error(_("File Not Found"),
1124 bformat(_("Unable to open file `%1$s'."),
1125 from_utf8(fn.absFileName())));
1126 return ReadFileNotFound;
1130 ReadStatus const ret_plf = parseLyXFormat(lex, fn, file_format);
1131 if (ret_plf != ReadSuccess)
1134 if (file_format != LYX_FORMAT) {
1136 ReadStatus const ret_clf = convertLyXFormat(fn, tmpFile, file_format);
1137 if (ret_clf != ReadSuccess)
1139 return readFile(tmpFile);
1142 // FIXME: InsetInfo needs to know whether the file is under VCS
1143 // during the parse process, so this has to be done before.
1144 lyxvc().file_found_hook(d->filename);
1146 if (readDocument(lex)) {
1147 Alert::error(_("Document format failure"),
1148 bformat(_("%1$s ended unexpectedly, which means"
1149 " that it is probably corrupted."),
1150 from_utf8(fn.absFileName())));
1151 return ReadDocumentFailure;
1154 d->file_fully_loaded = true;
1155 d->read_only = !d->filename.isWritable();
1156 params().compressed = formats.isZippedFile(d->filename);
1162 bool Buffer::isFullyLoaded() const
1164 return d->file_fully_loaded;
1168 void Buffer::setFullyLoaded(bool value)
1170 d->file_fully_loaded = value;
1174 bool Buffer::lastPreviewError() const
1176 return d->preview_error_;
1180 PreviewLoader * Buffer::loader() const
1182 if (!isExporting() && lyxrc.preview == LyXRC::PREVIEW_OFF)
1184 if (!d->preview_loader_)
1185 d->preview_loader_ = new PreviewLoader(*this);
1186 return d->preview_loader_;
1190 void Buffer::removePreviews() const
1192 delete d->preview_loader_;
1193 d->preview_loader_ = 0;
1197 void Buffer::updatePreviews() const
1199 PreviewLoader * ploader = loader();
1203 InsetIterator it = inset_iterator_begin(*d->inset);
1204 InsetIterator const end = inset_iterator_end(*d->inset);
1205 for (; it != end; ++it)
1206 it->addPreview(it, *ploader);
1208 ploader->startLoading();
1212 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
1213 FileName const & fn, int & file_format) const
1215 if(!lex.checkFor("\\lyxformat")) {
1216 Alert::error(_("Document format failure"),
1217 bformat(_("%1$s is not a readable LyX document."),
1218 from_utf8(fn.absFileName())));
1219 return ReadNoLyXFormat;
1225 // LyX formats 217 and earlier were written as 2.17. This corresponds
1226 // to files from LyX versions < 1.1.6.3. We just remove the dot in
1227 // these cases. See also: www.lyx.org/trac/changeset/1313.
1228 size_t dot = tmp_format.find_first_of(".,");
1229 if (dot != string::npos)
1230 tmp_format.erase(dot, 1);
1232 file_format = convert<int>(tmp_format);
1237 Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
1238 FileName & tmpfile, int from_format)
1240 TempFile tempfile("Buffer_convertLyXFormatXXXXXX.lyx");
1241 tempfile.setAutoRemove(false);
1242 tmpfile = tempfile.name();
1243 if(tmpfile.empty()) {
1244 Alert::error(_("Conversion failed"),
1245 bformat(_("%1$s is from a different"
1246 " version of LyX, but a temporary"
1247 " file for converting it could"
1248 " not be created."),
1249 from_utf8(fn.absFileName())));
1250 return LyX2LyXNoTempFile;
1253 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
1254 if (lyx2lyx.empty()) {
1255 Alert::error(_("Conversion script not found"),
1256 bformat(_("%1$s is from a different"
1257 " version of LyX, but the"
1258 " conversion script lyx2lyx"
1259 " could not be found."),
1260 from_utf8(fn.absFileName())));
1261 return LyX2LyXNotFound;
1265 // $python$ "$lyx2lyx$" -t $LYX_FORMAT$ -o "$tempfile$" "$filetoread$"
1266 ostringstream command;
1267 command << os::python()
1268 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
1269 << " -t " << convert<string>(LYX_FORMAT)
1270 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
1271 << ' ' << quoteName(fn.toSafeFilesystemEncoding());
1272 string const command_str = command.str();
1274 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
1276 cmd_ret const ret = runCommand(command_str);
1277 if (ret.first != 0) {
1278 if (from_format < LYX_FORMAT) {
1279 Alert::error(_("Conversion script failed"),
1280 bformat(_("%1$s is from an older version"
1281 " of LyX and the lyx2lyx script"
1282 " failed to convert it."),
1283 from_utf8(fn.absFileName())));
1284 return LyX2LyXOlderFormat;
1286 Alert::error(_("Conversion script failed"),
1287 bformat(_("%1$s is from a newer version"
1288 " of LyX and the lyx2lyx script"
1289 " failed to convert it."),
1290 from_utf8(fn.absFileName())));
1291 return LyX2LyXNewerFormat;
1298 // Should probably be moved to somewhere else: BufferView? GuiView?
1299 bool Buffer::save() const
1301 docstring const file = makeDisplayPath(absFileName(), 20);
1302 d->filename.refresh();
1304 // check the read-only status before moving the file as a backup
1305 if (d->filename.exists()) {
1306 bool const read_only = !d->filename.isWritable();
1308 Alert::warning(_("File is read-only"),
1309 bformat(_("The file %1$s cannot be written because it "
1310 "is marked as read-only."), file));
1315 // ask if the disk file has been externally modified (use checksum method)
1316 if (fileName().exists() && isExternallyModified(checksum_method)) {
1318 bformat(_("Document %1$s has been externally modified. "
1319 "Are you sure you want to overwrite this file?"), file);
1320 int const ret = Alert::prompt(_("Overwrite modified file?"),
1321 text, 1, 1, _("&Overwrite"), _("&Cancel"));
1326 // We don't need autosaves in the immediate future. (Asger)
1327 resetAutosaveTimers();
1329 // if the file does not yet exist, none of the backup activity
1330 // that follows is necessary
1331 if (!fileName().exists()) {
1332 if (!writeFile(fileName()))
1338 // we first write the file to a new name, then move it to its
1339 // proper location once that has been done successfully. that
1340 // way we preserve the original file if something goes wrong.
1341 string const justname = fileName().onlyFileNameWithoutExt();
1342 boost::scoped_ptr<TempFile>
1343 tempfile(new TempFile(fileName().onlyPath(),
1344 justname + "-XXXXXX.lyx"));
1345 bool const symlink = fileName().isSymLink();
1347 tempfile->setAutoRemove(false);
1349 FileName savefile(tempfile->name());
1350 LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
1351 if (!writeFile(savefile))
1354 // we will set this to false if we fail
1355 bool made_backup = true;
1357 FileName backupName(absFileName() + '~');
1358 if (lyxrc.make_backup) {
1359 if (!lyxrc.backupdir_path.empty()) {
1360 string const mangledName =
1361 subst(subst(backupName.absFileName(), '/', '!'), ':', '!');
1362 backupName = FileName(addName(lyxrc.backupdir_path,
1366 LYXERR(Debug::FILES, "Backing up original file to " <<
1367 backupName.absFileName());
1368 // Except file is symlink do not copy because of #6587.
1369 // Hard links have bad luck.
1370 made_backup = symlink ?
1371 fileName().copyTo(backupName):
1372 fileName().moveTo(backupName);
1375 Alert::error(_("Backup failure"),
1376 bformat(_("Cannot create backup file %1$s.\n"
1377 "Please check whether the directory exists and is writable."),
1378 from_utf8(backupName.absFileName())));
1379 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
1383 // Destroy tempfile since it keeps the file locked on windows (bug 9234)
1384 // Only do this if tempfile is not in autoremove mode
1387 // If we have no symlink, we can simply rename the temp file.
1388 // Otherwise, we need to copy it so the symlink stays intact.
1389 if (made_backup && symlink ? savefile.copyTo(fileName(), true) :
1390 savefile.moveTo(fileName()))
1392 // saveCheckSum() was already called by writeFile(), but the
1393 // time stamp is invalidated by copying/moving
1398 // else we saved the file, but failed to move it to the right location.
1400 if (lyxrc.make_backup && made_backup && !symlink) {
1401 // the original file was moved to filename.lyx~, so it will look
1402 // to the user as if it was deleted. (see bug #9234.) we could try
1403 // to restore it, but that would basically mean trying to do again
1404 // what we just failed to do. better to leave things as they are.
1405 Alert::error(_("Write failure"),
1406 bformat(_("The file has successfully been saved as:\n %1$s.\n"
1407 "But LyX could not move it to:\n %2$s.\n"
1408 "Your original file has been backed up to:\n %3$s"),
1409 from_utf8(savefile.absFileName()),
1410 from_utf8(fileName().absFileName()),
1411 from_utf8(backupName.absFileName())));
1413 // either we did not try to make a backup, or else we tried and failed,
1414 // or else the original file was a symlink, in which case it was copied,
1415 // not moved. so the original file is intact.
1416 Alert::error(_("Write failure"),
1417 bformat(_("Cannot move saved file to:\n %1$s.\n"
1418 "But the file has successfully been saved as:\n %2$s."),
1419 from_utf8(fileName().absFileName()),
1420 from_utf8(savefile.absFileName())));
1426 bool Buffer::writeFile(FileName const & fname) const
1428 if (d->read_only && fname == d->filename)
1431 bool retval = false;
1433 docstring const str = bformat(_("Saving document %1$s..."),
1434 makeDisplayPath(fname.absFileName()));
1437 string const encoded_fname = fname.toSafeFilesystemEncoding(os::CREATE);
1439 if (params().compressed) {
1440 gz::ogzstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1441 retval = ofs && write(ofs);
1443 ofstream ofs(encoded_fname.c_str(), ios::out|ios::trunc);
1444 retval = ofs && write(ofs);
1448 message(str + _(" could not write file!"));
1453 // removeAutosaveFile();
1456 message(str + _(" done."));
1462 docstring Buffer::emergencyWrite()
1464 // No need to save if the buffer has not changed.
1468 string const doc = isUnnamed() ? onlyFileName(absFileName()) : absFileName();
1470 docstring user_message = bformat(
1471 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
1473 // We try to save three places:
1474 // 1) Same place as document. Unless it is an unnamed doc.
1476 string s = absFileName();
1479 if (writeFile(FileName(s))) {
1481 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1482 return user_message;
1484 user_message += " " + _("Save failed! Trying again...\n");
1488 // 2) In HOME directory.
1489 string s = addName(Package::get_home_dir().absFileName(), absFileName());
1491 lyxerr << ' ' << s << endl;
1492 if (writeFile(FileName(s))) {
1494 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1495 return user_message;
1498 user_message += " " + _("Save failed! Trying yet again...\n");
1500 // 3) In "/tmp" directory.
1501 // MakeAbsPath to prepend the current
1502 // drive letter on OS/2
1503 s = addName(package().temp_dir().absFileName(), absFileName());
1505 lyxerr << ' ' << s << endl;
1506 if (writeFile(FileName(s))) {
1508 user_message += " " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
1509 return user_message;
1512 user_message += " " + _("Save failed! Bummer. Document is lost.");
1515 return user_message;
1519 bool Buffer::write(ostream & ofs) const
1522 // Use the standard "C" locale for file output.
1523 ofs.imbue(locale::classic());
1526 // The top of the file should not be written by params().
1528 // write out a comment in the top of the file
1529 // Important: Keep the version formatting in sync with lyx2lyx and
1530 // tex2lyx (bug 7951)
1531 ofs << "#LyX " << lyx_version_major << "." << lyx_version_minor
1532 << " created this file. For more info see http://www.lyx.org/\n"
1533 << "\\lyxformat " << LYX_FORMAT << "\n"
1534 << "\\begin_document\n";
1536 /// For each author, set 'used' to true if there is a change
1537 /// by this author in the document; otherwise set it to 'false'.
1538 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1539 AuthorList::Authors::const_iterator a_end = params().authors().end();
1540 for (; a_it != a_end; ++a_it)
1541 a_it->setUsed(false);
1543 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1544 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1545 for ( ; it != end; ++it)
1546 it->checkAuthors(params().authors());
1548 // now write out the buffer parameters.
1549 ofs << "\\begin_header\n";
1550 params().writeFile(ofs, this);
1551 ofs << "\\end_header\n";
1554 ofs << "\n\\begin_body\n";
1556 ofs << "\n\\end_body\n";
1558 // Write marker that shows file is complete
1559 ofs << "\\end_document" << endl;
1561 // Shouldn't really be needed....
1564 // how to check if close went ok?
1565 // Following is an attempt... (BE 20001011)
1567 // good() returns false if any error occurred, including some
1568 // formatting error.
1569 // bad() returns true if something bad happened in the buffer,
1570 // which should include file system full errors.
1575 lyxerr << "File was not closed properly." << endl;
1582 bool Buffer::makeLaTeXFile(FileName const & fname,
1583 string const & original_path,
1584 OutputParams const & runparams_in,
1585 OutputWhat output) const
1587 OutputParams runparams = runparams_in;
1589 // This is necessary for LuaTeX/XeTeX with tex fonts.
1590 // See FIXME in BufferParams::encoding()
1591 if (runparams.isFullUnicode())
1592 runparams.encoding = encodings.fromLyXName("utf8-plain");
1594 string const encoding = runparams.encoding->iconvName();
1595 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
1598 try { ofs.reset(encoding); }
1599 catch (iconv_codecvt_facet_exception const & e) {
1600 lyxerr << "Caught iconv exception: " << e.what() << endl;
1601 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1602 "verify that the support software for your encoding (%1$s) is "
1603 "properly installed"), from_ascii(encoding)));
1606 if (!openFileWrite(ofs, fname))
1609 ErrorList & errorList = d->errorLists["Export"];
1611 bool failed_export = false;
1612 otexstream os(ofs, d->texrow);
1614 // make sure we are ready to export
1615 // this needs to be done before we validate
1616 // FIXME Do we need to do this all the time? I.e., in children
1617 // of a master we are exporting?
1619 updateMacroInstances(OutputUpdate);
1622 os.texrow().reset();
1623 writeLaTeXSource(os, original_path, runparams, output);
1625 catch (EncodingException const & e) {
1626 docstring const failed(1, e.failed_char);
1628 oss << "0x" << hex << e.failed_char << dec;
1629 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1630 " (code point %2$s)"),
1631 failed, from_utf8(oss.str()));
1632 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1633 "representable in the chosen encoding.\n"
1634 "Changing the document encoding to utf8 could help."),
1635 e.par_id, e.pos, e.pos + 1));
1636 failed_export = true;
1638 catch (iconv_codecvt_facet_exception const & e) {
1639 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1640 _(e.what()), -1, 0, 0));
1641 failed_export = true;
1643 catch (exception const & e) {
1644 errorList.push_back(ErrorItem(_("conversion failed"),
1645 _(e.what()), -1, 0, 0));
1646 failed_export = true;
1649 lyxerr << "Caught some really weird exception..." << endl;
1655 failed_export = true;
1656 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1659 if (runparams_in.silent)
1663 return !failed_export;
1667 void Buffer::writeLaTeXSource(otexstream & os,
1668 string const & original_path,
1669 OutputParams const & runparams_in,
1670 OutputWhat output) const
1672 // The child documents, if any, shall be already loaded at this point.
1674 OutputParams runparams = runparams_in;
1676 // This is necessary for LuaTeX/XeTeX with tex fonts.
1677 // See FIXME in BufferParams::encoding()
1678 if (runparams.isFullUnicode())
1679 runparams.encoding = encodings.fromLyXName("utf8-plain");
1681 // If we are compiling a file standalone, even if this is the
1682 // child of some other buffer, let's cut the link here, so the
1683 // file is really independent and no concurring settings from
1684 // the master (e.g. branch state) interfere (see #8100).
1685 if (!runparams.is_child)
1686 d->ignore_parent = true;
1688 // Classify the unicode characters appearing in math insets
1689 BufferEncodings::initUnicodeMath(*this);
1691 // validate the buffer.
1692 LYXERR(Debug::LATEX, " Validating buffer...");
1693 LaTeXFeatures features(*this, params(), runparams);
1695 // This is only set once per document (in master)
1696 if (!runparams.is_child)
1697 runparams.use_polyglossia = features.usePolyglossia();
1698 LYXERR(Debug::LATEX, " Buffer validation done.");
1700 bool const output_preamble =
1701 output == FullSource || output == OnlyPreamble;
1702 bool const output_body =
1703 output == FullSource || output == OnlyBody;
1705 // The starting paragraph of the coming rows is the
1706 // first paragraph of the document. (Asger)
1707 if (output_preamble && runparams.nice) {
1708 os << "%% LyX " << lyx_version << " created this file. "
1709 "For more info, see http://www.lyx.org/.\n"
1710 "%% Do not edit unless you really know what "
1713 LYXERR(Debug::INFO, "lyx document header finished");
1715 // There are a few differences between nice LaTeX and usual files:
1716 // usual files have \batchmode and special input@path to allow
1717 // inclusion of figures specified by an explicitly relative path
1718 // (i.e., a path starting with './' or '../') with either \input or
1719 // \includegraphics, as the TEXINPUTS method doesn't work in this case.
1720 // input@path is set when the actual parameter original_path is set.
1721 // This is done for usual tex-file, but not for nice-latex-file.
1722 // (Matthias 250696)
1723 // Note that input@path is only needed for something the user does
1724 // in the preamble, included .tex files or ERT, files included by
1725 // LyX work without it.
1726 if (output_preamble) {
1727 if (!runparams.nice) {
1728 // code for usual, NOT nice-latex-file
1729 os << "\\batchmode\n"; // changed from \nonstopmode
1731 if (!original_path.empty()) {
1733 // We don't know the encoding of inputpath
1734 docstring const inputpath = from_utf8(original_path);
1735 docstring uncodable_glyphs;
1736 Encoding const * const enc = runparams.encoding;
1738 for (size_t n = 0; n < inputpath.size(); ++n) {
1739 if (!enc->encodable(inputpath[n])) {
1740 docstring const glyph(1, inputpath[n]);
1741 LYXERR0("Uncodable character '"
1743 << "' in input path!");
1744 uncodable_glyphs += glyph;
1749 // warn user if we found uncodable glyphs.
1750 if (!uncodable_glyphs.empty()) {
1751 frontend::Alert::warning(
1752 _("Uncodable character in file path"),
1754 _("The path of your document\n"
1756 "contains glyphs that are unknown "
1757 "in the current document encoding "
1758 "(namely %2$s). This may result in "
1759 "incomplete output, unless "
1760 "TEXINPUTS contains the document "
1761 "directory and you don't use "
1762 "explicitly relative paths (i.e., "
1763 "paths starting with './' or "
1764 "'../') in the preamble or in ERT."
1765 "\n\nIn case of problems, choose "
1766 "an appropriate document encoding\n"
1767 "(such as utf8) or change the "
1769 inputpath, uncodable_glyphs));
1772 support::latex_path(original_path);
1773 if (contains(docdir, '#')) {
1774 docdir = subst(docdir, "#", "\\#");
1775 os << "\\catcode`\\#=11"
1776 "\\def\\#{#}\\catcode`\\#=6\n";
1778 if (contains(docdir, '%')) {
1779 docdir = subst(docdir, "%", "\\%");
1780 os << "\\catcode`\\%=11"
1781 "\\def\\%{%}\\catcode`\\%=14\n";
1783 os << "\\makeatletter\n"
1784 << "\\def\\input@path{{"
1785 << docdir << "/}}\n"
1786 << "\\makeatother\n";
1790 // get parent macros (if this buffer has a parent) which will be
1791 // written at the document begin further down.
1792 MacroSet parentMacros;
1793 listParentMacros(parentMacros, features);
1795 // Write the preamble
1796 runparams.use_babel = params().writeLaTeX(os, features,
1797 d->filename.onlyPath());
1799 // Japanese might be required only in some children of a document,
1800 // but once required, we must keep use_japanese true.
1801 runparams.use_japanese |= features.isRequired("japanese");
1804 // Restore the parenthood if needed
1805 if (!runparams.is_child)
1806 d->ignore_parent = false;
1811 os << "\\begin{document}\n";
1813 // output the parent macros
1814 MacroSet::iterator it = parentMacros.begin();
1815 MacroSet::iterator end = parentMacros.end();
1816 for (; it != end; ++it) {
1817 int num_lines = (*it)->write(os.os(), true);
1818 os.texrow().newlines(num_lines);
1821 } // output_preamble
1823 os.texrow().start(paragraphs().begin()->id(), 0);
1825 LYXERR(Debug::INFO, "preamble finished, now the body.");
1828 latexParagraphs(*this, text(), os, runparams);
1830 // Restore the parenthood if needed
1831 if (!runparams.is_child)
1832 d->ignore_parent = false;
1834 // add this just in case after all the paragraphs
1837 if (output_preamble) {
1838 os << "\\end{document}\n";
1839 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1841 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1843 runparams_in.encoding = runparams.encoding;
1845 // Just to be sure. (Asger)
1846 os.texrow().newline();
1848 //for (int i = 0; i<d->texrow.rows(); i++) {
1850 // if (d->texrow.getIdFromRow(i+1,id,pos) && id>0)
1851 // lyxerr << i+1 << ":" << id << ":" << getParFromID(id).paragraph().asString()<<"\n";
1854 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1855 LYXERR(Debug::INFO, "Row count was " << os.texrow().rows() - 1 << '.');
1859 void Buffer::makeDocBookFile(FileName const & fname,
1860 OutputParams const & runparams,
1861 OutputWhat output) const
1863 LYXERR(Debug::LATEX, "makeDocBookFile...");
1866 if (!openFileWrite(ofs, fname))
1869 // make sure we are ready to export
1870 // this needs to be done before we validate
1872 updateMacroInstances(OutputUpdate);
1874 writeDocBookSource(ofs, fname.absFileName(), runparams, output);
1878 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1882 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1883 OutputParams const & runparams,
1884 OutputWhat output) const
1886 LaTeXFeatures features(*this, params(), runparams);
1891 DocumentClass const & tclass = params().documentClass();
1892 string const & top_element = tclass.latexname();
1894 bool const output_preamble =
1895 output == FullSource || output == OnlyPreamble;
1896 bool const output_body =
1897 output == FullSource || output == OnlyBody;
1899 if (output_preamble) {
1900 if (runparams.flavor == OutputParams::XML)
1901 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1904 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1907 if (! tclass.class_header().empty())
1908 os << from_ascii(tclass.class_header());
1909 else if (runparams.flavor == OutputParams::XML)
1910 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1911 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1913 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1915 docstring preamble = from_utf8(params().preamble);
1916 if (runparams.flavor != OutputParams::XML ) {
1917 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1918 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1919 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1920 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1923 string const name = runparams.nice
1924 ? changeExtension(absFileName(), ".sgml") : fname;
1925 preamble += features.getIncludedFiles(name);
1926 preamble += features.getLyXSGMLEntities();
1928 if (!preamble.empty()) {
1929 os << "\n [ " << preamble << " ]";
1935 string top = top_element;
1937 if (runparams.flavor == OutputParams::XML)
1938 top += params().language->code();
1940 top += params().language->code().substr(0, 2);
1943 if (!params().options.empty()) {
1945 top += params().options;
1948 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1949 << " file was created by LyX " << lyx_version
1950 << "\n See http://www.lyx.org/ for more information -->\n";
1952 params().documentClass().counters().reset();
1954 sgml::openTag(os, top);
1956 docbookParagraphs(text(), *this, os, runparams);
1957 sgml::closeTag(os, top_element);
1962 void Buffer::makeLyXHTMLFile(FileName const & fname,
1963 OutputParams const & runparams) const
1965 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1968 if (!openFileWrite(ofs, fname))
1971 // make sure we are ready to export
1972 // this has to be done before we validate
1973 updateBuffer(UpdateMaster, OutputUpdate);
1974 updateMacroInstances(OutputUpdate);
1976 writeLyXHTMLSource(ofs, runparams, FullSource);
1980 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1984 void Buffer::writeLyXHTMLSource(odocstream & os,
1985 OutputParams const & runparams,
1986 OutputWhat output) const
1988 LaTeXFeatures features(*this, params(), runparams);
1990 d->bibinfo_.makeCitationLabels(*this);
1992 bool const output_preamble =
1993 output == FullSource || output == OnlyPreamble;
1994 bool const output_body =
1995 output == FullSource || output == OnlyBody || output == IncludedFile;
1997 if (output_preamble) {
1998 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
1999 << "<!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"
2000 // FIXME Language should be set properly.
2001 << "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
2003 << "<meta name=\"GENERATOR\" content=\"" << PACKAGE_STRING << "\" />\n"
2004 // FIXME Presumably need to set this right
2005 << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
2007 docstring const & doctitle = features.htmlTitle();
2009 << (doctitle.empty() ?
2010 from_ascii("LyX Document") :
2011 html::htmlize(doctitle, XHTMLStream::ESCAPE_ALL))
2014 docstring styles = features.getTClassHTMLPreamble();
2015 if (!styles.empty())
2016 os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
2018 styles = from_utf8(features.getPreambleSnippets());
2019 if (!styles.empty())
2020 os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
2022 // we will collect CSS information in a stream, and then output it
2023 // either here, as part of the header, or else in a separate file.
2024 odocstringstream css;
2025 styles = from_utf8(features.getCSSSnippets());
2026 if (!styles.empty())
2027 css << "/* LyX Provided Styles */\n" << styles << '\n';
2029 styles = features.getTClassHTMLStyles();
2030 if (!styles.empty())
2031 css << "/* Layout-provided Styles */\n" << styles << '\n';
2033 bool const needfg = params().fontcolor != RGBColor(0, 0, 0);
2034 bool const needbg = params().backgroundcolor != RGBColor(0xFF, 0xFF, 0xFF);
2035 if (needfg || needbg) {
2036 css << "\nbody {\n";
2039 << from_ascii(X11hexname(params().fontcolor))
2042 css << " background-color: "
2043 << from_ascii(X11hexname(params().backgroundcolor))
2048 docstring const dstyles = css.str();
2049 if (!dstyles.empty()) {
2050 bool written = false;
2051 if (params().html_css_as_file) {
2052 // open a file for CSS info
2054 string const fcssname = addName(temppath(), "docstyle.css");
2055 FileName const fcssfile = FileName(fcssname);
2056 if (openFileWrite(ocss, fcssfile)) {
2060 // write link to header
2061 os << "<link rel='stylesheet' href='docstyle.css' type='text/css' />\n";
2063 runparams.exportdata->addExternalFile("xhtml", fcssfile);
2066 // we are here if the CSS is supposed to be written to the header
2067 // or if we failed to write it to an external file.
2069 os << "<style type='text/css'>\n"
2078 bool const output_body_tag = (output != IncludedFile);
2079 if (output_body_tag)
2082 if (output != IncludedFile)
2083 // if we're an included file, the counters are in the master.
2084 params().documentClass().counters().reset();
2085 xhtmlParagraphs(text(), *this, xs, runparams);
2086 if (output_body_tag)
2090 if (output_preamble)
2095 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
2096 // Other flags: -wall -v0 -x
2097 int Buffer::runChktex()
2101 // get LaTeX-Filename
2102 FileName const path(temppath());
2103 string const name = addName(path.absFileName(), latexName());
2104 string const org_path = filePath();
2106 PathChanger p(path); // path to LaTeX file
2107 message(_("Running chktex..."));
2109 // Generate the LaTeX file if neccessary
2110 OutputParams runparams(¶ms().encoding());
2111 runparams.flavor = OutputParams::LATEX;
2112 runparams.nice = false;
2113 runparams.linelen = lyxrc.plaintext_linelen;
2114 makeLaTeXFile(FileName(name), org_path, runparams);
2117 Chktex chktex(lyxrc.chktex_command, onlyFileName(name), filePath());
2118 int const res = chktex.run(terr); // run chktex
2121 Alert::error(_("chktex failure"),
2122 _("Could not run chktex successfully."));
2124 ErrorList & errlist = d->errorLists["ChkTeX"];
2126 bufferErrors(terr, errlist);
2131 if (runparams.silent)
2132 d->errorLists["ChkTeX"].clear();
2140 void Buffer::validate(LaTeXFeatures & features) const
2142 // Validate the buffer params, but not for included
2143 // files, since they also use the parent buffer's
2145 if (!features.runparams().is_child)
2146 params().validate(features);
2148 for_each(paragraphs().begin(), paragraphs().end(),
2149 bind(&Paragraph::validate, _1, ref(features)));
2151 if (lyxerr.debugging(Debug::LATEX)) {
2152 features.showStruct();
2157 void Buffer::getLabelList(vector<docstring> & list) const
2159 // If this is a child document, use the master's list instead.
2161 masterBuffer()->getLabelList(list);
2166 Toc & toc = d->toc_backend.toc("label");
2167 TocIterator toc_it = toc.begin();
2168 TocIterator end = toc.end();
2169 for (; toc_it != end; ++toc_it) {
2170 if (toc_it->depth() == 0)
2171 list.push_back(toc_it->str());
2176 void Buffer::updateBibfilesCache(UpdateScope scope) const
2178 // FIXME This is probably unnecssary, given where we call this.
2179 // If this is a child document, use the parent's cache instead.
2180 if (parent() && scope != UpdateChildOnly) {
2181 masterBuffer()->updateBibfilesCache();
2185 d->bibfiles_cache_.clear();
2186 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2187 if (it->lyxCode() == BIBTEX_CODE) {
2188 InsetBibtex const & inset = static_cast<InsetBibtex const &>(*it);
2189 support::FileNameList const bibfiles = inset.getBibFiles();
2190 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2193 } else if (it->lyxCode() == INCLUDE_CODE) {
2194 InsetInclude & inset = static_cast<InsetInclude &>(*it);
2195 Buffer const * const incbuf = inset.getChildBuffer();
2198 support::FileNameList const & bibfiles =
2199 incbuf->getBibfilesCache(UpdateChildOnly);
2200 if (!bibfiles.empty()) {
2201 d->bibfiles_cache_.insert(d->bibfiles_cache_.end(),
2207 d->bibfile_cache_valid_ = true;
2208 d->bibinfo_cache_valid_ = false;
2209 d->cite_labels_valid_ = false;
2213 void Buffer::invalidateBibinfoCache() const
2215 d->bibinfo_cache_valid_ = false;
2216 d->cite_labels_valid_ = false;
2217 // also invalidate the cache for the parent buffer
2218 Buffer const * const pbuf = d->parent();
2220 pbuf->invalidateBibinfoCache();
2224 void Buffer::invalidateBibfileCache() const
2226 d->bibfile_cache_valid_ = false;
2227 d->bibinfo_cache_valid_ = false;
2228 d->cite_labels_valid_ = false;
2229 // also invalidate the cache for the parent buffer
2230 Buffer const * const pbuf = d->parent();
2232 pbuf->invalidateBibfileCache();
2236 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
2238 // FIXME This is probably unnecessary, given where we call this.
2239 // If this is a child document, use the master's cache instead.
2240 Buffer const * const pbuf = masterBuffer();
2241 if (pbuf != this && scope != UpdateChildOnly)
2242 return pbuf->getBibfilesCache();
2244 if (!d->bibfile_cache_valid_)
2245 this->updateBibfilesCache(scope);
2247 return d->bibfiles_cache_;
2251 BiblioInfo const & Buffer::masterBibInfo() const
2253 Buffer const * const tmp = masterBuffer();
2255 return tmp->masterBibInfo();
2260 void Buffer::checkIfBibInfoCacheIsValid() const
2262 // use the master's cache
2263 Buffer const * const tmp = masterBuffer();
2265 tmp->checkIfBibInfoCacheIsValid();
2269 // compare the cached timestamps with the actual ones.
2270 FileNameList const & bibfiles_cache = getBibfilesCache();
2271 FileNameList::const_iterator ei = bibfiles_cache.begin();
2272 FileNameList::const_iterator en = bibfiles_cache.end();
2273 for (; ei != en; ++ ei) {
2274 time_t lastw = ei->lastModified();
2275 time_t prevw = d->bibfile_status_[*ei];
2276 if (lastw != prevw) {
2277 d->bibinfo_cache_valid_ = false;
2278 d->cite_labels_valid_ = false;
2279 d->bibfile_status_[*ei] = lastw;
2285 void Buffer::reloadBibInfoCache() const
2287 // use the master's cache
2288 Buffer const * const tmp = masterBuffer();
2290 tmp->reloadBibInfoCache();
2294 checkIfBibInfoCacheIsValid();
2295 if (d->bibinfo_cache_valid_)
2298 d->bibinfo_.clear();
2300 d->bibinfo_cache_valid_ = true;
2304 void Buffer::collectBibKeys() const
2306 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
2307 it->collectBibKeys(it);
2311 void Buffer::addBiblioInfo(BiblioInfo const & bi) const
2313 Buffer const * tmp = masterBuffer();
2314 BiblioInfo & masterbi = (tmp == this) ?
2315 d->bibinfo_ : tmp->d->bibinfo_;
2316 masterbi.mergeBiblioInfo(bi);
2320 void Buffer::addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const
2322 Buffer const * tmp = masterBuffer();
2323 BiblioInfo & masterbi = (tmp == this) ?
2324 d->bibinfo_ : tmp->d->bibinfo_;
2329 void Buffer::makeCitationLabels() const
2331 Buffer const * const master = masterBuffer();
2332 return d->bibinfo_.makeCitationLabels(*master);
2336 bool Buffer::citeLabelsValid() const
2338 return masterBuffer()->d->cite_labels_valid_;
2342 void Buffer::removeBiblioTempFiles() const
2344 // We remove files that contain LaTeX commands specific to the
2345 // particular bibliographic style being used, in order to avoid
2346 // LaTeX errors when we switch style.
2347 FileName const aux_file(addName(temppath(), changeExtension(latexName(),".aux")));
2348 FileName const bbl_file(addName(temppath(), changeExtension(latexName(),".bbl")));
2349 LYXERR(Debug::FILES, "Removing the .aux file " << aux_file);
2350 aux_file.removeFile();
2351 LYXERR(Debug::FILES, "Removing the .bbl file " << bbl_file);
2352 bbl_file.removeFile();
2353 // Also for the parent buffer
2354 Buffer const * const pbuf = parent();
2356 pbuf->removeBiblioTempFiles();
2360 bool Buffer::isDepClean(string const & name) const
2362 DepClean::const_iterator const it = d->dep_clean.find(name);
2363 if (it == d->dep_clean.end())
2369 void Buffer::markDepClean(string const & name)
2371 d->dep_clean[name] = true;
2375 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
2378 // FIXME? if there is an Buffer LFUN that can be dispatched even
2379 // if internal, put a switch '(cmd.action)' here.
2385 switch (cmd.action()) {
2387 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2388 flag.setOnOff(isReadonly());
2391 // FIXME: There is need for a command-line import.
2392 //case LFUN_BUFFER_IMPORT:
2394 case LFUN_BUFFER_AUTO_SAVE:
2397 case LFUN_BUFFER_EXPORT_CUSTOM:
2398 // FIXME: Nothing to check here?
2401 case LFUN_BUFFER_EXPORT: {
2402 docstring const arg = cmd.argument();
2403 if (arg == "custom") {
2407 string format = to_utf8(arg);
2408 size_t pos = format.find(' ');
2409 if (pos != string::npos)
2410 format = format.substr(0, pos);
2411 enable = params().isExportable(format);
2413 flag.message(bformat(
2414 _("Don't know how to export to format: %1$s"), arg));
2418 case LFUN_BUFFER_CHKTEX:
2419 enable = params().isLatex() && !lyxrc.chktex_command.empty();
2422 case LFUN_BUILD_PROGRAM:
2423 enable = params().isExportable("program");
2426 case LFUN_BRANCH_ACTIVATE:
2427 case LFUN_BRANCH_DEACTIVATE:
2428 case LFUN_BRANCH_MASTER_ACTIVATE:
2429 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2430 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
2431 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2432 BranchList const & branchList = master ? masterBuffer()->params().branchlist()
2433 : params().branchlist();
2434 docstring const branchName = cmd.argument();
2435 flag.setEnabled(!branchName.empty() && branchList.find(branchName));
2439 case LFUN_BRANCH_ADD:
2440 case LFUN_BRANCHES_RENAME:
2441 // if no Buffer is present, then of course we won't be called!
2444 case LFUN_BUFFER_LANGUAGE:
2445 enable = !isReadonly();
2448 case LFUN_BUFFER_VIEW_CACHE:
2449 enable = (d->preview_file_).exists();
2455 flag.setEnabled(enable);
2460 void Buffer::dispatch(string const & command, DispatchResult & result)
2462 return dispatch(lyxaction.lookupFunc(command), result);
2466 // NOTE We can end up here even if we have no GUI, because we are called
2467 // by LyX::exec to handled command-line requests. So we may need to check
2468 // whether we have a GUI or not. The boolean use_gui holds this information.
2469 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
2472 // FIXME? if there is an Buffer LFUN that can be dispatched even
2473 // if internal, put a switch '(cmd.action())' here.
2474 dr.dispatched(false);
2477 string const argument = to_utf8(func.argument());
2478 // We'll set this back to false if need be.
2479 bool dispatched = true;
2480 undo().beginUndoGroup();
2482 switch (func.action()) {
2483 case LFUN_BUFFER_TOGGLE_READ_ONLY:
2484 if (lyxvc().inUse()) {
2485 string log = lyxvc().toggleReadOnly();
2490 setReadonly(!isReadonly());
2493 case LFUN_BUFFER_EXPORT: {
2494 ExportStatus const status = doExport(argument, false);
2495 dr.setError(status != ExportSuccess);
2496 if (status != ExportSuccess)
2497 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
2502 case LFUN_BUILD_PROGRAM: {
2503 ExportStatus const status = doExport("program", true);
2504 dr.setError(status != ExportSuccess);
2505 if (status != ExportSuccess)
2506 dr.setMessage(_("Error generating literate programming code."));
2510 case LFUN_BUFFER_CHKTEX:
2514 case LFUN_BUFFER_EXPORT_CUSTOM: {
2516 string command = split(argument, format_name, ' ');
2517 Format const * format = formats.getFormat(format_name);
2519 lyxerr << "Format \"" << format_name
2520 << "\" not recognized!"
2525 // The name of the file created by the conversion process
2528 // Output to filename
2529 if (format->name() == "lyx") {
2530 string const latexname = latexName(false);
2531 filename = changeExtension(latexname,
2532 format->extension());
2533 filename = addName(temppath(), filename);
2535 if (!writeFile(FileName(filename)))
2539 doExport(format_name, true, filename);
2542 // Substitute $$FName for filename
2543 if (!contains(command, "$$FName"))
2544 command = "( " + command + " ) < $$FName";
2545 command = subst(command, "$$FName", filename);
2547 // Execute the command in the background
2549 call.startscript(Systemcall::DontWait, command,
2550 filePath(), layoutPos());
2554 // FIXME: There is need for a command-line import.
2556 case LFUN_BUFFER_IMPORT:
2561 case LFUN_BUFFER_AUTO_SAVE:
2563 resetAutosaveTimers();
2566 case LFUN_BRANCH_ACTIVATE:
2567 case LFUN_BRANCH_DEACTIVATE:
2568 case LFUN_BRANCH_MASTER_ACTIVATE:
2569 case LFUN_BRANCH_MASTER_DEACTIVATE: {
2570 bool const master = (func.action() == LFUN_BRANCH_MASTER_ACTIVATE
2571 || func.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
2572 Buffer * buf = master ? const_cast<Buffer *>(masterBuffer())
2575 docstring const branch_name = func.argument();
2576 // the case without a branch name is handled elsewhere
2577 if (branch_name.empty()) {
2581 Branch * branch = buf->params().branchlist().find(branch_name);
2583 LYXERR0("Branch " << branch_name << " does not exist.");
2585 docstring const msg =
2586 bformat(_("Branch \"%1$s\" does not exist."), branch_name);
2590 bool const activate = (func.action() == LFUN_BRANCH_ACTIVATE
2591 || func.action() == LFUN_BRANCH_MASTER_ACTIVATE);
2592 if (branch->isSelected() != activate) {
2593 buf->undo().recordUndoBufferParams(CursorData());
2594 branch->setSelected(activate);
2596 dr.screenUpdate(Update::Force);
2597 dr.forceBufferUpdate();
2602 case LFUN_BRANCH_ADD: {
2603 docstring branch_name = func.argument();
2604 if (branch_name.empty()) {
2608 BranchList & branch_list = params().branchlist();
2609 vector<docstring> const branches =
2610 getVectorFromString(branch_name, branch_list.separator());
2612 for (vector<docstring>::const_iterator it = branches.begin();
2613 it != branches.end(); ++it) {
2615 Branch * branch = branch_list.find(branch_name);
2617 LYXERR0("Branch " << branch_name << " already exists.");
2621 msg += bformat(_("Branch \"%1$s\" already exists."), branch_name);
2623 undo().recordUndoBufferParams(CursorData());
2624 branch_list.add(branch_name);
2625 branch = branch_list.find(branch_name);
2626 string const x11hexname = X11hexname(branch->color());
2627 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
2628 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
2630 dr.screenUpdate(Update::Force);
2638 case LFUN_BRANCHES_RENAME: {
2639 if (func.argument().empty())
2642 docstring const oldname = from_utf8(func.getArg(0));
2643 docstring const newname = from_utf8(func.getArg(1));
2644 InsetIterator it = inset_iterator_begin(inset());
2645 InsetIterator const end = inset_iterator_end(inset());
2646 bool success = false;
2647 for (; it != end; ++it) {
2648 if (it->lyxCode() == BRANCH_CODE) {
2649 InsetBranch & ins = static_cast<InsetBranch &>(*it);
2650 if (ins.branch() == oldname) {
2651 undo().recordUndo(CursorData(it));
2652 ins.rename(newname);
2657 if (it->lyxCode() == INCLUDE_CODE) {
2658 // get buffer of external file
2659 InsetInclude const & ins =
2660 static_cast<InsetInclude const &>(*it);
2661 Buffer * child = ins.getChildBuffer();
2664 child->dispatch(func, dr);
2669 dr.screenUpdate(Update::Force);
2670 dr.forceBufferUpdate();
2675 case LFUN_BUFFER_VIEW_CACHE:
2676 if (!formats.view(*this, d->preview_file_,
2677 d->preview_format_))
2678 dr.setMessage(_("Error viewing the output file."));
2685 dr.dispatched(dispatched);
2686 undo().endUndoGroup();
2690 void Buffer::changeLanguage(Language const * from, Language const * to)
2692 LASSERT(from, return);
2693 LASSERT(to, return);
2695 for_each(par_iterator_begin(),
2697 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2701 bool Buffer::isMultiLingual() const
2703 ParConstIterator end = par_iterator_end();
2704 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2705 if (it->isMultiLingual(params()))
2712 std::set<Language const *> Buffer::getLanguages() const
2714 std::set<Language const *> languages;
2715 getLanguages(languages);
2720 void Buffer::getLanguages(std::set<Language const *> & languages) const
2722 ParConstIterator end = par_iterator_end();
2723 // add the buffer language, even if it's not actively used
2724 languages.insert(language());
2725 // iterate over the paragraphs
2726 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2727 it->getLanguages(languages);
2729 ListOfBuffers clist = getDescendents();
2730 ListOfBuffers::const_iterator cit = clist.begin();
2731 ListOfBuffers::const_iterator const cen = clist.end();
2732 for (; cit != cen; ++cit)
2733 (*cit)->getLanguages(languages);
2737 DocIterator Buffer::getParFromID(int const id) const
2739 Buffer * buf = const_cast<Buffer *>(this);
2741 // John says this is called with id == -1 from undo
2742 lyxerr << "getParFromID(), id: " << id << endl;
2743 return doc_iterator_end(buf);
2746 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2747 if (it.paragraph().id() == id)
2750 return doc_iterator_end(buf);
2754 bool Buffer::hasParWithID(int const id) const
2756 return !getParFromID(id).atEnd();
2760 ParIterator Buffer::par_iterator_begin()
2762 return ParIterator(doc_iterator_begin(this));
2766 ParIterator Buffer::par_iterator_end()
2768 return ParIterator(doc_iterator_end(this));
2772 ParConstIterator Buffer::par_iterator_begin() const
2774 return ParConstIterator(doc_iterator_begin(this));
2778 ParConstIterator Buffer::par_iterator_end() const
2780 return ParConstIterator(doc_iterator_end(this));
2784 Language const * Buffer::language() const
2786 return params().language;
2790 docstring const Buffer::B_(string const & l10n) const
2792 return params().B_(l10n);
2796 bool Buffer::isClean() const
2798 return d->lyx_clean;
2802 bool Buffer::isExternallyModified(CheckMethod method) const
2804 LASSERT(d->filename.exists(), return false);
2805 // if method == timestamp, check timestamp before checksum
2806 return (method == checksum_method
2807 || d->timestamp_ != d->filename.lastModified())
2808 && d->checksum_ != d->filename.checksum();
2812 void Buffer::saveCheckSum() const
2814 FileName const & file = d->filename;
2817 if (file.exists()) {
2818 d->timestamp_ = file.lastModified();
2819 d->checksum_ = file.checksum();
2821 // in the case of save to a new file.
2828 void Buffer::markClean() const
2830 if (!d->lyx_clean) {
2831 d->lyx_clean = true;
2834 // if the .lyx file has been saved, we don't need an
2836 d->bak_clean = true;
2837 d->undo_.markDirty();
2841 void Buffer::setUnnamed(bool flag)
2847 bool Buffer::isUnnamed() const
2854 /// Don't check unnamed, here: isInternal() is used in
2855 /// newBuffer(), where the unnamed flag has not been set by anyone
2856 /// yet. Also, for an internal buffer, there should be no need for
2857 /// retrieving fileName() nor for checking if it is unnamed or not.
2858 bool Buffer::isInternal() const
2860 return d->internal_buffer;
2864 void Buffer::setInternal(bool flag)
2866 d->internal_buffer = flag;
2870 void Buffer::markDirty()
2873 d->lyx_clean = false;
2876 d->bak_clean = false;
2878 DepClean::iterator it = d->dep_clean.begin();
2879 DepClean::const_iterator const end = d->dep_clean.end();
2881 for (; it != end; ++it)
2886 FileName Buffer::fileName() const
2892 string Buffer::absFileName() const
2894 return d->filename.absFileName();
2898 string Buffer::filePath() const
2900 string const abs = d->filename.onlyPath().absFileName();
2903 int last = abs.length() - 1;
2905 return abs[last] == '/' ? abs : abs + '/';
2909 string Buffer::originFilePath() const
2911 if (FileName::isAbsolute(params().origin))
2912 return params().origin;
2918 string Buffer::layoutPos() const
2920 return d->layout_position;
2924 void Buffer::setLayoutPos(string const & path)
2927 d->layout_position.clear();
2931 LATTEST(FileName::isAbsolute(path));
2933 d->layout_position =
2934 to_utf8(makeRelPath(from_utf8(path), from_utf8(filePath())));
2936 if (d->layout_position.empty())
2937 d->layout_position = ".";
2941 bool Buffer::isReadonly() const
2943 return d->read_only;
2947 void Buffer::setParent(Buffer const * buffer)
2949 // Avoids recursive include.
2950 d->setParent(buffer == this ? 0 : buffer);
2955 Buffer const * Buffer::parent() const
2961 ListOfBuffers Buffer::allRelatives() const
2963 ListOfBuffers lb = masterBuffer()->getDescendents();
2964 lb.push_front(const_cast<Buffer *>(masterBuffer()));
2969 Buffer const * Buffer::masterBuffer() const
2971 // FIXME Should be make sure we are not in some kind
2972 // of recursive include? A -> B -> A will crash this.
2973 Buffer const * const pbuf = d->parent();
2977 return pbuf->masterBuffer();
2981 bool Buffer::isChild(Buffer * child) const
2983 return d->children_positions.find(child) != d->children_positions.end();
2987 DocIterator Buffer::firstChildPosition(Buffer const * child)
2989 Impl::BufferPositionMap::iterator it;
2990 it = d->children_positions.find(child);
2991 if (it == d->children_positions.end())
2992 return DocIterator(this);
2997 bool Buffer::hasChildren() const
2999 return !d->children_positions.empty();
3003 void Buffer::collectChildren(ListOfBuffers & clist, bool grand_children) const
3005 // loop over children
3006 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3007 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3008 for (; it != end; ++it) {
3009 Buffer * child = const_cast<Buffer *>(it->first);
3011 ListOfBuffers::const_iterator bit = find(clist.begin(), clist.end(), child);
3012 if (bit != clist.end())
3014 clist.push_back(child);
3016 // there might be grandchildren
3017 child->collectChildren(clist, true);
3022 ListOfBuffers Buffer::getChildren() const
3025 collectChildren(v, false);
3026 // Make sure we have not included ourselves.
3027 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3028 if (bit != v.end()) {
3029 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3036 ListOfBuffers Buffer::getDescendents() const
3039 collectChildren(v, true);
3040 // Make sure we have not included ourselves.
3041 ListOfBuffers::iterator bit = find(v.begin(), v.end(), this);
3042 if (bit != v.end()) {
3043 LYXERR0("Recursive include detected in `" << fileName() << "'.");
3050 template<typename M>
3051 typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
3056 typename M::const_iterator it = m.lower_bound(x);
3057 if (it == m.begin())
3065 MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
3066 DocIterator const & pos) const
3068 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
3070 // if paragraphs have no macro context set, pos will be empty
3074 // we haven't found anything yet
3075 DocIterator bestPos = owner_->par_iterator_begin();
3076 MacroData const * bestData = 0;
3078 // find macro definitions for name
3079 NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
3080 if (nameIt != macros.end()) {
3081 // find last definition in front of pos or at pos itself
3082 PositionScopeMacroMap::const_iterator it
3083 = greatest_below(nameIt->second, pos);
3084 if (it != nameIt->second.end()) {
3086 // scope ends behind pos?
3087 if (pos < it->second.scope) {
3088 // Looks good, remember this. If there
3089 // is no external macro behind this,
3090 // we found the right one already.
3091 bestPos = it->first;
3092 bestData = &it->second.macro;
3096 // try previous macro if there is one
3097 if (it == nameIt->second.begin())
3104 // find macros in included files
3105 PositionScopeBufferMap::const_iterator it
3106 = greatest_below(position_to_children, pos);
3107 if (it == position_to_children.end())
3108 // no children before
3112 // do we know something better (i.e. later) already?
3113 if (it->first < bestPos )
3116 // scope ends behind pos?
3117 if (pos < it->second.scope
3118 && (cloned_buffer_ ||
3119 theBufferList().isLoaded(it->second.buffer))) {
3120 // look for macro in external file
3122 MacroData const * data
3123 = it->second.buffer->getMacro(name, false);
3126 bestPos = it->first;
3132 // try previous file if there is one
3133 if (it == position_to_children.begin())
3138 // return the best macro we have found
3143 MacroData const * Buffer::getMacro(docstring const & name,
3144 DocIterator const & pos, bool global) const
3149 // query buffer macros
3150 MacroData const * data = d->getBufferMacro(name, pos);
3154 // If there is a master buffer, query that
3155 Buffer const * const pbuf = d->parent();
3157 d->macro_lock = true;
3158 MacroData const * macro = pbuf->getMacro(
3159 name, *this, false);
3160 d->macro_lock = false;
3166 data = MacroTable::globalMacros().get(name);
3175 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
3177 // set scope end behind the last paragraph
3178 DocIterator scope = par_iterator_begin();
3179 scope.pit() = scope.lastpit() + 1;
3181 return getMacro(name, scope, global);
3185 MacroData const * Buffer::getMacro(docstring const & name,
3186 Buffer const & child, bool global) const
3188 // look where the child buffer is included first
3189 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
3190 if (it == d->children_positions.end())
3193 // check for macros at the inclusion position
3194 return getMacro(name, it->second, global);
3198 void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
3200 pit_type const lastpit = it.lastpit();
3202 // look for macros in each paragraph
3203 while (it.pit() <= lastpit) {
3204 Paragraph & par = it.paragraph();
3206 // iterate over the insets of the current paragraph
3207 InsetList const & insets = par.insetList();
3208 InsetList::const_iterator iit = insets.begin();
3209 InsetList::const_iterator end = insets.end();
3210 for (; iit != end; ++iit) {
3211 it.pos() = iit->pos;
3213 // is it a nested text inset?
3214 if (iit->inset->asInsetText()) {
3215 // Inset needs its own scope?
3216 InsetText const * itext = iit->inset->asInsetText();
3217 bool newScope = itext->isMacroScope();
3219 // scope which ends just behind the inset
3220 DocIterator insetScope = it;
3223 // collect macros in inset
3224 it.push_back(CursorSlice(*iit->inset));
3225 updateMacros(it, newScope ? insetScope : scope);
3230 if (iit->inset->asInsetTabular()) {
3231 CursorSlice slice(*iit->inset);
3232 size_t const numcells = slice.nargs();
3233 for (; slice.idx() < numcells; slice.forwardIdx()) {
3234 it.push_back(slice);
3235 updateMacros(it, scope);
3241 // is it an external file?
3242 if (iit->inset->lyxCode() == INCLUDE_CODE) {
3243 // get buffer of external file
3244 InsetInclude const & inset =
3245 static_cast<InsetInclude const &>(*iit->inset);
3247 Buffer * child = inset.getChildBuffer();
3252 // register its position, but only when it is
3253 // included first in the buffer
3254 if (children_positions.find(child) ==
3255 children_positions.end())
3256 children_positions[child] = it;
3258 // register child with its scope
3259 position_to_children[it] = Impl::ScopeBuffer(scope, child);
3263 InsetMath * im = iit->inset->asInsetMath();
3264 if (doing_export && im) {
3265 InsetMathHull * hull = im->asHullInset();
3267 hull->recordLocation(it);
3270 if (iit->inset->lyxCode() != MATHMACRO_CODE)
3274 MathMacroTemplate & macroTemplate =
3275 *iit->inset->asInsetMath()->asMacroTemplate();
3276 MacroContext mc(owner_, it);
3277 macroTemplate.updateToContext(mc);
3280 bool valid = macroTemplate.validMacro();
3281 // FIXME: Should be fixNameAndCheckIfValid() in fact,
3282 // then the BufferView's cursor will be invalid in
3283 // some cases which leads to crashes.
3288 // FIXME (Abdel), I don't understand why we pass 'it' here
3289 // instead of 'macroTemplate' defined above... is this correct?
3290 macros[macroTemplate.name()][it] =
3291 Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
3301 void Buffer::updateMacros() const
3306 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
3308 // start with empty table
3310 d->children_positions.clear();
3311 d->position_to_children.clear();
3313 // Iterate over buffer, starting with first paragraph
3314 // The scope must be bigger than any lookup DocIterator
3315 // later. For the global lookup, lastpit+1 is used, hence
3316 // we use lastpit+2 here.
3317 DocIterator it = par_iterator_begin();
3318 DocIterator outerScope = it;
3319 outerScope.pit() = outerScope.lastpit() + 2;
3320 d->updateMacros(it, outerScope);
3324 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
3326 InsetIterator it = inset_iterator_begin(inset());
3327 InsetIterator const end = inset_iterator_end(inset());
3328 for (; it != end; ++it) {
3329 if (it->lyxCode() == BRANCH_CODE) {
3330 InsetBranch & br = static_cast<InsetBranch &>(*it);
3331 docstring const name = br.branch();
3332 if (!from_master && !params().branchlist().find(name))
3333 result.push_back(name);
3334 else if (from_master && !masterBuffer()->params().branchlist().find(name))
3335 result.push_back(name);
3338 if (it->lyxCode() == INCLUDE_CODE) {
3339 // get buffer of external file
3340 InsetInclude const & ins =
3341 static_cast<InsetInclude const &>(*it);
3342 Buffer * child = ins.getChildBuffer();
3345 child->getUsedBranches(result, true);
3348 // remove duplicates
3353 void Buffer::updateMacroInstances(UpdateType utype) const
3355 LYXERR(Debug::MACROS, "updateMacroInstances for "
3356 << d->filename.onlyFileName());
3357 DocIterator it = doc_iterator_begin(this);
3359 DocIterator const end = doc_iterator_end(this);
3360 for (; it != end; it.forwardInset()) {
3361 // look for MathData cells in InsetMathNest insets
3362 InsetMath * minset = it.nextInset()->asInsetMath();
3366 // update macro in all cells of the InsetMathNest
3367 DocIterator::idx_type n = minset->nargs();
3368 MacroContext mc = MacroContext(this, it);
3369 for (DocIterator::idx_type i = 0; i < n; ++i) {
3370 MathData & data = minset->cell(i);
3371 data.updateMacros(0, mc, utype);
3377 void Buffer::listMacroNames(MacroNameSet & macros) const
3382 d->macro_lock = true;
3384 // loop over macro names
3385 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
3386 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
3387 for (; nameIt != nameEnd; ++nameIt)
3388 macros.insert(nameIt->first);
3390 // loop over children
3391 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
3392 Impl::BufferPositionMap::iterator end = d->children_positions.end();
3393 for (; it != end; ++it)
3394 it->first->listMacroNames(macros);
3397 Buffer const * const pbuf = d->parent();
3399 pbuf->listMacroNames(macros);
3401 d->macro_lock = false;
3405 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
3407 Buffer const * const pbuf = d->parent();
3412 pbuf->listMacroNames(names);
3415 MacroNameSet::iterator it = names.begin();
3416 MacroNameSet::iterator end = names.end();
3417 for (; it != end; ++it) {
3419 MacroData const * data =
3420 pbuf->getMacro(*it, *this, false);
3422 macros.insert(data);
3424 // we cannot access the original MathMacroTemplate anymore
3425 // here to calls validate method. So we do its work here manually.
3426 // FIXME: somehow make the template accessible here.
3427 if (data->optionals() > 0)
3428 features.require("xargs");
3434 Buffer::References & Buffer::getReferenceCache(docstring const & label)
3437 return const_cast<Buffer *>(masterBuffer())->getReferenceCache(label);
3439 RefCache::iterator it = d->ref_cache_.find(label);
3440 if (it != d->ref_cache_.end())
3441 return it->second.second;
3443 static InsetLabel const * dummy_il = 0;
3444 static References const dummy_refs;
3445 it = d->ref_cache_.insert(
3446 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
3447 return it->second.second;
3451 Buffer::References const & Buffer::references(docstring const & label) const
3453 return const_cast<Buffer *>(this)->getReferenceCache(label);
3457 void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it)
3459 References & refs = getReferenceCache(label);
3460 refs.push_back(make_pair(inset, it));
3464 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
3466 masterBuffer()->d->ref_cache_[label].first = il;
3470 InsetLabel const * Buffer::insetLabel(docstring const & label) const
3472 return masterBuffer()->d->ref_cache_[label].first;
3476 void Buffer::clearReferenceCache() const
3479 d->ref_cache_.clear();
3483 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to)
3485 //FIXME: This does not work for child documents yet.
3486 reloadBibInfoCache();
3488 // Check if the label 'from' appears more than once
3489 BiblioInfo const & keys = masterBibInfo();
3490 BiblioInfo::const_iterator bit = keys.begin();
3491 BiblioInfo::const_iterator bend = keys.end();
3492 vector<docstring> labels;
3494 for (; bit != bend; ++bit)
3496 labels.push_back(bit->first);
3498 if (count(labels.begin(), labels.end(), from) > 1)
3501 string const paramName = "key";
3502 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
3503 if (it->lyxCode() != CITE_CODE)
3505 InsetCommand * inset = it->asInsetCommand();
3506 docstring const oldValue = inset->getParam(paramName);
3507 if (oldValue == from)
3508 inset->setParam(paramName, to);
3513 void Buffer::getSourceCode(odocstream & os, string const & format,
3514 pit_type par_begin, pit_type par_end,
3515 OutputWhat output, bool master) const
3517 OutputParams runparams(¶ms().encoding());
3518 runparams.nice = true;
3519 runparams.flavor = params().getOutputFlavor(format);
3520 runparams.linelen = lyxrc.plaintext_linelen;
3521 // No side effect of file copying and image conversion
3522 runparams.dryrun = true;
3524 if (output == CurrentParagraph) {
3525 runparams.par_begin = par_begin;
3526 runparams.par_end = par_end;
3527 if (par_begin + 1 == par_end) {
3529 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
3533 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
3534 convert<docstring>(par_begin),
3535 convert<docstring>(par_end - 1))
3538 // output paragraphs
3539 if (runparams.flavor == OutputParams::LYX) {
3540 Paragraph const & par = text().paragraphs()[par_begin];
3542 depth_type dt = par.getDepth();
3543 par.write(ods, params(), dt);
3544 os << from_utf8(ods.str());
3545 } else if (runparams.flavor == OutputParams::HTML) {
3547 setMathFlavor(runparams);
3548 xhtmlParagraphs(text(), *this, xs, runparams);
3549 } else if (runparams.flavor == OutputParams::TEXT) {
3551 // FIXME Handles only one paragraph, unlike the others.
3552 // Probably should have some routine with a signature like them.
3553 writePlaintextParagraph(*this,
3554 text().paragraphs()[par_begin], os, runparams, dummy);
3555 } else if (params().isDocBook()) {
3556 docbookParagraphs(text(), *this, os, runparams);
3558 // If we are previewing a paragraph, even if this is the
3559 // child of some other buffer, let's cut the link here,
3560 // so that no concurring settings from the master
3561 // (e.g. branch state) interfere (see #8101).
3563 d->ignore_parent = true;
3564 // We need to validate the Buffer params' features here
3565 // in order to know if we should output polyglossia
3566 // macros (instead of babel macros)
3567 LaTeXFeatures features(*this, params(), runparams);
3568 params().validate(features);
3569 runparams.use_polyglossia = features.usePolyglossia();
3574 // latex or literate
3575 otexstream ots(os, texrow);
3578 latexParagraphs(*this, text(), ots, runparams);
3580 // Restore the parenthood
3582 d->ignore_parent = false;
3586 if (output == FullSource)
3587 os << _("Preview source code");
3588 else if (output == OnlyPreamble)
3589 os << _("Preview preamble");
3590 else if (output == OnlyBody)
3591 os << _("Preview body");
3593 if (runparams.flavor == OutputParams::LYX) {
3595 if (output == FullSource)
3597 else if (output == OnlyPreamble)
3598 params().writeFile(ods, this);
3599 else if (output == OnlyBody)
3601 os << from_utf8(ods.str());
3602 } else if (runparams.flavor == OutputParams::HTML) {
3603 writeLyXHTMLSource(os, runparams, output);
3604 } else if (runparams.flavor == OutputParams::TEXT) {
3605 if (output == OnlyPreamble) {
3606 os << "% "<< _("Plain text does not have a preamble.");
3608 writePlaintextFile(*this, os, runparams);
3609 } else if (params().isDocBook()) {
3610 writeDocBookSource(os, absFileName(), runparams, output);
3612 // latex or literate
3614 d->texrow.newline();
3615 d->texrow.newline();
3616 otexstream ots(os, d->texrow);
3618 runparams.is_child = true;
3619 writeLaTeXSource(ots, string(), runparams, output);
3625 ErrorList & Buffer::errorList(string const & type) const
3627 return d->errorLists[type];
3631 void Buffer::updateTocItem(std::string const & type,
3632 DocIterator const & dit) const
3635 d->gui_->updateTocItem(type, dit);
3639 void Buffer::structureChanged() const
3642 d->gui_->structureChanged();
3646 void Buffer::errors(string const & err, bool from_master) const
3649 d->gui_->errors(err, from_master);
3653 void Buffer::message(docstring const & msg) const
3656 d->gui_->message(msg);
3660 void Buffer::setBusy(bool on) const
3663 d->gui_->setBusy(on);
3667 void Buffer::updateTitles() const
3670 d->wa_->updateTitles();
3674 void Buffer::resetAutosaveTimers() const
3677 d->gui_->resetAutosaveTimers();
3681 bool Buffer::hasGuiDelegate() const
3687 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
3696 class AutoSaveBuffer : public ForkedProcess {
3699 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
3700 : buffer_(buffer), fname_(fname) {}
3702 virtual shared_ptr<ForkedProcess> clone() const
3704 return shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
3709 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
3710 from_utf8(fname_.absFileName())));
3711 return run(DontWait);
3715 virtual int generateChild();
3717 Buffer const & buffer_;
3722 int AutoSaveBuffer::generateChild()
3724 #if defined(__APPLE__)
3725 /* FIXME fork() is not usable for autosave on Mac OS X 10.6 (snow leopard)
3726 * We should use something else like threads.
3728 * Since I do not know how to determine at run time what is the OS X
3729 * version, I just disable forking altogether for now (JMarc)
3731 pid_t const pid = -1;
3733 // tmp_ret will be located (usually) in /tmp
3734 // will that be a problem?
3735 // Note that this calls ForkedCalls::fork(), so it's
3736 // ok cross-platform.
3737 pid_t const pid = fork();
3738 // If you want to debug the autosave
3739 // you should set pid to -1, and comment out the fork.
3740 if (pid != 0 && pid != -1)
3744 // pid = -1 signifies that lyx was unable
3745 // to fork. But we will do the save
3747 bool failed = false;
3748 TempFile tempfile("lyxautoXXXXXX.lyx");
3749 tempfile.setAutoRemove(false);
3750 FileName const tmp_ret = tempfile.name();
3751 if (!tmp_ret.empty()) {
3752 if (!buffer_.writeFile(tmp_ret))
3754 else if (!tmp_ret.moveTo(fname_))
3760 // failed to write/rename tmp_ret so try writing direct
3761 if (!buffer_.writeFile(fname_)) {
3762 // It is dangerous to do this in the child,
3763 // but safe in the parent, so...
3764 if (pid == -1) // emit message signal.
3765 buffer_.message(_("Autosave failed!"));
3769 if (pid == 0) // we are the child so...
3778 FileName Buffer::getEmergencyFileName() const
3780 return FileName(d->filename.absFileName() + ".emergency");
3784 FileName Buffer::getAutosaveFileName() const
3786 // if the document is unnamed try to save in the backup dir, else
3787 // in the default document path, and as a last try in the filePath,
3788 // which will most often be the temporary directory
3791 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3792 : lyxrc.backupdir_path;
3793 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3796 string const fname = "#" + d->filename.onlyFileName() + "#";
3798 return makeAbsPath(fname, fpath);
3802 void Buffer::removeAutosaveFile() const
3804 FileName const f = getAutosaveFileName();
3810 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3812 FileName const newauto = getAutosaveFileName();
3814 if (newauto != oldauto && oldauto.exists())
3815 if (!oldauto.moveTo(newauto))
3816 LYXERR0("Unable to move autosave file `" << oldauto << "'!");
3820 bool Buffer::autoSave() const
3822 Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
3823 if (buf->d->bak_clean || isReadonly())
3826 message(_("Autosaving current document..."));
3827 buf->d->bak_clean = true;
3829 FileName const fname = getAutosaveFileName();
3830 LASSERT(d->cloned_buffer_, return false);
3832 // If this buffer is cloned, we assume that
3833 // we are running in a separate thread already.
3834 TempFile tempfile("lyxautoXXXXXX.lyx");
3835 tempfile.setAutoRemove(false);
3836 FileName const tmp_ret = tempfile.name();
3837 if (!tmp_ret.empty()) {
3839 // assume successful write of tmp_ret
3840 if (tmp_ret.moveTo(fname))
3843 // failed to write/rename tmp_ret so try writing direct
3844 return writeFile(fname);
3848 void Buffer::setExportStatus(bool e) const
3850 d->doing_export = e;
3851 ListOfBuffers clist = getDescendents();
3852 ListOfBuffers::const_iterator cit = clist.begin();
3853 ListOfBuffers::const_iterator const cen = clist.end();
3854 for (; cit != cen; ++cit)
3855 (*cit)->d->doing_export = e;
3859 bool Buffer::isExporting() const
3861 return d->doing_export;
3865 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir)
3869 return doExport(target, put_in_tempdir, result_file);
3872 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3873 string & result_file) const
3875 bool const update_unincluded =
3876 params().maintain_unincluded_children
3877 && !params().getIncludedChildren().empty();
3879 // (1) export with all included children (omit \includeonly)
3880 if (update_unincluded) {
3881 ExportStatus const status =
3882 doExport(target, put_in_tempdir, true, result_file);
3883 if (status != ExportSuccess)
3886 // (2) export with included children only
3887 return doExport(target, put_in_tempdir, false, result_file);
3891 void Buffer::setMathFlavor(OutputParams & op) const
3893 switch (params().html_math_output) {
3894 case BufferParams::MathML:
3895 op.math_flavor = OutputParams::MathAsMathML;
3897 case BufferParams::HTML:
3898 op.math_flavor = OutputParams::MathAsHTML;
3900 case BufferParams::Images:
3901 op.math_flavor = OutputParams::MathAsImages;
3903 case BufferParams::LaTeX:
3904 op.math_flavor = OutputParams::MathAsLaTeX;
3910 Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir,
3911 bool includeall, string & result_file) const
3913 LYXERR(Debug::FILES, "target=" << target);
3914 OutputParams runparams(¶ms().encoding());
3915 string format = target;
3916 string dest_filename;
3917 size_t pos = target.find(' ');
3918 if (pos != string::npos) {
3919 dest_filename = target.substr(pos + 1, target.length() - pos - 1);
3920 format = target.substr(0, pos);
3921 runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
3922 FileName(dest_filename).onlyPath().createPath();
3923 LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
3925 MarkAsExporting exporting(this);
3926 string backend_format;
3927 runparams.flavor = OutputParams::LATEX;
3928 runparams.linelen = lyxrc.plaintext_linelen;
3929 runparams.includeall = includeall;
3930 vector<string> backs = params().backends();
3931 Converters converters = theConverters();
3932 bool need_nice_file = false;
3933 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3934 // Get shortest path to format
3935 converters.buildGraph();
3936 Graph::EdgePath path;
3937 for (vector<string>::const_iterator it = backs.begin();
3938 it != backs.end(); ++it) {
3939 Graph::EdgePath p = converters.getPath(*it, format);
3940 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3941 backend_format = *it;
3946 if (!put_in_tempdir) {
3947 // Only show this alert if this is an export to a non-temporary
3948 // file (not for previewing).
3949 Alert::error(_("Couldn't export file"), bformat(
3950 _("No information for exporting the format %1$s."),
3951 formats.prettyName(format)));
3953 return ExportNoPathToFormat;
3955 runparams.flavor = converters.getFlavor(path, this);
3956 Graph::EdgePath::const_iterator it = path.begin();
3957 Graph::EdgePath::const_iterator en = path.end();
3958 for (; it != en; ++it)
3959 if (theConverters().get(*it).nice()) {
3960 need_nice_file = true;
3965 backend_format = format;
3966 LYXERR(Debug::FILES, "backend_format=" << backend_format);
3967 // FIXME: Don't hardcode format names here, but use a flag
3968 if (backend_format == "pdflatex")
3969 runparams.flavor = OutputParams::PDFLATEX;
3970 else if (backend_format == "luatex")
3971 runparams.flavor = OutputParams::LUATEX;
3972 else if (backend_format == "dviluatex")
3973 runparams.flavor = OutputParams::DVILUATEX;
3974 else if (backend_format == "xetex")
3975 runparams.flavor = OutputParams::XETEX;
3978 string filename = latexName(false);
3979 filename = addName(temppath(), filename);
3980 filename = changeExtension(filename,
3981 formats.extension(backend_format));
3982 LYXERR(Debug::FILES, "filename=" << filename);
3984 // Plain text backend
3985 if (backend_format == "text") {
3986 runparams.flavor = OutputParams::TEXT;
3987 writePlaintextFile(*this, FileName(filename), runparams);
3990 else if (backend_format == "xhtml") {
3991 runparams.flavor = OutputParams::HTML;
3992 setMathFlavor(runparams);
3993 makeLyXHTMLFile(FileName(filename), runparams);
3994 } else if (backend_format == "lyx")
3995 writeFile(FileName(filename));
3997 else if (params().isDocBook()) {
3998 runparams.nice = !put_in_tempdir;
3999 makeDocBookFile(FileName(filename), runparams);
4002 else if (backend_format == format || need_nice_file) {
4003 runparams.nice = true;
4004 bool const success = makeLaTeXFile(FileName(filename), string(), runparams);
4005 if (d->cloned_buffer_)
4006 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4009 } else if (!lyxrc.tex_allows_spaces
4010 && contains(filePath(), ' ')) {
4011 Alert::error(_("File name error"),
4012 _("The directory path to the document cannot contain spaces."));
4013 return ExportTexPathHasSpaces;
4015 runparams.nice = false;
4016 bool const success = makeLaTeXFile(
4017 FileName(filename), filePath(), runparams);
4018 if (d->cloned_buffer_)
4019 d->cloned_buffer_->d->errorLists["Export"] = d->errorLists["Export"];
4024 string const error_type = (format == "program")
4025 ? "Build" : params().bufferFormat();
4026 ErrorList & error_list = d->errorLists[error_type];
4027 string const ext = formats.extension(format);
4028 FileName const tmp_result_file(changeExtension(filename, ext));
4029 bool const success = converters.convert(this, FileName(filename),
4030 tmp_result_file, FileName(absFileName()), backend_format, format,
4033 // Emit the signal to show the error list or copy it back to the
4034 // cloned Buffer so that it can be emitted afterwards.
4035 if (format != backend_format) {
4036 if (runparams.silent)
4038 else if (d->cloned_buffer_)
4039 d->cloned_buffer_->d->errorLists[error_type] =
4040 d->errorLists[error_type];
4043 // also to the children, in case of master-buffer-view
4044 ListOfBuffers clist = getDescendents();
4045 ListOfBuffers::const_iterator cit = clist.begin();
4046 ListOfBuffers::const_iterator const cen = clist.end();
4047 for (; cit != cen; ++cit) {
4048 if (runparams.silent)
4049 (*cit)->d->errorLists[error_type].clear();
4050 else if (d->cloned_buffer_) {
4051 // Enable reverse search by copying back the
4052 // texrow object to the cloned buffer.
4053 // FIXME: this is not thread safe.
4054 (*cit)->d->cloned_buffer_->d->texrow = (*cit)->d->texrow;
4055 (*cit)->d->cloned_buffer_->d->errorLists[error_type] =
4056 (*cit)->d->errorLists[error_type];
4058 (*cit)->errors(error_type, true);
4062 if (d->cloned_buffer_) {
4063 // Enable reverse dvi or pdf to work by copying back the texrow
4064 // object to the cloned buffer.
4065 // FIXME: There is a possibility of concurrent access to texrow
4066 // here from the main GUI thread that should be securized.
4067 d->cloned_buffer_->d->texrow = d->texrow;
4068 string const error_type = params().bufferFormat();
4069 d->cloned_buffer_->d->errorLists[error_type] = d->errorLists[error_type];
4073 if (put_in_tempdir) {
4074 result_file = tmp_result_file.absFileName();
4075 return success ? ExportSuccess : ExportConverterError;
4078 if (dest_filename.empty())
4079 result_file = changeExtension(d->exportFileName().absFileName(), ext);
4081 result_file = dest_filename;
4082 // We need to copy referenced files (e. g. included graphics
4083 // if format == "dvi") to the result dir.
4084 vector<ExportedFile> const files =
4085 runparams.exportdata->externalFiles(format);
4086 string const dest = runparams.export_folder.empty() ?
4087 onlyPath(result_file) : runparams.export_folder;
4088 bool use_force = use_gui ? lyxrc.export_overwrite == ALL_FILES
4089 : force_overwrite == ALL_FILES;
4090 CopyStatus status = use_force ? FORCE : SUCCESS;
4092 vector<ExportedFile>::const_iterator it = files.begin();
4093 vector<ExportedFile>::const_iterator const en = files.end();
4094 for (; it != en && status != CANCEL; ++it) {
4095 string const fmt = formats.getFormatFromFile(it->sourceName);
4096 string fixedName = it->exportName;
4097 if (!runparams.export_folder.empty()) {
4098 // Relative pathnames starting with ../ will be sanitized
4099 // if exporting to a different folder
4100 while (fixedName.substr(0, 3) == "../")
4101 fixedName = fixedName.substr(3, fixedName.length() - 3);
4103 FileName fixedFileName = makeAbsPath(fixedName, dest);
4104 fixedFileName.onlyPath().createPath();
4105 status = copyFile(fmt, it->sourceName,
4107 it->exportName, status == FORCE,
4108 runparams.export_folder.empty());
4111 if (status == CANCEL) {
4112 message(_("Document export cancelled."));
4113 return ExportCancel;
4116 if (tmp_result_file.exists()) {
4117 // Finally copy the main file
4118 use_force = use_gui ? lyxrc.export_overwrite != NO_FILES
4119 : force_overwrite != NO_FILES;
4120 if (status == SUCCESS && use_force)
4122 status = copyFile(format, tmp_result_file,
4123 FileName(result_file), result_file,
4125 if (status == CANCEL) {
4126 message(_("Document export cancelled."));
4127 return ExportCancel;
4129 message(bformat(_("Document exported as %1$s "
4131 formats.prettyName(format),
4132 makeDisplayPath(result_file)));
4135 // This must be a dummy converter like fax (bug 1888)
4136 message(bformat(_("Document exported as %1$s"),
4137 formats.prettyName(format)));
4140 return success ? ExportSuccess : ExportConverterError;
4144 Buffer::ExportStatus Buffer::preview(string const & format) const
4146 bool const update_unincluded =
4147 params().maintain_unincluded_children
4148 && !params().getIncludedChildren().empty();
4149 return preview(format, update_unincluded);
4153 Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) const
4155 MarkAsExporting exporting(this);
4157 // (1) export with all included children (omit \includeonly)
4159 ExportStatus const status = doExport(format, true, true, result_file);
4160 if (status != ExportSuccess)
4163 // (2) export with included children only
4164 ExportStatus const status = doExport(format, true, false, result_file);
4165 FileName const previewFile(result_file);
4167 LATTEST (isClone());
4168 d->cloned_buffer_->d->preview_file_ = previewFile;
4169 d->cloned_buffer_->d->preview_format_ = format;
4170 d->cloned_buffer_->d->preview_error_ = (status != ExportSuccess);
4172 if (status != ExportSuccess)
4174 if (previewFile.exists()) {
4175 if (!formats.view(*this, previewFile, format))
4176 return PreviewError;
4178 return PreviewSuccess;
4181 // Successful export but no output file?
4182 // Probably a bug in error detection.
4183 LATTEST (status != ExportSuccess);
4190 Buffer::ReadStatus Buffer::extractFromVC()
4192 bool const found = LyXVC::file_not_found_hook(d->filename);
4194 return ReadFileNotFound;
4195 if (!d->filename.isReadableFile())
4201 Buffer::ReadStatus Buffer::loadEmergency()
4203 FileName const emergencyFile = getEmergencyFileName();
4204 if (!emergencyFile.exists()
4205 || emergencyFile.lastModified() <= d->filename.lastModified())
4206 return ReadFileNotFound;
4208 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4209 docstring const text = bformat(_("An emergency save of the document "
4210 "%1$s exists.\n\nRecover emergency save?"), file);
4212 int const load_emerg = Alert::prompt(_("Load emergency save?"), text,
4213 0, 2, _("&Recover"), _("&Load Original"), _("&Cancel"));
4219 ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
4220 bool const success = (ret_llf == ReadSuccess);
4223 Alert::warning(_("File is read-only"),
4224 bformat(_("An emergency file is successfully loaded, "
4225 "but the original file %1$s is marked read-only. "
4226 "Please make sure to save the document as a different "
4227 "file."), from_utf8(d->filename.absFileName())));
4230 lyxvc().file_found_hook(d->filename);
4231 str = _("Document was successfully recovered.");
4233 str = _("Document was NOT successfully recovered.");
4234 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
4235 makeDisplayPath(emergencyFile.absFileName()));
4237 int const del_emerg =
4238 Alert::prompt(_("Delete emergency file?"), str, 1, 1,
4239 _("&Remove"), _("&Keep"));
4240 if (del_emerg == 0) {
4241 emergencyFile.removeFile();
4243 Alert::warning(_("Emergency file deleted"),
4244 _("Do not forget to save your file now!"), true);
4246 return success ? ReadSuccess : ReadEmergencyFailure;
4249 int const del_emerg =
4250 Alert::prompt(_("Delete emergency file?"),
4251 _("Remove emergency file now?"), 1, 1,
4252 _("&Remove"), _("&Keep"));
4254 emergencyFile.removeFile();
4255 return ReadOriginal;
4265 Buffer::ReadStatus Buffer::loadAutosave()
4267 // Now check if autosave file is newer.
4268 FileName const autosaveFile = getAutosaveFileName();
4269 if (!autosaveFile.exists()
4270 || autosaveFile.lastModified() <= d->filename.lastModified())
4271 return ReadFileNotFound;
4273 docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
4274 docstring const text = bformat(_("The backup of the document %1$s "
4275 "is newer.\n\nLoad the backup instead?"), file);
4276 int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
4277 _("&Load backup"), _("Load &original"), _("&Cancel"));
4282 ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
4283 // the file is not saved if we load the autosave file.
4284 if (ret_llf == ReadSuccess) {
4286 Alert::warning(_("File is read-only"),
4287 bformat(_("A backup file is successfully loaded, "
4288 "but the original file %1$s is marked read-only. "
4289 "Please make sure to save the document as a "
4291 from_utf8(d->filename.absFileName())));
4294 lyxvc().file_found_hook(d->filename);
4297 return ReadAutosaveFailure;
4300 // Here we delete the autosave
4301 autosaveFile.removeFile();
4302 return ReadOriginal;
4310 Buffer::ReadStatus Buffer::loadLyXFile()
4312 if (!d->filename.isReadableFile()) {
4313 ReadStatus const ret_rvc = extractFromVC();
4314 if (ret_rvc != ReadSuccess)
4318 ReadStatus const ret_re = loadEmergency();
4319 if (ret_re == ReadSuccess || ret_re == ReadCancel)
4322 ReadStatus const ret_ra = loadAutosave();
4323 if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
4326 return loadThisLyXFile(d->filename);
4330 Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
4332 return readFile(fn);
4336 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
4338 TeXErrors::Errors::const_iterator it = terr.begin();
4339 TeXErrors::Errors::const_iterator end = terr.end();
4340 ListOfBuffers clist = getDescendents();
4341 ListOfBuffers::const_iterator cen = clist.end();
4343 for (; it != end; ++it) {
4346 int errorRow = it->error_in_line;
4347 Buffer const * buf = 0;
4349 if (it->child_name.empty())
4350 p->texrow.getIdFromRow(errorRow, id_start, pos_start);
4352 // The error occurred in a child
4353 ListOfBuffers::const_iterator cit = clist.begin();
4354 for (; cit != cen; ++cit) {
4355 string const child_name =
4356 DocFileName(changeExtension(
4357 (*cit)->absFileName(), "tex")).
4359 if (it->child_name != child_name)
4361 (*cit)->d->texrow.getIdFromRow(errorRow,
4362 id_start, pos_start);
4363 if (id_start != -1) {
4364 buf = d->cloned_buffer_
4365 ? (*cit)->d->cloned_buffer_->d->owner_
4366 : (*cit)->d->owner_;
4377 found = p->texrow.getIdFromRow(errorRow, id_end, pos_end);
4378 } while (found && id_start == id_end && pos_start == pos_end);
4380 if (id_start != id_end) {
4381 // Next registered position is outside the inset where
4382 // the error occurred, so signal end-of-paragraph
4386 errorList.push_back(ErrorItem(it->error_desc,
4387 it->error_text, id_start, pos_start, pos_end, buf));
4392 void Buffer::setBuffersForInsets() const
4394 inset().setBuffer(const_cast<Buffer &>(*this));
4398 void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
4400 LBUFERR(!text().paragraphs().empty());
4402 // Use the master text class also for child documents
4403 Buffer const * const master = masterBuffer();
4404 DocumentClass const & textclass = master->params().documentClass();
4406 // do this only if we are the top-level Buffer
4407 if (master == this) {
4408 textclass.counters().reset(from_ascii("bibitem"));
4409 reloadBibInfoCache();
4412 // keep the buffers to be children in this set. If the call from the
4413 // master comes back we can see which of them were actually seen (i.e.
4414 // via an InsetInclude). The remaining ones in the set need still be updated.
4415 static std::set<Buffer const *> bufToUpdate;
4416 if (scope == UpdateMaster) {
4417 // If this is a child document start with the master
4418 if (master != this) {
4419 bufToUpdate.insert(this);
4420 master->updateBuffer(UpdateMaster, utype);
4421 // If the master buffer has no gui associated with it, then the TocModel is
4422 // not updated during the updateBuffer call and TocModel::toc_ is invalid
4423 // (bug 5699). The same happens if the master buffer is open in a different
4424 // window. This test catches both possibilities.
4425 // See: http://marc.info/?l=lyx-devel&m=138590578911716&w=2
4426 // There remains a problem here: If there is another child open in yet a third
4427 // window, that TOC is not updated. So some more general solution is needed at
4429 if (master->d->gui_ != d->gui_)
4432 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
4433 if (bufToUpdate.find(this) == bufToUpdate.end())
4437 // start over the counters in the master
4438 textclass.counters().reset();
4441 // update will be done below for this buffer
4442 bufToUpdate.erase(this);
4444 // update all caches
4445 clearReferenceCache();
4448 Buffer & cbuf = const_cast<Buffer &>(*this);
4451 ParIterator parit = cbuf.par_iterator_begin();
4452 updateBuffer(parit, utype);
4455 // TocBackend update will be done later.
4458 d->bibinfo_cache_valid_ = true;
4459 d->cite_labels_valid_ = true;
4460 cbuf.tocBackend().update(utype == OutputUpdate);
4461 if (scope == UpdateMaster)
4462 cbuf.structureChanged();
4466 static depth_type getDepth(DocIterator const & it)
4468 depth_type depth = 0;
4469 for (size_t i = 0 ; i < it.depth() ; ++i)
4470 if (!it[i].inset().inMathed())
4471 depth += it[i].paragraph().getDepth() + 1;
4472 // remove 1 since the outer inset does not count
4476 static depth_type getItemDepth(ParIterator const & it)
4478 Paragraph const & par = *it;
4479 LabelType const labeltype = par.layout().labeltype;
4481 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
4484 // this will hold the lowest depth encountered up to now.
4485 depth_type min_depth = getDepth(it);
4486 ParIterator prev_it = it;
4489 --prev_it.top().pit();
4491 // start of nested inset: go to outer par
4493 if (prev_it.empty()) {
4494 // start of document: nothing to do
4499 // We search for the first paragraph with same label
4500 // that is not more deeply nested.
4501 Paragraph & prev_par = *prev_it;
4502 depth_type const prev_depth = getDepth(prev_it);
4503 if (labeltype == prev_par.layout().labeltype) {
4504 if (prev_depth < min_depth)
4505 return prev_par.itemdepth + 1;
4506 if (prev_depth == min_depth)
4507 return prev_par.itemdepth;
4509 min_depth = min(min_depth, prev_depth);
4510 // small optimization: if we are at depth 0, we won't
4511 // find anything else
4512 if (prev_depth == 0)
4518 static bool needEnumCounterReset(ParIterator const & it)
4520 Paragraph const & par = *it;
4521 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, return false);
4522 depth_type const cur_depth = par.getDepth();
4523 ParIterator prev_it = it;
4524 while (prev_it.pit()) {
4525 --prev_it.top().pit();
4526 Paragraph const & prev_par = *prev_it;
4527 if (prev_par.getDepth() <= cur_depth)
4528 return prev_par.layout().labeltype != LABEL_ENUMERATE;
4530 // start of nested inset: reset
4535 // set the label of a paragraph. This includes the counters.
4536 void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
4538 BufferParams const & bp = owner_->masterBuffer()->params();
4539 DocumentClass const & textclass = bp.documentClass();
4540 Paragraph & par = it.paragraph();
4541 Layout const & layout = par.layout();
4542 Counters & counters = textclass.counters();
4544 if (par.params().startOfAppendix()) {
4545 // We want to reset the counter corresponding to toplevel sectioning
4546 Layout const & lay = textclass.getTOCLayout();
4547 docstring const cnt = lay.counter;
4549 counters.reset(cnt);
4550 counters.appendix(true);
4552 par.params().appendix(counters.appendix());
4554 // Compute the item depth of the paragraph
4555 par.itemdepth = getItemDepth(it);
4557 if (layout.margintype == MARGIN_MANUAL) {
4558 if (par.params().labelWidthString().empty())
4559 par.params().labelWidthString(par.expandLabel(layout, bp));
4560 } else if (layout.latextype == LATEX_BIB_ENVIRONMENT) {
4561 // we do not need to do anything here, since the empty case is
4562 // handled during export.
4564 par.params().labelWidthString(docstring());
4567 switch(layout.labeltype) {
4568 case LABEL_ITEMIZE: {
4569 // At some point of time we should do something more
4570 // clever here, like:
4571 // par.params().labelString(
4572 // bp.user_defined_bullet(par.itemdepth).getText());
4573 // for now, use a simple hardcoded label
4574 docstring itemlabel;
4575 switch (par.itemdepth) {
4577 itemlabel = char_type(0x2022);
4580 itemlabel = char_type(0x2013);
4583 itemlabel = char_type(0x2217);
4586 itemlabel = char_type(0x2219); // or 0x00b7
4589 par.params().labelString(itemlabel);
4593 case LABEL_ENUMERATE: {
4594 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
4596 switch (par.itemdepth) {
4605 enumcounter += "iv";
4608 // not a valid enumdepth...
4612 // Maybe we have to reset the enumeration counter.
4613 if (needEnumCounterReset(it))
4614 counters.reset(enumcounter);
4615 counters.step(enumcounter, utype);
4617 string const & lang = par.getParLanguage(bp)->code();
4618 par.params().labelString(counters.theCounter(enumcounter, lang));
4623 case LABEL_SENSITIVE: {
4624 string const & type = counters.current_float();
4625 docstring full_label;
4627 full_label = owner_->B_("Senseless!!! ");
4629 docstring name = owner_->B_(textclass.floats().getType(type).name());
4630 if (counters.hasCounter(from_utf8(type))) {
4631 string const & lang = par.getParLanguage(bp)->code();
4632 counters.step(from_utf8(type), utype);
4633 full_label = bformat(from_ascii("%1$s %2$s:"),
4635 counters.theCounter(from_utf8(type), lang));
4637 full_label = bformat(from_ascii("%1$s #:"), name);
4639 par.params().labelString(full_label);
4643 case LABEL_NO_LABEL:
4644 par.params().labelString(docstring());
4648 case LABEL_CENTERED:
4649 case LABEL_STATIC: {
4650 docstring const & lcounter = layout.counter;
4651 if (!lcounter.empty()) {
4652 if (layout.toclevel <= bp.secnumdepth
4653 && (layout.latextype != LATEX_ENVIRONMENT
4654 || it.text()->isFirstInSequence(it.pit()))) {
4655 if (counters.hasCounter(lcounter))
4656 counters.step(lcounter, utype);
4657 par.params().labelString(par.expandLabel(layout, bp));
4659 par.params().labelString(docstring());
4661 par.params().labelString(par.expandLabel(layout, bp));
4667 par.params().labelString(par.expandLabel(layout, bp));
4672 void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
4674 // LASSERT: Is it safe to continue here, or should we just return?
4675 LASSERT(parit.pit() == 0, /**/);
4677 // Set the position of the text in the buffer to be able
4678 // to resolve macros in it.
4679 parit.text()->setMacrocontextPosition(parit);
4681 depth_type maxdepth = 0;
4682 pit_type const lastpit = parit.lastpit();
4683 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
4684 // reduce depth if necessary
4685 if (parit->params().depth() > maxdepth) {
4686 /** FIXME: this function is const, but
4687 * nevertheless it modifies the buffer. To be
4688 * cleaner, one should modify the buffer in
4689 * another function, which is actually
4690 * non-const. This would however be costly in
4691 * terms of code duplication.
4693 const_cast<Buffer *>(this)->undo().recordUndo(CursorData(parit));
4694 parit->params().depth(maxdepth);
4696 maxdepth = parit->getMaxDepthAfter();
4698 if (utype == OutputUpdate) {
4699 // track the active counters
4700 // we have to do this for the master buffer, since the local
4701 // buffer isn't tracking anything.
4702 masterBuffer()->params().documentClass().counters().
4703 setActiveLayout(parit->layout());
4706 // set the counter for this paragraph
4707 d->setLabel(parit, utype);
4710 InsetList::const_iterator iit = parit->insetList().begin();
4711 InsetList::const_iterator end = parit->insetList().end();
4712 for (; iit != end; ++iit) {
4713 parit.pos() = iit->pos;
4714 iit->inset->updateBuffer(parit, utype);
4720 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
4721 WordLangTuple & word_lang, docstring_list & suggestions) const
4725 suggestions.clear();
4726 word_lang = WordLangTuple();
4727 bool const to_end = to.empty();
4728 DocIterator const end = to_end ? doc_iterator_end(this) : to;
4729 // OK, we start from here.
4730 for (; from != end; from.forwardPos()) {
4731 // This skips all insets with spell check disabled.
4732 while (!from.allowSpellCheck()) {
4736 // If from is at the end of the document (which is possible
4737 // when "from" was changed above) LyX will crash later otherwise.
4738 if (from.atEnd() || (!to_end && from >= end))
4741 from.paragraph().spellCheck();
4742 SpellChecker::Result res = from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions);
4743 if (SpellChecker::misspelled(res)) {
4747 // Do not increase progress when from == to, otherwise the word
4748 // count will be wrong.
4758 void Buffer::Impl::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput)
4760 bool inword = false;
4765 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
4766 if (!dit.inTexted()) {
4771 Paragraph const & par = dit.paragraph();
4772 pos_type const pos = dit.pos();
4774 // Copied and adapted from isWordSeparator() in Paragraph
4775 if (pos == dit.lastpos()) {
4778 Inset const * ins = par.getInset(pos);
4779 if (ins && skipNoOutput && !ins->producesOutput()) {
4782 // stop if end of range was skipped
4783 if (!to.atEnd() && dit >= to)
4786 } else if (!par.isDeleted(pos)) {
4787 if (par.isWordSeparator(pos))
4793 if (ins && ins->isLetter())
4795 else if (ins && ins->isSpace())
4798 char_type const c = par.getChar(pos);
4799 if (isPrintableNonspace(c))
4801 else if (isSpace(c))
4811 void Buffer::updateStatistics(DocIterator & from, DocIterator & to, bool skipNoOutput) const
4813 d->updateStatistics(from, to, skipNoOutput);
4817 int Buffer::wordCount() const
4819 return d->wordCount();
4823 int Buffer::charCount(bool with_blanks) const
4825 return d->charCount(with_blanks);
4829 Buffer::ReadStatus Buffer::reload()
4832 // c.f. bug http://www.lyx.org/trac/ticket/6587
4833 removeAutosaveFile();
4834 // e.g., read-only status could have changed due to version control
4835 d->filename.refresh();
4836 docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
4838 // clear parent. this will get reset if need be.
4840 ReadStatus const status = loadLyXFile();
4841 if (status == ReadSuccess) {
4846 message(bformat(_("Document %1$s reloaded."), disp_fn));
4849 message(bformat(_("Could not reload document %1$s."), disp_fn));
4859 bool Buffer::saveAs(FileName const & fn)
4861 FileName const old_name = fileName();
4862 FileName const old_auto = getAutosaveFileName();
4863 bool const old_unnamed = isUnnamed();
4864 bool success = true;
4865 d->old_position = filePath();
4872 // bring the autosave file with us, just in case.
4873 moveAutosaveFile(old_auto);
4874 // validate version control data and
4875 // correct buffer title
4876 lyxvc().file_found_hook(fileName());
4878 // the file has now been saved to the new location.
4879 // we need to check that the locations of child buffers
4881 checkChildBuffers();
4882 checkMasterBuffer();
4885 // reset the old filename and unnamed state
4886 setFileName(old_name);
4887 setUnnamed(old_unnamed);
4891 d->old_position.clear();
4896 void Buffer::checkChildBuffers()
4898 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
4899 Impl::BufferPositionMap::iterator const en = d->children_positions.end();
4900 for (; it != en; ++it) {
4901 DocIterator dit = it->second;
4902 Buffer * cbuf = const_cast<Buffer *>(it->first);
4903 if (!cbuf || !theBufferList().isLoaded(cbuf))
4905 Inset * inset = dit.nextInset();
4906 LASSERT(inset && inset->lyxCode() == INCLUDE_CODE, continue);
4907 InsetInclude * inset_inc = static_cast<InsetInclude *>(inset);
4908 docstring const & incfile = inset_inc->getParam("filename");
4909 string oldloc = cbuf->absFileName();
4910 string newloc = makeAbsPath(to_utf8(incfile),
4911 onlyPath(absFileName())).absFileName();
4912 if (oldloc == newloc)
4914 // the location of the child file is incorrect.
4916 inset_inc->setChildBuffer(0);
4918 // invalidate cache of children
4919 d->children_positions.clear();
4920 d->position_to_children.clear();
4924 // If a child has been saved under a different name/path, it might have been
4925 // orphaned. Therefore the master needs to be reset (bug 8161).
4926 void Buffer::checkMasterBuffer()
4928 Buffer const * const master = masterBuffer();
4932 // necessary to re-register the child (bug 5873)
4933 // FIXME: clean up updateMacros (here, only
4934 // child registering is needed).
4935 master->updateMacros();
4936 // (re)set master as master buffer, but only
4937 // if we are a real child
4938 if (master->isChild(this))
4945 string Buffer::includedFilePath(string const & name, string const & ext) const
4947 bool isabsolute = FileName::isAbsolute(name);
4948 // old_position already contains a trailing path separator
4949 string const absname = isabsolute ? name : d->old_position + name;
4951 if (d->old_position.empty() || d->old_position == filePath()
4952 || !FileName(addExtension(absname, ext)).exists())
4956 return to_utf8(makeRelPath(from_utf8(name), from_utf8(filePath())));
4958 return to_utf8(makeRelPath(from_utf8(FileName(absname).realPath()),
4959 from_utf8(filePath())));