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"
27 #include "DocIterator.h"
29 #include "ErrorList.h"
32 #include "FuncRequest.h"
33 #include "InsetIterator.h"
34 #include "InsetList.h"
36 #include "LaTeXFeatures.h"
40 #include "LyXAction.h"
44 #include "output_docbook.h"
46 #include "output_latex.h"
47 #include "output_plaintext.h"
48 #include "paragraph_funcs.h"
49 #include "Paragraph.h"
50 #include "ParagraphParameters.h"
51 #include "ParIterator.h"
52 #include "PDFOptions.h"
55 #include "TexStream.h"
57 #include "TextClass.h"
58 #include "TocBackend.h"
60 #include "VCBackend.h"
64 #include "insets/InsetBibitem.h"
65 #include "insets/InsetBibtex.h"
66 #include "insets/InsetInclude.h"
67 #include "insets/InsetText.h"
69 #include "mathed/MacroTable.h"
70 #include "mathed/MathMacroTemplate.h"
71 #include "mathed/MathSupport.h"
73 #include "frontends/alert.h"
74 #include "frontends/Delegates.h"
75 #include "frontends/WorkAreaManager.h"
77 #include "graphics/Previews.h"
79 #include "support/lassert.h"
80 #include "support/convert.h"
81 #include "support/debug.h"
82 #include "support/ExceptionMessage.h"
83 #include "support/FileName.h"
84 #include "support/FileNameList.h"
85 #include "support/filetools.h"
86 #include "support/ForkedCalls.h"
87 #include "support/gettext.h"
88 #include "support/gzstream.h"
89 #include "support/lstrings.h"
90 #include "support/lyxalgo.h"
91 #include "support/os.h"
92 #include "support/Package.h"
93 #include "support/Path.h"
94 #include "support/textutils.h"
95 #include "support/types.h"
97 #include <boost/bind.hpp>
98 #include <boost/shared_ptr.hpp>
110 using namespace lyx::support;
114 namespace Alert = frontend::Alert;
115 namespace os = support::os;
119 // Do not remove the comment below, so we get merge conflict in
120 // independent branches. Instead add your own.
121 int const LYX_FORMAT = 346; // jspitzm: Swiss German
123 typedef map<string, bool> DepClean;
124 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
128 class BufferSet : public std::set<Buffer const *> {};
133 Impl(Buffer & parent, FileName const & file, bool readonly);
147 mutable TexRow texrow;
148 Buffer const * parent_buffer;
150 /// need to regenerate .tex?
154 mutable bool lyx_clean;
156 /// is autosave needed?
157 mutable bool bak_clean;
159 /// is this a unnamed file (New...)?
165 /// name of the file the buffer is associated with.
168 /** Set to true only when the file is fully loaded.
169 * Used to prevent the premature generation of previews
170 * and by the citation inset.
172 bool file_fully_loaded;
175 mutable TocBackend toc_backend;
178 typedef pair<DocIterator, MacroData> ScopeMacro;
179 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
180 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
181 /// map from the macro name to the position map,
182 /// which maps the macro definition position to the scope and the MacroData.
183 NamePositionScopeMacroMap macros;
186 /// positions of child buffers in the buffer
187 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
188 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
189 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
190 /// position of children buffers in this buffer
191 BufferPositionMap children_positions;
192 /// map from children inclusion positions to their scope and their buffer
193 PositionScopeBufferMap position_to_children;
195 /// Container for all sort of Buffer dependant errors.
196 map<string, ErrorList> errorLists;
198 /// timestamp and checksum used to test if the file has been externally
199 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
201 unsigned long checksum_;
204 frontend::WorkAreaManager * wa_;
209 /// A cache for the bibfiles (including bibfiles of loaded child
210 /// documents), needed for appropriate update of natbib labels.
211 mutable support::FileNameList bibfilesCache_;
213 // FIXME The caching mechanism could be improved. At present, we have a
214 // cache for each Buffer, that caches all the bibliography info for that
215 // Buffer. A more efficient solution would be to have a global cache per
216 // file, and then to construct the Buffer's bibinfo from that.
217 /// A cache for bibliography info
218 mutable BiblioInfo bibinfo_;
219 /// whether the bibinfo cache is valid
220 bool bibinfoCacheValid_;
221 /// Cache of timestamps of .bib files
222 map<FileName, time_t> bibfileStatus_;
224 mutable RefCache ref_cache_;
226 /// our Text that should be wrapped in an InsetText
231 /// Creates the per buffer temporary directory
232 static FileName createBufferTmpDir()
235 // We are in our own directory. Why bother to mangle name?
236 // In fact I wrote this code to circumvent a problematic behaviour
237 // (bug?) of EMX mkstemp().
238 FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
239 convert<string>(count++));
241 if (!tmpfl.createDirectory(0777)) {
242 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
243 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
244 from_utf8(tmpfl.absFilename())));
250 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
251 : parent_buffer(0), lyx_clean(true), bak_clean(true), unnamed(false),
252 read_only(readonly_), filename(file), file_fully_loaded(false),
253 toc_backend(&parent), macro_lock(false), timestamp_(0),
254 checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false)
256 temppath = createBufferTmpDir();
257 lyxvc.setBuffer(&parent);
259 wa_ = new frontend::WorkAreaManager;
263 Buffer::Buffer(string const & file, bool readonly)
264 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
266 LYXERR(Debug::INFO, "Buffer::Buffer()");
268 d->inset = new InsetText(*this);
269 d->inset->setAutoBreakRows(true);
270 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
276 LYXERR(Debug::INFO, "Buffer::~Buffer()");
277 // here the buffer should take care that it is
278 // saved properly, before it goes into the void.
280 // GuiView already destroyed
283 if (d->unnamed && d->filename.extension() == "internal") {
284 // No need to do additional cleanups for internal buffer.
289 // loop over children
290 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
291 Impl::BufferPositionMap::iterator end = d->children_positions.end();
292 for (; it != end; ++it)
293 theBufferList().releaseChild(this, const_cast<Buffer *>(it->first));
295 // clear references to children in macro tables
296 d->children_positions.clear();
297 d->position_to_children.clear();
299 if (!d->temppath.destroyDirectory()) {
300 Alert::warning(_("Could not remove temporary directory"),
301 bformat(_("Could not remove the temporary directory %1$s"),
302 from_utf8(d->temppath.absFilename())));
305 // Remove any previewed LaTeX snippets associated with this buffer.
306 thePreviews().removeLoader(*this);
312 void Buffer::changed() const
319 frontend::WorkAreaManager & Buffer::workAreaManager() const
321 LASSERT(d->wa_, /**/);
326 Text & Buffer::text() const
328 return d->inset->text();
332 Inset & Buffer::inset() const
338 BufferParams & Buffer::params()
344 BufferParams const & Buffer::params() const
350 ParagraphList & Buffer::paragraphs()
352 return text().paragraphs();
356 ParagraphList const & Buffer::paragraphs() const
358 return text().paragraphs();
362 LyXVC & Buffer::lyxvc()
368 LyXVC const & Buffer::lyxvc() const
374 string const Buffer::temppath() const
376 return d->temppath.absFilename();
380 TexRow & Buffer::texrow()
386 TexRow const & Buffer::texrow() const
392 TocBackend & Buffer::tocBackend() const
394 return d->toc_backend;
398 Undo & Buffer::undo()
404 string Buffer::latexName(bool const no_path) const
406 FileName latex_name = makeLatexName(d->filename);
407 return no_path ? latex_name.onlyFileName()
408 : latex_name.absFilename();
412 string Buffer::logName(LogType * type) const
414 string const filename = latexName(false);
416 if (filename.empty()) {
422 string const path = temppath();
424 FileName const fname(addName(temppath(),
425 onlyFilename(changeExtension(filename,
427 FileName const bname(
428 addName(path, onlyFilename(
429 changeExtension(filename,
430 formats.extension("literate") + ".out"))));
432 // If no Latex log or Build log is newer, show Build log
434 if (bname.exists() &&
435 (!fname.exists() || fname.lastModified() < bname.lastModified())) {
436 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
439 return bname.absFilename();
441 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
444 return fname.absFilename();
448 void Buffer::setReadonly(bool const flag)
450 if (d->read_only != flag) {
457 void Buffer::setFileName(string const & newfile)
459 d->filename = makeAbsPath(newfile);
460 setReadonly(d->filename.isReadOnly());
465 int Buffer::readHeader(Lexer & lex)
467 int unknown_tokens = 0;
469 int begin_header_line = -1;
471 // Initialize parameters that may be/go lacking in header:
472 params().branchlist().clear();
473 params().preamble.erase();
474 params().options.erase();
475 params().master.erase();
476 params().float_placement.erase();
477 params().paperwidth.erase();
478 params().paperheight.erase();
479 params().leftmargin.erase();
480 params().rightmargin.erase();
481 params().topmargin.erase();
482 params().bottommargin.erase();
483 params().headheight.erase();
484 params().headsep.erase();
485 params().footskip.erase();
486 params().columnsep.erase();
487 params().fontsCJK.erase();
488 params().listings_params.clear();
489 params().clearLayoutModules();
490 params().clearRemovedModules();
491 params().pdfoptions().clear();
493 for (int i = 0; i < 4; ++i) {
494 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
495 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
498 ErrorList & errorList = d->errorLists["Parse"];
507 if (token == "\\end_header")
511 if (token == "\\begin_header") {
512 begin_header_line = line;
516 LYXERR(Debug::PARSER, "Handling document header token: `"
519 string unknown = params().readToken(lex, token, d->filename.onlyPath());
520 if (!unknown.empty()) {
521 if (unknown[0] != '\\' && token == "\\textclass") {
522 Alert::warning(_("Unknown document class"),
523 bformat(_("Using the default document class, because the "
524 "class %1$s is unknown."), from_utf8(unknown)));
527 docstring const s = bformat(_("Unknown token: "
531 errorList.push_back(ErrorItem(_("Document header error"),
536 if (begin_header_line) {
537 docstring const s = _("\\begin_header is missing");
538 errorList.push_back(ErrorItem(_("Document header error"),
542 params().makeDocumentClass();
544 return unknown_tokens;
549 // changed to be public and have one parameter
550 // Returns false if "\end_document" is not read (Asger)
551 bool Buffer::readDocument(Lexer & lex)
553 ErrorList & errorList = d->errorLists["Parse"];
556 if (!lex.checkFor("\\begin_document")) {
557 docstring const s = _("\\begin_document is missing");
558 errorList.push_back(ErrorItem(_("Document header error"),
562 // we are reading in a brand new document
563 LASSERT(paragraphs().empty(), /**/);
567 if (params().outputChanges) {
568 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
569 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
570 LaTeXFeatures::isAvailable("xcolor");
572 if (!dvipost && !xcolorsoul) {
573 Alert::warning(_("Changes not shown in LaTeX output"),
574 _("Changes will not be highlighted in LaTeX output, "
575 "because neither dvipost nor xcolor/soul are installed.\n"
576 "Please install these packages or redefine "
577 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
578 } else if (!xcolorsoul) {
579 Alert::warning(_("Changes not shown in LaTeX output"),
580 _("Changes will not be highlighted in LaTeX output "
581 "when using pdflatex, because xcolor and soul are not installed.\n"
582 "Please install both packages or redefine "
583 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
587 if (!params().master.empty()) {
588 FileName const master_file = makeAbsPath(params().master,
589 onlyPath(absFileName()));
590 if (isLyXFilename(master_file.absFilename())) {
591 Buffer * master = checkAndLoadLyXFile(master_file, true);
592 d->parent_buffer = master;
597 bool const res = text().read(*this, lex, errorList, d->inset);
600 updateMacroInstances();
605 // needed to insert the selection
606 void Buffer::insertStringAsLines(ParagraphList & pars,
607 pit_type & pit, pos_type & pos,
608 Font const & fn, docstring const & str, bool autobreakrows)
612 // insert the string, don't insert doublespace
613 bool space_inserted = true;
614 for (docstring::const_iterator cit = str.begin();
615 cit != str.end(); ++cit) {
616 Paragraph & par = pars[pit];
618 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
619 breakParagraph(params(), pars, pit, pos,
620 par.layout().isEnvironment());
623 space_inserted = true;
627 // do not insert consecutive spaces if !free_spacing
628 } else if ((*cit == ' ' || *cit == '\t') &&
629 space_inserted && !par.isFreeSpacing()) {
631 } else if (*cit == '\t') {
632 if (!par.isFreeSpacing()) {
633 // tabs are like spaces here
634 par.insertChar(pos, ' ', font, params().trackChanges);
636 space_inserted = true;
638 par.insertChar(pos, *cit, font, params().trackChanges);
640 space_inserted = true;
642 } else if (!isPrintable(*cit)) {
643 // Ignore unprintables
646 // just insert the character
647 par.insertChar(pos, *cit, font, params().trackChanges);
649 space_inserted = (*cit == ' ');
656 bool Buffer::readString(string const & s)
658 params().compressed = false;
660 // remove dummy empty par
661 paragraphs().clear();
665 FileName const name = FileName::tempName("Buffer_readString");
666 switch (readFile(lex, name, true)) {
670 // We need to call lyx2lyx, so write the input to a file
671 ofstream os(name.toFilesystemEncoding().c_str());
674 return readFile(name);
684 bool Buffer::readFile(FileName const & filename)
686 FileName fname(filename);
688 params().compressed = fname.isZippedFile();
690 // remove dummy empty par
691 paragraphs().clear();
694 if (readFile(lex, fname) != success)
701 bool Buffer::isFullyLoaded() const
703 return d->file_fully_loaded;
707 void Buffer::setFullyLoaded(bool value)
709 d->file_fully_loaded = value;
713 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
716 LASSERT(!filename.empty(), /**/);
718 // the first (non-comment) token _must_ be...
719 if (!lex.checkFor("\\lyxformat")) {
720 Alert::error(_("Document format failure"),
721 bformat(_("%1$s is not a readable LyX document."),
722 from_utf8(filename.absFilename())));
728 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
729 // if present remove ".," from string.
730 size_t dot = tmp_format.find_first_of(".,");
731 //lyxerr << " dot found at " << dot << endl;
732 if (dot != string::npos)
733 tmp_format.erase(dot, 1);
734 int const file_format = convert<int>(tmp_format);
735 //lyxerr << "format: " << file_format << endl;
737 // save timestamp and checksum of the original disk file, making sure
738 // to not overwrite them with those of the file created in the tempdir
739 // when it has to be converted to the current format.
741 // Save the timestamp and checksum of disk file. If filename is an
742 // emergency file, save the timestamp and checksum of the original lyx file
743 // because isExternallyModified will check for this file. (BUG4193)
744 string diskfile = filename.absFilename();
745 if (suffixIs(diskfile, ".emergency"))
746 diskfile = diskfile.substr(0, diskfile.size() - 10);
747 saveCheckSum(FileName(diskfile));
750 if (file_format != LYX_FORMAT) {
753 // lyx2lyx would fail
756 FileName const tmpfile = FileName::tempName("Buffer_readFile");
757 if (tmpfile.empty()) {
758 Alert::error(_("Conversion failed"),
759 bformat(_("%1$s is from a different"
760 " version of LyX, but a temporary"
761 " file for converting it could"
763 from_utf8(filename.absFilename())));
766 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
767 if (lyx2lyx.empty()) {
768 Alert::error(_("Conversion script not found"),
769 bformat(_("%1$s is from a different"
770 " version of LyX, but the"
771 " conversion script lyx2lyx"
772 " could not be found."),
773 from_utf8(filename.absFilename())));
776 ostringstream command;
777 command << os::python()
778 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
779 << " -t " << convert<string>(LYX_FORMAT)
780 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
781 << ' ' << quoteName(filename.toFilesystemEncoding());
782 string const command_str = command.str();
784 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
786 cmd_ret const ret = runCommand(command_str);
787 if (ret.first != 0) {
788 Alert::error(_("Conversion script failed"),
789 bformat(_("%1$s is from a different version"
790 " of LyX, but the lyx2lyx script"
791 " failed to convert it."),
792 from_utf8(filename.absFilename())));
795 bool const ret = readFile(tmpfile);
796 // Do stuff with tmpfile name and buffer name here.
797 return ret ? success : failure;
802 if (readDocument(lex)) {
803 Alert::error(_("Document format failure"),
804 bformat(_("%1$s ended unexpectedly, which means"
805 " that it is probably corrupted."),
806 from_utf8(filename.absFilename())));
809 d->file_fully_loaded = true;
814 // Should probably be moved to somewhere else: BufferView? LyXView?
815 bool Buffer::save() const
817 // We don't need autosaves in the immediate future. (Asger)
818 resetAutosaveTimers();
820 string const encodedFilename = d->filename.toFilesystemEncoding();
823 bool madeBackup = false;
825 // make a backup if the file already exists
826 if (lyxrc.make_backup && fileName().exists()) {
827 backupName = FileName(absFileName() + '~');
828 if (!lyxrc.backupdir_path.empty()) {
829 string const mangledName =
830 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
831 backupName = FileName(addName(lyxrc.backupdir_path,
834 if (fileName().copyTo(backupName)) {
837 Alert::error(_("Backup failure"),
838 bformat(_("Cannot create backup file %1$s.\n"
839 "Please check whether the directory exists and is writeable."),
840 from_utf8(backupName.absFilename())));
841 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
845 // ask if the disk file has been externally modified (use checksum method)
846 if (fileName().exists() && isExternallyModified(checksum_method)) {
847 docstring const file = makeDisplayPath(absFileName(), 20);
848 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
849 "you want to overwrite this file?"), file);
850 int const ret = Alert::prompt(_("Overwrite modified file?"),
851 text, 1, 1, _("&Overwrite"), _("&Cancel"));
856 if (writeFile(d->filename)) {
860 // Saving failed, so backup is not backup
862 backupName.moveTo(d->filename);
868 bool Buffer::writeFile(FileName const & fname) const
870 if (d->read_only && fname == d->filename)
875 docstring const str = bformat(_("Saving document %1$s..."),
876 makeDisplayPath(fname.absFilename()));
879 if (params().compressed) {
880 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
881 retval = ofs && write(ofs);
883 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
884 retval = ofs && write(ofs);
888 message(str + _(" could not write file!"));
892 removeAutosaveFile(d->filename.absFilename());
894 saveCheckSum(d->filename);
895 message(str + _(" done."));
901 bool Buffer::write(ostream & ofs) const
904 // Use the standard "C" locale for file output.
905 ofs.imbue(locale::classic());
908 // The top of the file should not be written by params().
910 // write out a comment in the top of the file
911 ofs << "#LyX " << lyx_version
912 << " created this file. For more info see http://www.lyx.org/\n"
913 << "\\lyxformat " << LYX_FORMAT << "\n"
914 << "\\begin_document\n";
916 /// For each author, set 'used' to true if there is a change
917 /// by this author in the document; otherwise set it to 'false'.
918 AuthorList::Authors::const_iterator a_it = params().authors().begin();
919 AuthorList::Authors::const_iterator a_end = params().authors().end();
920 for (; a_it != a_end; ++a_it)
921 a_it->second.setUsed(false);
923 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
924 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
925 for ( ; it != end; ++it)
926 it->checkAuthors(params().authors());
928 // now write out the buffer parameters.
929 ofs << "\\begin_header\n";
930 params().writeFile(ofs);
931 ofs << "\\end_header\n";
934 ofs << "\n\\begin_body\n";
935 text().write(*this, ofs);
936 ofs << "\n\\end_body\n";
938 // Write marker that shows file is complete
939 ofs << "\\end_document" << endl;
941 // Shouldn't really be needed....
944 // how to check if close went ok?
945 // Following is an attempt... (BE 20001011)
947 // good() returns false if any error occured, including some
949 // bad() returns true if something bad happened in the buffer,
950 // which should include file system full errors.
955 lyxerr << "File was not closed properly." << endl;
962 bool Buffer::makeLaTeXFile(FileName const & fname,
963 string const & original_path,
964 OutputParams const & runparams,
965 bool output_preamble, bool output_body) const
967 string const encoding = runparams.encoding->iconvName();
968 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
971 try { ofs.reset(encoding); }
972 catch (iconv_codecvt_facet_exception & e) {
973 lyxerr << "Caught iconv exception: " << e.what() << endl;
974 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
975 "verify that the support software for your encoding (%1$s) is "
976 "properly installed"), from_ascii(encoding)));
979 if (!openFileWrite(ofs, fname))
982 //TexStream ts(ofs.rdbuf(), &texrow());
983 ErrorList & errorList = d->errorLists["Export"];
985 bool failed_export = false;
988 writeLaTeXSource(ofs, original_path,
989 runparams, output_preamble, output_body);
991 catch (EncodingException & e) {
992 odocstringstream ods;
993 ods.put(e.failed_char);
995 oss << "0x" << hex << e.failed_char << dec;
996 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
997 " (code point %2$s)"),
998 ods.str(), from_utf8(oss.str()));
999 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1000 "representable in the chosen encoding.\n"
1001 "Changing the document encoding to utf8 could help."),
1002 e.par_id, e.pos, e.pos + 1));
1003 failed_export = true;
1005 catch (iconv_codecvt_facet_exception & e) {
1006 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1007 _(e.what()), -1, 0, 0));
1008 failed_export = true;
1010 catch (exception const & e) {
1011 errorList.push_back(ErrorItem(_("conversion failed"),
1012 _(e.what()), -1, 0, 0));
1013 failed_export = true;
1016 lyxerr << "Caught some really weird exception..." << endl;
1022 failed_export = true;
1023 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1027 return !failed_export;
1031 void Buffer::writeLaTeXSource(odocstream & os,
1032 string const & original_path,
1033 OutputParams const & runparams_in,
1034 bool const output_preamble, bool const output_body) const
1036 // The child documents, if any, shall be already loaded at this point.
1038 OutputParams runparams = runparams_in;
1040 // Classify the unicode characters appearing in math insets
1041 Encodings::initUnicodeMath(*this);
1043 // validate the buffer.
1044 LYXERR(Debug::LATEX, " Validating buffer...");
1045 LaTeXFeatures features(*this, params(), runparams);
1047 LYXERR(Debug::LATEX, " Buffer validation done.");
1049 // The starting paragraph of the coming rows is the
1050 // first paragraph of the document. (Asger)
1051 if (output_preamble && runparams.nice) {
1052 os << "%% LyX " << lyx_version << " created this file. "
1053 "For more info, see http://www.lyx.org/.\n"
1054 "%% Do not edit unless you really know what "
1056 d->texrow.newline();
1057 d->texrow.newline();
1059 LYXERR(Debug::INFO, "lyx document header finished");
1061 // Don't move this behind the parent_buffer=0 code below,
1062 // because then the macros will not get the right "redefinition"
1063 // flag as they don't see the parent macros which are output before.
1066 // fold macros if possible, still with parent buffer as the
1067 // macros will be put in the prefix anyway.
1068 updateMacroInstances();
1070 // There are a few differences between nice LaTeX and usual files:
1071 // usual is \batchmode and has a
1072 // special input@path to allow the including of figures
1073 // with either \input or \includegraphics (what figinsets do).
1074 // input@path is set when the actual parameter
1075 // original_path is set. This is done for usual tex-file, but not
1076 // for nice-latex-file. (Matthias 250696)
1077 // Note that input@path is only needed for something the user does
1078 // in the preamble, included .tex files or ERT, files included by
1079 // LyX work without it.
1080 if (output_preamble) {
1081 if (!runparams.nice) {
1082 // code for usual, NOT nice-latex-file
1083 os << "\\batchmode\n"; // changed
1084 // from \nonstopmode
1085 d->texrow.newline();
1087 if (!original_path.empty()) {
1089 // We don't know the encoding of inputpath
1090 docstring const inputpath = from_utf8(latex_path(original_path));
1091 os << "\\makeatletter\n"
1092 << "\\def\\input@path{{"
1093 << inputpath << "/}}\n"
1094 << "\\makeatother\n";
1095 d->texrow.newline();
1096 d->texrow.newline();
1097 d->texrow.newline();
1100 // get parent macros (if this buffer has a parent) which will be
1101 // written at the document begin further down.
1102 MacroSet parentMacros;
1103 listParentMacros(parentMacros, features);
1105 // Write the preamble
1106 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1108 runparams.use_japanese = features.isRequired("japanese");
1114 os << "\\begin{document}\n";
1115 d->texrow.newline();
1117 // output the parent macros
1118 MacroSet::iterator it = parentMacros.begin();
1119 MacroSet::iterator end = parentMacros.end();
1120 for (; it != end; ++it)
1121 (*it)->write(os, true);
1122 } // output_preamble
1124 d->texrow.start(paragraphs().begin()->id(), 0);
1126 LYXERR(Debug::INFO, "preamble finished, now the body.");
1128 // if we are doing a real file with body, even if this is the
1129 // child of some other buffer, let's cut the link here.
1130 // This happens for example if only a child document is printed.
1131 Buffer const * save_parent = 0;
1132 if (output_preamble) {
1133 save_parent = d->parent_buffer;
1134 d->parent_buffer = 0;
1138 latexParagraphs(*this, text(), os, d->texrow, runparams);
1140 // Restore the parenthood if needed
1141 if (output_preamble)
1142 d->parent_buffer = save_parent;
1144 // add this just in case after all the paragraphs
1146 d->texrow.newline();
1148 if (output_preamble) {
1149 os << "\\end{document}\n";
1150 d->texrow.newline();
1151 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1153 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1155 runparams_in.encoding = runparams.encoding;
1157 // Just to be sure. (Asger)
1158 d->texrow.newline();
1160 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1161 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1165 bool Buffer::isLatex() const
1167 return params().documentClass().outputType() == LATEX;
1171 bool Buffer::isLiterate() const
1173 return params().documentClass().outputType() == LITERATE;
1177 bool Buffer::isDocBook() const
1179 return params().documentClass().outputType() == DOCBOOK;
1183 void Buffer::makeDocBookFile(FileName const & fname,
1184 OutputParams const & runparams,
1185 bool const body_only) const
1187 LYXERR(Debug::LATEX, "makeDocBookFile...");
1190 if (!openFileWrite(ofs, fname))
1193 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1197 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1201 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1202 OutputParams const & runparams,
1203 bool const only_body) const
1205 LaTeXFeatures features(*this, params(), runparams);
1210 DocumentClass const & tclass = params().documentClass();
1211 string const top_element = tclass.latexname();
1214 if (runparams.flavor == OutputParams::XML)
1215 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1218 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1221 if (! tclass.class_header().empty())
1222 os << from_ascii(tclass.class_header());
1223 else if (runparams.flavor == OutputParams::XML)
1224 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1225 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1227 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1229 docstring preamble = from_utf8(params().preamble);
1230 if (runparams.flavor != OutputParams::XML ) {
1231 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1232 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1233 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1234 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1237 string const name = runparams.nice
1238 ? changeExtension(absFileName(), ".sgml") : fname;
1239 preamble += features.getIncludedFiles(name);
1240 preamble += features.getLyXSGMLEntities();
1242 if (!preamble.empty()) {
1243 os << "\n [ " << preamble << " ]";
1248 string top = top_element;
1250 if (runparams.flavor == OutputParams::XML)
1251 top += params().language->code();
1253 top += params().language->code().substr(0, 2);
1256 if (!params().options.empty()) {
1258 top += params().options;
1261 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1262 << " file was created by LyX " << lyx_version
1263 << "\n See http://www.lyx.org/ for more information -->\n";
1265 params().documentClass().counters().reset();
1269 sgml::openTag(os, top);
1271 docbookParagraphs(paragraphs(), *this, os, runparams);
1272 sgml::closeTag(os, top_element);
1276 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1277 // Other flags: -wall -v0 -x
1278 int Buffer::runChktex()
1282 // get LaTeX-Filename
1283 FileName const path(temppath());
1284 string const name = addName(path.absFilename(), latexName());
1285 string const org_path = filePath();
1287 PathChanger p(path); // path to LaTeX file
1288 message(_("Running chktex..."));
1290 // Generate the LaTeX file if neccessary
1291 OutputParams runparams(¶ms().encoding());
1292 runparams.flavor = OutputParams::LATEX;
1293 runparams.nice = false;
1294 makeLaTeXFile(FileName(name), org_path, runparams);
1297 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1298 int const res = chktex.run(terr); // run chktex
1301 Alert::error(_("chktex failure"),
1302 _("Could not run chktex successfully."));
1303 } else if (res > 0) {
1304 ErrorList & errlist = d->errorLists["ChkTeX"];
1306 bufferErrors(terr, errlist);
1317 void Buffer::validate(LaTeXFeatures & features) const
1319 params().validate(features);
1323 for_each(paragraphs().begin(), paragraphs().end(),
1324 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1326 if (lyxerr.debugging(Debug::LATEX)) {
1327 features.showStruct();
1332 void Buffer::getLabelList(vector<docstring> & list) const
1334 // If this is a child document, use the parent's list instead.
1335 if (d->parent_buffer) {
1336 d->parent_buffer->getLabelList(list);
1341 Toc & toc = d->toc_backend.toc("label");
1342 TocIterator toc_it = toc.begin();
1343 TocIterator end = toc.end();
1344 for (; toc_it != end; ++toc_it) {
1345 if (toc_it->depth() == 0)
1346 list.push_back(toc_it->str());
1351 void Buffer::updateBibfilesCache() const
1353 // If this is a child document, use the parent's cache instead.
1354 if (d->parent_buffer) {
1355 d->parent_buffer->updateBibfilesCache();
1359 d->bibfilesCache_.clear();
1360 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1361 if (it->lyxCode() == BIBTEX_CODE) {
1362 InsetBibtex const & inset =
1363 static_cast<InsetBibtex const &>(*it);
1364 support::FileNameList const bibfiles = inset.getBibFiles();
1365 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1368 } else if (it->lyxCode() == INCLUDE_CODE) {
1369 InsetInclude & inset =
1370 static_cast<InsetInclude &>(*it);
1371 inset.updateBibfilesCache();
1372 support::FileNameList const & bibfiles =
1373 inset.getBibfilesCache(*this);
1374 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1379 // the bibinfo cache is now invalid
1380 d->bibinfoCacheValid_ = false;
1384 void Buffer::invalidateBibinfoCache()
1386 d->bibinfoCacheValid_ = false;
1390 support::FileNameList const & Buffer::getBibfilesCache() const
1392 // If this is a child document, use the parent's cache instead.
1393 if (d->parent_buffer)
1394 return d->parent_buffer->getBibfilesCache();
1396 // We update the cache when first used instead of at loading time.
1397 if (d->bibfilesCache_.empty())
1398 const_cast<Buffer *>(this)->updateBibfilesCache();
1400 return d->bibfilesCache_;
1404 BiblioInfo const & Buffer::masterBibInfo() const
1406 // if this is a child document and the parent is already loaded
1407 // use the parent's list instead [ale990412]
1408 Buffer const * const tmp = masterBuffer();
1411 return tmp->masterBibInfo();
1412 return localBibInfo();
1416 BiblioInfo const & Buffer::localBibInfo() const
1418 if (d->bibinfoCacheValid_) {
1419 support::FileNameList const & bibfilesCache = getBibfilesCache();
1420 // compare the cached timestamps with the actual ones.
1421 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1422 support::FileNameList::const_iterator en = bibfilesCache.end();
1423 for (; ei != en; ++ ei) {
1424 time_t lastw = ei->lastModified();
1425 if (lastw != d->bibfileStatus_[*ei]) {
1426 d->bibinfoCacheValid_ = false;
1427 d->bibfileStatus_[*ei] = lastw;
1433 if (!d->bibinfoCacheValid_) {
1434 d->bibinfo_.clear();
1435 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1436 it->fillWithBibKeys(d->bibinfo_, it);
1437 d->bibinfoCacheValid_ = true;
1443 bool Buffer::isDepClean(string const & name) const
1445 DepClean::const_iterator const it = d->dep_clean.find(name);
1446 if (it == d->dep_clean.end())
1452 void Buffer::markDepClean(string const & name)
1454 d->dep_clean[name] = true;
1458 bool Buffer::dispatch(string const & command, bool * result)
1460 return dispatch(lyxaction.lookupFunc(command), result);
1464 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1466 bool dispatched = true;
1468 switch (func.action) {
1469 case LFUN_BUFFER_EXPORT: {
1470 bool const tmp = doExport(to_utf8(func.argument()), false);
1476 case LFUN_BRANCH_ACTIVATE:
1477 case LFUN_BRANCH_DEACTIVATE: {
1478 BranchList & branchList = params().branchlist();
1479 docstring const branchName = func.argument();
1480 Branch * branch = branchList.find(branchName);
1482 LYXERR0("Branch " << branchName << " does not exist.");
1484 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1496 void Buffer::changeLanguage(Language const * from, Language const * to)
1498 LASSERT(from, /**/);
1501 for_each(par_iterator_begin(),
1503 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1507 bool Buffer::isMultiLingual() const
1509 ParConstIterator end = par_iterator_end();
1510 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1511 if (it->isMultiLingual(params()))
1518 DocIterator Buffer::getParFromID(int const id) const
1520 Buffer * buf = const_cast<Buffer *>(this);
1522 // John says this is called with id == -1 from undo
1523 lyxerr << "getParFromID(), id: " << id << endl;
1524 return doc_iterator_end(buf);
1527 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
1528 if (it.paragraph().id() == id)
1531 return doc_iterator_end(buf);
1535 bool Buffer::hasParWithID(int const id) const
1537 return !getParFromID(id).atEnd();
1541 ParIterator Buffer::par_iterator_begin()
1543 return ParIterator(doc_iterator_begin(this));
1547 ParIterator Buffer::par_iterator_end()
1549 return ParIterator(doc_iterator_end(this));
1553 ParConstIterator Buffer::par_iterator_begin() const
1555 return ParConstIterator(doc_iterator_begin(this));
1559 ParConstIterator Buffer::par_iterator_end() const
1561 return ParConstIterator(doc_iterator_end(this));
1565 Language const * Buffer::language() const
1567 return params().language;
1571 docstring const Buffer::B_(string const & l10n) const
1573 return params().B_(l10n);
1577 bool Buffer::isClean() const
1579 return d->lyx_clean;
1583 bool Buffer::isBakClean() const
1585 return d->bak_clean;
1589 bool Buffer::isExternallyModified(CheckMethod method) const
1591 LASSERT(d->filename.exists(), /**/);
1592 // if method == timestamp, check timestamp before checksum
1593 return (method == checksum_method
1594 || d->timestamp_ != d->filename.lastModified())
1595 && d->checksum_ != d->filename.checksum();
1599 void Buffer::saveCheckSum(FileName const & file) const
1601 if (file.exists()) {
1602 d->timestamp_ = file.lastModified();
1603 d->checksum_ = file.checksum();
1605 // in the case of save to a new file.
1612 void Buffer::markClean() const
1614 if (!d->lyx_clean) {
1615 d->lyx_clean = true;
1618 // if the .lyx file has been saved, we don't need an
1620 d->bak_clean = true;
1624 void Buffer::markBakClean() const
1626 d->bak_clean = true;
1630 void Buffer::setUnnamed(bool flag)
1636 bool Buffer::isUnnamed() const
1642 // FIXME: this function should be moved to buffer_pimpl.C
1643 void Buffer::markDirty()
1646 d->lyx_clean = false;
1649 d->bak_clean = false;
1651 DepClean::iterator it = d->dep_clean.begin();
1652 DepClean::const_iterator const end = d->dep_clean.end();
1654 for (; it != end; ++it)
1659 FileName Buffer::fileName() const
1665 string Buffer::absFileName() const
1667 return d->filename.absFilename();
1671 string Buffer::filePath() const
1673 return d->filename.onlyPath().absFilename() + "/";
1677 bool Buffer::isReadonly() const
1679 return d->read_only;
1683 void Buffer::setParent(Buffer const * buffer)
1685 // Avoids recursive include.
1686 d->parent_buffer = buffer == this ? 0 : buffer;
1691 Buffer const * Buffer::parent() const
1693 return d->parent_buffer;
1697 void Buffer::collectRelatives(BufferSet & bufs) const
1701 parent()->collectRelatives(bufs);
1703 // loop over children
1704 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
1705 Impl::BufferPositionMap::iterator end = d->children_positions.end();
1706 for (; it != end; ++it)
1707 bufs.insert(const_cast<Buffer *>(it->first));
1711 std::vector<Buffer const *> Buffer::allRelatives() const
1714 collectRelatives(bufs);
1715 BufferSet::iterator it = bufs.begin();
1716 std::vector<Buffer const *> ret;
1717 for (; it != bufs.end(); ++it)
1723 Buffer const * Buffer::masterBuffer() const
1725 if (!d->parent_buffer)
1728 return d->parent_buffer->masterBuffer();
1732 bool Buffer::isChild(Buffer * child) const
1734 return d->children_positions.find(child) != d->children_positions.end();
1738 DocIterator Buffer::firstChildPosition(Buffer const * child)
1740 Impl::BufferPositionMap::iterator it;
1741 it = d->children_positions.find(child);
1742 if (it == d->children_positions.end())
1743 return DocIterator(this);
1748 template<typename M>
1749 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
1754 typename M::iterator it = m.lower_bound(x);
1755 if (it == m.begin())
1763 MacroData const * Buffer::getBufferMacro(docstring const & name,
1764 DocIterator const & pos) const
1766 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
1768 // if paragraphs have no macro context set, pos will be empty
1772 // we haven't found anything yet
1773 DocIterator bestPos = par_iterator_begin();
1774 MacroData const * bestData = 0;
1776 // find macro definitions for name
1777 Impl::NamePositionScopeMacroMap::iterator nameIt
1778 = d->macros.find(name);
1779 if (nameIt != d->macros.end()) {
1780 // find last definition in front of pos or at pos itself
1781 Impl::PositionScopeMacroMap::const_iterator it
1782 = greatest_below(nameIt->second, pos);
1783 if (it != nameIt->second.end()) {
1785 // scope ends behind pos?
1786 if (pos < it->second.first) {
1787 // Looks good, remember this. If there
1788 // is no external macro behind this,
1789 // we found the right one already.
1790 bestPos = it->first;
1791 bestData = &it->second.second;
1795 // try previous macro if there is one
1796 if (it == nameIt->second.begin())
1803 // find macros in included files
1804 Impl::PositionScopeBufferMap::const_iterator it
1805 = greatest_below(d->position_to_children, pos);
1806 if (it == d->position_to_children.end())
1807 // no children before
1811 // do we know something better (i.e. later) already?
1812 if (it->first < bestPos )
1815 // scope ends behind pos?
1816 if (pos < it->second.first) {
1817 // look for macro in external file
1818 d->macro_lock = true;
1819 MacroData const * data
1820 = it->second.second->getMacro(name, false);
1821 d->macro_lock = false;
1823 bestPos = it->first;
1829 // try previous file if there is one
1830 if (it == d->position_to_children.begin())
1835 // return the best macro we have found
1840 MacroData const * Buffer::getMacro(docstring const & name,
1841 DocIterator const & pos, bool global) const
1846 // query buffer macros
1847 MacroData const * data = getBufferMacro(name, pos);
1851 // If there is a master buffer, query that
1852 if (d->parent_buffer) {
1853 d->macro_lock = true;
1854 MacroData const * macro = d->parent_buffer->getMacro(
1855 name, *this, false);
1856 d->macro_lock = false;
1862 data = MacroTable::globalMacros().get(name);
1871 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
1873 // set scope end behind the last paragraph
1874 DocIterator scope = par_iterator_begin();
1875 scope.pit() = scope.lastpit() + 1;
1877 return getMacro(name, scope, global);
1881 MacroData const * Buffer::getMacro(docstring const & name,
1882 Buffer const & child, bool global) const
1884 // look where the child buffer is included first
1885 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
1886 if (it == d->children_positions.end())
1889 // check for macros at the inclusion position
1890 return getMacro(name, it->second, global);
1894 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
1896 pit_type lastpit = it.lastpit();
1898 // look for macros in each paragraph
1899 while (it.pit() <= lastpit) {
1900 Paragraph & par = it.paragraph();
1902 // iterate over the insets of the current paragraph
1903 InsetList const & insets = par.insetList();
1904 InsetList::const_iterator iit = insets.begin();
1905 InsetList::const_iterator end = insets.end();
1906 for (; iit != end; ++iit) {
1907 it.pos() = iit->pos;
1909 // is it a nested text inset?
1910 if (iit->inset->asInsetText()) {
1911 // Inset needs its own scope?
1912 InsetText const * itext
1913 = iit->inset->asInsetText();
1914 bool newScope = itext->isMacroScope();
1916 // scope which ends just behind the inset
1917 DocIterator insetScope = it;
1920 // collect macros in inset
1921 it.push_back(CursorSlice(*iit->inset));
1922 updateMacros(it, newScope ? insetScope : scope);
1927 // is it an external file?
1928 if (iit->inset->lyxCode() == INCLUDE_CODE) {
1929 // get buffer of external file
1930 InsetInclude const & inset
1931 = static_cast<InsetInclude const &>(*iit->inset);
1932 d->macro_lock = true;
1933 Buffer * child = inset.loadIfNeeded(*this);
1934 d->macro_lock = false;
1938 // register its position, but only when it is
1939 // included first in the buffer
1940 if (d->children_positions.find(child)
1941 == d->children_positions.end())
1942 d->children_positions[child] = it;
1944 // register child with its scope
1945 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
1949 if (iit->inset->lyxCode() != MATHMACRO_CODE)
1953 MathMacroTemplate & macroTemplate
1954 = static_cast<MathMacroTemplate &>(*iit->inset);
1955 MacroContext mc(*this, it);
1956 macroTemplate.updateToContext(mc);
1959 bool valid = macroTemplate.validMacro();
1960 // FIXME: Should be fixNameAndCheckIfValid() in fact,
1961 // then the BufferView's cursor will be invalid in
1962 // some cases which leads to crashes.
1967 d->macros[macroTemplate.name()][it] =
1968 Impl::ScopeMacro(scope, MacroData(*this, it));
1978 void Buffer::updateMacros() const
1983 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
1985 // start with empty table
1987 d->children_positions.clear();
1988 d->position_to_children.clear();
1990 // Iterate over buffer, starting with first paragraph
1991 // The scope must be bigger than any lookup DocIterator
1992 // later. For the global lookup, lastpit+1 is used, hence
1993 // we use lastpit+2 here.
1994 DocIterator it = par_iterator_begin();
1995 DocIterator outerScope = it;
1996 outerScope.pit() = outerScope.lastpit() + 2;
1997 updateMacros(it, outerScope);
2001 void Buffer::updateMacroInstances() const
2003 LYXERR(Debug::MACROS, "updateMacroInstances for "
2004 << d->filename.onlyFileName());
2005 DocIterator it = doc_iterator_begin(this);
2006 DocIterator end = doc_iterator_end(this);
2007 for (; it != end; it.forwardPos()) {
2008 // look for MathData cells in InsetMathNest insets
2009 Inset * inset = it.nextInset();
2013 InsetMath * minset = inset->asInsetMath();
2017 // update macro in all cells of the InsetMathNest
2018 DocIterator::idx_type n = minset->nargs();
2019 MacroContext mc = MacroContext(*this, it);
2020 for (DocIterator::idx_type i = 0; i < n; ++i) {
2021 MathData & data = minset->cell(i);
2022 data.updateMacros(0, mc);
2028 void Buffer::listMacroNames(MacroNameSet & macros) const
2033 d->macro_lock = true;
2035 // loop over macro names
2036 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2037 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2038 for (; nameIt != nameEnd; ++nameIt)
2039 macros.insert(nameIt->first);
2041 // loop over children
2042 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2043 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2044 for (; it != end; ++it)
2045 it->first->listMacroNames(macros);
2048 if (d->parent_buffer)
2049 d->parent_buffer->listMacroNames(macros);
2051 d->macro_lock = false;
2055 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2057 if (!d->parent_buffer)
2061 d->parent_buffer->listMacroNames(names);
2064 MacroNameSet::iterator it = names.begin();
2065 MacroNameSet::iterator end = names.end();
2066 for (; it != end; ++it) {
2068 MacroData const * data =
2069 d->parent_buffer->getMacro(*it, *this, false);
2071 macros.insert(data);
2073 // we cannot access the original MathMacroTemplate anymore
2074 // here to calls validate method. So we do its work here manually.
2075 // FIXME: somehow make the template accessible here.
2076 if (data->optionals() > 0)
2077 features.require("xargs");
2083 Buffer::References & Buffer::references(docstring const & label)
2085 if (d->parent_buffer)
2086 return const_cast<Buffer *>(masterBuffer())->references(label);
2088 RefCache::iterator it = d->ref_cache_.find(label);
2089 if (it != d->ref_cache_.end())
2090 return it->second.second;
2092 static InsetLabel const * dummy_il = 0;
2093 static References const dummy_refs;
2094 it = d->ref_cache_.insert(
2095 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2096 return it->second.second;
2100 Buffer::References const & Buffer::references(docstring const & label) const
2102 return const_cast<Buffer *>(this)->references(label);
2106 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2108 masterBuffer()->d->ref_cache_[label].first = il;
2112 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2114 return masterBuffer()->d->ref_cache_[label].first;
2118 void Buffer::clearReferenceCache() const
2120 if (!d->parent_buffer)
2121 d->ref_cache_.clear();
2125 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2128 //FIXME: This does not work for child documents yet.
2129 LASSERT(code == CITE_CODE, /**/);
2130 // Check if the label 'from' appears more than once
2131 vector<docstring> labels;
2133 BiblioInfo const & keys = masterBibInfo();
2134 BiblioInfo::const_iterator bit = keys.begin();
2135 BiblioInfo::const_iterator bend = keys.end();
2137 for (; bit != bend; ++bit)
2139 labels.push_back(bit->first);
2142 if (count(labels.begin(), labels.end(), from) > 1)
2145 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2146 if (it->lyxCode() == code) {
2147 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2148 docstring const oldValue = inset.getParam(paramName);
2149 if (oldValue == from)
2150 inset.setParam(paramName, to);
2156 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2157 pit_type par_end, bool full_source) const
2159 OutputParams runparams(¶ms().encoding());
2160 runparams.nice = true;
2161 runparams.flavor = OutputParams::LATEX;
2162 runparams.linelen = lyxrc.plaintext_linelen;
2163 // No side effect of file copying and image conversion
2164 runparams.dryrun = true;
2168 os << "% " << _("Preview source code") << "\n\n";
2169 d->texrow.newline();
2170 d->texrow.newline();
2172 writeDocBookSource(os, absFileName(), runparams, false);
2174 // latex or literate
2175 writeLaTeXSource(os, string(), runparams, true, true);
2177 runparams.par_begin = par_begin;
2178 runparams.par_end = par_end;
2179 if (par_begin + 1 == par_end) {
2181 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2185 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2186 convert<docstring>(par_begin),
2187 convert<docstring>(par_end - 1))
2190 d->texrow.newline();
2191 d->texrow.newline();
2192 // output paragraphs
2194 docbookParagraphs(paragraphs(), *this, os, runparams);
2196 // latex or literate
2197 latexParagraphs(*this, text(), os, d->texrow, runparams);
2202 ErrorList & Buffer::errorList(string const & type) const
2204 static ErrorList emptyErrorList;
2205 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2206 if (I == d->errorLists.end())
2207 return emptyErrorList;
2213 void Buffer::updateTocItem(std::string const & type,
2214 DocIterator const & dit) const
2217 gui_->updateTocItem(type, dit);
2221 void Buffer::structureChanged() const
2224 gui_->structureChanged();
2228 void Buffer::errors(string const & err) const
2235 void Buffer::message(docstring const & msg) const
2242 void Buffer::setBusy(bool on) const
2249 void Buffer::setReadOnly(bool on) const
2252 d->wa_->setReadOnly(on);
2256 void Buffer::updateTitles() const
2259 d->wa_->updateTitles();
2263 void Buffer::resetAutosaveTimers() const
2266 gui_->resetAutosaveTimers();
2270 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2279 class AutoSaveBuffer : public ForkedProcess {
2282 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2283 : buffer_(buffer), fname_(fname) {}
2285 virtual boost::shared_ptr<ForkedProcess> clone() const
2287 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2292 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2293 from_utf8(fname_.absFilename())));
2294 return run(DontWait);
2298 virtual int generateChild();
2300 Buffer const & buffer_;
2305 int AutoSaveBuffer::generateChild()
2307 // tmp_ret will be located (usually) in /tmp
2308 // will that be a problem?
2309 // Note that this calls ForkedCalls::fork(), so it's
2310 // ok cross-platform.
2311 pid_t const pid = fork();
2312 // If you want to debug the autosave
2313 // you should set pid to -1, and comment out the fork.
2314 if (pid != 0 && pid != -1)
2317 // pid = -1 signifies that lyx was unable
2318 // to fork. But we will do the save
2320 bool failed = false;
2321 FileName const tmp_ret = FileName::tempName("lyxauto");
2322 if (!tmp_ret.empty()) {
2323 buffer_.writeFile(tmp_ret);
2324 // assume successful write of tmp_ret
2325 if (!tmp_ret.moveTo(fname_))
2331 // failed to write/rename tmp_ret so try writing direct
2332 if (!buffer_.writeFile(fname_)) {
2333 // It is dangerous to do this in the child,
2334 // but safe in the parent, so...
2335 if (pid == -1) // emit message signal.
2336 buffer_.message(_("Autosave failed!"));
2340 if (pid == 0) // we are the child so...
2349 // Perfect target for a thread...
2350 void Buffer::autoSave() const
2352 if (isBakClean() || isReadonly()) {
2353 // We don't save now, but we'll try again later
2354 resetAutosaveTimers();
2358 // emit message signal.
2359 message(_("Autosaving current document..."));
2361 // create autosave filename
2362 string fname = filePath();
2364 fname += d->filename.onlyFileName();
2367 AutoSaveBuffer autosave(*this, FileName(fname));
2371 resetAutosaveTimers();
2375 string Buffer::bufferFormat() const
2381 if (params().encoding().package() == Encoding::japanese)
2387 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2388 string & result_file) const
2390 string backend_format;
2391 OutputParams runparams(¶ms().encoding());
2392 runparams.flavor = OutputParams::LATEX;
2393 runparams.linelen = lyxrc.plaintext_linelen;
2394 vector<string> backs = backends();
2395 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2396 // Get shortest path to format
2397 Graph::EdgePath path;
2398 for (vector<string>::const_iterator it = backs.begin();
2399 it != backs.end(); ++it) {
2400 Graph::EdgePath p = theConverters().getPath(*it, format);
2401 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2402 backend_format = *it;
2407 runparams.flavor = theConverters().getFlavor(path);
2409 Alert::error(_("Couldn't export file"),
2410 bformat(_("No information for exporting the format %1$s."),
2411 formats.prettyName(format)));
2415 backend_format = format;
2416 // FIXME: Don't hardcode format names here, but use a flag
2417 if (backend_format == "pdflatex")
2418 runparams.flavor = OutputParams::PDFLATEX;
2421 string filename = latexName(false);
2422 filename = addName(temppath(), filename);
2423 filename = changeExtension(filename,
2424 formats.extension(backend_format));
2427 updateMacroInstances();
2429 // Plain text backend
2430 if (backend_format == "text")
2431 writePlaintextFile(*this, FileName(filename), runparams);
2433 else if (backend_format == "lyx")
2434 writeFile(FileName(filename));
2436 else if (isDocBook()) {
2437 runparams.nice = !put_in_tempdir;
2438 makeDocBookFile(FileName(filename), runparams);
2441 else if (backend_format == format) {
2442 runparams.nice = true;
2443 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2445 } else if (!lyxrc.tex_allows_spaces
2446 && contains(filePath(), ' ')) {
2447 Alert::error(_("File name error"),
2448 _("The directory path to the document cannot contain spaces."));
2451 runparams.nice = false;
2452 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2456 string const error_type = (format == "program")
2457 ? "Build" : bufferFormat();
2458 ErrorList & error_list = d->errorLists[error_type];
2459 string const ext = formats.extension(format);
2460 FileName const tmp_result_file(changeExtension(filename, ext));
2461 bool const success = theConverters().convert(this, FileName(filename),
2462 tmp_result_file, FileName(absFileName()), backend_format, format,
2464 // Emit the signal to show the error list.
2465 if (format != backend_format)
2470 if (put_in_tempdir) {
2471 result_file = tmp_result_file.absFilename();
2475 result_file = changeExtension(absFileName(), ext);
2476 // We need to copy referenced files (e. g. included graphics
2477 // if format == "dvi") to the result dir.
2478 vector<ExportedFile> const files =
2479 runparams.exportdata->externalFiles(format);
2480 string const dest = onlyPath(result_file);
2481 CopyStatus status = SUCCESS;
2482 for (vector<ExportedFile>::const_iterator it = files.begin();
2483 it != files.end() && status != CANCEL; ++it) {
2484 string const fmt = formats.getFormatFromFile(it->sourceName);
2485 status = copyFile(fmt, it->sourceName,
2486 makeAbsPath(it->exportName, dest),
2487 it->exportName, status == FORCE);
2489 if (status == CANCEL) {
2490 message(_("Document export cancelled."));
2491 } else if (tmp_result_file.exists()) {
2492 // Finally copy the main file
2493 status = copyFile(format, tmp_result_file,
2494 FileName(result_file), result_file,
2496 message(bformat(_("Document exported as %1$s "
2498 formats.prettyName(format),
2499 makeDisplayPath(result_file)));
2501 // This must be a dummy converter like fax (bug 1888)
2502 message(bformat(_("Document exported as %1$s"),
2503 formats.prettyName(format)));
2510 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
2513 return doExport(format, put_in_tempdir, result_file);
2517 bool Buffer::preview(string const & format) const
2520 if (!doExport(format, true, result_file))
2522 return formats.view(*this, FileName(result_file), format);
2526 bool Buffer::isExportable(string const & format) const
2528 vector<string> backs = backends();
2529 for (vector<string>::const_iterator it = backs.begin();
2530 it != backs.end(); ++it)
2531 if (theConverters().isReachable(*it, format))
2537 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
2539 vector<string> backs = backends();
2540 vector<Format const *> result =
2541 theConverters().getReachable(backs[0], only_viewable, true);
2542 for (vector<string>::const_iterator it = backs.begin() + 1;
2543 it != backs.end(); ++it) {
2544 vector<Format const *> r =
2545 theConverters().getReachable(*it, only_viewable, false);
2546 result.insert(result.end(), r.begin(), r.end());
2552 vector<string> Buffer::backends() const
2555 if (params().baseClass()->isTeXClassAvailable()) {
2556 v.push_back(bufferFormat());
2557 // FIXME: Don't hardcode format names here, but use a flag
2558 if (v.back() == "latex")
2559 v.push_back("pdflatex");
2561 v.push_back("text");
2567 bool Buffer::readFileHelper(FileName const & s)
2569 // File information about normal file
2571 docstring const file = makeDisplayPath(s.absFilename(), 50);
2572 docstring text = bformat(_("The specified document\n%1$s"
2573 "\ncould not be read."), file);
2574 Alert::error(_("Could not read document"), text);
2578 // Check if emergency save file exists and is newer.
2579 FileName const e(s.absFilename() + ".emergency");
2581 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
2582 docstring const file = makeDisplayPath(s.absFilename(), 20);
2583 docstring const text =
2584 bformat(_("An emergency save of the document "
2586 "Recover emergency save?"), file);
2587 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
2588 _("&Recover"), _("&Load Original"),
2592 // the file is not saved if we load the emergency file.
2602 // Now check if autosave file is newer.
2603 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
2605 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
2606 docstring const file = makeDisplayPath(s.absFilename(), 20);
2607 docstring const text =
2608 bformat(_("The backup of the document "
2609 "%1$s is newer.\n\nLoad the "
2610 "backup instead?"), file);
2611 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
2612 _("&Load backup"), _("Load &original"),
2616 // the file is not saved if we load the autosave file.
2620 // Here we delete the autosave
2631 bool Buffer::loadLyXFile(FileName const & s)
2633 if (s.isReadableFile()) {
2634 if (readFileHelper(s)) {
2635 lyxvc().file_found_hook(s);
2636 if (!s.isWritable())
2641 docstring const file = makeDisplayPath(s.absFilename(), 20);
2642 // Here we probably should run
2643 if (LyXVC::file_not_found_hook(s)) {
2644 docstring const text =
2645 bformat(_("Do you want to retrieve the document"
2646 " %1$s from version control?"), file);
2647 int const ret = Alert::prompt(_("Retrieve from version control?"),
2648 text, 0, 1, _("&Retrieve"), _("&Cancel"));
2651 // How can we know _how_ to do the checkout?
2652 // With the current VC support it has to be,
2653 // a RCS file since CVS do not have special ,v files.
2655 return loadLyXFile(s);
2663 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
2665 TeXErrors::Errors::const_iterator cit = terr.begin();
2666 TeXErrors::Errors::const_iterator end = terr.end();
2668 for (; cit != end; ++cit) {
2671 int errorRow = cit->error_in_line;
2672 bool found = d->texrow.getIdFromRow(errorRow, id_start,
2678 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
2679 } while (found && id_start == id_end && pos_start == pos_end);
2681 errorList.push_back(ErrorItem(cit->error_desc,
2682 cit->error_text, id_start, pos_start, pos_end));
2687 void Buffer::updateLabels(bool childonly) const
2689 // Use the master text class also for child documents
2690 Buffer const * const master = masterBuffer();
2691 DocumentClass const & textclass = master->params().documentClass();
2693 // keep the buffers to be children in this set. If the call from the
2694 // master comes back we can see which of them were actually seen (i.e.
2695 // via an InsetInclude). The remaining ones in the set need still be updated.
2696 static std::set<Buffer const *> bufToUpdate;
2698 // If this is a child document start with the master
2699 if (master != this) {
2700 bufToUpdate.insert(this);
2701 master->updateLabels(false);
2703 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
2704 if (bufToUpdate.find(this) == bufToUpdate.end())
2708 // start over the counters in the master
2709 textclass.counters().reset();
2712 // update will be done below for this buffer
2713 bufToUpdate.erase(this);
2715 // update all caches
2716 clearReferenceCache();
2717 inset().setBuffer(const_cast<Buffer &>(*this));
2720 Buffer & cbuf = const_cast<Buffer &>(*this);
2722 LASSERT(!text().paragraphs().empty(), /**/);
2725 ParIterator parit = cbuf.par_iterator_begin();
2726 updateLabels(parit);
2729 // TocBackend update will be done later.
2732 cbuf.tocBackend().update();
2734 cbuf.structureChanged();
2738 static depth_type getDepth(DocIterator const & it)
2740 depth_type depth = 0;
2741 for (size_t i = 0 ; i < it.depth() ; ++i)
2742 if (!it[i].inset().inMathed())
2743 depth += it[i].paragraph().getDepth() + 1;
2744 // remove 1 since the outer inset does not count
2748 static depth_type getItemDepth(ParIterator const & it)
2750 Paragraph const & par = *it;
2751 LabelType const labeltype = par.layout().labeltype;
2753 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
2756 // this will hold the lowest depth encountered up to now.
2757 depth_type min_depth = getDepth(it);
2758 ParIterator prev_it = it;
2761 --prev_it.top().pit();
2763 // start of nested inset: go to outer par
2765 if (prev_it.empty()) {
2766 // start of document: nothing to do
2771 // We search for the first paragraph with same label
2772 // that is not more deeply nested.
2773 Paragraph & prev_par = *prev_it;
2774 depth_type const prev_depth = getDepth(prev_it);
2775 if (labeltype == prev_par.layout().labeltype) {
2776 if (prev_depth < min_depth)
2777 return prev_par.itemdepth + 1;
2778 if (prev_depth == min_depth)
2779 return prev_par.itemdepth;
2781 min_depth = min(min_depth, prev_depth);
2782 // small optimization: if we are at depth 0, we won't
2783 // find anything else
2784 if (prev_depth == 0)
2790 static bool needEnumCounterReset(ParIterator const & it)
2792 Paragraph const & par = *it;
2793 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
2794 depth_type const cur_depth = par.getDepth();
2795 ParIterator prev_it = it;
2796 while (prev_it.pit()) {
2797 --prev_it.top().pit();
2798 Paragraph const & prev_par = *prev_it;
2799 if (prev_par.getDepth() <= cur_depth)
2800 return prev_par.layout().labeltype != LABEL_ENUMERATE;
2802 // start of nested inset: reset
2807 // set the label of a paragraph. This includes the counters.
2808 static void setLabel(Buffer const & buf, ParIterator & it)
2810 BufferParams const & bp = buf.masterBuffer()->params();
2811 DocumentClass const & textclass = bp.documentClass();
2812 Paragraph & par = it.paragraph();
2813 Layout const & layout = par.layout();
2814 Counters & counters = textclass.counters();
2816 if (par.params().startOfAppendix()) {
2817 // FIXME: only the counter corresponding to toplevel
2818 // sectionning should be reset
2820 counters.appendix(true);
2822 par.params().appendix(counters.appendix());
2824 // Compute the item depth of the paragraph
2825 par.itemdepth = getItemDepth(it);
2827 if (layout.margintype == MARGIN_MANUAL) {
2828 if (par.params().labelWidthString().empty())
2829 par.params().labelWidthString(par.translateIfPossible(layout.labelstring(), bp));
2831 par.params().labelWidthString(docstring());
2834 switch(layout.labeltype) {
2836 if (layout.toclevel <= bp.secnumdepth
2837 && (layout.latextype != LATEX_ENVIRONMENT
2838 || isFirstInSequence(it.pit(), it.plist()))) {
2839 counters.step(layout.counter);
2840 par.params().labelString(
2841 par.expandLabel(layout, bp));
2843 par.params().labelString(docstring());
2846 case LABEL_ITEMIZE: {
2847 // At some point of time we should do something more
2848 // clever here, like:
2849 // par.params().labelString(
2850 // bp.user_defined_bullet(par.itemdepth).getText());
2851 // for now, use a simple hardcoded label
2852 docstring itemlabel;
2853 switch (par.itemdepth) {
2855 itemlabel = char_type(0x2022);
2858 itemlabel = char_type(0x2013);
2861 itemlabel = char_type(0x2217);
2864 itemlabel = char_type(0x2219); // or 0x00b7
2867 par.params().labelString(itemlabel);
2871 case LABEL_ENUMERATE: {
2872 // FIXME: Yes I know this is a really, really! bad solution
2874 docstring enumcounter = from_ascii("enum");
2876 switch (par.itemdepth) {
2885 enumcounter += "iv";
2888 // not a valid enumdepth...
2892 // Maybe we have to reset the enumeration counter.
2893 if (needEnumCounterReset(it))
2894 counters.reset(enumcounter);
2896 counters.step(enumcounter);
2900 switch (par.itemdepth) {
2902 format = N_("\\arabic{enumi}.");
2905 format = N_("(\\alph{enumii})");
2908 format = N_("\\roman{enumiii}.");
2911 format = N_("\\Alph{enumiv}.");
2914 // not a valid enumdepth...
2918 par.params().labelString(counters.counterLabel(
2919 par.translateIfPossible(from_ascii(format), bp)));
2924 case LABEL_SENSITIVE: {
2925 string const & type = counters.current_float();
2926 docstring full_label;
2928 full_label = buf.B_("Senseless!!! ");
2930 docstring name = buf.B_(textclass.floats().getType(type).name());
2931 if (counters.hasCounter(from_utf8(type))) {
2932 counters.step(from_utf8(type));
2933 full_label = bformat(from_ascii("%1$s %2$s:"),
2935 counters.theCounter(from_utf8(type)));
2937 full_label = bformat(from_ascii("%1$s #:"), name);
2939 par.params().labelString(full_label);
2943 case LABEL_NO_LABEL:
2944 par.params().labelString(docstring());
2948 case LABEL_TOP_ENVIRONMENT:
2949 case LABEL_CENTERED_TOP_ENVIRONMENT:
2952 par.params().labelString(
2953 par.translateIfPossible(layout.labelstring(), bp));
2959 void Buffer::updateLabels(ParIterator & parit) const
2961 LASSERT(parit.pit() == 0, /**/);
2963 // set the position of the text in the buffer to be able
2964 // to resolve macros in it. This has nothing to do with
2965 // labels, but by putting it here we avoid implementing
2966 // a whole bunch of traversal routines just for this call.
2967 parit.text()->setMacrocontextPosition(parit);
2969 depth_type maxdepth = 0;
2970 pit_type const lastpit = parit.lastpit();
2971 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
2972 // reduce depth if necessary
2973 parit->params().depth(min(parit->params().depth(), maxdepth));
2974 maxdepth = parit->getMaxDepthAfter();
2976 // set the counter for this paragraph
2977 setLabel(*this, parit);
2980 InsetList::const_iterator iit = parit->insetList().begin();
2981 InsetList::const_iterator end = parit->insetList().end();
2982 for (; iit != end; ++iit) {
2983 parit.pos() = iit->pos;
2984 iit->inset->updateLabels(parit);