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 "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
48 #include "output_docbook.h"
50 #include "output_latex.h"
51 #include "output_xhtml.h"
52 #include "output_plaintext.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
56 #include "PDFOptions.h"
57 #include "SpellChecker.h"
60 #include "TexStream.h"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibitem.h"
71 #include "insets/InsetBibtex.h"
72 #include "insets/InsetBranch.h"
73 #include "insets/InsetInclude.h"
74 #include "insets/InsetText.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "frontends/alert.h"
81 #include "frontends/Delegates.h"
82 #include "frontends/WorkAreaManager.h"
84 #include "graphics/Previews.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include <boost/bind.hpp>
107 #include <boost/shared_ptr.hpp>
119 using namespace lyx::support;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 // Do not remove the comment below, so we get merge conflict in
129 // independent branches. Instead add your own.
130 int const LYX_FORMAT = 370; // uwestoehr: option to suppress default date
132 typedef map<string, bool> DepClean;
133 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
135 void showPrintError(string const & name)
137 docstring str = bformat(_("Could not print the document %1$s.\n"
138 "Check that your printer is set up correctly."),
139 makeDisplayPath(name, 50));
140 Alert::error(_("Print document failed"), str);
145 class BufferSet : public std::set<Buffer const *> {};
150 Impl(Buffer & parent, FileName const & file, bool readonly);
164 mutable TexRow texrow;
166 /// need to regenerate .tex?
170 mutable bool lyx_clean;
172 /// is autosave needed?
173 mutable bool bak_clean;
175 /// is this a unnamed file (New...)?
181 /// name of the file the buffer is associated with.
184 /** Set to true only when the file is fully loaded.
185 * Used to prevent the premature generation of previews
186 * and by the citation inset.
188 bool file_fully_loaded;
191 mutable TocBackend toc_backend;
194 typedef pair<DocIterator, MacroData> ScopeMacro;
195 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
196 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
197 /// map from the macro name to the position map,
198 /// which maps the macro definition position to the scope and the MacroData.
199 NamePositionScopeMacroMap macros;
202 /// positions of child buffers in the buffer
203 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
204 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
205 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
206 /// position of children buffers in this buffer
207 BufferPositionMap children_positions;
208 /// map from children inclusion positions to their scope and their buffer
209 PositionScopeBufferMap position_to_children;
211 /// Container for all sort of Buffer dependant errors.
212 map<string, ErrorList> errorLists;
214 /// timestamp and checksum used to test if the file has been externally
215 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
217 unsigned long checksum_;
220 frontend::WorkAreaManager * wa_;
225 /// A cache for the bibfiles (including bibfiles of loaded child
226 /// documents), needed for appropriate update of natbib labels.
227 mutable support::FileNameList bibfilesCache_;
229 // FIXME The caching mechanism could be improved. At present, we have a
230 // cache for each Buffer, that caches all the bibliography info for that
231 // Buffer. A more efficient solution would be to have a global cache per
232 // file, and then to construct the Buffer's bibinfo from that.
233 /// A cache for bibliography info
234 mutable BiblioInfo bibinfo_;
235 /// whether the bibinfo cache is valid
236 bool bibinfoCacheValid_;
237 /// Cache of timestamps of .bib files
238 map<FileName, time_t> bibfileStatus_;
240 mutable RefCache ref_cache_;
242 /// our Text that should be wrapped in an InsetText
245 /// This is here to force the test to be done whenever parent_buffer
247 Buffer const * parent() const {
248 // if parent_buffer is not loaded, then it has been unloaded,
249 // which means that parent_buffer is an invalid pointer. So we
250 // set it to null in that case.
251 if (!theBufferList().isLoaded(parent_buffer))
253 return parent_buffer;
256 void setParent(Buffer const * pb) { parent_buffer = pb; }
258 /// So we can force access via the accessors.
259 mutable Buffer const * parent_buffer;
263 /// Creates the per buffer temporary directory
264 static FileName createBufferTmpDir()
267 // We are in our own directory. Why bother to mangle name?
268 // In fact I wrote this code to circumvent a problematic behaviour
269 // (bug?) of EMX mkstemp().
270 FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
271 convert<string>(count++));
273 if (!tmpfl.createDirectory(0777)) {
274 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
275 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
276 from_utf8(tmpfl.absFilename())));
282 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
283 : lyx_clean(true), bak_clean(true), unnamed(false),
284 read_only(readonly_), filename(file), file_fully_loaded(false),
285 toc_backend(&parent), macro_lock(false), timestamp_(0),
286 checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false),
289 temppath = createBufferTmpDir();
290 lyxvc.setBuffer(&parent);
292 wa_ = new frontend::WorkAreaManager;
296 Buffer::Buffer(string const & file, bool readonly)
297 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
299 LYXERR(Debug::INFO, "Buffer::Buffer()");
301 d->inset = new InsetText(*this);
302 d->inset->setAutoBreakRows(true);
303 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
309 LYXERR(Debug::INFO, "Buffer::~Buffer()");
310 // here the buffer should take care that it is
311 // saved properly, before it goes into the void.
313 // GuiView already destroyed
317 // No need to do additional cleanups for internal buffer.
322 // loop over children
323 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
324 Impl::BufferPositionMap::iterator end = d->children_positions.end();
325 for (; it != end; ++it) {
326 Buffer * child = const_cast<Buffer *>(it->first);
327 // The child buffer might have been closed already.
328 if (theBufferList().isLoaded(child))
329 theBufferList().releaseChild(this, child);
333 docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
334 msg += emergencyWrite();
335 frontend::Alert::warning(_("Attempting to close changed document!"), msg);
338 // clear references to children in macro tables
339 d->children_positions.clear();
340 d->position_to_children.clear();
342 if (!d->temppath.destroyDirectory()) {
343 Alert::warning(_("Could not remove temporary directory"),
344 bformat(_("Could not remove the temporary directory %1$s"),
345 from_utf8(d->temppath.absFilename())));
348 // Remove any previewed LaTeX snippets associated with this buffer.
349 thePreviews().removeLoader(*this);
355 void Buffer::changed() const
362 frontend::WorkAreaManager & Buffer::workAreaManager() const
364 LASSERT(d->wa_, /**/);
369 Text & Buffer::text() const
371 return d->inset->text();
375 Inset & Buffer::inset() const
381 BufferParams & Buffer::params()
387 BufferParams const & Buffer::params() const
393 ParagraphList & Buffer::paragraphs()
395 return text().paragraphs();
399 ParagraphList const & Buffer::paragraphs() const
401 return text().paragraphs();
405 LyXVC & Buffer::lyxvc()
411 LyXVC const & Buffer::lyxvc() const
417 string const Buffer::temppath() const
419 return d->temppath.absFilename();
423 TexRow & Buffer::texrow()
429 TexRow const & Buffer::texrow() const
435 TocBackend & Buffer::tocBackend() const
437 return d->toc_backend;
441 Undo & Buffer::undo()
447 string Buffer::latexName(bool const no_path) const
449 FileName latex_name =
450 makeLatexName(exportFileName());
451 return no_path ? latex_name.onlyFileName()
452 : latex_name.absFilename();
456 FileName Buffer::exportFileName() const
458 docstring const branch_suffix =
459 params().branchlist().getFilenameSuffix();
460 if (branch_suffix.empty())
463 string const name = fileName().onlyFileNameWithoutExt()
464 + to_utf8(branch_suffix);
465 FileName res(fileName().onlyPath().absFilename() + "/" + name);
466 res.changeExtension(fileName().extension());
472 string Buffer::logName(LogType * type) const
474 string const filename = latexName(false);
476 if (filename.empty()) {
482 string const path = temppath();
484 FileName const fname(addName(temppath(),
485 onlyFilename(changeExtension(filename,
488 // FIXME: how do we know this is the name of the build log?
489 FileName const bname(
490 addName(path, onlyFilename(
491 changeExtension(filename,
492 formats.extension(bufferFormat()) + ".out"))));
494 // Also consider the master buffer log file
495 FileName masterfname = fname;
497 if (masterBuffer() != this) {
498 string const mlogfile = masterBuffer()->logName(&mtype);
499 masterfname = FileName(mlogfile);
502 // If no Latex log or Build log is newer, show Build log
503 if (bname.exists() &&
504 ((!fname.exists() && !masterfname.exists())
505 || (fname.lastModified() < bname.lastModified()
506 && masterfname.lastModified() < bname.lastModified()))) {
507 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
510 return bname.absFilename();
511 // If we have a newer master file log or only a master log, show this
512 } else if (fname != masterfname
513 && (!fname.exists() && (masterfname.exists()
514 || fname.lastModified() < masterfname.lastModified()))) {
515 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
518 return masterfname.absFilename();
520 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
523 return fname.absFilename();
527 void Buffer::setReadonly(bool const flag)
529 if (d->read_only != flag) {
536 void Buffer::setFileName(string const & newfile)
538 d->filename = makeAbsPath(newfile);
539 setReadonly(d->filename.isReadOnly());
544 int Buffer::readHeader(Lexer & lex)
546 int unknown_tokens = 0;
548 int begin_header_line = -1;
550 // Initialize parameters that may be/go lacking in header:
551 params().branchlist().clear();
552 params().preamble.erase();
553 params().options.erase();
554 params().master.erase();
555 params().float_placement.erase();
556 params().paperwidth.erase();
557 params().paperheight.erase();
558 params().leftmargin.erase();
559 params().rightmargin.erase();
560 params().topmargin.erase();
561 params().bottommargin.erase();
562 params().headheight.erase();
563 params().headsep.erase();
564 params().footskip.erase();
565 params().columnsep.erase();
566 params().fontsCJK.erase();
567 params().listings_params.clear();
568 params().clearLayoutModules();
569 params().clearRemovedModules();
570 params().pdfoptions().clear();
571 params().indiceslist().clear();
572 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
574 for (int i = 0; i < 4; ++i) {
575 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
576 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
579 ErrorList & errorList = d->errorLists["Parse"];
588 if (token == "\\end_header")
592 if (token == "\\begin_header") {
593 begin_header_line = line;
597 LYXERR(Debug::PARSER, "Handling document header token: `"
600 string unknown = params().readToken(lex, token, d->filename.onlyPath());
601 if (!unknown.empty()) {
602 if (unknown[0] != '\\' && token == "\\textclass") {
603 Alert::warning(_("Unknown document class"),
604 bformat(_("Using the default document class, because the "
605 "class %1$s is unknown."), from_utf8(unknown)));
608 docstring const s = bformat(_("Unknown token: "
612 errorList.push_back(ErrorItem(_("Document header error"),
617 if (begin_header_line) {
618 docstring const s = _("\\begin_header is missing");
619 errorList.push_back(ErrorItem(_("Document header error"),
623 params().makeDocumentClass();
625 return unknown_tokens;
630 // changed to be public and have one parameter
631 // Returns true if "\end_document" is not read (Asger)
632 bool Buffer::readDocument(Lexer & lex)
634 ErrorList & errorList = d->errorLists["Parse"];
637 if (!lex.checkFor("\\begin_document")) {
638 docstring const s = _("\\begin_document is missing");
639 errorList.push_back(ErrorItem(_("Document header error"),
643 // we are reading in a brand new document
644 LASSERT(paragraphs().empty(), /**/);
648 if (params().outputChanges) {
649 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
650 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
651 LaTeXFeatures::isAvailable("xcolor");
653 if (!dvipost && !xcolorulem) {
654 Alert::warning(_("Changes not shown in LaTeX output"),
655 _("Changes will not be highlighted in LaTeX output, "
656 "because neither dvipost nor xcolor/ulem are installed.\n"
657 "Please install these packages or redefine "
658 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
659 } else if (!xcolorulem) {
660 Alert::warning(_("Changes not shown in LaTeX output"),
661 _("Changes will not be highlighted in LaTeX output "
662 "when using pdflatex, because xcolor and ulem are not installed.\n"
663 "Please install both packages or redefine "
664 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
668 if (!params().master.empty()) {
669 FileName const master_file = makeAbsPath(params().master,
670 onlyPath(absFileName()));
671 if (isLyXFilename(master_file.absFilename())) {
673 checkAndLoadLyXFile(master_file, true);
675 // necessary e.g. after a reload
676 // to re-register the child (bug 5873)
677 // FIXME: clean up updateMacros (here, only
678 // child registering is needed).
679 master->updateMacros();
680 // set master as master buffer, but only
681 // if we are a real child
682 if (master->isChild(this))
684 // if the master is not fully loaded
685 // it is probably just loading this
686 // child. No warning needed then.
687 else if (master->isFullyLoaded())
688 LYXERR0("The master '"
690 << "' assigned to this document ("
692 << ") does not include "
693 "this document. Ignoring the master assignment.");
698 // assure we have a default index
699 params().indiceslist().addDefault(B_("Index"));
702 bool const res = text().read(lex, errorList, d->inset);
705 updateMacroInstances();
710 bool Buffer::readString(string const & s)
712 params().compressed = false;
714 // remove dummy empty par
715 paragraphs().clear();
719 FileName const name = FileName::tempName("Buffer_readString");
720 switch (readFile(lex, name, true)) {
724 // We need to call lyx2lyx, so write the input to a file
725 ofstream os(name.toFilesystemEncoding().c_str());
728 return readFile(name);
738 bool Buffer::readFile(FileName const & filename)
740 FileName fname(filename);
742 params().compressed = fname.isZippedFile();
744 // remove dummy empty par
745 paragraphs().clear();
748 if (readFile(lex, fname) != success)
755 bool Buffer::isFullyLoaded() const
757 return d->file_fully_loaded;
761 void Buffer::setFullyLoaded(bool value)
763 d->file_fully_loaded = value;
767 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
770 LASSERT(!filename.empty(), /**/);
772 // the first (non-comment) token _must_ be...
773 if (!lex.checkFor("\\lyxformat")) {
774 Alert::error(_("Document format failure"),
775 bformat(_("%1$s is not a readable LyX document."),
776 from_utf8(filename.absFilename())));
782 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
783 // if present remove ".," from string.
784 size_t dot = tmp_format.find_first_of(".,");
785 //lyxerr << " dot found at " << dot << endl;
786 if (dot != string::npos)
787 tmp_format.erase(dot, 1);
788 int const file_format = convert<int>(tmp_format);
789 //lyxerr << "format: " << file_format << endl;
791 // save timestamp and checksum of the original disk file, making sure
792 // to not overwrite them with those of the file created in the tempdir
793 // when it has to be converted to the current format.
795 // Save the timestamp and checksum of disk file. If filename is an
796 // emergency file, save the timestamp and checksum of the original lyx file
797 // because isExternallyModified will check for this file. (BUG4193)
798 string diskfile = filename.absFilename();
799 if (suffixIs(diskfile, ".emergency"))
800 diskfile = diskfile.substr(0, diskfile.size() - 10);
801 saveCheckSum(FileName(diskfile));
804 if (file_format != LYX_FORMAT) {
807 // lyx2lyx would fail
810 FileName const tmpfile = FileName::tempName("Buffer_readFile");
811 if (tmpfile.empty()) {
812 Alert::error(_("Conversion failed"),
813 bformat(_("%1$s is from a different"
814 " version of LyX, but a temporary"
815 " file for converting it could"
817 from_utf8(filename.absFilename())));
820 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
821 if (lyx2lyx.empty()) {
822 Alert::error(_("Conversion script not found"),
823 bformat(_("%1$s is from a different"
824 " version of LyX, but the"
825 " conversion script lyx2lyx"
826 " could not be found."),
827 from_utf8(filename.absFilename())));
830 ostringstream command;
831 command << os::python()
832 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
833 << " -t " << convert<string>(LYX_FORMAT)
834 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
835 << ' ' << quoteName(filename.toFilesystemEncoding());
836 string const command_str = command.str();
838 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
840 cmd_ret const ret = runCommand(command_str);
841 if (ret.first != 0) {
842 Alert::error(_("Conversion script failed"),
843 bformat(_("%1$s is from a different version"
844 " of LyX, but the lyx2lyx script"
845 " failed to convert it."),
846 from_utf8(filename.absFilename())));
849 bool const ret = readFile(tmpfile);
850 // Do stuff with tmpfile name and buffer name here.
851 return ret ? success : failure;
856 if (readDocument(lex)) {
857 Alert::error(_("Document format failure"),
858 bformat(_("%1$s ended unexpectedly, which means"
859 " that it is probably corrupted."),
860 from_utf8(filename.absFilename())));
863 d->file_fully_loaded = true;
868 // Should probably be moved to somewhere else: BufferView? LyXView?
869 bool Buffer::save() const
871 // We don't need autosaves in the immediate future. (Asger)
872 resetAutosaveTimers();
874 string const encodedFilename = d->filename.toFilesystemEncoding();
877 bool madeBackup = false;
879 // make a backup if the file already exists
880 if (lyxrc.make_backup && fileName().exists()) {
881 backupName = FileName(absFileName() + '~');
882 if (!lyxrc.backupdir_path.empty()) {
883 string const mangledName =
884 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
885 backupName = FileName(addName(lyxrc.backupdir_path,
888 if (fileName().copyTo(backupName)) {
891 Alert::error(_("Backup failure"),
892 bformat(_("Cannot create backup file %1$s.\n"
893 "Please check whether the directory exists and is writeable."),
894 from_utf8(backupName.absFilename())));
895 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
899 // ask if the disk file has been externally modified (use checksum method)
900 if (fileName().exists() && isExternallyModified(checksum_method)) {
901 docstring const file = makeDisplayPath(absFileName(), 20);
902 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
903 "you want to overwrite this file?"), file);
904 int const ret = Alert::prompt(_("Overwrite modified file?"),
905 text, 1, 1, _("&Overwrite"), _("&Cancel"));
910 if (writeFile(d->filename)) {
914 // Saving failed, so backup is not backup
916 backupName.moveTo(d->filename);
922 bool Buffer::writeFile(FileName const & fname) const
924 if (d->read_only && fname == d->filename)
929 docstring const str = bformat(_("Saving document %1$s..."),
930 makeDisplayPath(fname.absFilename()));
933 if (params().compressed) {
934 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
935 retval = ofs && write(ofs);
937 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
938 retval = ofs && write(ofs);
942 message(str + _(" could not write file!"));
946 removeAutosaveFile();
948 saveCheckSum(d->filename);
949 message(str + _(" done."));
955 docstring Buffer::emergencyWrite()
957 // No need to save if the buffer has not changed.
961 string const doc = isUnnamed() ? onlyFilename(absFileName()) : absFileName();
963 docstring user_message = bformat(
964 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
966 // We try to save three places:
967 // 1) Same place as document. Unless it is an unnamed doc.
969 string s = absFileName();
972 if (writeFile(FileName(s))) {
974 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
977 user_message += _(" Save failed! Trying again...\n");
981 // 2) In HOME directory.
982 string s = addName(package().home_dir().absFilename(), absFileName());
984 lyxerr << ' ' << s << endl;
985 if (writeFile(FileName(s))) {
987 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
991 user_message += _(" Save failed! Trying yet again...\n");
993 // 3) In "/tmp" directory.
994 // MakeAbsPath to prepend the current
995 // drive letter on OS/2
996 s = addName(package().temp_dir().absFilename(), absFileName());
998 lyxerr << ' ' << s << endl;
999 if (writeFile(FileName(s))) {
1001 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1002 return user_message;
1005 user_message += _(" Save failed! Bummer. Document is lost.");
1008 return user_message;
1012 bool Buffer::write(ostream & ofs) const
1015 // Use the standard "C" locale for file output.
1016 ofs.imbue(locale::classic());
1019 // The top of the file should not be written by params().
1021 // write out a comment in the top of the file
1022 ofs << "#LyX " << lyx_version
1023 << " created this file. For more info see http://www.lyx.org/\n"
1024 << "\\lyxformat " << LYX_FORMAT << "\n"
1025 << "\\begin_document\n";
1027 /// For each author, set 'used' to true if there is a change
1028 /// by this author in the document; otherwise set it to 'false'.
1029 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1030 AuthorList::Authors::const_iterator a_end = params().authors().end();
1031 for (; a_it != a_end; ++a_it)
1032 a_it->setUsed(false);
1034 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1035 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1036 for ( ; it != end; ++it)
1037 it->checkAuthors(params().authors());
1039 // now write out the buffer parameters.
1040 ofs << "\\begin_header\n";
1041 params().writeFile(ofs);
1042 ofs << "\\end_header\n";
1045 ofs << "\n\\begin_body\n";
1047 ofs << "\n\\end_body\n";
1049 // Write marker that shows file is complete
1050 ofs << "\\end_document" << endl;
1052 // Shouldn't really be needed....
1055 // how to check if close went ok?
1056 // Following is an attempt... (BE 20001011)
1058 // good() returns false if any error occured, including some
1059 // formatting error.
1060 // bad() returns true if something bad happened in the buffer,
1061 // which should include file system full errors.
1066 lyxerr << "File was not closed properly." << endl;
1073 bool Buffer::makeLaTeXFile(FileName const & fname,
1074 string const & original_path,
1075 OutputParams const & runparams_in,
1076 bool output_preamble, bool output_body) const
1078 OutputParams runparams = runparams_in;
1079 if (params().useXetex)
1080 runparams.flavor = OutputParams::XETEX;
1082 string const encoding = runparams.encoding->iconvName();
1083 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1086 try { ofs.reset(encoding); }
1087 catch (iconv_codecvt_facet_exception & e) {
1088 lyxerr << "Caught iconv exception: " << e.what() << endl;
1089 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1090 "verify that the support software for your encoding (%1$s) is "
1091 "properly installed"), from_ascii(encoding)));
1094 if (!openFileWrite(ofs, fname))
1097 //TexStream ts(ofs.rdbuf(), &texrow());
1098 ErrorList & errorList = d->errorLists["Export"];
1100 bool failed_export = false;
1103 writeLaTeXSource(ofs, original_path,
1104 runparams, output_preamble, output_body);
1106 catch (EncodingException & e) {
1107 odocstringstream ods;
1108 ods.put(e.failed_char);
1110 oss << "0x" << hex << e.failed_char << dec;
1111 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1112 " (code point %2$s)"),
1113 ods.str(), from_utf8(oss.str()));
1114 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1115 "representable in the chosen encoding.\n"
1116 "Changing the document encoding to utf8 could help."),
1117 e.par_id, e.pos, e.pos + 1));
1118 failed_export = true;
1120 catch (iconv_codecvt_facet_exception & e) {
1121 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1122 _(e.what()), -1, 0, 0));
1123 failed_export = true;
1125 catch (exception const & e) {
1126 errorList.push_back(ErrorItem(_("conversion failed"),
1127 _(e.what()), -1, 0, 0));
1128 failed_export = true;
1131 lyxerr << "Caught some really weird exception..." << endl;
1137 failed_export = true;
1138 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1142 return !failed_export;
1146 void Buffer::writeLaTeXSource(odocstream & os,
1147 string const & original_path,
1148 OutputParams const & runparams_in,
1149 bool const output_preamble, bool const output_body) const
1151 // The child documents, if any, shall be already loaded at this point.
1153 OutputParams runparams = runparams_in;
1155 // Classify the unicode characters appearing in math insets
1156 Encodings::initUnicodeMath(*this);
1158 // validate the buffer.
1159 LYXERR(Debug::LATEX, " Validating buffer...");
1160 LaTeXFeatures features(*this, params(), runparams);
1162 LYXERR(Debug::LATEX, " Buffer validation done.");
1164 // The starting paragraph of the coming rows is the
1165 // first paragraph of the document. (Asger)
1166 if (output_preamble && runparams.nice) {
1167 os << "%% LyX " << lyx_version << " created this file. "
1168 "For more info, see http://www.lyx.org/.\n"
1169 "%% Do not edit unless you really know what "
1171 d->texrow.newline();
1172 d->texrow.newline();
1174 LYXERR(Debug::INFO, "lyx document header finished");
1176 // Don't move this behind the parent_buffer=0 code below,
1177 // because then the macros will not get the right "redefinition"
1178 // flag as they don't see the parent macros which are output before.
1181 // fold macros if possible, still with parent buffer as the
1182 // macros will be put in the prefix anyway.
1183 updateMacroInstances();
1185 // There are a few differences between nice LaTeX and usual files:
1186 // usual is \batchmode and has a
1187 // special input@path to allow the including of figures
1188 // with either \input or \includegraphics (what figinsets do).
1189 // input@path is set when the actual parameter
1190 // original_path is set. This is done for usual tex-file, but not
1191 // for nice-latex-file. (Matthias 250696)
1192 // Note that input@path is only needed for something the user does
1193 // in the preamble, included .tex files or ERT, files included by
1194 // LyX work without it.
1195 if (output_preamble) {
1196 if (!runparams.nice) {
1197 // code for usual, NOT nice-latex-file
1198 os << "\\batchmode\n"; // changed
1199 // from \nonstopmode
1200 d->texrow.newline();
1202 if (!original_path.empty()) {
1204 // We don't know the encoding of inputpath
1205 docstring const inputpath = from_utf8(latex_path(original_path));
1206 os << "\\makeatletter\n"
1207 << "\\def\\input@path{{"
1208 << inputpath << "/}}\n"
1209 << "\\makeatother\n";
1210 d->texrow.newline();
1211 d->texrow.newline();
1212 d->texrow.newline();
1215 // get parent macros (if this buffer has a parent) which will be
1216 // written at the document begin further down.
1217 MacroSet parentMacros;
1218 listParentMacros(parentMacros, features);
1220 // Write the preamble
1221 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1223 runparams.use_japanese = features.isRequired("japanese");
1229 os << "\\begin{document}\n";
1230 d->texrow.newline();
1232 // output the parent macros
1233 MacroSet::iterator it = parentMacros.begin();
1234 MacroSet::iterator end = parentMacros.end();
1235 for (; it != end; ++it)
1236 (*it)->write(os, true);
1237 } // output_preamble
1239 d->texrow.start(paragraphs().begin()->id(), 0);
1241 LYXERR(Debug::INFO, "preamble finished, now the body.");
1243 // if we are doing a real file with body, even if this is the
1244 // child of some other buffer, let's cut the link here.
1245 // This happens for example if only a child document is printed.
1246 Buffer const * save_parent = 0;
1247 if (output_preamble) {
1248 save_parent = d->parent();
1253 latexParagraphs(*this, text(), os, d->texrow, runparams);
1255 // Restore the parenthood if needed
1256 if (output_preamble)
1257 d->setParent(save_parent);
1259 // add this just in case after all the paragraphs
1261 d->texrow.newline();
1263 if (output_preamble) {
1264 os << "\\end{document}\n";
1265 d->texrow.newline();
1266 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1268 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1270 runparams_in.encoding = runparams.encoding;
1272 // Just to be sure. (Asger)
1273 d->texrow.newline();
1275 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1276 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1280 bool Buffer::isLatex() const
1282 return params().documentClass().outputType() == LATEX;
1286 bool Buffer::isLiterate() const
1288 return params().documentClass().outputType() == LITERATE;
1292 bool Buffer::isDocBook() const
1294 return params().documentClass().outputType() == DOCBOOK;
1298 void Buffer::makeDocBookFile(FileName const & fname,
1299 OutputParams const & runparams,
1300 bool const body_only) const
1302 LYXERR(Debug::LATEX, "makeDocBookFile...");
1305 if (!openFileWrite(ofs, fname))
1308 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1312 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1316 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1317 OutputParams const & runparams,
1318 bool const only_body) const
1320 LaTeXFeatures features(*this, params(), runparams);
1325 DocumentClass const & tclass = params().documentClass();
1326 string const top_element = tclass.latexname();
1329 if (runparams.flavor == OutputParams::XML)
1330 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1333 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1336 if (! tclass.class_header().empty())
1337 os << from_ascii(tclass.class_header());
1338 else if (runparams.flavor == OutputParams::XML)
1339 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1340 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1342 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1344 docstring preamble = from_utf8(params().preamble);
1345 if (runparams.flavor != OutputParams::XML ) {
1346 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1347 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1348 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1349 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1352 string const name = runparams.nice
1353 ? changeExtension(absFileName(), ".sgml") : fname;
1354 preamble += features.getIncludedFiles(name);
1355 preamble += features.getLyXSGMLEntities();
1357 if (!preamble.empty()) {
1358 os << "\n [ " << preamble << " ]";
1363 string top = top_element;
1365 if (runparams.flavor == OutputParams::XML)
1366 top += params().language->code();
1368 top += params().language->code().substr(0, 2);
1371 if (!params().options.empty()) {
1373 top += params().options;
1376 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1377 << " file was created by LyX " << lyx_version
1378 << "\n See http://www.lyx.org/ for more information -->\n";
1380 params().documentClass().counters().reset();
1384 sgml::openTag(os, top);
1386 docbookParagraphs(text(), *this, os, runparams);
1387 sgml::closeTag(os, top_element);
1391 void Buffer::makeLyXHTMLFile(FileName const & fname,
1392 OutputParams const & runparams,
1393 bool const body_only) const
1395 LYXERR(Debug::LATEX, "makeLyXHTMLFile...");
1398 if (!openFileWrite(ofs, fname))
1401 writeLyXHTMLSource(ofs, runparams, body_only);
1405 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1409 void Buffer::writeLyXHTMLSource(odocstream & os,
1410 OutputParams const & runparams,
1411 bool const only_body) const
1413 LaTeXFeatures features(*this, params(), runparams);
1419 os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" <<
1420 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
1421 // FIXME Language should be set properly.
1422 os << "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n";
1425 // FIXME Presumably need to set this right
1426 os << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1427 // FIXME Get this during validation? What about other meta-data?
1428 os << "<title>TBA</title>\n";
1430 os << features.getTClassHTMLPreamble();
1434 docstring const styleinfo = features.getTClassHTMLStyles();
1435 if (!styleinfo.empty()) {
1436 os << "<style type='text/css'>\n";
1440 os << "</head>\n<body>\n";
1443 params().documentClass().counters().reset();
1444 xhtmlParagraphs(text(), *this, os, runparams);
1446 os << "</body>\n</html>\n";
1450 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1451 // Other flags: -wall -v0 -x
1452 int Buffer::runChktex()
1456 // get LaTeX-Filename
1457 FileName const path(temppath());
1458 string const name = addName(path.absFilename(), latexName());
1459 string const org_path = filePath();
1461 PathChanger p(path); // path to LaTeX file
1462 message(_("Running chktex..."));
1464 // Generate the LaTeX file if neccessary
1465 OutputParams runparams(¶ms().encoding());
1466 runparams.flavor = OutputParams::LATEX;
1467 runparams.nice = false;
1468 makeLaTeXFile(FileName(name), org_path, runparams);
1471 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1472 int const res = chktex.run(terr); // run chktex
1475 Alert::error(_("chktex failure"),
1476 _("Could not run chktex successfully."));
1477 } else if (res > 0) {
1478 ErrorList & errlist = d->errorLists["ChkTeX"];
1480 bufferErrors(terr, errlist);
1491 void Buffer::validate(LaTeXFeatures & features) const
1493 params().validate(features);
1497 for_each(paragraphs().begin(), paragraphs().end(),
1498 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1500 if (lyxerr.debugging(Debug::LATEX)) {
1501 features.showStruct();
1506 void Buffer::getLabelList(vector<docstring> & list) const
1508 // If this is a child document, use the parent's list instead.
1509 Buffer const * const pbuf = d->parent();
1511 pbuf->getLabelList(list);
1516 Toc & toc = d->toc_backend.toc("label");
1517 TocIterator toc_it = toc.begin();
1518 TocIterator end = toc.end();
1519 for (; toc_it != end; ++toc_it) {
1520 if (toc_it->depth() == 0)
1521 list.push_back(toc_it->str());
1526 void Buffer::updateBibfilesCache(UpdateScope scope) const
1528 // If this is a child document, use the parent's cache instead.
1529 Buffer const * const pbuf = d->parent();
1530 if (pbuf && scope != UpdateChildOnly) {
1531 pbuf->updateBibfilesCache();
1535 d->bibfilesCache_.clear();
1536 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1537 if (it->lyxCode() == BIBTEX_CODE) {
1538 InsetBibtex const & inset =
1539 static_cast<InsetBibtex const &>(*it);
1540 support::FileNameList const bibfiles = inset.getBibFiles();
1541 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1544 } else if (it->lyxCode() == INCLUDE_CODE) {
1545 InsetInclude & inset =
1546 static_cast<InsetInclude &>(*it);
1547 inset.updateBibfilesCache();
1548 support::FileNameList const & bibfiles =
1549 inset.getBibfilesCache();
1550 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1555 // the bibinfo cache is now invalid
1556 d->bibinfoCacheValid_ = false;
1560 void Buffer::invalidateBibinfoCache()
1562 d->bibinfoCacheValid_ = false;
1566 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1568 // If this is a child document, use the parent's cache instead.
1569 Buffer const * const pbuf = d->parent();
1570 if (pbuf && scope != UpdateChildOnly)
1571 return pbuf->getBibfilesCache();
1573 // We update the cache when first used instead of at loading time.
1574 if (d->bibfilesCache_.empty())
1575 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1577 return d->bibfilesCache_;
1581 BiblioInfo const & Buffer::masterBibInfo() const
1583 // if this is a child document and the parent is already loaded
1584 // use the parent's list instead [ale990412]
1585 Buffer const * const tmp = masterBuffer();
1588 return tmp->masterBibInfo();
1589 return localBibInfo();
1593 BiblioInfo const & Buffer::localBibInfo() const
1595 if (d->bibinfoCacheValid_) {
1596 support::FileNameList const & bibfilesCache = getBibfilesCache();
1597 // compare the cached timestamps with the actual ones.
1598 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1599 support::FileNameList::const_iterator en = bibfilesCache.end();
1600 for (; ei != en; ++ ei) {
1601 time_t lastw = ei->lastModified();
1602 if (lastw != d->bibfileStatus_[*ei]) {
1603 d->bibinfoCacheValid_ = false;
1604 d->bibfileStatus_[*ei] = lastw;
1610 if (!d->bibinfoCacheValid_) {
1611 d->bibinfo_.clear();
1612 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1613 it->fillWithBibKeys(d->bibinfo_, it);
1614 d->bibinfoCacheValid_ = true;
1620 bool Buffer::isDepClean(string const & name) const
1622 DepClean::const_iterator const it = d->dep_clean.find(name);
1623 if (it == d->dep_clean.end())
1629 void Buffer::markDepClean(string const & name)
1631 d->dep_clean[name] = true;
1635 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1638 // FIXME? if there is an Buffer LFUN that can be dispatched even
1639 // if internal, put a switch '(cmd.action)' here.
1645 switch (cmd.action) {
1647 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1648 flag.setOnOff(isReadonly());
1651 // FIXME: There is need for a command-line import.
1652 //case LFUN_BUFFER_IMPORT:
1654 case LFUN_BUFFER_AUTO_SAVE:
1657 case LFUN_BUFFER_EXPORT_CUSTOM:
1658 // FIXME: Nothing to check here?
1661 case LFUN_BUFFER_EXPORT: {
1662 docstring const arg = cmd.argument();
1663 enable = arg == "custom" || isExportable(to_utf8(arg));
1665 flag.message(bformat(
1666 _("Don't know how to export to format: %1$s"), arg));
1670 case LFUN_MASTER_BUFFER_UPDATE:
1671 case LFUN_MASTER_BUFFER_VIEW:
1672 enable = parent() != 0;
1674 case LFUN_BUFFER_UPDATE:
1675 case LFUN_BUFFER_VIEW: {
1676 string format = to_utf8(cmd.argument());
1677 if (cmd.argument().empty())
1678 format = getDefaultOutputFormat();
1679 typedef vector<Format const *> Formats;
1681 formats = exportableFormats(true);
1682 Formats::const_iterator fit = formats.begin();
1683 Formats::const_iterator end = formats.end();
1685 for (; fit != end ; ++fit) {
1686 if ((*fit)->name() == format)
1691 case LFUN_BUFFER_CHKTEX:
1692 enable = isLatex() && !lyxrc.chktex_command.empty();
1695 case LFUN_BUILD_PROGRAM:
1696 enable = isExportable("program");
1699 case LFUN_BRANCH_ACTIVATE:
1700 case LFUN_BRANCH_DEACTIVATE: {
1701 BranchList const & branchList = params().branchlist();
1702 docstring const branchName = cmd.argument();
1703 enable = !branchName.empty() && branchList.find(branchName);
1707 case LFUN_BRANCH_ADD:
1708 case LFUN_BRANCHES_RENAME:
1709 case LFUN_BUFFER_PRINT:
1710 // if no Buffer is present, then of course we won't be called!
1713 case LFUN_BUFFER_LANGUAGE:
1714 enable = !isReadonly();
1720 flag.setEnabled(enable);
1725 void Buffer::dispatch(string const & command, DispatchResult & result)
1727 return dispatch(lyxaction.lookupFunc(command), result);
1731 // NOTE We can end up here even if we have no GUI, because we are called
1732 // by LyX::exec to handled command-line requests. So we may need to check
1733 // whether we have a GUI or not. The boolean use_gui holds this information.
1734 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1737 // FIXME? if there is an Buffer LFUN that can be dispatched even
1738 // if internal, put a switch '(cmd.action)' here.
1739 dr.dispatched(false);
1742 string const argument = to_utf8(func.argument());
1743 // We'll set this back to false if need be.
1744 bool dispatched = true;
1745 undo().beginUndoGroup();
1747 switch (func.action) {
1748 case LFUN_BUFFER_TOGGLE_READ_ONLY:
1749 if (lyxvc().inUse())
1750 lyxvc().toggleReadOnly();
1752 setReadonly(!isReadonly());
1755 case LFUN_BUFFER_EXPORT: {
1756 if (argument == "custom") {
1757 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
1760 doExport(argument, false);
1761 bool success = doExport(argument, false);
1762 dr.setError(success);
1764 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1769 case LFUN_BUFFER_UPDATE: {
1770 string format = argument;
1771 if (argument.empty())
1772 format = getDefaultOutputFormat();
1773 doExport(format, true);
1777 case LFUN_BUFFER_VIEW: {
1778 string format = argument;
1779 if (argument.empty())
1780 format = getDefaultOutputFormat();
1785 case LFUN_MASTER_BUFFER_UPDATE: {
1786 string format = argument;
1787 if (argument.empty())
1788 format = masterBuffer()->getDefaultOutputFormat();
1789 masterBuffer()->doExport(format, true);
1793 case LFUN_MASTER_BUFFER_VIEW: {
1794 string format = argument;
1795 if (argument.empty())
1796 format = masterBuffer()->getDefaultOutputFormat();
1797 masterBuffer()->preview(format);
1801 case LFUN_BUILD_PROGRAM:
1802 doExport("program", true);
1805 case LFUN_BUFFER_CHKTEX:
1809 case LFUN_BUFFER_EXPORT_CUSTOM: {
1811 string command = split(argument, format_name, ' ');
1812 Format const * format = formats.getFormat(format_name);
1814 lyxerr << "Format \"" << format_name
1815 << "\" not recognized!"
1820 // The name of the file created by the conversion process
1823 // Output to filename
1824 if (format->name() == "lyx") {
1825 string const latexname = latexName(false);
1826 filename = changeExtension(latexname,
1827 format->extension());
1828 filename = addName(temppath(), filename);
1830 if (!writeFile(FileName(filename)))
1834 doExport(format_name, true, filename);
1837 // Substitute $$FName for filename
1838 if (!contains(command, "$$FName"))
1839 command = "( " + command + " ) < $$FName";
1840 command = subst(command, "$$FName", filename);
1842 // Execute the command in the background
1844 call.startscript(Systemcall::DontWait, command);
1848 // FIXME: There is need for a command-line import.
1850 case LFUN_BUFFER_IMPORT:
1855 case LFUN_BUFFER_AUTO_SAVE:
1859 case LFUN_BRANCH_ADD: {
1860 docstring const branch_name = func.argument();
1861 if (branch_name.empty()) {
1865 BranchList & branch_list = params().branchlist();
1866 Branch * branch = branch_list.find(branch_name);
1868 LYXERR0("Branch " << branch_name << " already exists.");
1870 docstring const msg =
1871 bformat(_("Branch \"%1$s\" already exists."), branch_name);
1874 branch_list.add(branch_name);
1875 branch = branch_list.find(branch_name);
1876 string const x11hexname = X11hexname(branch->color());
1877 docstring const str = branch_name + ' ' + from_ascii(x11hexname);
1878 lyx::dispatch(FuncRequest(LFUN_SET_COLOR, str));
1880 dr.update(Update::Force);
1885 case LFUN_BRANCH_ACTIVATE:
1886 case LFUN_BRANCH_DEACTIVATE: {
1887 BranchList & branchList = params().branchlist();
1888 docstring const branchName = func.argument();
1889 // the case without a branch name is handled elsewhere
1890 if (branchName.empty()) {
1894 Branch * branch = branchList.find(branchName);
1896 LYXERR0("Branch " << branchName << " does not exist.");
1898 docstring const msg =
1899 bformat(_("Branch \"%1$s\" does not exist."), branchName);
1902 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1904 dr.update(Update::Force);
1909 case LFUN_BRANCHES_RENAME: {
1910 if (func.argument().empty())
1913 docstring const oldname = from_utf8(func.getArg(0));
1914 docstring const newname = from_utf8(func.getArg(1));
1915 InsetIterator it = inset_iterator_begin(inset());
1916 InsetIterator const end = inset_iterator_end(inset());
1917 bool success = false;
1918 for (; it != end; ++it) {
1919 if (it->lyxCode() == BRANCH_CODE) {
1920 InsetBranch & ins = static_cast<InsetBranch &>(*it);
1921 if (ins.branch() == oldname) {
1922 undo().recordUndo(it);
1923 ins.rename(newname);
1928 if (it->lyxCode() == INCLUDE_CODE) {
1929 // get buffer of external file
1930 InsetInclude const & ins =
1931 static_cast<InsetInclude const &>(*it);
1932 Buffer * child = ins.getChildBuffer();
1935 child->dispatch(func, dr);
1940 dr.update(Update::Force);
1944 case LFUN_BUFFER_PRINT: {
1945 // we'll assume there's a problem until we succeed
1947 string target = func.getArg(0);
1948 string target_name = func.getArg(1);
1949 string command = func.getArg(2);
1952 || target_name.empty()
1953 || command.empty()) {
1954 LYXERR0("Unable to parse " << func.argument());
1955 docstring const msg =
1956 bformat(_("Unable to parse \"%1$s\""), func.argument());
1960 if (target != "printer" && target != "file") {
1961 LYXERR0("Unrecognized target \"" << target << '"');
1962 docstring const msg =
1963 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
1968 if (!doExport("dvi", true)) {
1969 showPrintError(absFileName());
1970 dr.setMessage(_("Error exporting to DVI."));
1974 // Push directory path.
1975 string const path = temppath();
1976 // Prevent the compiler from optimizing away p
1980 // there are three cases here:
1981 // 1. we print to a file
1982 // 2. we print directly to a printer
1983 // 3. we print using a spool command (print to file first)
1986 string const dviname = changeExtension(latexName(true), "dvi");
1988 if (target == "printer") {
1989 if (!lyxrc.print_spool_command.empty()) {
1990 // case 3: print using a spool
1991 string const psname = changeExtension(dviname,".ps");
1992 command += ' ' + lyxrc.print_to_file
1995 + quoteName(dviname);
1997 string command2 = lyxrc.print_spool_command + ' ';
1998 if (target_name != "default") {
1999 command2 += lyxrc.print_spool_printerprefix
2003 command2 += quoteName(psname);
2005 // If successful, then spool command
2006 res = one.startscript(Systemcall::Wait, command);
2009 // If there's no GUI, we have to wait on this command. Otherwise,
2010 // LyX deletes the temporary directory, and with it the spooled
2011 // file, before it can be printed!!
2012 Systemcall::Starttype stype = use_gui ?
2013 Systemcall::DontWait : Systemcall::Wait;
2014 res = one.startscript(stype, command2);
2017 // case 2: print directly to a printer
2018 if (target_name != "default")
2019 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
2021 Systemcall::Starttype stype = use_gui ?
2022 Systemcall::DontWait : Systemcall::Wait;
2023 res = one.startscript(stype, command + quoteName(dviname));
2027 // case 1: print to a file
2028 FileName const filename(makeAbsPath(target_name, filePath()));
2029 FileName const dvifile(makeAbsPath(dviname, path));
2030 if (filename.exists()) {
2031 docstring text = bformat(
2032 _("The file %1$s already exists.\n\n"
2033 "Do you want to overwrite that file?"),
2034 makeDisplayPath(filename.absFilename()));
2035 if (Alert::prompt(_("Overwrite file?"),
2036 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2039 command += ' ' + lyxrc.print_to_file
2040 + quoteName(filename.toFilesystemEncoding())
2042 + quoteName(dvifile.toFilesystemEncoding());
2044 Systemcall::Starttype stype = use_gui ?
2045 Systemcall::DontWait : Systemcall::Wait;
2046 res = one.startscript(stype, command);
2052 dr.setMessage(_("Error running external commands."));
2053 showPrintError(absFileName());
2058 case LFUN_BUFFER_LANGUAGE: {
2059 Language const * oldL = params().language;
2060 Language const * newL = languages.getLanguage(argument);
2061 if (!newL || oldL == newL)
2063 if (oldL->rightToLeft() == newL->rightToLeft() && !isMultiLingual())
2064 changeLanguage(oldL, newL);
2072 dr.dispatched(dispatched);
2073 undo().endUndoGroup();
2077 void Buffer::changeLanguage(Language const * from, Language const * to)
2079 LASSERT(from, /**/);
2082 for_each(par_iterator_begin(),
2084 bind(&Paragraph::changeLanguage, _1, params(), from, to));
2088 bool Buffer::isMultiLingual() const
2090 ParConstIterator end = par_iterator_end();
2091 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
2092 if (it->isMultiLingual(params()))
2099 DocIterator Buffer::getParFromID(int const id) const
2101 Buffer * buf = const_cast<Buffer *>(this);
2103 // John says this is called with id == -1 from undo
2104 lyxerr << "getParFromID(), id: " << id << endl;
2105 return doc_iterator_end(buf);
2108 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
2109 if (it.paragraph().id() == id)
2112 return doc_iterator_end(buf);
2116 bool Buffer::hasParWithID(int const id) const
2118 return !getParFromID(id).atEnd();
2122 ParIterator Buffer::par_iterator_begin()
2124 return ParIterator(doc_iterator_begin(this));
2128 ParIterator Buffer::par_iterator_end()
2130 return ParIterator(doc_iterator_end(this));
2134 ParConstIterator Buffer::par_iterator_begin() const
2136 return ParConstIterator(doc_iterator_begin(this));
2140 ParConstIterator Buffer::par_iterator_end() const
2142 return ParConstIterator(doc_iterator_end(this));
2146 Language const * Buffer::language() const
2148 return params().language;
2152 docstring const Buffer::B_(string const & l10n) const
2154 return params().B_(l10n);
2158 bool Buffer::isClean() const
2160 return d->lyx_clean;
2164 bool Buffer::isBakClean() const
2166 return d->bak_clean;
2170 bool Buffer::isExternallyModified(CheckMethod method) const
2172 LASSERT(d->filename.exists(), /**/);
2173 // if method == timestamp, check timestamp before checksum
2174 return (method == checksum_method
2175 || d->timestamp_ != d->filename.lastModified())
2176 && d->checksum_ != d->filename.checksum();
2180 void Buffer::saveCheckSum(FileName const & file) const
2182 if (file.exists()) {
2183 d->timestamp_ = file.lastModified();
2184 d->checksum_ = file.checksum();
2186 // in the case of save to a new file.
2193 void Buffer::markClean() const
2195 if (!d->lyx_clean) {
2196 d->lyx_clean = true;
2199 // if the .lyx file has been saved, we don't need an
2201 d->bak_clean = true;
2205 void Buffer::markBakClean() const
2207 d->bak_clean = true;
2211 void Buffer::setUnnamed(bool flag)
2217 bool Buffer::isUnnamed() const
2224 /// Don't check unnamed, here: isInternal() is used in
2225 /// newBuffer(), where the unnamed flag has not been set by anyone
2226 /// yet. Also, for an internal buffer, there should be no need for
2227 /// retrieving fileName() nor for checking if it is unnamed or not.
2228 bool Buffer::isInternal() const
2230 return fileName().extension() == "internal";
2234 void Buffer::markDirty()
2237 d->lyx_clean = false;
2240 d->bak_clean = false;
2242 DepClean::iterator it = d->dep_clean.begin();
2243 DepClean::const_iterator const end = d->dep_clean.end();
2245 for (; it != end; ++it)
2250 FileName Buffer::fileName() const
2256 string Buffer::absFileName() const
2258 return d->filename.absFilename();
2262 string Buffer::filePath() const
2264 return d->filename.onlyPath().absFilename() + "/";
2268 bool Buffer::isReadonly() const
2270 return d->read_only;
2274 void Buffer::setParent(Buffer const * buffer)
2276 // Avoids recursive include.
2277 d->setParent(buffer == this ? 0 : buffer);
2282 Buffer const * Buffer::parent() const
2288 void Buffer::collectRelatives(BufferSet & bufs) const
2292 parent()->collectRelatives(bufs);
2294 // loop over children
2295 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2296 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2297 for (; it != end; ++it)
2298 bufs.insert(const_cast<Buffer *>(it->first));
2302 std::vector<Buffer const *> Buffer::allRelatives() const
2305 collectRelatives(bufs);
2306 BufferSet::iterator it = bufs.begin();
2307 std::vector<Buffer const *> ret;
2308 for (; it != bufs.end(); ++it)
2314 Buffer const * Buffer::masterBuffer() const
2316 Buffer const * const pbuf = d->parent();
2320 return pbuf->masterBuffer();
2324 bool Buffer::isChild(Buffer * child) const
2326 return d->children_positions.find(child) != d->children_positions.end();
2330 DocIterator Buffer::firstChildPosition(Buffer const * child)
2332 Impl::BufferPositionMap::iterator it;
2333 it = d->children_positions.find(child);
2334 if (it == d->children_positions.end())
2335 return DocIterator(this);
2340 std::vector<Buffer *> Buffer::getChildren(bool grand_children) const
2342 std::vector<Buffer *> clist;
2343 // loop over children
2344 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2345 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2346 for (; it != end; ++it) {
2347 Buffer * child = const_cast<Buffer *>(it->first);
2348 clist.push_back(child);
2349 if (grand_children) {
2350 // there might be grandchildren
2351 std::vector<Buffer *> glist = child->getChildren();
2352 for (vector<Buffer *>::const_iterator git = glist.begin();
2353 git != glist.end(); ++git)
2354 clist.push_back(*git);
2361 template<typename M>
2362 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
2367 typename M::iterator it = m.lower_bound(x);
2368 if (it == m.begin())
2376 MacroData const * Buffer::getBufferMacro(docstring const & name,
2377 DocIterator const & pos) const
2379 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2381 // if paragraphs have no macro context set, pos will be empty
2385 // we haven't found anything yet
2386 DocIterator bestPos = par_iterator_begin();
2387 MacroData const * bestData = 0;
2389 // find macro definitions for name
2390 Impl::NamePositionScopeMacroMap::iterator nameIt
2391 = d->macros.find(name);
2392 if (nameIt != d->macros.end()) {
2393 // find last definition in front of pos or at pos itself
2394 Impl::PositionScopeMacroMap::const_iterator it
2395 = greatest_below(nameIt->second, pos);
2396 if (it != nameIt->second.end()) {
2398 // scope ends behind pos?
2399 if (pos < it->second.first) {
2400 // Looks good, remember this. If there
2401 // is no external macro behind this,
2402 // we found the right one already.
2403 bestPos = it->first;
2404 bestData = &it->second.second;
2408 // try previous macro if there is one
2409 if (it == nameIt->second.begin())
2416 // find macros in included files
2417 Impl::PositionScopeBufferMap::const_iterator it
2418 = greatest_below(d->position_to_children, pos);
2419 if (it == d->position_to_children.end())
2420 // no children before
2424 // do we know something better (i.e. later) already?
2425 if (it->first < bestPos )
2428 // scope ends behind pos?
2429 if (pos < it->second.first) {
2430 // look for macro in external file
2431 d->macro_lock = true;
2432 MacroData const * data
2433 = it->second.second->getMacro(name, false);
2434 d->macro_lock = false;
2436 bestPos = it->first;
2442 // try previous file if there is one
2443 if (it == d->position_to_children.begin())
2448 // return the best macro we have found
2453 MacroData const * Buffer::getMacro(docstring const & name,
2454 DocIterator const & pos, bool global) const
2459 // query buffer macros
2460 MacroData const * data = getBufferMacro(name, pos);
2464 // If there is a master buffer, query that
2465 Buffer const * const pbuf = d->parent();
2467 d->macro_lock = true;
2468 MacroData const * macro = pbuf->getMacro(
2469 name, *this, false);
2470 d->macro_lock = false;
2476 data = MacroTable::globalMacros().get(name);
2485 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2487 // set scope end behind the last paragraph
2488 DocIterator scope = par_iterator_begin();
2489 scope.pit() = scope.lastpit() + 1;
2491 return getMacro(name, scope, global);
2495 MacroData const * Buffer::getMacro(docstring const & name,
2496 Buffer const & child, bool global) const
2498 // look where the child buffer is included first
2499 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2500 if (it == d->children_positions.end())
2503 // check for macros at the inclusion position
2504 return getMacro(name, it->second, global);
2508 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
2510 pit_type lastpit = it.lastpit();
2512 // look for macros in each paragraph
2513 while (it.pit() <= lastpit) {
2514 Paragraph & par = it.paragraph();
2516 // iterate over the insets of the current paragraph
2517 InsetList const & insets = par.insetList();
2518 InsetList::const_iterator iit = insets.begin();
2519 InsetList::const_iterator end = insets.end();
2520 for (; iit != end; ++iit) {
2521 it.pos() = iit->pos;
2523 // is it a nested text inset?
2524 if (iit->inset->asInsetText()) {
2525 // Inset needs its own scope?
2526 InsetText const * itext = iit->inset->asInsetText();
2527 bool newScope = itext->isMacroScope();
2529 // scope which ends just behind the inset
2530 DocIterator insetScope = it;
2533 // collect macros in inset
2534 it.push_back(CursorSlice(*iit->inset));
2535 updateMacros(it, newScope ? insetScope : scope);
2540 // is it an external file?
2541 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2542 // get buffer of external file
2543 InsetInclude const & inset =
2544 static_cast<InsetInclude const &>(*iit->inset);
2545 d->macro_lock = true;
2546 Buffer * child = inset.getChildBuffer();
2547 d->macro_lock = false;
2551 // register its position, but only when it is
2552 // included first in the buffer
2553 if (d->children_positions.find(child) ==
2554 d->children_positions.end())
2555 d->children_positions[child] = it;
2557 // register child with its scope
2558 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
2562 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2566 MathMacroTemplate & macroTemplate =
2567 static_cast<MathMacroTemplate &>(*iit->inset);
2568 MacroContext mc(*this, it);
2569 macroTemplate.updateToContext(mc);
2572 bool valid = macroTemplate.validMacro();
2573 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2574 // then the BufferView's cursor will be invalid in
2575 // some cases which leads to crashes.
2580 d->macros[macroTemplate.name()][it] =
2581 Impl::ScopeMacro(scope, MacroData(*this, it));
2591 void Buffer::updateMacros() const
2596 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2598 // start with empty table
2600 d->children_positions.clear();
2601 d->position_to_children.clear();
2603 // Iterate over buffer, starting with first paragraph
2604 // The scope must be bigger than any lookup DocIterator
2605 // later. For the global lookup, lastpit+1 is used, hence
2606 // we use lastpit+2 here.
2607 DocIterator it = par_iterator_begin();
2608 DocIterator outerScope = it;
2609 outerScope.pit() = outerScope.lastpit() + 2;
2610 updateMacros(it, outerScope);
2614 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2616 InsetIterator it = inset_iterator_begin(inset());
2617 InsetIterator const end = inset_iterator_end(inset());
2618 for (; it != end; ++it) {
2619 if (it->lyxCode() == BRANCH_CODE) {
2620 InsetBranch & br = static_cast<InsetBranch &>(*it);
2621 docstring const name = br.branch();
2622 if (!from_master && !params().branchlist().find(name))
2623 result.push_back(name);
2624 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2625 result.push_back(name);
2628 if (it->lyxCode() == INCLUDE_CODE) {
2629 // get buffer of external file
2630 InsetInclude const & ins =
2631 static_cast<InsetInclude const &>(*it);
2632 Buffer * child = ins.getChildBuffer();
2635 child->getUsedBranches(result, true);
2638 // remove duplicates
2643 void Buffer::updateMacroInstances() const
2645 LYXERR(Debug::MACROS, "updateMacroInstances for "
2646 << d->filename.onlyFileName());
2647 DocIterator it = doc_iterator_begin(this);
2648 DocIterator end = doc_iterator_end(this);
2649 for (; it != end; it.forwardPos()) {
2650 // look for MathData cells in InsetMathNest insets
2651 Inset * inset = it.nextInset();
2655 InsetMath * minset = inset->asInsetMath();
2659 // update macro in all cells of the InsetMathNest
2660 DocIterator::idx_type n = minset->nargs();
2661 MacroContext mc = MacroContext(*this, it);
2662 for (DocIterator::idx_type i = 0; i < n; ++i) {
2663 MathData & data = minset->cell(i);
2664 data.updateMacros(0, mc);
2670 void Buffer::listMacroNames(MacroNameSet & macros) const
2675 d->macro_lock = true;
2677 // loop over macro names
2678 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2679 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2680 for (; nameIt != nameEnd; ++nameIt)
2681 macros.insert(nameIt->first);
2683 // loop over children
2684 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2685 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2686 for (; it != end; ++it)
2687 it->first->listMacroNames(macros);
2690 Buffer const * const pbuf = d->parent();
2692 pbuf->listMacroNames(macros);
2694 d->macro_lock = false;
2698 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2700 Buffer const * const pbuf = d->parent();
2705 pbuf->listMacroNames(names);
2708 MacroNameSet::iterator it = names.begin();
2709 MacroNameSet::iterator end = names.end();
2710 for (; it != end; ++it) {
2712 MacroData const * data =
2713 pbuf->getMacro(*it, *this, false);
2715 macros.insert(data);
2717 // we cannot access the original MathMacroTemplate anymore
2718 // here to calls validate method. So we do its work here manually.
2719 // FIXME: somehow make the template accessible here.
2720 if (data->optionals() > 0)
2721 features.require("xargs");
2727 Buffer::References & Buffer::references(docstring const & label)
2730 return const_cast<Buffer *>(masterBuffer())->references(label);
2732 RefCache::iterator it = d->ref_cache_.find(label);
2733 if (it != d->ref_cache_.end())
2734 return it->second.second;
2736 static InsetLabel const * dummy_il = 0;
2737 static References const dummy_refs;
2738 it = d->ref_cache_.insert(
2739 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2740 return it->second.second;
2744 Buffer::References const & Buffer::references(docstring const & label) const
2746 return const_cast<Buffer *>(this)->references(label);
2750 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2752 masterBuffer()->d->ref_cache_[label].first = il;
2756 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2758 return masterBuffer()->d->ref_cache_[label].first;
2762 void Buffer::clearReferenceCache() const
2765 d->ref_cache_.clear();
2769 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2772 //FIXME: This does not work for child documents yet.
2773 LASSERT(code == CITE_CODE, /**/);
2774 // Check if the label 'from' appears more than once
2775 vector<docstring> labels;
2777 BiblioInfo const & keys = masterBibInfo();
2778 BiblioInfo::const_iterator bit = keys.begin();
2779 BiblioInfo::const_iterator bend = keys.end();
2781 for (; bit != bend; ++bit)
2783 labels.push_back(bit->first);
2786 if (count(labels.begin(), labels.end(), from) > 1)
2789 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2790 if (it->lyxCode() == code) {
2791 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2792 docstring const oldValue = inset.getParam(paramName);
2793 if (oldValue == from)
2794 inset.setParam(paramName, to);
2800 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2801 pit_type par_end, bool full_source) const
2803 OutputParams runparams(¶ms().encoding());
2804 runparams.nice = true;
2805 runparams.flavor = params().useXetex ?
2806 OutputParams::XETEX : OutputParams::LATEX;
2807 runparams.linelen = lyxrc.plaintext_linelen;
2808 // No side effect of file copying and image conversion
2809 runparams.dryrun = true;
2812 os << "% " << _("Preview source code") << "\n\n";
2814 d->texrow.newline();
2815 d->texrow.newline();
2817 writeDocBookSource(os, absFileName(), runparams, false);
2819 // latex or literate
2820 writeLaTeXSource(os, string(), runparams, true, true);
2822 runparams.par_begin = par_begin;
2823 runparams.par_end = par_end;
2824 if (par_begin + 1 == par_end) {
2826 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2830 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2831 convert<docstring>(par_begin),
2832 convert<docstring>(par_end - 1))
2839 // output paragraphs
2841 docbookParagraphs(text(), *this, os, runparams);
2843 // latex or literate
2844 latexParagraphs(*this, text(), os, texrow, runparams);
2849 ErrorList & Buffer::errorList(string const & type) const
2851 static ErrorList emptyErrorList;
2852 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2853 if (I == d->errorLists.end())
2854 return emptyErrorList;
2860 void Buffer::updateTocItem(std::string const & type,
2861 DocIterator const & dit) const
2864 gui_->updateTocItem(type, dit);
2868 void Buffer::structureChanged() const
2871 gui_->structureChanged();
2875 void Buffer::errors(string const & err, bool from_master) const
2878 gui_->errors(err, from_master);
2882 void Buffer::message(docstring const & msg) const
2889 void Buffer::setBusy(bool on) const
2896 void Buffer::setReadOnly(bool on) const
2899 d->wa_->setReadOnly(on);
2903 void Buffer::updateTitles() const
2906 d->wa_->updateTitles();
2910 void Buffer::resetAutosaveTimers() const
2913 gui_->resetAutosaveTimers();
2917 bool Buffer::hasGuiDelegate() const
2923 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2932 class AutoSaveBuffer : public ForkedProcess {
2935 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2936 : buffer_(buffer), fname_(fname) {}
2938 virtual boost::shared_ptr<ForkedProcess> clone() const
2940 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2945 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2946 from_utf8(fname_.absFilename())));
2947 return run(DontWait);
2951 virtual int generateChild();
2953 Buffer const & buffer_;
2958 int AutoSaveBuffer::generateChild()
2960 // tmp_ret will be located (usually) in /tmp
2961 // will that be a problem?
2962 // Note that this calls ForkedCalls::fork(), so it's
2963 // ok cross-platform.
2964 pid_t const pid = fork();
2965 // If you want to debug the autosave
2966 // you should set pid to -1, and comment out the fork.
2967 if (pid != 0 && pid != -1)
2970 // pid = -1 signifies that lyx was unable
2971 // to fork. But we will do the save
2973 bool failed = false;
2974 FileName const tmp_ret = FileName::tempName("lyxauto");
2975 if (!tmp_ret.empty()) {
2976 buffer_.writeFile(tmp_ret);
2977 // assume successful write of tmp_ret
2978 if (!tmp_ret.moveTo(fname_))
2984 // failed to write/rename tmp_ret so try writing direct
2985 if (!buffer_.writeFile(fname_)) {
2986 // It is dangerous to do this in the child,
2987 // but safe in the parent, so...
2988 if (pid == -1) // emit message signal.
2989 buffer_.message(_("Autosave failed!"));
2993 if (pid == 0) // we are the child so...
3002 FileName Buffer::getAutosaveFilename() const
3004 // if the document is unnamed try to save in the backup dir, else
3005 // in the default document path, and as a last try in the filePath,
3006 // which will most often be the temporary directory
3009 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
3010 : lyxrc.backupdir_path;
3011 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
3014 string const fname = "#" + d->filename.onlyFileName() + "#";
3015 return makeAbsPath(fname, fpath);
3019 void Buffer::removeAutosaveFile() const
3021 FileName const f = getAutosaveFilename();
3027 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
3029 FileName const newauto = getAutosaveFilename();
3030 if (!(oldauto == newauto || oldauto.moveTo(newauto)))
3031 LYXERR0("Unable to remove autosave file `" << oldauto << "'!");
3035 // Perfect target for a thread...
3036 void Buffer::autoSave() const
3038 if (isBakClean() || isReadonly()) {
3039 // We don't save now, but we'll try again later
3040 resetAutosaveTimers();
3044 // emit message signal.
3045 message(_("Autosaving current document..."));
3046 AutoSaveBuffer autosave(*this, getAutosaveFilename());
3050 resetAutosaveTimers();
3054 string Buffer::bufferFormat() const
3056 string format = params().documentClass().outputFormat();
3057 if (format == "latex") {
3058 if (params().useXetex)
3060 if (params().encoding().package() == Encoding::japanese)
3067 string Buffer::getDefaultOutputFormat() const
3069 if (!params().defaultOutputFormat.empty()
3070 && params().defaultOutputFormat != "default")
3071 return params().defaultOutputFormat;
3072 typedef vector<Format const *> Formats;
3073 Formats formats = exportableFormats(true);
3076 || params().useXetex
3077 || params().encoding().package() == Encoding::japanese) {
3078 if (formats.empty())
3080 // return the first we find
3081 return formats.front()->name();
3083 return lyxrc.default_view_format;
3088 bool Buffer::doExport(string const & format, bool put_in_tempdir,
3089 string & result_file) const
3091 string backend_format;
3092 OutputParams runparams(¶ms().encoding());
3093 runparams.flavor = OutputParams::LATEX;
3094 runparams.linelen = lyxrc.plaintext_linelen;
3095 vector<string> backs = backends();
3096 if (find(backs.begin(), backs.end(), format) == backs.end()) {
3097 // Get shortest path to format
3098 Graph::EdgePath path;
3099 for (vector<string>::const_iterator it = backs.begin();
3100 it != backs.end(); ++it) {
3101 Graph::EdgePath p = theConverters().getPath(*it, format);
3102 if (!p.empty() && (path.empty() || p.size() < path.size())) {
3103 backend_format = *it;
3108 runparams.flavor = theConverters().getFlavor(path);
3110 Alert::error(_("Couldn't export file"),
3111 bformat(_("No information for exporting the format %1$s."),
3112 formats.prettyName(format)));
3116 backend_format = format;
3117 // FIXME: Don't hardcode format names here, but use a flag
3118 if (backend_format == "pdflatex")
3119 runparams.flavor = OutputParams::PDFLATEX;
3122 string filename = latexName(false);
3123 filename = addName(temppath(), filename);
3124 filename = changeExtension(filename,
3125 formats.extension(backend_format));
3128 updateMacroInstances();
3130 // Plain text backend
3131 if (backend_format == "text")
3132 writePlaintextFile(*this, FileName(filename), runparams);
3134 else if (backend_format == "xhtml") {
3135 runparams.flavor = OutputParams::HTML;
3136 makeLyXHTMLFile(FileName(filename), runparams);
3137 } else if (backend_format == "lyx")
3138 writeFile(FileName(filename));
3140 else if (isDocBook()) {
3141 runparams.nice = !put_in_tempdir;
3142 makeDocBookFile(FileName(filename), runparams);
3145 else if (backend_format == format) {
3146 runparams.nice = true;
3147 if (!makeLaTeXFile(FileName(filename), string(), runparams))
3149 } else if (!lyxrc.tex_allows_spaces
3150 && contains(filePath(), ' ')) {
3151 Alert::error(_("File name error"),
3152 _("The directory path to the document cannot contain spaces."));
3155 runparams.nice = false;
3156 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
3160 string const error_type = (format == "program")
3161 ? "Build" : bufferFormat();
3162 ErrorList & error_list = d->errorLists[error_type];
3163 string const ext = formats.extension(format);
3164 FileName const tmp_result_file(changeExtension(filename, ext));
3165 bool const success = theConverters().convert(this, FileName(filename),
3166 tmp_result_file, FileName(absFileName()), backend_format, format,
3168 // Emit the signal to show the error list.
3169 if (format != backend_format) {
3171 // also to the children, in case of master-buffer-view
3172 std::vector<Buffer *> clist = getChildren();
3173 for (vector<Buffer *>::const_iterator cit = clist.begin();
3174 cit != clist.end(); ++cit)
3175 (*cit)->errors(error_type, true);
3180 if (put_in_tempdir) {
3181 result_file = tmp_result_file.absFilename();
3185 result_file = changeExtension(exportFileName().absFilename(), ext);
3186 // We need to copy referenced files (e. g. included graphics
3187 // if format == "dvi") to the result dir.
3188 vector<ExportedFile> const files =
3189 runparams.exportdata->externalFiles(format);
3190 string const dest = onlyPath(result_file);
3191 CopyStatus status = SUCCESS;
3192 for (vector<ExportedFile>::const_iterator it = files.begin();
3193 it != files.end() && status != CANCEL; ++it) {
3194 string const fmt = formats.getFormatFromFile(it->sourceName);
3195 status = copyFile(fmt, it->sourceName,
3196 makeAbsPath(it->exportName, dest),
3197 it->exportName, status == FORCE);
3199 if (status == CANCEL) {
3200 message(_("Document export cancelled."));
3201 } else if (tmp_result_file.exists()) {
3202 // Finally copy the main file
3203 status = copyFile(format, tmp_result_file,
3204 FileName(result_file), result_file,
3206 message(bformat(_("Document exported as %1$s "
3208 formats.prettyName(format),
3209 makeDisplayPath(result_file)));
3211 // This must be a dummy converter like fax (bug 1888)
3212 message(bformat(_("Document exported as %1$s"),
3213 formats.prettyName(format)));
3220 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
3223 return doExport(format, put_in_tempdir, result_file);
3227 bool Buffer::preview(string const & format) const
3230 if (!doExport(format, true, result_file))
3232 return formats.view(*this, FileName(result_file), format);
3236 bool Buffer::isExportable(string const & format) const
3238 vector<string> backs = backends();
3239 for (vector<string>::const_iterator it = backs.begin();
3240 it != backs.end(); ++it)
3241 if (theConverters().isReachable(*it, format))
3247 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3249 vector<string> backs = backends();
3250 vector<Format const *> result =
3251 theConverters().getReachable(backs[0], only_viewable, true);
3252 for (vector<string>::const_iterator it = backs.begin() + 1;
3253 it != backs.end(); ++it) {
3254 vector<Format const *> r =
3255 theConverters().getReachable(*it, only_viewable, false);
3256 result.insert(result.end(), r.begin(), r.end());
3262 vector<string> Buffer::backends() const
3265 if (params().baseClass()->isTeXClassAvailable()) {
3266 v.push_back(bufferFormat());
3267 // FIXME: Don't hardcode format names here, but use a flag
3268 if (v.back() == "latex")
3269 v.push_back("pdflatex");
3271 v.push_back("text");
3272 v.push_back("xhtml");
3278 bool Buffer::readFileHelper(FileName const & s)
3280 // File information about normal file
3282 docstring const file = makeDisplayPath(s.absFilename(), 50);
3283 docstring text = bformat(_("The specified document\n%1$s"
3284 "\ncould not be read."), file);
3285 Alert::error(_("Could not read document"), text);
3289 // Check if emergency save file exists and is newer.
3290 FileName const e(s.absFilename() + ".emergency");
3292 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3293 docstring const file = makeDisplayPath(s.absFilename(), 20);
3294 docstring const text =
3295 bformat(_("An emergency save of the document "
3297 "Recover emergency save?"), file);
3298 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3299 _("&Recover"), _("&Load Original"),
3303 // the file is not saved if we load the emergency file.
3308 if ((res = readFile(e)) == success)
3309 str = _("Document was successfully recovered.");
3311 str = _("Document was NOT successfully recovered.");
3312 str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3313 from_utf8(e.absFilename()));
3315 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3316 _("&Remove"), _("&Keep it"))) {
3319 Alert::warning(_("Emergency file deleted"),
3320 _("Do not forget to save your file now!"), true);
3325 if (!Alert::prompt(_("Delete emergency file?"),
3326 _("Remove emergency file now?"), 1, 1,
3327 _("&Remove"), _("&Keep it")))
3335 // Now check if autosave file is newer.
3336 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3338 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3339 docstring const file = makeDisplayPath(s.absFilename(), 20);
3340 docstring const text =
3341 bformat(_("The backup of the document "
3342 "%1$s is newer.\n\nLoad the "
3343 "backup instead?"), file);
3344 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3345 _("&Load backup"), _("Load &original"),
3349 // the file is not saved if we load the autosave file.
3353 // Here we delete the autosave
3364 bool Buffer::loadLyXFile(FileName const & s)
3366 if (s.isReadableFile()) {
3367 if (readFileHelper(s)) {
3368 lyxvc().file_found_hook(s);
3369 if (!s.isWritable())
3374 docstring const file = makeDisplayPath(s.absFilename(), 20);
3375 // Here we probably should run
3376 if (LyXVC::file_not_found_hook(s)) {
3377 docstring const text =
3378 bformat(_("Do you want to retrieve the document"
3379 " %1$s from version control?"), file);
3380 int const ret = Alert::prompt(_("Retrieve from version control?"),
3381 text, 0, 1, _("&Retrieve"), _("&Cancel"));
3384 // How can we know _how_ to do the checkout?
3385 // With the current VC support it has to be,
3386 // a RCS file since CVS do not have special ,v files.
3388 return loadLyXFile(s);
3396 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3398 TeXErrors::Errors::const_iterator cit = terr.begin();
3399 TeXErrors::Errors::const_iterator end = terr.end();
3401 for (; cit != end; ++cit) {
3404 int errorRow = cit->error_in_line;
3405 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3411 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3412 } while (found && id_start == id_end && pos_start == pos_end);
3414 errorList.push_back(ErrorItem(cit->error_desc,
3415 cit->error_text, id_start, pos_start, pos_end));
3420 void Buffer::setBuffersForInsets() const
3422 inset().setBuffer(const_cast<Buffer &>(*this));
3426 void Buffer::updateLabels(UpdateScope scope) const
3428 // Use the master text class also for child documents
3429 Buffer const * const master = masterBuffer();
3430 DocumentClass const & textclass = master->params().documentClass();
3432 // keep the buffers to be children in this set. If the call from the
3433 // master comes back we can see which of them were actually seen (i.e.
3434 // via an InsetInclude). The remaining ones in the set need still be updated.
3435 static std::set<Buffer const *> bufToUpdate;
3436 if (scope == UpdateMaster) {
3437 // If this is a child document start with the master
3438 if (master != this) {
3439 bufToUpdate.insert(this);
3440 master->updateLabels();
3441 // Do this here in case the master has no gui associated with it. Then,
3442 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3446 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3447 if (bufToUpdate.find(this) == bufToUpdate.end())
3451 // start over the counters in the master
3452 textclass.counters().reset();
3455 // update will be done below for this buffer
3456 bufToUpdate.erase(this);
3458 // update all caches
3459 clearReferenceCache();
3462 Buffer & cbuf = const_cast<Buffer &>(*this);
3464 LASSERT(!text().paragraphs().empty(), /**/);
3467 ParIterator parit = cbuf.par_iterator_begin();
3468 updateLabels(parit);
3471 // TocBackend update will be done later.
3474 cbuf.tocBackend().update();
3475 if (scope == UpdateMaster)
3476 cbuf.structureChanged();
3480 static depth_type getDepth(DocIterator const & it)
3482 depth_type depth = 0;
3483 for (size_t i = 0 ; i < it.depth() ; ++i)
3484 if (!it[i].inset().inMathed())
3485 depth += it[i].paragraph().getDepth() + 1;
3486 // remove 1 since the outer inset does not count
3490 static depth_type getItemDepth(ParIterator const & it)
3492 Paragraph const & par = *it;
3493 LabelType const labeltype = par.layout().labeltype;
3495 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3498 // this will hold the lowest depth encountered up to now.
3499 depth_type min_depth = getDepth(it);
3500 ParIterator prev_it = it;
3503 --prev_it.top().pit();
3505 // start of nested inset: go to outer par
3507 if (prev_it.empty()) {
3508 // start of document: nothing to do
3513 // We search for the first paragraph with same label
3514 // that is not more deeply nested.
3515 Paragraph & prev_par = *prev_it;
3516 depth_type const prev_depth = getDepth(prev_it);
3517 if (labeltype == prev_par.layout().labeltype) {
3518 if (prev_depth < min_depth)
3519 return prev_par.itemdepth + 1;
3520 if (prev_depth == min_depth)
3521 return prev_par.itemdepth;
3523 min_depth = min(min_depth, prev_depth);
3524 // small optimization: if we are at depth 0, we won't
3525 // find anything else
3526 if (prev_depth == 0)
3532 static bool needEnumCounterReset(ParIterator const & it)
3534 Paragraph const & par = *it;
3535 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3536 depth_type const cur_depth = par.getDepth();
3537 ParIterator prev_it = it;
3538 while (prev_it.pit()) {
3539 --prev_it.top().pit();
3540 Paragraph const & prev_par = *prev_it;
3541 if (prev_par.getDepth() <= cur_depth)
3542 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3544 // start of nested inset: reset
3549 // set the label of a paragraph. This includes the counters.
3550 static void setLabel(Buffer const & buf, ParIterator & it)
3552 BufferParams const & bp = buf.masterBuffer()->params();
3553 DocumentClass const & textclass = bp.documentClass();
3554 Paragraph & par = it.paragraph();
3555 Layout const & layout = par.layout();
3556 Counters & counters = textclass.counters();
3558 if (par.params().startOfAppendix()) {
3559 // FIXME: only the counter corresponding to toplevel
3560 // sectionning should be reset
3562 counters.appendix(true);
3564 par.params().appendix(counters.appendix());
3566 // Compute the item depth of the paragraph
3567 par.itemdepth = getItemDepth(it);
3569 if (layout.margintype == MARGIN_MANUAL
3570 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3571 if (par.params().labelWidthString().empty())
3572 par.params().labelWidthString(par.expandLabel(layout, bp));
3574 par.params().labelWidthString(docstring());
3577 switch(layout.labeltype) {
3579 if (layout.toclevel <= bp.secnumdepth
3580 && (layout.latextype != LATEX_ENVIRONMENT
3581 || it.text()->isFirstInSequence(it.pit()))) {
3582 counters.step(layout.counter);
3583 par.params().labelString(
3584 par.expandLabel(layout, bp));
3586 par.params().labelString(docstring());
3589 case LABEL_ITEMIZE: {
3590 // At some point of time we should do something more
3591 // clever here, like:
3592 // par.params().labelString(
3593 // bp.user_defined_bullet(par.itemdepth).getText());
3594 // for now, use a simple hardcoded label
3595 docstring itemlabel;
3596 switch (par.itemdepth) {
3598 itemlabel = char_type(0x2022);
3601 itemlabel = char_type(0x2013);
3604 itemlabel = char_type(0x2217);
3607 itemlabel = char_type(0x2219); // or 0x00b7
3610 par.params().labelString(itemlabel);
3614 case LABEL_ENUMERATE: {
3615 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3617 switch (par.itemdepth) {
3626 enumcounter += "iv";
3629 // not a valid enumdepth...
3633 // Maybe we have to reset the enumeration counter.
3634 if (needEnumCounterReset(it))
3635 counters.reset(enumcounter);
3636 counters.step(enumcounter);
3638 string const & lang = par.getParLanguage(bp)->code();
3639 par.params().labelString(counters.theCounter(enumcounter, lang));
3644 case LABEL_SENSITIVE: {
3645 string const & type = counters.current_float();
3646 docstring full_label;
3648 full_label = buf.B_("Senseless!!! ");
3650 docstring name = buf.B_(textclass.floats().getType(type).name());
3651 if (counters.hasCounter(from_utf8(type))) {
3652 string const & lang = par.getParLanguage(bp)->code();
3653 counters.step(from_utf8(type));
3654 full_label = bformat(from_ascii("%1$s %2$s:"),
3656 counters.theCounter(from_utf8(type), lang));
3658 full_label = bformat(from_ascii("%1$s #:"), name);
3660 par.params().labelString(full_label);
3664 case LABEL_NO_LABEL:
3665 par.params().labelString(docstring());
3669 case LABEL_TOP_ENVIRONMENT:
3670 case LABEL_CENTERED_TOP_ENVIRONMENT:
3673 par.params().labelString(par.expandLabel(layout, bp));
3679 void Buffer::updateLabels(ParIterator & parit) const
3681 LASSERT(parit.pit() == 0, /**/);
3683 // set the position of the text in the buffer to be able
3684 // to resolve macros in it. This has nothing to do with
3685 // labels, but by putting it here we avoid implementing
3686 // a whole bunch of traversal routines just for this call.
3687 parit.text()->setMacrocontextPosition(parit);
3689 depth_type maxdepth = 0;
3690 pit_type const lastpit = parit.lastpit();
3691 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3692 // reduce depth if necessary
3693 parit->params().depth(min(parit->params().depth(), maxdepth));
3694 maxdepth = parit->getMaxDepthAfter();
3696 // set the counter for this paragraph
3697 setLabel(*this, parit);
3700 InsetList::const_iterator iit = parit->insetList().begin();
3701 InsetList::const_iterator end = parit->insetList().end();
3702 for (; iit != end; ++iit) {
3703 parit.pos() = iit->pos;
3704 iit->inset->updateLabels(parit);
3710 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3711 WordLangTuple & word_lang, docstring_list & suggestions) const
3715 suggestions.clear();
3716 word_lang = WordLangTuple();
3717 // OK, we start from here.
3718 DocIterator const end = doc_iterator_end(this);
3719 for (; from != end; from.forwardPos()) {
3720 // We are only interested in text so remove the math CursorSlice.
3721 while (from.inMathed())
3722 from.forwardInset();
3724 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {