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"
47 #include "output_docbook.h"
49 #include "output_latex.h"
50 #include "output_xhtml.h"
51 #include "output_plaintext.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.h"
55 #include "PDFOptions.h"
56 #include "SpellChecker.h"
59 #include "TexStream.h"
61 #include "TextClass.h"
62 #include "TocBackend.h"
64 #include "VCBackend.h"
66 #include "WordLangTuple.h"
69 #include "insets/InsetBibitem.h"
70 #include "insets/InsetBibtex.h"
71 #include "insets/InsetBranch.h"
72 #include "insets/InsetInclude.h"
73 #include "insets/InsetText.h"
75 #include "mathed/MacroTable.h"
76 #include "mathed/MathMacroTemplate.h"
77 #include "mathed/MathSupport.h"
79 #include "frontends/alert.h"
80 #include "frontends/Delegates.h"
81 #include "frontends/WorkAreaManager.h"
83 #include "graphics/Previews.h"
85 #include "support/lassert.h"
86 #include "support/convert.h"
87 #include "support/debug.h"
88 #include "support/docstring_list.h"
89 #include "support/ExceptionMessage.h"
90 #include "support/FileName.h"
91 #include "support/FileNameList.h"
92 #include "support/filetools.h"
93 #include "support/ForkedCalls.h"
94 #include "support/gettext.h"
95 #include "support/gzstream.h"
96 #include "support/lstrings.h"
97 #include "support/lyxalgo.h"
98 #include "support/os.h"
99 #include "support/Package.h"
100 #include "support/Path.h"
101 #include "support/Systemcall.h"
102 #include "support/textutils.h"
103 #include "support/types.h"
105 #include <boost/bind.hpp>
106 #include <boost/shared_ptr.hpp>
118 using namespace lyx::support;
122 namespace Alert = frontend::Alert;
123 namespace os = support::os;
127 // Do not remove the comment below, so we get merge conflict in
128 // independent branches. Instead add your own.
129 int const LYX_FORMAT = 370; // uwestoehr: option to suppress default date
131 typedef map<string, bool> DepClean;
132 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
134 void showPrintError(string const & name)
136 docstring str = bformat(_("Could not print the document %1$s.\n"
137 "Check that your printer is set up correctly."),
138 makeDisplayPath(name, 50));
139 Alert::error(_("Print document failed"), str);
144 class BufferSet : public std::set<Buffer const *> {};
149 Impl(Buffer & parent, FileName const & file, bool readonly);
163 mutable TexRow texrow;
165 /// need to regenerate .tex?
169 mutable bool lyx_clean;
171 /// is autosave needed?
172 mutable bool bak_clean;
174 /// is this a unnamed file (New...)?
180 /// name of the file the buffer is associated with.
183 /** Set to true only when the file is fully loaded.
184 * Used to prevent the premature generation of previews
185 * and by the citation inset.
187 bool file_fully_loaded;
190 mutable TocBackend toc_backend;
193 typedef pair<DocIterator, MacroData> ScopeMacro;
194 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
195 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
196 /// map from the macro name to the position map,
197 /// which maps the macro definition position to the scope and the MacroData.
198 NamePositionScopeMacroMap macros;
201 /// positions of child buffers in the buffer
202 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
203 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
204 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
205 /// position of children buffers in this buffer
206 BufferPositionMap children_positions;
207 /// map from children inclusion positions to their scope and their buffer
208 PositionScopeBufferMap position_to_children;
210 /// Container for all sort of Buffer dependant errors.
211 map<string, ErrorList> errorLists;
213 /// timestamp and checksum used to test if the file has been externally
214 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
216 unsigned long checksum_;
219 frontend::WorkAreaManager * wa_;
224 /// A cache for the bibfiles (including bibfiles of loaded child
225 /// documents), needed for appropriate update of natbib labels.
226 mutable support::FileNameList bibfilesCache_;
228 // FIXME The caching mechanism could be improved. At present, we have a
229 // cache for each Buffer, that caches all the bibliography info for that
230 // Buffer. A more efficient solution would be to have a global cache per
231 // file, and then to construct the Buffer's bibinfo from that.
232 /// A cache for bibliography info
233 mutable BiblioInfo bibinfo_;
234 /// whether the bibinfo cache is valid
235 bool bibinfoCacheValid_;
236 /// Cache of timestamps of .bib files
237 map<FileName, time_t> bibfileStatus_;
239 mutable RefCache ref_cache_;
241 /// our Text that should be wrapped in an InsetText
244 /// This is here to force the test to be done whenever parent_buffer
246 Buffer const * parent() const {
247 // if parent_buffer is not loaded, then it has been unloaded,
248 // which means that parent_buffer is an invalid pointer. So we
249 // set it to null in that case.
250 if (!theBufferList().isLoaded(parent_buffer))
252 return parent_buffer;
255 void setParent(Buffer const * pb) { parent_buffer = pb; }
257 /// So we can force access via the accessors.
258 mutable Buffer const * parent_buffer;
262 /// Creates the per buffer temporary directory
263 static FileName createBufferTmpDir()
266 // We are in our own directory. Why bother to mangle name?
267 // In fact I wrote this code to circumvent a problematic behaviour
268 // (bug?) of EMX mkstemp().
269 FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
270 convert<string>(count++));
272 if (!tmpfl.createDirectory(0777)) {
273 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
274 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
275 from_utf8(tmpfl.absFilename())));
281 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
282 : lyx_clean(true), bak_clean(true), unnamed(false),
283 read_only(readonly_), filename(file), file_fully_loaded(false),
284 toc_backend(&parent), macro_lock(false), timestamp_(0),
285 checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false),
288 temppath = createBufferTmpDir();
289 lyxvc.setBuffer(&parent);
291 wa_ = new frontend::WorkAreaManager;
295 Buffer::Buffer(string const & file, bool readonly)
296 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
298 LYXERR(Debug::INFO, "Buffer::Buffer()");
300 d->inset = new InsetText(*this);
301 d->inset->setAutoBreakRows(true);
302 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
308 LYXERR(Debug::INFO, "Buffer::~Buffer()");
309 // here the buffer should take care that it is
310 // saved properly, before it goes into the void.
312 // GuiView already destroyed
315 if (d->unnamed && d->filename.extension() == "internal") {
316 // No need to do additional cleanups for internal buffer.
321 // loop over children
322 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
323 Impl::BufferPositionMap::iterator end = d->children_positions.end();
324 for (; it != end; ++it) {
325 Buffer * child = const_cast<Buffer *>(it->first);
326 // The child buffer might have been closed already.
327 if (theBufferList().isLoaded(child))
328 theBufferList().releaseChild(this, child);
332 docstring msg = _("Buffer had unsaved changes when destroyed!\n");
333 msg += emergencyWrite();
334 frontend::Alert::warning(_("Attempting to destroy dirty Buffer!"), msg);
337 // clear references to children in macro tables
338 d->children_positions.clear();
339 d->position_to_children.clear();
341 if (!d->temppath.destroyDirectory()) {
342 Alert::warning(_("Could not remove temporary directory"),
343 bformat(_("Could not remove the temporary directory %1$s"),
344 from_utf8(d->temppath.absFilename())));
347 // Remove any previewed LaTeX snippets associated with this buffer.
348 thePreviews().removeLoader(*this);
354 void Buffer::changed() const
361 frontend::WorkAreaManager & Buffer::workAreaManager() const
363 LASSERT(d->wa_, /**/);
368 Text & Buffer::text() const
370 return d->inset->text();
374 Inset & Buffer::inset() const
380 BufferParams & Buffer::params()
386 BufferParams const & Buffer::params() const
392 ParagraphList & Buffer::paragraphs()
394 return text().paragraphs();
398 ParagraphList const & Buffer::paragraphs() const
400 return text().paragraphs();
404 LyXVC & Buffer::lyxvc()
410 LyXVC const & Buffer::lyxvc() const
416 string const Buffer::temppath() const
418 return d->temppath.absFilename();
422 TexRow & Buffer::texrow()
428 TexRow const & Buffer::texrow() const
434 TocBackend & Buffer::tocBackend() const
436 return d->toc_backend;
440 Undo & Buffer::undo()
446 string Buffer::latexName(bool const no_path) const
448 FileName latex_name =
449 makeLatexName(exportFileName());
450 return no_path ? latex_name.onlyFileName()
451 : latex_name.absFilename();
455 FileName Buffer::exportFileName() const
457 docstring const branch_suffix =
458 params().branchlist().getFilenameSuffix();
459 if (branch_suffix.empty())
462 string const name = fileName().onlyFileNameWithoutExt()
463 + to_utf8(branch_suffix);
464 FileName res(fileName().onlyPath().absFilename() + "/" + name);
465 res.changeExtension(fileName().extension());
471 string Buffer::logName(LogType * type) const
473 string const filename = latexName(false);
475 if (filename.empty()) {
481 string const path = temppath();
483 FileName const fname(addName(temppath(),
484 onlyFilename(changeExtension(filename,
487 // FIXME: how do we know this is the name of the build log?
488 FileName const bname(
489 addName(path, onlyFilename(
490 changeExtension(filename,
491 formats.extension(bufferFormat()) + ".out"))));
493 // Also consider the master buffer log file
494 FileName masterfname = fname;
496 if (masterBuffer() != this) {
497 string const mlogfile = masterBuffer()->logName(&mtype);
498 masterfname = FileName(mlogfile);
501 // If no Latex log or Build log is newer, show Build log
502 if (bname.exists() &&
503 ((!fname.exists() && !masterfname.exists())
504 || (fname.lastModified() < bname.lastModified()
505 && masterfname.lastModified() < bname.lastModified()))) {
506 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
509 return bname.absFilename();
510 // If we have a newer master file log or only a master log, show this
511 } else if (fname != masterfname
512 && (!fname.exists() && (masterfname.exists()
513 || fname.lastModified() < masterfname.lastModified()))) {
514 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
517 return masterfname.absFilename();
519 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
522 return fname.absFilename();
526 void Buffer::setReadonly(bool const flag)
528 if (d->read_only != flag) {
535 void Buffer::setFileName(string const & newfile)
537 d->filename = makeAbsPath(newfile);
538 setReadonly(d->filename.isReadOnly());
543 int Buffer::readHeader(Lexer & lex)
545 int unknown_tokens = 0;
547 int begin_header_line = -1;
549 // Initialize parameters that may be/go lacking in header:
550 params().branchlist().clear();
551 params().preamble.erase();
552 params().options.erase();
553 params().master.erase();
554 params().float_placement.erase();
555 params().paperwidth.erase();
556 params().paperheight.erase();
557 params().leftmargin.erase();
558 params().rightmargin.erase();
559 params().topmargin.erase();
560 params().bottommargin.erase();
561 params().headheight.erase();
562 params().headsep.erase();
563 params().footskip.erase();
564 params().columnsep.erase();
565 params().fontsCJK.erase();
566 params().listings_params.clear();
567 params().clearLayoutModules();
568 params().clearRemovedModules();
569 params().pdfoptions().clear();
570 params().indiceslist().clear();
572 params().indiceslist().addDefault(B_("Index"));
573 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
575 for (int i = 0; i < 4; ++i) {
576 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
577 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
580 ErrorList & errorList = d->errorLists["Parse"];
589 if (token == "\\end_header")
593 if (token == "\\begin_header") {
594 begin_header_line = line;
598 LYXERR(Debug::PARSER, "Handling document header token: `"
601 string unknown = params().readToken(lex, token, d->filename.onlyPath());
602 if (!unknown.empty()) {
603 if (unknown[0] != '\\' && token == "\\textclass") {
604 Alert::warning(_("Unknown document class"),
605 bformat(_("Using the default document class, because the "
606 "class %1$s is unknown."), from_utf8(unknown)));
609 docstring const s = bformat(_("Unknown token: "
613 errorList.push_back(ErrorItem(_("Document header error"),
618 if (begin_header_line) {
619 docstring const s = _("\\begin_header is missing");
620 errorList.push_back(ErrorItem(_("Document header error"),
624 params().makeDocumentClass();
626 return unknown_tokens;
631 // changed to be public and have one parameter
632 // Returns true if "\end_document" is not read (Asger)
633 bool Buffer::readDocument(Lexer & lex)
635 ErrorList & errorList = d->errorLists["Parse"];
638 if (!lex.checkFor("\\begin_document")) {
639 docstring const s = _("\\begin_document is missing");
640 errorList.push_back(ErrorItem(_("Document header error"),
644 // we are reading in a brand new document
645 LASSERT(paragraphs().empty(), /**/);
649 if (params().outputChanges) {
650 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
651 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
652 LaTeXFeatures::isAvailable("xcolor");
654 if (!dvipost && !xcolorulem) {
655 Alert::warning(_("Changes not shown in LaTeX output"),
656 _("Changes will not be highlighted in LaTeX output, "
657 "because neither dvipost nor xcolor/ulem are installed.\n"
658 "Please install these packages or redefine "
659 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
660 } else if (!xcolorulem) {
661 Alert::warning(_("Changes not shown in LaTeX output"),
662 _("Changes will not be highlighted in LaTeX output "
663 "when using pdflatex, because xcolor and ulem are not installed.\n"
664 "Please install both packages or redefine "
665 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
669 if (!params().master.empty()) {
670 FileName const master_file = makeAbsPath(params().master,
671 onlyPath(absFileName()));
672 if (isLyXFilename(master_file.absFilename())) {
674 checkAndLoadLyXFile(master_file, true);
676 // necessary e.g. after a reload
677 // to re-register the child (bug 5873)
678 // FIXME: clean up updateMacros (here, only
679 // child registering is needed).
680 master->updateMacros();
681 // set master as master buffer, but only
682 // if we are a real child
683 if (master->isChild(this))
685 // if the master is not fully loaded
686 // it is probably just loading this
687 // child. No warning needed then.
688 else if (master->isFullyLoaded())
689 LYXERR0("The master '"
691 << "' assigned to this document ("
693 << ") does not include "
694 "this document. Ignoring the master assignment.");
700 bool const res = text().read(lex, errorList, d->inset);
703 updateMacroInstances();
708 bool Buffer::readString(string const & s)
710 params().compressed = false;
712 // remove dummy empty par
713 paragraphs().clear();
717 FileName const name = FileName::tempName("Buffer_readString");
718 switch (readFile(lex, name, true)) {
722 // We need to call lyx2lyx, so write the input to a file
723 ofstream os(name.toFilesystemEncoding().c_str());
726 return readFile(name);
736 bool Buffer::readFile(FileName const & filename)
738 FileName fname(filename);
740 params().compressed = fname.isZippedFile();
742 // remove dummy empty par
743 paragraphs().clear();
746 if (readFile(lex, fname) != success)
753 bool Buffer::isFullyLoaded() const
755 return d->file_fully_loaded;
759 void Buffer::setFullyLoaded(bool value)
761 d->file_fully_loaded = value;
765 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
768 LASSERT(!filename.empty(), /**/);
770 // the first (non-comment) token _must_ be...
771 if (!lex.checkFor("\\lyxformat")) {
772 Alert::error(_("Document format failure"),
773 bformat(_("%1$s is not a readable LyX document."),
774 from_utf8(filename.absFilename())));
780 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
781 // if present remove ".," from string.
782 size_t dot = tmp_format.find_first_of(".,");
783 //lyxerr << " dot found at " << dot << endl;
784 if (dot != string::npos)
785 tmp_format.erase(dot, 1);
786 int const file_format = convert<int>(tmp_format);
787 //lyxerr << "format: " << file_format << endl;
789 // save timestamp and checksum of the original disk file, making sure
790 // to not overwrite them with those of the file created in the tempdir
791 // when it has to be converted to the current format.
793 // Save the timestamp and checksum of disk file. If filename is an
794 // emergency file, save the timestamp and checksum of the original lyx file
795 // because isExternallyModified will check for this file. (BUG4193)
796 string diskfile = filename.absFilename();
797 if (suffixIs(diskfile, ".emergency"))
798 diskfile = diskfile.substr(0, diskfile.size() - 10);
799 saveCheckSum(FileName(diskfile));
802 if (file_format != LYX_FORMAT) {
805 // lyx2lyx would fail
808 FileName const tmpfile = FileName::tempName("Buffer_readFile");
809 if (tmpfile.empty()) {
810 Alert::error(_("Conversion failed"),
811 bformat(_("%1$s is from a different"
812 " version of LyX, but a temporary"
813 " file for converting it could"
815 from_utf8(filename.absFilename())));
818 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
819 if (lyx2lyx.empty()) {
820 Alert::error(_("Conversion script not found"),
821 bformat(_("%1$s is from a different"
822 " version of LyX, but the"
823 " conversion script lyx2lyx"
824 " could not be found."),
825 from_utf8(filename.absFilename())));
828 ostringstream command;
829 command << os::python()
830 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
831 << " -t " << convert<string>(LYX_FORMAT)
832 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
833 << ' ' << quoteName(filename.toFilesystemEncoding());
834 string const command_str = command.str();
836 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
838 cmd_ret const ret = runCommand(command_str);
839 if (ret.first != 0) {
840 Alert::error(_("Conversion script failed"),
841 bformat(_("%1$s is from a different version"
842 " of LyX, but the lyx2lyx script"
843 " failed to convert it."),
844 from_utf8(filename.absFilename())));
847 bool const ret = readFile(tmpfile);
848 // Do stuff with tmpfile name and buffer name here.
849 return ret ? success : failure;
854 if (readDocument(lex)) {
855 Alert::error(_("Document format failure"),
856 bformat(_("%1$s ended unexpectedly, which means"
857 " that it is probably corrupted."),
858 from_utf8(filename.absFilename())));
861 d->file_fully_loaded = true;
866 // Should probably be moved to somewhere else: BufferView? LyXView?
867 bool Buffer::save() const
869 // We don't need autosaves in the immediate future. (Asger)
870 resetAutosaveTimers();
872 string const encodedFilename = d->filename.toFilesystemEncoding();
875 bool madeBackup = false;
877 // make a backup if the file already exists
878 if (lyxrc.make_backup && fileName().exists()) {
879 backupName = FileName(absFileName() + '~');
880 if (!lyxrc.backupdir_path.empty()) {
881 string const mangledName =
882 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
883 backupName = FileName(addName(lyxrc.backupdir_path,
886 if (fileName().copyTo(backupName)) {
889 Alert::error(_("Backup failure"),
890 bformat(_("Cannot create backup file %1$s.\n"
891 "Please check whether the directory exists and is writeable."),
892 from_utf8(backupName.absFilename())));
893 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
897 // ask if the disk file has been externally modified (use checksum method)
898 if (fileName().exists() && isExternallyModified(checksum_method)) {
899 docstring const file = makeDisplayPath(absFileName(), 20);
900 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
901 "you want to overwrite this file?"), file);
902 int const ret = Alert::prompt(_("Overwrite modified file?"),
903 text, 1, 1, _("&Overwrite"), _("&Cancel"));
908 if (writeFile(d->filename)) {
912 // Saving failed, so backup is not backup
914 backupName.moveTo(d->filename);
920 bool Buffer::writeFile(FileName const & fname) const
922 if (d->read_only && fname == d->filename)
927 docstring const str = bformat(_("Saving document %1$s..."),
928 makeDisplayPath(fname.absFilename()));
931 if (params().compressed) {
932 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
933 retval = ofs && write(ofs);
935 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
936 retval = ofs && write(ofs);
940 message(str + _(" could not write file!"));
944 removeAutosaveFile();
946 saveCheckSum(d->filename);
947 message(str + _(" done."));
953 docstring Buffer::emergencyWrite()
955 // No need to save if the buffer has not changed.
959 string const doc = isUnnamed() ? onlyFilename(absFileName()) : absFileName();
961 docstring user_message = bformat(
962 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
964 // We try to save three places:
965 // 1) Same place as document. Unless it is an unnamed doc.
967 string s = absFileName();
970 if (writeFile(FileName(s))) {
972 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
975 user_message += _(" Save failed! Trying again...\n");
979 // 2) In HOME directory.
980 string s = addName(package().home_dir().absFilename(), absFileName());
982 lyxerr << ' ' << s << endl;
983 if (writeFile(FileName(s))) {
985 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
989 user_message += _(" Save failed! Trying yet again...\n");
991 // 3) In "/tmp" directory.
992 // MakeAbsPath to prepend the current
993 // drive letter on OS/2
994 s = addName(package().temp_dir().absFilename(), absFileName());
996 lyxerr << ' ' << s << endl;
997 if (writeFile(FileName(s))) {
999 user_message += bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s));
1000 return user_message;
1003 user_message += _(" Save failed! Bummer. Document is lost.");
1006 return user_message;
1010 bool Buffer::write(ostream & ofs) const
1013 // Use the standard "C" locale for file output.
1014 ofs.imbue(locale::classic());
1017 // The top of the file should not be written by params().
1019 // write out a comment in the top of the file
1020 ofs << "#LyX " << lyx_version
1021 << " created this file. For more info see http://www.lyx.org/\n"
1022 << "\\lyxformat " << LYX_FORMAT << "\n"
1023 << "\\begin_document\n";
1025 /// For each author, set 'used' to true if there is a change
1026 /// by this author in the document; otherwise set it to 'false'.
1027 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1028 AuthorList::Authors::const_iterator a_end = params().authors().end();
1029 for (; a_it != a_end; ++a_it)
1030 a_it->setUsed(false);
1032 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1033 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1034 for ( ; it != end; ++it)
1035 it->checkAuthors(params().authors());
1037 // now write out the buffer parameters.
1038 ofs << "\\begin_header\n";
1039 params().writeFile(ofs);
1040 ofs << "\\end_header\n";
1043 ofs << "\n\\begin_body\n";
1045 ofs << "\n\\end_body\n";
1047 // Write marker that shows file is complete
1048 ofs << "\\end_document" << endl;
1050 // Shouldn't really be needed....
1053 // how to check if close went ok?
1054 // Following is an attempt... (BE 20001011)
1056 // good() returns false if any error occured, including some
1057 // formatting error.
1058 // bad() returns true if something bad happened in the buffer,
1059 // which should include file system full errors.
1064 lyxerr << "File was not closed properly." << endl;
1071 bool Buffer::makeLaTeXFile(FileName const & fname,
1072 string const & original_path,
1073 OutputParams const & runparams_in,
1074 bool output_preamble, bool output_body) const
1076 OutputParams runparams = runparams_in;
1077 if (params().useXetex)
1078 runparams.flavor = OutputParams::XETEX;
1080 string const encoding = runparams.encoding->iconvName();
1081 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1084 try { ofs.reset(encoding); }
1085 catch (iconv_codecvt_facet_exception & e) {
1086 lyxerr << "Caught iconv exception: " << e.what() << endl;
1087 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1088 "verify that the support software for your encoding (%1$s) is "
1089 "properly installed"), from_ascii(encoding)));
1092 if (!openFileWrite(ofs, fname))
1095 //TexStream ts(ofs.rdbuf(), &texrow());
1096 ErrorList & errorList = d->errorLists["Export"];
1098 bool failed_export = false;
1101 writeLaTeXSource(ofs, original_path,
1102 runparams, output_preamble, output_body);
1104 catch (EncodingException & e) {
1105 odocstringstream ods;
1106 ods.put(e.failed_char);
1108 oss << "0x" << hex << e.failed_char << dec;
1109 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1110 " (code point %2$s)"),
1111 ods.str(), from_utf8(oss.str()));
1112 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1113 "representable in the chosen encoding.\n"
1114 "Changing the document encoding to utf8 could help."),
1115 e.par_id, e.pos, e.pos + 1));
1116 failed_export = true;
1118 catch (iconv_codecvt_facet_exception & e) {
1119 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1120 _(e.what()), -1, 0, 0));
1121 failed_export = true;
1123 catch (exception const & e) {
1124 errorList.push_back(ErrorItem(_("conversion failed"),
1125 _(e.what()), -1, 0, 0));
1126 failed_export = true;
1129 lyxerr << "Caught some really weird exception..." << endl;
1135 failed_export = true;
1136 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1140 return !failed_export;
1144 void Buffer::writeLaTeXSource(odocstream & os,
1145 string const & original_path,
1146 OutputParams const & runparams_in,
1147 bool const output_preamble, bool const output_body) const
1149 // The child documents, if any, shall be already loaded at this point.
1151 OutputParams runparams = runparams_in;
1153 // Classify the unicode characters appearing in math insets
1154 Encodings::initUnicodeMath(*this);
1156 // validate the buffer.
1157 LYXERR(Debug::LATEX, " Validating buffer...");
1158 LaTeXFeatures features(*this, params(), runparams);
1160 LYXERR(Debug::LATEX, " Buffer validation done.");
1162 // The starting paragraph of the coming rows is the
1163 // first paragraph of the document. (Asger)
1164 if (output_preamble && runparams.nice) {
1165 os << "%% LyX " << lyx_version << " created this file. "
1166 "For more info, see http://www.lyx.org/.\n"
1167 "%% Do not edit unless you really know what "
1169 d->texrow.newline();
1170 d->texrow.newline();
1172 LYXERR(Debug::INFO, "lyx document header finished");
1174 // Don't move this behind the parent_buffer=0 code below,
1175 // because then the macros will not get the right "redefinition"
1176 // flag as they don't see the parent macros which are output before.
1179 // fold macros if possible, still with parent buffer as the
1180 // macros will be put in the prefix anyway.
1181 updateMacroInstances();
1183 // There are a few differences between nice LaTeX and usual files:
1184 // usual is \batchmode and has a
1185 // special input@path to allow the including of figures
1186 // with either \input or \includegraphics (what figinsets do).
1187 // input@path is set when the actual parameter
1188 // original_path is set. This is done for usual tex-file, but not
1189 // for nice-latex-file. (Matthias 250696)
1190 // Note that input@path is only needed for something the user does
1191 // in the preamble, included .tex files or ERT, files included by
1192 // LyX work without it.
1193 if (output_preamble) {
1194 if (!runparams.nice) {
1195 // code for usual, NOT nice-latex-file
1196 os << "\\batchmode\n"; // changed
1197 // from \nonstopmode
1198 d->texrow.newline();
1200 if (!original_path.empty()) {
1202 // We don't know the encoding of inputpath
1203 docstring const inputpath = from_utf8(latex_path(original_path));
1204 os << "\\makeatletter\n"
1205 << "\\def\\input@path{{"
1206 << inputpath << "/}}\n"
1207 << "\\makeatother\n";
1208 d->texrow.newline();
1209 d->texrow.newline();
1210 d->texrow.newline();
1213 // get parent macros (if this buffer has a parent) which will be
1214 // written at the document begin further down.
1215 MacroSet parentMacros;
1216 listParentMacros(parentMacros, features);
1218 // Write the preamble
1219 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1221 runparams.use_japanese = features.isRequired("japanese");
1227 os << "\\begin{document}\n";
1228 d->texrow.newline();
1230 // output the parent macros
1231 MacroSet::iterator it = parentMacros.begin();
1232 MacroSet::iterator end = parentMacros.end();
1233 for (; it != end; ++it)
1234 (*it)->write(os, true);
1235 } // output_preamble
1237 d->texrow.start(paragraphs().begin()->id(), 0);
1239 LYXERR(Debug::INFO, "preamble finished, now the body.");
1241 // if we are doing a real file with body, even if this is the
1242 // child of some other buffer, let's cut the link here.
1243 // This happens for example if only a child document is printed.
1244 Buffer const * save_parent = 0;
1245 if (output_preamble) {
1246 save_parent = d->parent();
1251 latexParagraphs(*this, text(), os, d->texrow, runparams);
1253 // Restore the parenthood if needed
1254 if (output_preamble)
1255 d->setParent(save_parent);
1257 // add this just in case after all the paragraphs
1259 d->texrow.newline();
1261 if (output_preamble) {
1262 os << "\\end{document}\n";
1263 d->texrow.newline();
1264 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1266 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1268 runparams_in.encoding = runparams.encoding;
1270 // Just to be sure. (Asger)
1271 d->texrow.newline();
1273 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1274 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1278 bool Buffer::isLatex() const
1280 return params().documentClass().outputType() == LATEX;
1284 bool Buffer::isLiterate() const
1286 return params().documentClass().outputType() == LITERATE;
1290 bool Buffer::isDocBook() const
1292 return params().documentClass().outputType() == DOCBOOK;
1296 void Buffer::makeDocBookFile(FileName const & fname,
1297 OutputParams const & runparams,
1298 bool const body_only) const
1300 LYXERR(Debug::LATEX, "makeDocBookFile...");
1303 if (!openFileWrite(ofs, fname))
1306 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1310 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1314 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1315 OutputParams const & runparams,
1316 bool const only_body) const
1318 LaTeXFeatures features(*this, params(), runparams);
1323 DocumentClass const & tclass = params().documentClass();
1324 string const top_element = tclass.latexname();
1327 if (runparams.flavor == OutputParams::XML)
1328 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1331 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1334 if (! tclass.class_header().empty())
1335 os << from_ascii(tclass.class_header());
1336 else if (runparams.flavor == OutputParams::XML)
1337 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1338 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1340 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1342 docstring preamble = from_utf8(params().preamble);
1343 if (runparams.flavor != OutputParams::XML ) {
1344 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1345 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1346 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1347 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1350 string const name = runparams.nice
1351 ? changeExtension(absFileName(), ".sgml") : fname;
1352 preamble += features.getIncludedFiles(name);
1353 preamble += features.getLyXSGMLEntities();
1355 if (!preamble.empty()) {
1356 os << "\n [ " << preamble << " ]";
1361 string top = top_element;
1363 if (runparams.flavor == OutputParams::XML)
1364 top += params().language->code();
1366 top += params().language->code().substr(0, 2);
1369 if (!params().options.empty()) {
1371 top += params().options;
1374 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1375 << " file was created by LyX " << lyx_version
1376 << "\n See http://www.lyx.org/ for more information -->\n";
1378 params().documentClass().counters().reset();
1382 sgml::openTag(os, top);
1384 docbookParagraphs(text(), *this, os, runparams);
1385 sgml::closeTag(os, top_element);
1389 void Buffer::makeLyXHTMLFile(FileName const & fname,
1390 OutputParams const & runparams,
1391 bool const body_only) const
1393 LYXERR(Debug::LATEX, "makeLYXHTMLFile...");
1396 if (!openFileWrite(ofs, fname))
1399 writeLyXHTMLSource(ofs, runparams, body_only);
1403 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1407 void Buffer::writeLyXHTMLSource(odocstream & os,
1408 OutputParams const & runparams,
1409 bool const only_body) const
1411 LaTeXFeatures features(*this, params(), runparams);
1417 os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" <<
1418 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
1419 // FIXME Language should be set properly.
1420 os << "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n";
1423 // FIXME Presumably need to set this right
1424 os << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1425 // FIXME Get this during validation? What about other meta-data?
1426 os << "<title>TBA</title>\n";
1428 os << features.getTClassHTMLPreamble();
1432 docstring const styleinfo = features.getTClassHTMLStyles();
1433 if (!styleinfo.empty()) {
1434 os << "<style type='text/css'>\n";
1438 os << "</head>\n<body>\n";
1441 params().documentClass().counters().reset();
1442 xhtmlParagraphs(text(), *this, os, runparams);
1444 os << "</body>\n</html>\n";
1448 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1449 // Other flags: -wall -v0 -x
1450 int Buffer::runChktex()
1454 // get LaTeX-Filename
1455 FileName const path(temppath());
1456 string const name = addName(path.absFilename(), latexName());
1457 string const org_path = filePath();
1459 PathChanger p(path); // path to LaTeX file
1460 message(_("Running chktex..."));
1462 // Generate the LaTeX file if neccessary
1463 OutputParams runparams(¶ms().encoding());
1464 runparams.flavor = OutputParams::LATEX;
1465 runparams.nice = false;
1466 makeLaTeXFile(FileName(name), org_path, runparams);
1469 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1470 int const res = chktex.run(terr); // run chktex
1473 Alert::error(_("chktex failure"),
1474 _("Could not run chktex successfully."));
1475 } else if (res > 0) {
1476 ErrorList & errlist = d->errorLists["ChkTeX"];
1478 bufferErrors(terr, errlist);
1489 void Buffer::validate(LaTeXFeatures & features) const
1491 params().validate(features);
1495 for_each(paragraphs().begin(), paragraphs().end(),
1496 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1498 if (lyxerr.debugging(Debug::LATEX)) {
1499 features.showStruct();
1504 void Buffer::getLabelList(vector<docstring> & list) const
1506 // If this is a child document, use the parent's list instead.
1507 Buffer const * const pbuf = d->parent();
1509 pbuf->getLabelList(list);
1514 Toc & toc = d->toc_backend.toc("label");
1515 TocIterator toc_it = toc.begin();
1516 TocIterator end = toc.end();
1517 for (; toc_it != end; ++toc_it) {
1518 if (toc_it->depth() == 0)
1519 list.push_back(toc_it->str());
1524 void Buffer::updateBibfilesCache(UpdateScope scope) const
1526 // If this is a child document, use the parent's cache instead.
1527 Buffer const * const pbuf = d->parent();
1528 if (pbuf && scope != UpdateChildOnly) {
1529 pbuf->updateBibfilesCache();
1533 d->bibfilesCache_.clear();
1534 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1535 if (it->lyxCode() == BIBTEX_CODE) {
1536 InsetBibtex const & inset =
1537 static_cast<InsetBibtex const &>(*it);
1538 support::FileNameList const bibfiles = inset.getBibFiles();
1539 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1542 } else if (it->lyxCode() == INCLUDE_CODE) {
1543 InsetInclude & inset =
1544 static_cast<InsetInclude &>(*it);
1545 inset.updateBibfilesCache();
1546 support::FileNameList const & bibfiles =
1547 inset.getBibfilesCache();
1548 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1553 // the bibinfo cache is now invalid
1554 d->bibinfoCacheValid_ = false;
1558 void Buffer::invalidateBibinfoCache()
1560 d->bibinfoCacheValid_ = false;
1564 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1566 // If this is a child document, use the parent's cache instead.
1567 Buffer const * const pbuf = d->parent();
1568 if (pbuf && scope != UpdateChildOnly)
1569 return pbuf->getBibfilesCache();
1571 // We update the cache when first used instead of at loading time.
1572 if (d->bibfilesCache_.empty())
1573 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1575 return d->bibfilesCache_;
1579 BiblioInfo const & Buffer::masterBibInfo() const
1581 // if this is a child document and the parent is already loaded
1582 // use the parent's list instead [ale990412]
1583 Buffer const * const tmp = masterBuffer();
1586 return tmp->masterBibInfo();
1587 return localBibInfo();
1591 BiblioInfo const & Buffer::localBibInfo() const
1593 if (d->bibinfoCacheValid_) {
1594 support::FileNameList const & bibfilesCache = getBibfilesCache();
1595 // compare the cached timestamps with the actual ones.
1596 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1597 support::FileNameList::const_iterator en = bibfilesCache.end();
1598 for (; ei != en; ++ ei) {
1599 time_t lastw = ei->lastModified();
1600 if (lastw != d->bibfileStatus_[*ei]) {
1601 d->bibinfoCacheValid_ = false;
1602 d->bibfileStatus_[*ei] = lastw;
1608 if (!d->bibinfoCacheValid_) {
1609 d->bibinfo_.clear();
1610 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1611 it->fillWithBibKeys(d->bibinfo_, it);
1612 d->bibinfoCacheValid_ = true;
1618 bool Buffer::isDepClean(string const & name) const
1620 DepClean::const_iterator const it = d->dep_clean.find(name);
1621 if (it == d->dep_clean.end())
1627 void Buffer::markDepClean(string const & name)
1629 d->dep_clean[name] = true;
1633 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1635 switch (cmd.action) {
1636 case LFUN_BUFFER_EXPORT: {
1637 docstring const arg = cmd.argument();
1638 bool enable = arg == "custom" || isExportable(to_utf8(arg));
1640 flag.message(bformat(
1641 _("Don't know how to export to format: %1$s"), arg));
1642 flag.setEnabled(enable);
1646 case LFUN_BRANCH_ACTIVATE:
1647 case LFUN_BRANCH_DEACTIVATE: {
1648 BranchList const & branchList = params().branchlist();
1649 docstring const branchName = cmd.argument();
1650 flag.setEnabled(!branchName.empty()
1651 && branchList.find(branchName));
1655 case LFUN_BRANCH_ADD:
1656 case LFUN_BRANCHES_RENAME:
1657 case LFUN_BUFFER_PRINT:
1658 // if no Buffer is present, then of course we won't be called!
1659 flag.setEnabled(true);
1669 void Buffer::dispatch(string const & command, DispatchResult & result)
1671 return dispatch(lyxaction.lookupFunc(command), result);
1675 // NOTE We can end up here even if we have no GUI, because we are called
1676 // by LyX::exec to handled command-line requests. So we may need to check
1677 // whether we have a GUI or not. The boolean use_gui holds this information.
1678 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1680 // We'll set this back to false if need be.
1681 bool dispatched = true;
1683 switch (func.action) {
1684 case LFUN_BUFFER_EXPORT: {
1685 bool success = doExport(to_utf8(func.argument()), false);
1686 dr.setError(success);
1688 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1693 case LFUN_BRANCH_ADD: {
1694 BranchList & branchList = params().branchlist();
1695 docstring const branchName = func.argument();
1696 if (branchName.empty()) {
1700 Branch * branch = branchList.find(branchName);
1702 LYXERR0("Branch " << branchName << " does already exist.");
1704 docstring const msg =
1705 bformat(_("Branch \"%1$s\" does already exist."), branchName);
1708 branchList.add(branchName);
1710 dr.update(Update::Force);
1715 case LFUN_BRANCH_ACTIVATE:
1716 case LFUN_BRANCH_DEACTIVATE: {
1717 BranchList & branchList = params().branchlist();
1718 docstring const branchName = func.argument();
1719 // the case without a branch name is handled elsewhere
1720 if (branchName.empty()) {
1724 Branch * branch = branchList.find(branchName);
1726 LYXERR0("Branch " << branchName << " does not exist.");
1728 docstring const msg =
1729 bformat(_("Branch \"%1$s\" does not exist."), branchName);
1732 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1734 dr.update(Update::Force);
1739 case LFUN_BRANCHES_RENAME: {
1740 if (func.argument().empty())
1743 docstring const oldname = from_utf8(func.getArg(0));
1744 docstring const newname = from_utf8(func.getArg(1));
1745 InsetIterator it = inset_iterator_begin(inset());
1746 InsetIterator const end = inset_iterator_end(inset());
1747 bool success = false;
1748 for (; it != end; ++it) {
1749 if (it->lyxCode() == BRANCH_CODE) {
1750 InsetBranch & ins = static_cast<InsetBranch &>(*it);
1751 if (ins.branch() == oldname) {
1752 undo().recordUndo(it);
1753 ins.rename(newname);
1758 if (it->lyxCode() == INCLUDE_CODE) {
1759 // get buffer of external file
1760 InsetInclude const & ins =
1761 static_cast<InsetInclude const &>(*it);
1762 Buffer * child = ins.getChildBuffer();
1765 child->dispatch(func, dr);
1770 dr.update(Update::Force);
1774 case LFUN_BUFFER_PRINT: {
1775 // we'll assume there's a problem until we succeed
1777 string target = func.getArg(0);
1778 string target_name = func.getArg(1);
1779 string command = func.getArg(2);
1782 || target_name.empty()
1783 || command.empty()) {
1784 LYXERR0("Unable to parse " << func.argument());
1785 docstring const msg =
1786 bformat(_("Unable to parse \"%1$s\""), func.argument());
1790 if (target != "printer" && target != "file") {
1791 LYXERR0("Unrecognized target \"" << target << '"');
1792 docstring const msg =
1793 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
1798 if (!doExport("dvi", true)) {
1799 showPrintError(absFileName());
1800 dr.setMessage(_("Error exporting to DVI."));
1804 // Push directory path.
1805 string const path = temppath();
1806 // Prevent the compiler from optimizing away p
1810 // there are three cases here:
1811 // 1. we print to a file
1812 // 2. we print directly to a printer
1813 // 3. we print using a spool command (print to file first)
1816 string const dviname = changeExtension(latexName(true), "dvi");
1818 if (target == "printer") {
1819 if (!lyxrc.print_spool_command.empty()) {
1820 // case 3: print using a spool
1821 string const psname = changeExtension(dviname,".ps");
1822 command += ' ' + lyxrc.print_to_file
1825 + quoteName(dviname);
1827 string command2 = lyxrc.print_spool_command + ' ';
1828 if (target_name != "default") {
1829 command2 += lyxrc.print_spool_printerprefix
1833 command2 += quoteName(psname);
1835 // If successful, then spool command
1836 res = one.startscript(Systemcall::Wait, command);
1839 // If there's no GUI, we have to wait on this command. Otherwise,
1840 // LyX deletes the temporary directory, and with it the spooled
1841 // file, before it can be printed!!
1842 Systemcall::Starttype stype = use_gui ?
1843 Systemcall::DontWait : Systemcall::Wait;
1844 res = one.startscript(stype, command2);
1847 // case 2: print directly to a printer
1848 if (target_name != "default")
1849 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
1851 Systemcall::Starttype stype = use_gui ?
1852 Systemcall::DontWait : Systemcall::Wait;
1853 res = one.startscript(stype, command + quoteName(dviname));
1857 // case 1: print to a file
1858 FileName const filename(makeAbsPath(target_name, filePath()));
1859 FileName const dvifile(makeAbsPath(dviname, path));
1860 if (filename.exists()) {
1861 docstring text = bformat(
1862 _("The file %1$s already exists.\n\n"
1863 "Do you want to overwrite that file?"),
1864 makeDisplayPath(filename.absFilename()));
1865 if (Alert::prompt(_("Overwrite file?"),
1866 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
1869 command += ' ' + lyxrc.print_to_file
1870 + quoteName(filename.toFilesystemEncoding())
1872 + quoteName(dvifile.toFilesystemEncoding());
1874 Systemcall::Starttype stype = use_gui ?
1875 Systemcall::DontWait : Systemcall::Wait;
1876 res = one.startscript(stype, command);
1882 dr.setMessage(_("Error running external commands."));
1883 showPrintError(absFileName());
1892 dr.dispatched(dispatched);
1896 void Buffer::changeLanguage(Language const * from, Language const * to)
1898 LASSERT(from, /**/);
1901 for_each(par_iterator_begin(),
1903 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1907 bool Buffer::isMultiLingual() const
1909 ParConstIterator end = par_iterator_end();
1910 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1911 if (it->isMultiLingual(params()))
1918 DocIterator Buffer::getParFromID(int const id) const
1920 Buffer * buf = const_cast<Buffer *>(this);
1922 // John says this is called with id == -1 from undo
1923 lyxerr << "getParFromID(), id: " << id << endl;
1924 return doc_iterator_end(buf);
1927 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
1928 if (it.paragraph().id() == id)
1931 return doc_iterator_end(buf);
1935 bool Buffer::hasParWithID(int const id) const
1937 return !getParFromID(id).atEnd();
1941 ParIterator Buffer::par_iterator_begin()
1943 return ParIterator(doc_iterator_begin(this));
1947 ParIterator Buffer::par_iterator_end()
1949 return ParIterator(doc_iterator_end(this));
1953 ParConstIterator Buffer::par_iterator_begin() const
1955 return ParConstIterator(doc_iterator_begin(this));
1959 ParConstIterator Buffer::par_iterator_end() const
1961 return ParConstIterator(doc_iterator_end(this));
1965 Language const * Buffer::language() const
1967 return params().language;
1971 docstring const Buffer::B_(string const & l10n) const
1973 return params().B_(l10n);
1977 bool Buffer::isClean() const
1979 return d->lyx_clean;
1983 bool Buffer::isBakClean() const
1985 return d->bak_clean;
1989 bool Buffer::isExternallyModified(CheckMethod method) const
1991 LASSERT(d->filename.exists(), /**/);
1992 // if method == timestamp, check timestamp before checksum
1993 return (method == checksum_method
1994 || d->timestamp_ != d->filename.lastModified())
1995 && d->checksum_ != d->filename.checksum();
1999 void Buffer::saveCheckSum(FileName const & file) const
2001 if (file.exists()) {
2002 d->timestamp_ = file.lastModified();
2003 d->checksum_ = file.checksum();
2005 // in the case of save to a new file.
2012 void Buffer::markClean() const
2014 if (!d->lyx_clean) {
2015 d->lyx_clean = true;
2018 // if the .lyx file has been saved, we don't need an
2020 d->bak_clean = true;
2024 void Buffer::markBakClean() const
2026 d->bak_clean = true;
2030 void Buffer::setUnnamed(bool flag)
2036 bool Buffer::isUnnamed() const
2042 // FIXME: this function should be moved to buffer_pimpl.C
2043 void Buffer::markDirty()
2046 d->lyx_clean = false;
2049 d->bak_clean = false;
2051 DepClean::iterator it = d->dep_clean.begin();
2052 DepClean::const_iterator const end = d->dep_clean.end();
2054 for (; it != end; ++it)
2059 FileName Buffer::fileName() const
2065 string Buffer::absFileName() const
2067 return d->filename.absFilename();
2071 string Buffer::filePath() const
2073 return d->filename.onlyPath().absFilename() + "/";
2077 bool Buffer::isReadonly() const
2079 return d->read_only;
2083 void Buffer::setParent(Buffer const * buffer)
2085 // Avoids recursive include.
2086 d->setParent(buffer == this ? 0 : buffer);
2091 Buffer const * Buffer::parent() const
2097 void Buffer::collectRelatives(BufferSet & bufs) const
2101 parent()->collectRelatives(bufs);
2103 // loop over children
2104 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2105 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2106 for (; it != end; ++it)
2107 bufs.insert(const_cast<Buffer *>(it->first));
2111 std::vector<Buffer const *> Buffer::allRelatives() const
2114 collectRelatives(bufs);
2115 BufferSet::iterator it = bufs.begin();
2116 std::vector<Buffer const *> ret;
2117 for (; it != bufs.end(); ++it)
2123 Buffer const * Buffer::masterBuffer() const
2125 Buffer const * const pbuf = d->parent();
2129 return pbuf->masterBuffer();
2133 bool Buffer::isChild(Buffer * child) const
2135 return d->children_positions.find(child) != d->children_positions.end();
2139 DocIterator Buffer::firstChildPosition(Buffer const * child)
2141 Impl::BufferPositionMap::iterator it;
2142 it = d->children_positions.find(child);
2143 if (it == d->children_positions.end())
2144 return DocIterator(this);
2149 std::vector<Buffer *> Buffer::getChildren() const
2151 std::vector<Buffer *> clist;
2152 // loop over children
2153 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2154 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2155 for (; it != end; ++it) {
2156 Buffer * child = const_cast<Buffer *>(it->first);
2157 clist.push_back(child);
2158 // there might be grandchildren
2159 std::vector<Buffer *> glist = child->getChildren();
2160 for (vector<Buffer *>::const_iterator git = glist.begin();
2161 git != glist.end(); ++git)
2162 clist.push_back(*git);
2168 template<typename M>
2169 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
2174 typename M::iterator it = m.lower_bound(x);
2175 if (it == m.begin())
2183 MacroData const * Buffer::getBufferMacro(docstring const & name,
2184 DocIterator const & pos) const
2186 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2188 // if paragraphs have no macro context set, pos will be empty
2192 // we haven't found anything yet
2193 DocIterator bestPos = par_iterator_begin();
2194 MacroData const * bestData = 0;
2196 // find macro definitions for name
2197 Impl::NamePositionScopeMacroMap::iterator nameIt
2198 = d->macros.find(name);
2199 if (nameIt != d->macros.end()) {
2200 // find last definition in front of pos or at pos itself
2201 Impl::PositionScopeMacroMap::const_iterator it
2202 = greatest_below(nameIt->second, pos);
2203 if (it != nameIt->second.end()) {
2205 // scope ends behind pos?
2206 if (pos < it->second.first) {
2207 // Looks good, remember this. If there
2208 // is no external macro behind this,
2209 // we found the right one already.
2210 bestPos = it->first;
2211 bestData = &it->second.second;
2215 // try previous macro if there is one
2216 if (it == nameIt->second.begin())
2223 // find macros in included files
2224 Impl::PositionScopeBufferMap::const_iterator it
2225 = greatest_below(d->position_to_children, pos);
2226 if (it == d->position_to_children.end())
2227 // no children before
2231 // do we know something better (i.e. later) already?
2232 if (it->first < bestPos )
2235 // scope ends behind pos?
2236 if (pos < it->second.first) {
2237 // look for macro in external file
2238 d->macro_lock = true;
2239 MacroData const * data
2240 = it->second.second->getMacro(name, false);
2241 d->macro_lock = false;
2243 bestPos = it->first;
2249 // try previous file if there is one
2250 if (it == d->position_to_children.begin())
2255 // return the best macro we have found
2260 MacroData const * Buffer::getMacro(docstring const & name,
2261 DocIterator const & pos, bool global) const
2266 // query buffer macros
2267 MacroData const * data = getBufferMacro(name, pos);
2271 // If there is a master buffer, query that
2272 Buffer const * const pbuf = d->parent();
2274 d->macro_lock = true;
2275 MacroData const * macro = pbuf->getMacro(
2276 name, *this, false);
2277 d->macro_lock = false;
2283 data = MacroTable::globalMacros().get(name);
2292 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2294 // set scope end behind the last paragraph
2295 DocIterator scope = par_iterator_begin();
2296 scope.pit() = scope.lastpit() + 1;
2298 return getMacro(name, scope, global);
2302 MacroData const * Buffer::getMacro(docstring const & name,
2303 Buffer const & child, bool global) const
2305 // look where the child buffer is included first
2306 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2307 if (it == d->children_positions.end())
2310 // check for macros at the inclusion position
2311 return getMacro(name, it->second, global);
2315 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
2317 pit_type lastpit = it.lastpit();
2319 // look for macros in each paragraph
2320 while (it.pit() <= lastpit) {
2321 Paragraph & par = it.paragraph();
2323 // iterate over the insets of the current paragraph
2324 InsetList const & insets = par.insetList();
2325 InsetList::const_iterator iit = insets.begin();
2326 InsetList::const_iterator end = insets.end();
2327 for (; iit != end; ++iit) {
2328 it.pos() = iit->pos;
2330 // is it a nested text inset?
2331 if (iit->inset->asInsetText()) {
2332 // Inset needs its own scope?
2333 InsetText const * itext = iit->inset->asInsetText();
2334 bool newScope = itext->isMacroScope();
2336 // scope which ends just behind the inset
2337 DocIterator insetScope = it;
2340 // collect macros in inset
2341 it.push_back(CursorSlice(*iit->inset));
2342 updateMacros(it, newScope ? insetScope : scope);
2347 // is it an external file?
2348 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2349 // get buffer of external file
2350 InsetInclude const & inset =
2351 static_cast<InsetInclude const &>(*iit->inset);
2352 d->macro_lock = true;
2353 Buffer * child = inset.getChildBuffer();
2354 d->macro_lock = false;
2358 // register its position, but only when it is
2359 // included first in the buffer
2360 if (d->children_positions.find(child) ==
2361 d->children_positions.end())
2362 d->children_positions[child] = it;
2364 // register child with its scope
2365 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
2369 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2373 MathMacroTemplate & macroTemplate =
2374 static_cast<MathMacroTemplate &>(*iit->inset);
2375 MacroContext mc(*this, it);
2376 macroTemplate.updateToContext(mc);
2379 bool valid = macroTemplate.validMacro();
2380 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2381 // then the BufferView's cursor will be invalid in
2382 // some cases which leads to crashes.
2387 d->macros[macroTemplate.name()][it] =
2388 Impl::ScopeMacro(scope, MacroData(*this, it));
2398 void Buffer::updateMacros() const
2403 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2405 // start with empty table
2407 d->children_positions.clear();
2408 d->position_to_children.clear();
2410 // Iterate over buffer, starting with first paragraph
2411 // The scope must be bigger than any lookup DocIterator
2412 // later. For the global lookup, lastpit+1 is used, hence
2413 // we use lastpit+2 here.
2414 DocIterator it = par_iterator_begin();
2415 DocIterator outerScope = it;
2416 outerScope.pit() = outerScope.lastpit() + 2;
2417 updateMacros(it, outerScope);
2421 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2423 InsetIterator it = inset_iterator_begin(inset());
2424 InsetIterator const end = inset_iterator_end(inset());
2425 for (; it != end; ++it) {
2426 if (it->lyxCode() == BRANCH_CODE) {
2427 InsetBranch & br = static_cast<InsetBranch &>(*it);
2428 docstring const name = br.branch();
2429 if (!from_master && !params().branchlist().find(name))
2430 result.push_back(name);
2431 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2432 result.push_back(name);
2435 if (it->lyxCode() == INCLUDE_CODE) {
2436 // get buffer of external file
2437 InsetInclude const & ins =
2438 static_cast<InsetInclude const &>(*it);
2439 Buffer * child = ins.getChildBuffer();
2442 child->getUsedBranches(result, true);
2445 // remove duplicates
2450 void Buffer::updateMacroInstances() const
2452 LYXERR(Debug::MACROS, "updateMacroInstances for "
2453 << d->filename.onlyFileName());
2454 DocIterator it = doc_iterator_begin(this);
2455 DocIterator end = doc_iterator_end(this);
2456 for (; it != end; it.forwardPos()) {
2457 // look for MathData cells in InsetMathNest insets
2458 Inset * inset = it.nextInset();
2462 InsetMath * minset = inset->asInsetMath();
2466 // update macro in all cells of the InsetMathNest
2467 DocIterator::idx_type n = minset->nargs();
2468 MacroContext mc = MacroContext(*this, it);
2469 for (DocIterator::idx_type i = 0; i < n; ++i) {
2470 MathData & data = minset->cell(i);
2471 data.updateMacros(0, mc);
2477 void Buffer::listMacroNames(MacroNameSet & macros) const
2482 d->macro_lock = true;
2484 // loop over macro names
2485 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2486 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2487 for (; nameIt != nameEnd; ++nameIt)
2488 macros.insert(nameIt->first);
2490 // loop over children
2491 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2492 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2493 for (; it != end; ++it)
2494 it->first->listMacroNames(macros);
2497 Buffer const * const pbuf = d->parent();
2499 pbuf->listMacroNames(macros);
2501 d->macro_lock = false;
2505 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2507 Buffer const * const pbuf = d->parent();
2512 pbuf->listMacroNames(names);
2515 MacroNameSet::iterator it = names.begin();
2516 MacroNameSet::iterator end = names.end();
2517 for (; it != end; ++it) {
2519 MacroData const * data =
2520 pbuf->getMacro(*it, *this, false);
2522 macros.insert(data);
2524 // we cannot access the original MathMacroTemplate anymore
2525 // here to calls validate method. So we do its work here manually.
2526 // FIXME: somehow make the template accessible here.
2527 if (data->optionals() > 0)
2528 features.require("xargs");
2534 Buffer::References & Buffer::references(docstring const & label)
2537 return const_cast<Buffer *>(masterBuffer())->references(label);
2539 RefCache::iterator it = d->ref_cache_.find(label);
2540 if (it != d->ref_cache_.end())
2541 return it->second.second;
2543 static InsetLabel const * dummy_il = 0;
2544 static References const dummy_refs;
2545 it = d->ref_cache_.insert(
2546 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2547 return it->second.second;
2551 Buffer::References const & Buffer::references(docstring const & label) const
2553 return const_cast<Buffer *>(this)->references(label);
2557 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2559 masterBuffer()->d->ref_cache_[label].first = il;
2563 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2565 return masterBuffer()->d->ref_cache_[label].first;
2569 void Buffer::clearReferenceCache() const
2572 d->ref_cache_.clear();
2576 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2579 //FIXME: This does not work for child documents yet.
2580 LASSERT(code == CITE_CODE, /**/);
2581 // Check if the label 'from' appears more than once
2582 vector<docstring> labels;
2584 BiblioInfo const & keys = masterBibInfo();
2585 BiblioInfo::const_iterator bit = keys.begin();
2586 BiblioInfo::const_iterator bend = keys.end();
2588 for (; bit != bend; ++bit)
2590 labels.push_back(bit->first);
2593 if (count(labels.begin(), labels.end(), from) > 1)
2596 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2597 if (it->lyxCode() == code) {
2598 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2599 docstring const oldValue = inset.getParam(paramName);
2600 if (oldValue == from)
2601 inset.setParam(paramName, to);
2607 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2608 pit_type par_end, bool full_source) const
2610 OutputParams runparams(¶ms().encoding());
2611 runparams.nice = true;
2612 runparams.flavor = params().useXetex ?
2613 OutputParams::XETEX : OutputParams::LATEX;
2614 runparams.linelen = lyxrc.plaintext_linelen;
2615 // No side effect of file copying and image conversion
2616 runparams.dryrun = true;
2619 os << "% " << _("Preview source code") << "\n\n";
2621 d->texrow.newline();
2622 d->texrow.newline();
2624 writeDocBookSource(os, absFileName(), runparams, false);
2626 // latex or literate
2627 writeLaTeXSource(os, string(), runparams, true, true);
2629 runparams.par_begin = par_begin;
2630 runparams.par_end = par_end;
2631 if (par_begin + 1 == par_end) {
2633 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2637 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2638 convert<docstring>(par_begin),
2639 convert<docstring>(par_end - 1))
2646 // output paragraphs
2648 docbookParagraphs(text(), *this, os, runparams);
2650 // latex or literate
2651 latexParagraphs(*this, text(), os, texrow, runparams);
2656 ErrorList & Buffer::errorList(string const & type) const
2658 static ErrorList emptyErrorList;
2659 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2660 if (I == d->errorLists.end())
2661 return emptyErrorList;
2667 void Buffer::updateTocItem(std::string const & type,
2668 DocIterator const & dit) const
2671 gui_->updateTocItem(type, dit);
2675 void Buffer::structureChanged() const
2678 gui_->structureChanged();
2682 void Buffer::errors(string const & err, bool from_master) const
2685 gui_->errors(err, from_master);
2689 void Buffer::message(docstring const & msg) const
2696 void Buffer::setBusy(bool on) const
2703 void Buffer::setReadOnly(bool on) const
2706 d->wa_->setReadOnly(on);
2710 void Buffer::updateTitles() const
2713 d->wa_->updateTitles();
2717 void Buffer::resetAutosaveTimers() const
2720 gui_->resetAutosaveTimers();
2724 bool Buffer::hasGuiDelegate() const
2730 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2739 class AutoSaveBuffer : public ForkedProcess {
2742 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2743 : buffer_(buffer), fname_(fname) {}
2745 virtual boost::shared_ptr<ForkedProcess> clone() const
2747 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2752 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2753 from_utf8(fname_.absFilename())));
2754 return run(DontWait);
2758 virtual int generateChild();
2760 Buffer const & buffer_;
2765 int AutoSaveBuffer::generateChild()
2767 // tmp_ret will be located (usually) in /tmp
2768 // will that be a problem?
2769 // Note that this calls ForkedCalls::fork(), so it's
2770 // ok cross-platform.
2771 pid_t const pid = fork();
2772 // If you want to debug the autosave
2773 // you should set pid to -1, and comment out the fork.
2774 if (pid != 0 && pid != -1)
2777 // pid = -1 signifies that lyx was unable
2778 // to fork. But we will do the save
2780 bool failed = false;
2781 FileName const tmp_ret = FileName::tempName("lyxauto");
2782 if (!tmp_ret.empty()) {
2783 buffer_.writeFile(tmp_ret);
2784 // assume successful write of tmp_ret
2785 if (!tmp_ret.moveTo(fname_))
2791 // failed to write/rename tmp_ret so try writing direct
2792 if (!buffer_.writeFile(fname_)) {
2793 // It is dangerous to do this in the child,
2794 // but safe in the parent, so...
2795 if (pid == -1) // emit message signal.
2796 buffer_.message(_("Autosave failed!"));
2800 if (pid == 0) // we are the child so...
2809 FileName Buffer::getAutosaveFilename() const
2811 // if the document is unnamed try to save in the backup dir, else
2812 // in the default document path, and as a last try in the filePath,
2813 // which will most often be the temporary directory
2816 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
2817 : lyxrc.backupdir_path;
2818 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
2821 string const fname = "#" + d->filename.onlyFileName() + "#";
2822 return makeAbsPath(fname, fpath);
2826 void Buffer::removeAutosaveFile() const
2828 FileName const f = getAutosaveFilename();
2834 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
2836 FileName const newauto = getAutosaveFilename();
2837 if (!(oldauto == newauto || oldauto.moveTo(newauto)))
2838 LYXERR0("Unable to remove autosave file `" << oldauto << "'!");
2842 // Perfect target for a thread...
2843 void Buffer::autoSave() const
2845 if (isBakClean() || isReadonly()) {
2846 // We don't save now, but we'll try again later
2847 resetAutosaveTimers();
2851 // emit message signal.
2852 message(_("Autosaving current document..."));
2853 AutoSaveBuffer autosave(*this, getAutosaveFilename());
2857 resetAutosaveTimers();
2861 string Buffer::bufferFormat() const
2863 string format = params().documentClass().outputFormat();
2864 if (format == "latex") {
2865 if (params().useXetex)
2867 if (params().encoding().package() == Encoding::japanese)
2874 string Buffer::getDefaultOutputFormat() const
2876 if (!params().defaultOutputFormat.empty()
2877 && params().defaultOutputFormat != "default")
2878 return params().defaultOutputFormat;
2879 typedef vector<Format const *> Formats;
2880 Formats formats = exportableFormats(true);
2883 || params().useXetex
2884 || params().encoding().package() == Encoding::japanese) {
2885 if (formats.empty())
2887 // return the first we find
2888 return formats.front()->name();
2890 return lyxrc.default_view_format;
2895 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2896 string & result_file) const
2898 string backend_format;
2899 OutputParams runparams(¶ms().encoding());
2900 runparams.flavor = OutputParams::LATEX;
2901 runparams.linelen = lyxrc.plaintext_linelen;
2902 vector<string> backs = backends();
2903 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2904 // Get shortest path to format
2905 Graph::EdgePath path;
2906 for (vector<string>::const_iterator it = backs.begin();
2907 it != backs.end(); ++it) {
2908 Graph::EdgePath p = theConverters().getPath(*it, format);
2909 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2910 backend_format = *it;
2915 runparams.flavor = theConverters().getFlavor(path);
2917 Alert::error(_("Couldn't export file"),
2918 bformat(_("No information for exporting the format %1$s."),
2919 formats.prettyName(format)));
2923 backend_format = format;
2924 // FIXME: Don't hardcode format names here, but use a flag
2925 if (backend_format == "pdflatex")
2926 runparams.flavor = OutputParams::PDFLATEX;
2929 string filename = latexName(false);
2930 filename = addName(temppath(), filename);
2931 filename = changeExtension(filename,
2932 formats.extension(backend_format));
2935 updateMacroInstances();
2937 // Plain text backend
2938 if (backend_format == "text")
2939 writePlaintextFile(*this, FileName(filename), runparams);
2941 else if (backend_format == "xhtml")
2942 makeLyXHTMLFile(FileName(filename), runparams);
2943 else if (backend_format == "lyx")
2944 writeFile(FileName(filename));
2946 else if (isDocBook()) {
2947 runparams.nice = !put_in_tempdir;
2948 makeDocBookFile(FileName(filename), runparams);
2951 else if (backend_format == format) {
2952 runparams.nice = true;
2953 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2955 } else if (!lyxrc.tex_allows_spaces
2956 && contains(filePath(), ' ')) {
2957 Alert::error(_("File name error"),
2958 _("The directory path to the document cannot contain spaces."));
2961 runparams.nice = false;
2962 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2966 string const error_type = (format == "program")
2967 ? "Build" : bufferFormat();
2968 ErrorList & error_list = d->errorLists[error_type];
2969 string const ext = formats.extension(format);
2970 FileName const tmp_result_file(changeExtension(filename, ext));
2971 bool const success = theConverters().convert(this, FileName(filename),
2972 tmp_result_file, FileName(absFileName()), backend_format, format,
2974 // Emit the signal to show the error list.
2975 if (format != backend_format) {
2977 // also to the children, in case of master-buffer-view
2978 std::vector<Buffer *> clist = getChildren();
2979 for (vector<Buffer *>::const_iterator cit = clist.begin();
2980 cit != clist.end(); ++cit)
2981 (*cit)->errors(error_type, true);
2986 if (put_in_tempdir) {
2987 result_file = tmp_result_file.absFilename();
2991 result_file = changeExtension(exportFileName().absFilename(), ext);
2992 // We need to copy referenced files (e. g. included graphics
2993 // if format == "dvi") to the result dir.
2994 vector<ExportedFile> const files =
2995 runparams.exportdata->externalFiles(format);
2996 string const dest = onlyPath(result_file);
2997 CopyStatus status = SUCCESS;
2998 for (vector<ExportedFile>::const_iterator it = files.begin();
2999 it != files.end() && status != CANCEL; ++it) {
3000 string const fmt = formats.getFormatFromFile(it->sourceName);
3001 status = copyFile(fmt, it->sourceName,
3002 makeAbsPath(it->exportName, dest),
3003 it->exportName, status == FORCE);
3005 if (status == CANCEL) {
3006 message(_("Document export cancelled."));
3007 } else if (tmp_result_file.exists()) {
3008 // Finally copy the main file
3009 status = copyFile(format, tmp_result_file,
3010 FileName(result_file), result_file,
3012 message(bformat(_("Document exported as %1$s "
3014 formats.prettyName(format),
3015 makeDisplayPath(result_file)));
3017 // This must be a dummy converter like fax (bug 1888)
3018 message(bformat(_("Document exported as %1$s"),
3019 formats.prettyName(format)));
3026 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
3029 return doExport(format, put_in_tempdir, result_file);
3033 bool Buffer::preview(string const & format) const
3036 if (!doExport(format, true, result_file))
3038 return formats.view(*this, FileName(result_file), format);
3042 bool Buffer::isExportable(string const & format) const
3044 vector<string> backs = backends();
3045 for (vector<string>::const_iterator it = backs.begin();
3046 it != backs.end(); ++it)
3047 if (theConverters().isReachable(*it, format))
3053 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3055 vector<string> backs = backends();
3056 vector<Format const *> result =
3057 theConverters().getReachable(backs[0], only_viewable, true);
3058 for (vector<string>::const_iterator it = backs.begin() + 1;
3059 it != backs.end(); ++it) {
3060 vector<Format const *> r =
3061 theConverters().getReachable(*it, only_viewable, false);
3062 result.insert(result.end(), r.begin(), r.end());
3068 vector<string> Buffer::backends() const
3071 if (params().baseClass()->isTeXClassAvailable()) {
3072 v.push_back(bufferFormat());
3073 // FIXME: Don't hardcode format names here, but use a flag
3074 if (v.back() == "latex")
3075 v.push_back("pdflatex");
3077 v.push_back("text");
3078 v.push_back("xhtml");
3084 bool Buffer::readFileHelper(FileName const & s)
3086 // File information about normal file
3088 docstring const file = makeDisplayPath(s.absFilename(), 50);
3089 docstring text = bformat(_("The specified document\n%1$s"
3090 "\ncould not be read."), file);
3091 Alert::error(_("Could not read document"), text);
3095 // Check if emergency save file exists and is newer.
3096 FileName const e(s.absFilename() + ".emergency");
3098 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3099 docstring const file = makeDisplayPath(s.absFilename(), 20);
3100 docstring const text =
3101 bformat(_("An emergency save of the document "
3103 "Recover emergency save?"), file);
3104 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3105 _("&Recover"), _("&Load Original"),
3109 // the file is not saved if we load the emergency file.
3114 if ((res = readFile(e)) == success)
3115 str = _("Document was successfully recovered.");
3117 str = _("Document was NOT successfully recovered.");
3118 str += "\n\n" + _("Remove emergency file now?");
3120 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3121 _("&Remove"), _("&Keep it"))) {
3124 Alert::warning(_("Emergency file deleted"),
3125 _("Do not forget to save your file now!"), true);
3130 if (!Alert::prompt(_("Delete emergency file?"),
3131 _("Remove emergency file now?"), 1, 1,
3132 _("&Remove"), _("&Keep it")))
3140 // Now check if autosave file is newer.
3141 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3143 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3144 docstring const file = makeDisplayPath(s.absFilename(), 20);
3145 docstring const text =
3146 bformat(_("The backup of the document "
3147 "%1$s is newer.\n\nLoad the "
3148 "backup instead?"), file);
3149 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3150 _("&Load backup"), _("Load &original"),
3154 // the file is not saved if we load the autosave file.
3158 // Here we delete the autosave
3169 bool Buffer::loadLyXFile(FileName const & s)
3171 if (s.isReadableFile()) {
3172 if (readFileHelper(s)) {
3173 lyxvc().file_found_hook(s);
3174 if (!s.isWritable())
3179 docstring const file = makeDisplayPath(s.absFilename(), 20);
3180 // Here we probably should run
3181 if (LyXVC::file_not_found_hook(s)) {
3182 docstring const text =
3183 bformat(_("Do you want to retrieve the document"
3184 " %1$s from version control?"), file);
3185 int const ret = Alert::prompt(_("Retrieve from version control?"),
3186 text, 0, 1, _("&Retrieve"), _("&Cancel"));
3189 // How can we know _how_ to do the checkout?
3190 // With the current VC support it has to be,
3191 // a RCS file since CVS do not have special ,v files.
3193 return loadLyXFile(s);
3201 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3203 TeXErrors::Errors::const_iterator cit = terr.begin();
3204 TeXErrors::Errors::const_iterator end = terr.end();
3206 for (; cit != end; ++cit) {
3209 int errorRow = cit->error_in_line;
3210 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3216 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3217 } while (found && id_start == id_end && pos_start == pos_end);
3219 errorList.push_back(ErrorItem(cit->error_desc,
3220 cit->error_text, id_start, pos_start, pos_end));
3225 void Buffer::setBuffersForInsets() const
3227 inset().setBuffer(const_cast<Buffer &>(*this));
3231 void Buffer::updateLabels(UpdateScope scope) const
3233 // Use the master text class also for child documents
3234 Buffer const * const master = masterBuffer();
3235 DocumentClass const & textclass = master->params().documentClass();
3237 // keep the buffers to be children in this set. If the call from the
3238 // master comes back we can see which of them were actually seen (i.e.
3239 // via an InsetInclude). The remaining ones in the set need still be updated.
3240 static std::set<Buffer const *> bufToUpdate;
3241 if (scope == UpdateMaster) {
3242 // If this is a child document start with the master
3243 if (master != this) {
3244 bufToUpdate.insert(this);
3245 master->updateLabels();
3246 // Do this here in case the master has no gui associated with it. Then,
3247 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3251 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3252 if (bufToUpdate.find(this) == bufToUpdate.end())
3256 // start over the counters in the master
3257 textclass.counters().reset();
3260 // update will be done below for this buffer
3261 bufToUpdate.erase(this);
3263 // update all caches
3264 clearReferenceCache();
3267 Buffer & cbuf = const_cast<Buffer &>(*this);
3269 LASSERT(!text().paragraphs().empty(), /**/);
3272 ParIterator parit = cbuf.par_iterator_begin();
3273 updateLabels(parit);
3276 // TocBackend update will be done later.
3279 cbuf.tocBackend().update();
3280 if (scope == UpdateMaster)
3281 cbuf.structureChanged();
3285 static depth_type getDepth(DocIterator const & it)
3287 depth_type depth = 0;
3288 for (size_t i = 0 ; i < it.depth() ; ++i)
3289 if (!it[i].inset().inMathed())
3290 depth += it[i].paragraph().getDepth() + 1;
3291 // remove 1 since the outer inset does not count
3295 static depth_type getItemDepth(ParIterator const & it)
3297 Paragraph const & par = *it;
3298 LabelType const labeltype = par.layout().labeltype;
3300 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3303 // this will hold the lowest depth encountered up to now.
3304 depth_type min_depth = getDepth(it);
3305 ParIterator prev_it = it;
3308 --prev_it.top().pit();
3310 // start of nested inset: go to outer par
3312 if (prev_it.empty()) {
3313 // start of document: nothing to do
3318 // We search for the first paragraph with same label
3319 // that is not more deeply nested.
3320 Paragraph & prev_par = *prev_it;
3321 depth_type const prev_depth = getDepth(prev_it);
3322 if (labeltype == prev_par.layout().labeltype) {
3323 if (prev_depth < min_depth)
3324 return prev_par.itemdepth + 1;
3325 if (prev_depth == min_depth)
3326 return prev_par.itemdepth;
3328 min_depth = min(min_depth, prev_depth);
3329 // small optimization: if we are at depth 0, we won't
3330 // find anything else
3331 if (prev_depth == 0)
3337 static bool needEnumCounterReset(ParIterator const & it)
3339 Paragraph const & par = *it;
3340 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3341 depth_type const cur_depth = par.getDepth();
3342 ParIterator prev_it = it;
3343 while (prev_it.pit()) {
3344 --prev_it.top().pit();
3345 Paragraph const & prev_par = *prev_it;
3346 if (prev_par.getDepth() <= cur_depth)
3347 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3349 // start of nested inset: reset
3354 // set the label of a paragraph. This includes the counters.
3355 static void setLabel(Buffer const & buf, ParIterator & it)
3357 BufferParams const & bp = buf.masterBuffer()->params();
3358 DocumentClass const & textclass = bp.documentClass();
3359 Paragraph & par = it.paragraph();
3360 Layout const & layout = par.layout();
3361 Counters & counters = textclass.counters();
3363 if (par.params().startOfAppendix()) {
3364 // FIXME: only the counter corresponding to toplevel
3365 // sectionning should be reset
3367 counters.appendix(true);
3369 par.params().appendix(counters.appendix());
3371 // Compute the item depth of the paragraph
3372 par.itemdepth = getItemDepth(it);
3374 if (layout.margintype == MARGIN_MANUAL
3375 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3376 if (par.params().labelWidthString().empty())
3377 par.params().labelWidthString(par.expandLabel(layout, bp));
3379 par.params().labelWidthString(docstring());
3382 switch(layout.labeltype) {
3384 if (layout.toclevel <= bp.secnumdepth
3385 && (layout.latextype != LATEX_ENVIRONMENT
3386 || it.text()->isFirstInSequence(it.pit()))) {
3387 counters.step(layout.counter);
3388 par.params().labelString(
3389 par.expandLabel(layout, bp));
3391 par.params().labelString(docstring());
3394 case LABEL_ITEMIZE: {
3395 // At some point of time we should do something more
3396 // clever here, like:
3397 // par.params().labelString(
3398 // bp.user_defined_bullet(par.itemdepth).getText());
3399 // for now, use a simple hardcoded label
3400 docstring itemlabel;
3401 switch (par.itemdepth) {
3403 itemlabel = char_type(0x2022);
3406 itemlabel = char_type(0x2013);
3409 itemlabel = char_type(0x2217);
3412 itemlabel = char_type(0x2219); // or 0x00b7
3415 par.params().labelString(itemlabel);
3419 case LABEL_ENUMERATE: {
3420 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3422 switch (par.itemdepth) {
3431 enumcounter += "iv";
3434 // not a valid enumdepth...
3438 // Maybe we have to reset the enumeration counter.
3439 if (needEnumCounterReset(it))
3440 counters.reset(enumcounter);
3441 counters.step(enumcounter);
3443 string const & lang = par.getParLanguage(bp)->code();
3444 par.params().labelString(counters.theCounter(enumcounter, lang));
3449 case LABEL_SENSITIVE: {
3450 string const & type = counters.current_float();
3451 docstring full_label;
3453 full_label = buf.B_("Senseless!!! ");
3455 docstring name = buf.B_(textclass.floats().getType(type).name());
3456 if (counters.hasCounter(from_utf8(type))) {
3457 string const & lang = par.getParLanguage(bp)->code();
3458 counters.step(from_utf8(type));
3459 full_label = bformat(from_ascii("%1$s %2$s:"),
3461 counters.theCounter(from_utf8(type), lang));
3463 full_label = bformat(from_ascii("%1$s #:"), name);
3465 par.params().labelString(full_label);
3469 case LABEL_NO_LABEL:
3470 par.params().labelString(docstring());
3474 case LABEL_TOP_ENVIRONMENT:
3475 case LABEL_CENTERED_TOP_ENVIRONMENT:
3478 par.params().labelString(par.expandLabel(layout, bp));
3484 void Buffer::updateLabels(ParIterator & parit) const
3486 LASSERT(parit.pit() == 0, /**/);
3488 // set the position of the text in the buffer to be able
3489 // to resolve macros in it. This has nothing to do with
3490 // labels, but by putting it here we avoid implementing
3491 // a whole bunch of traversal routines just for this call.
3492 parit.text()->setMacrocontextPosition(parit);
3494 depth_type maxdepth = 0;
3495 pit_type const lastpit = parit.lastpit();
3496 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3497 // reduce depth if necessary
3498 parit->params().depth(min(parit->params().depth(), maxdepth));
3499 maxdepth = parit->getMaxDepthAfter();
3501 // set the counter for this paragraph
3502 setLabel(*this, parit);
3505 InsetList::const_iterator iit = parit->insetList().begin();
3506 InsetList::const_iterator end = parit->insetList().end();
3507 for (; iit != end; ++iit) {
3508 parit.pos() = iit->pos;
3509 iit->inset->updateLabels(parit);
3515 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3516 WordLangTuple & word_lang, docstring_list & suggestions) const
3520 suggestions.clear();
3521 word_lang = WordLangTuple();
3522 // OK, we start from here.
3523 DocIterator const end = doc_iterator_end(this);
3524 for (; from != end; from.forwardPos()) {
3525 // We are only interested in text so remove the math CursorSlice.
3526 while (from.inMathed())
3527 from.forwardInset();
3529 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {