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();
571 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
573 for (int i = 0; i < 4; ++i) {
574 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
575 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
578 ErrorList & errorList = d->errorLists["Parse"];
587 if (token == "\\end_header")
591 if (token == "\\begin_header") {
592 begin_header_line = line;
596 LYXERR(Debug::PARSER, "Handling document header token: `"
599 string unknown = params().readToken(lex, token, d->filename.onlyPath());
600 if (!unknown.empty()) {
601 if (unknown[0] != '\\' && token == "\\textclass") {
602 Alert::warning(_("Unknown document class"),
603 bformat(_("Using the default document class, because the "
604 "class %1$s is unknown."), from_utf8(unknown)));
607 docstring const s = bformat(_("Unknown token: "
611 errorList.push_back(ErrorItem(_("Document header error"),
616 if (begin_header_line) {
617 docstring const s = _("\\begin_header is missing");
618 errorList.push_back(ErrorItem(_("Document header error"),
622 params().makeDocumentClass();
624 return unknown_tokens;
629 // changed to be public and have one parameter
630 // Returns true if "\end_document" is not read (Asger)
631 bool Buffer::readDocument(Lexer & lex)
633 ErrorList & errorList = d->errorLists["Parse"];
636 if (!lex.checkFor("\\begin_document")) {
637 docstring const s = _("\\begin_document is missing");
638 errorList.push_back(ErrorItem(_("Document header error"),
642 // we are reading in a brand new document
643 LASSERT(paragraphs().empty(), /**/);
647 if (params().outputChanges) {
648 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
649 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
650 LaTeXFeatures::isAvailable("xcolor");
652 if (!dvipost && !xcolorulem) {
653 Alert::warning(_("Changes not shown in LaTeX output"),
654 _("Changes will not be highlighted in LaTeX output, "
655 "because neither dvipost nor xcolor/ulem are installed.\n"
656 "Please install these packages or redefine "
657 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
658 } else if (!xcolorulem) {
659 Alert::warning(_("Changes not shown in LaTeX output"),
660 _("Changes will not be highlighted in LaTeX output "
661 "when using pdflatex, because xcolor and ulem are not installed.\n"
662 "Please install both packages or redefine "
663 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
667 if (!params().master.empty()) {
668 FileName const master_file = makeAbsPath(params().master,
669 onlyPath(absFileName()));
670 if (isLyXFilename(master_file.absFilename())) {
672 checkAndLoadLyXFile(master_file, true);
674 // necessary e.g. after a reload
675 // to re-register the child (bug 5873)
676 // FIXME: clean up updateMacros (here, only
677 // child registering is needed).
678 master->updateMacros();
679 // set master as master buffer, but only
680 // if we are a real child
681 if (master->isChild(this))
683 // if the master is not fully loaded
684 // it is probably just loading this
685 // child. No warning needed then.
686 else if (master->isFullyLoaded())
687 LYXERR0("The master '"
689 << "' assigned to this document ("
691 << ") does not include "
692 "this document. Ignoring the master assignment.");
698 bool const res = text().read(lex, errorList, d->inset);
701 updateMacroInstances();
706 bool Buffer::readString(string const & s)
708 params().compressed = false;
710 // remove dummy empty par
711 paragraphs().clear();
715 FileName const name = FileName::tempName("Buffer_readString");
716 switch (readFile(lex, name, true)) {
720 // We need to call lyx2lyx, so write the input to a file
721 ofstream os(name.toFilesystemEncoding().c_str());
724 return readFile(name);
734 bool Buffer::readFile(FileName const & filename)
736 FileName fname(filename);
738 params().compressed = fname.isZippedFile();
740 // remove dummy empty par
741 paragraphs().clear();
744 if (readFile(lex, fname) != success)
751 bool Buffer::isFullyLoaded() const
753 return d->file_fully_loaded;
757 void Buffer::setFullyLoaded(bool value)
759 d->file_fully_loaded = value;
763 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
766 LASSERT(!filename.empty(), /**/);
768 // the first (non-comment) token _must_ be...
769 if (!lex.checkFor("\\lyxformat")) {
770 Alert::error(_("Document format failure"),
771 bformat(_("%1$s is not a readable LyX document."),
772 from_utf8(filename.absFilename())));
778 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
779 // if present remove ".," from string.
780 size_t dot = tmp_format.find_first_of(".,");
781 //lyxerr << " dot found at " << dot << endl;
782 if (dot != string::npos)
783 tmp_format.erase(dot, 1);
784 int const file_format = convert<int>(tmp_format);
785 //lyxerr << "format: " << file_format << endl;
787 // save timestamp and checksum of the original disk file, making sure
788 // to not overwrite them with those of the file created in the tempdir
789 // when it has to be converted to the current format.
791 // Save the timestamp and checksum of disk file. If filename is an
792 // emergency file, save the timestamp and checksum of the original lyx file
793 // because isExternallyModified will check for this file. (BUG4193)
794 string diskfile = filename.absFilename();
795 if (suffixIs(diskfile, ".emergency"))
796 diskfile = diskfile.substr(0, diskfile.size() - 10);
797 saveCheckSum(FileName(diskfile));
800 if (file_format != LYX_FORMAT) {
803 // lyx2lyx would fail
806 FileName const tmpfile = FileName::tempName("Buffer_readFile");
807 if (tmpfile.empty()) {
808 Alert::error(_("Conversion failed"),
809 bformat(_("%1$s is from a different"
810 " version of LyX, but a temporary"
811 " file for converting it could"
813 from_utf8(filename.absFilename())));
816 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
817 if (lyx2lyx.empty()) {
818 Alert::error(_("Conversion script not found"),
819 bformat(_("%1$s is from a different"
820 " version of LyX, but the"
821 " conversion script lyx2lyx"
822 " could not be found."),
823 from_utf8(filename.absFilename())));
826 ostringstream command;
827 command << os::python()
828 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
829 << " -t " << convert<string>(LYX_FORMAT)
830 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
831 << ' ' << quoteName(filename.toFilesystemEncoding());
832 string const command_str = command.str();
834 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
836 cmd_ret const ret = runCommand(command_str);
837 if (ret.first != 0) {
838 Alert::error(_("Conversion script failed"),
839 bformat(_("%1$s is from a different version"
840 " of LyX, but the lyx2lyx script"
841 " failed to convert it."),
842 from_utf8(filename.absFilename())));
845 bool const ret = readFile(tmpfile);
846 // Do stuff with tmpfile name and buffer name here.
847 return ret ? success : failure;
852 if (readDocument(lex)) {
853 Alert::error(_("Document format failure"),
854 bformat(_("%1$s ended unexpectedly, which means"
855 " that it is probably corrupted."),
856 from_utf8(filename.absFilename())));
859 d->file_fully_loaded = true;
864 // Should probably be moved to somewhere else: BufferView? LyXView?
865 bool Buffer::save() const
867 // We don't need autosaves in the immediate future. (Asger)
868 resetAutosaveTimers();
870 string const encodedFilename = d->filename.toFilesystemEncoding();
873 bool madeBackup = false;
875 // make a backup if the file already exists
876 if (lyxrc.make_backup && fileName().exists()) {
877 backupName = FileName(absFileName() + '~');
878 if (!lyxrc.backupdir_path.empty()) {
879 string const mangledName =
880 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
881 backupName = FileName(addName(lyxrc.backupdir_path,
884 if (fileName().copyTo(backupName)) {
887 Alert::error(_("Backup failure"),
888 bformat(_("Cannot create backup file %1$s.\n"
889 "Please check whether the directory exists and is writeable."),
890 from_utf8(backupName.absFilename())));
891 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
895 // ask if the disk file has been externally modified (use checksum method)
896 if (fileName().exists() && isExternallyModified(checksum_method)) {
897 docstring const file = makeDisplayPath(absFileName(), 20);
898 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
899 "you want to overwrite this file?"), file);
900 int const ret = Alert::prompt(_("Overwrite modified file?"),
901 text, 1, 1, _("&Overwrite"), _("&Cancel"));
906 if (writeFile(d->filename)) {
910 // Saving failed, so backup is not backup
912 backupName.moveTo(d->filename);
918 bool Buffer::writeFile(FileName const & fname) const
920 if (d->read_only && fname == d->filename)
925 docstring const str = bformat(_("Saving document %1$s..."),
926 makeDisplayPath(fname.absFilename()));
929 if (params().compressed) {
930 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
931 retval = ofs && write(ofs);
933 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
934 retval = ofs && write(ofs);
938 message(str + _(" could not write file!"));
942 removeAutosaveFile();
944 saveCheckSum(d->filename);
945 message(str + _(" done."));
951 docstring Buffer::emergencyWrite()
953 // No need to save if the buffer has not changed.
957 string const doc = isUnnamed() ? onlyFilename(absFileName()) : absFileName();
959 docstring user_message = bformat(
960 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc));
962 // We try to save three places:
963 // 1) Same place as document. Unless it is an unnamed doc.
965 string s = absFileName();
968 if (writeFile(FileName(s))) {
970 user_message += bformat(_(" Saved to %1$. Phew.\n"), from_utf8(s));
973 user_message += _(" Save failed! Trying again...\n");
977 // 2) In HOME directory.
978 string s = addName(package().home_dir().absFilename(), absFileName());
980 lyxerr << ' ' << s << endl;
981 if (writeFile(FileName(s))) {
983 user_message += bformat(_(" Saved to %1$. Phew.\n"), from_utf8(s));
987 user_message += _(" Save failed! Trying yet again...\n");
989 // 3) In "/tmp" directory.
990 // MakeAbsPath to prepend the current
991 // drive letter on OS/2
992 s = addName(package().temp_dir().absFilename(), absFileName());
994 lyxerr << ' ' << s << endl;
995 if (writeFile(FileName(s))) {
997 user_message += bformat(_(" Saved to %1$. Phew.\n"), from_utf8(s));
1001 user_message += _(" Save failed! Bummer. Document is lost.");
1004 return user_message;
1008 bool Buffer::write(ostream & ofs) const
1011 // Use the standard "C" locale for file output.
1012 ofs.imbue(locale::classic());
1015 // The top of the file should not be written by params().
1017 // write out a comment in the top of the file
1018 ofs << "#LyX " << lyx_version
1019 << " created this file. For more info see http://www.lyx.org/\n"
1020 << "\\lyxformat " << LYX_FORMAT << "\n"
1021 << "\\begin_document\n";
1023 /// For each author, set 'used' to true if there is a change
1024 /// by this author in the document; otherwise set it to 'false'.
1025 AuthorList::Authors::const_iterator a_it = params().authors().begin();
1026 AuthorList::Authors::const_iterator a_end = params().authors().end();
1027 for (; a_it != a_end; ++a_it)
1028 a_it->setUsed(false);
1030 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1031 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1032 for ( ; it != end; ++it)
1033 it->checkAuthors(params().authors());
1035 // now write out the buffer parameters.
1036 ofs << "\\begin_header\n";
1037 params().writeFile(ofs);
1038 ofs << "\\end_header\n";
1041 ofs << "\n\\begin_body\n";
1043 ofs << "\n\\end_body\n";
1045 // Write marker that shows file is complete
1046 ofs << "\\end_document" << endl;
1048 // Shouldn't really be needed....
1051 // how to check if close went ok?
1052 // Following is an attempt... (BE 20001011)
1054 // good() returns false if any error occured, including some
1055 // formatting error.
1056 // bad() returns true if something bad happened in the buffer,
1057 // which should include file system full errors.
1062 lyxerr << "File was not closed properly." << endl;
1069 bool Buffer::makeLaTeXFile(FileName const & fname,
1070 string const & original_path,
1071 OutputParams const & runparams_in,
1072 bool output_preamble, bool output_body) const
1074 OutputParams runparams = runparams_in;
1075 if (params().useXetex)
1076 runparams.flavor = OutputParams::XETEX;
1078 string const encoding = runparams.encoding->iconvName();
1079 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1082 try { ofs.reset(encoding); }
1083 catch (iconv_codecvt_facet_exception & e) {
1084 lyxerr << "Caught iconv exception: " << e.what() << endl;
1085 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1086 "verify that the support software for your encoding (%1$s) is "
1087 "properly installed"), from_ascii(encoding)));
1090 if (!openFileWrite(ofs, fname))
1093 //TexStream ts(ofs.rdbuf(), &texrow());
1094 ErrorList & errorList = d->errorLists["Export"];
1096 bool failed_export = false;
1099 writeLaTeXSource(ofs, original_path,
1100 runparams, output_preamble, output_body);
1102 catch (EncodingException & e) {
1103 odocstringstream ods;
1104 ods.put(e.failed_char);
1106 oss << "0x" << hex << e.failed_char << dec;
1107 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1108 " (code point %2$s)"),
1109 ods.str(), from_utf8(oss.str()));
1110 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1111 "representable in the chosen encoding.\n"
1112 "Changing the document encoding to utf8 could help."),
1113 e.par_id, e.pos, e.pos + 1));
1114 failed_export = true;
1116 catch (iconv_codecvt_facet_exception & e) {
1117 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1118 _(e.what()), -1, 0, 0));
1119 failed_export = true;
1121 catch (exception const & e) {
1122 errorList.push_back(ErrorItem(_("conversion failed"),
1123 _(e.what()), -1, 0, 0));
1124 failed_export = true;
1127 lyxerr << "Caught some really weird exception..." << endl;
1133 failed_export = true;
1134 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1138 return !failed_export;
1142 void Buffer::writeLaTeXSource(odocstream & os,
1143 string const & original_path,
1144 OutputParams const & runparams_in,
1145 bool const output_preamble, bool const output_body) const
1147 // The child documents, if any, shall be already loaded at this point.
1149 OutputParams runparams = runparams_in;
1151 // Classify the unicode characters appearing in math insets
1152 Encodings::initUnicodeMath(*this);
1154 // validate the buffer.
1155 LYXERR(Debug::LATEX, " Validating buffer...");
1156 LaTeXFeatures features(*this, params(), runparams);
1158 LYXERR(Debug::LATEX, " Buffer validation done.");
1160 // The starting paragraph of the coming rows is the
1161 // first paragraph of the document. (Asger)
1162 if (output_preamble && runparams.nice) {
1163 os << "%% LyX " << lyx_version << " created this file. "
1164 "For more info, see http://www.lyx.org/.\n"
1165 "%% Do not edit unless you really know what "
1167 d->texrow.newline();
1168 d->texrow.newline();
1170 LYXERR(Debug::INFO, "lyx document header finished");
1172 // Don't move this behind the parent_buffer=0 code below,
1173 // because then the macros will not get the right "redefinition"
1174 // flag as they don't see the parent macros which are output before.
1177 // fold macros if possible, still with parent buffer as the
1178 // macros will be put in the prefix anyway.
1179 updateMacroInstances();
1181 // There are a few differences between nice LaTeX and usual files:
1182 // usual is \batchmode and has a
1183 // special input@path to allow the including of figures
1184 // with either \input or \includegraphics (what figinsets do).
1185 // input@path is set when the actual parameter
1186 // original_path is set. This is done for usual tex-file, but not
1187 // for nice-latex-file. (Matthias 250696)
1188 // Note that input@path is only needed for something the user does
1189 // in the preamble, included .tex files or ERT, files included by
1190 // LyX work without it.
1191 if (output_preamble) {
1192 if (!runparams.nice) {
1193 // code for usual, NOT nice-latex-file
1194 os << "\\batchmode\n"; // changed
1195 // from \nonstopmode
1196 d->texrow.newline();
1198 if (!original_path.empty()) {
1200 // We don't know the encoding of inputpath
1201 docstring const inputpath = from_utf8(latex_path(original_path));
1202 os << "\\makeatletter\n"
1203 << "\\def\\input@path{{"
1204 << inputpath << "/}}\n"
1205 << "\\makeatother\n";
1206 d->texrow.newline();
1207 d->texrow.newline();
1208 d->texrow.newline();
1211 // get parent macros (if this buffer has a parent) which will be
1212 // written at the document begin further down.
1213 MacroSet parentMacros;
1214 listParentMacros(parentMacros, features);
1216 // Write the preamble
1217 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1219 runparams.use_japanese = features.isRequired("japanese");
1225 os << "\\begin{document}\n";
1226 d->texrow.newline();
1228 // output the parent macros
1229 MacroSet::iterator it = parentMacros.begin();
1230 MacroSet::iterator end = parentMacros.end();
1231 for (; it != end; ++it)
1232 (*it)->write(os, true);
1233 } // output_preamble
1235 d->texrow.start(paragraphs().begin()->id(), 0);
1237 LYXERR(Debug::INFO, "preamble finished, now the body.");
1239 // if we are doing a real file with body, even if this is the
1240 // child of some other buffer, let's cut the link here.
1241 // This happens for example if only a child document is printed.
1242 Buffer const * save_parent = 0;
1243 if (output_preamble) {
1244 save_parent = d->parent();
1249 latexParagraphs(*this, text(), os, d->texrow, runparams);
1251 // Restore the parenthood if needed
1252 if (output_preamble)
1253 d->setParent(save_parent);
1255 // add this just in case after all the paragraphs
1257 d->texrow.newline();
1259 if (output_preamble) {
1260 os << "\\end{document}\n";
1261 d->texrow.newline();
1262 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1264 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1266 runparams_in.encoding = runparams.encoding;
1268 // Just to be sure. (Asger)
1269 d->texrow.newline();
1271 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1272 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1276 bool Buffer::isLatex() const
1278 return params().documentClass().outputType() == LATEX;
1282 bool Buffer::isLiterate() const
1284 return params().documentClass().outputType() == LITERATE;
1288 bool Buffer::isDocBook() const
1290 return params().documentClass().outputType() == DOCBOOK;
1294 void Buffer::makeDocBookFile(FileName const & fname,
1295 OutputParams const & runparams,
1296 bool const body_only) const
1298 LYXERR(Debug::LATEX, "makeDocBookFile...");
1301 if (!openFileWrite(ofs, fname))
1304 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1308 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1312 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1313 OutputParams const & runparams,
1314 bool const only_body) const
1316 LaTeXFeatures features(*this, params(), runparams);
1321 DocumentClass const & tclass = params().documentClass();
1322 string const top_element = tclass.latexname();
1325 if (runparams.flavor == OutputParams::XML)
1326 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1329 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1332 if (! tclass.class_header().empty())
1333 os << from_ascii(tclass.class_header());
1334 else if (runparams.flavor == OutputParams::XML)
1335 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1336 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1338 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1340 docstring preamble = from_utf8(params().preamble);
1341 if (runparams.flavor != OutputParams::XML ) {
1342 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1343 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1344 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1345 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1348 string const name = runparams.nice
1349 ? changeExtension(absFileName(), ".sgml") : fname;
1350 preamble += features.getIncludedFiles(name);
1351 preamble += features.getLyXSGMLEntities();
1353 if (!preamble.empty()) {
1354 os << "\n [ " << preamble << " ]";
1359 string top = top_element;
1361 if (runparams.flavor == OutputParams::XML)
1362 top += params().language->code();
1364 top += params().language->code().substr(0, 2);
1367 if (!params().options.empty()) {
1369 top += params().options;
1372 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1373 << " file was created by LyX " << lyx_version
1374 << "\n See http://www.lyx.org/ for more information -->\n";
1376 params().documentClass().counters().reset();
1380 sgml::openTag(os, top);
1382 docbookParagraphs(text(), *this, os, runparams);
1383 sgml::closeTag(os, top_element);
1387 void Buffer::makeLyXHTMLFile(FileName const & fname,
1388 OutputParams const & runparams,
1389 bool const body_only) const
1391 LYXERR(Debug::LATEX, "makeLYXHTMLFile...");
1394 if (!openFileWrite(ofs, fname))
1397 writeLyXHTMLSource(ofs, runparams, body_only);
1401 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1405 void Buffer::writeLyXHTMLSource(odocstream & os,
1406 OutputParams const & runparams,
1407 bool const only_body) const
1409 LaTeXFeatures features(*this, params(), runparams);
1415 os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" <<
1416 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
1417 // FIXME Language should be set properly.
1418 os << "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n";
1421 // FIXME Presumably need to set this right
1422 os << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1423 // FIXME Get this during validation? What about other meta-data?
1424 os << "<title>TBA</title>\n";
1426 os << features.getTClassHTMLPreamble();
1430 docstring const styleinfo = features.getTClassHTMLStyles();
1431 if (!styleinfo.empty()) {
1432 os << "<style type='text/css'>\n";
1436 os << "</head>\n<body>\n";
1439 params().documentClass().counters().reset();
1440 xhtmlParagraphs(text(), *this, os, runparams);
1442 os << "</body>\n</html>\n";
1446 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1447 // Other flags: -wall -v0 -x
1448 int Buffer::runChktex()
1452 // get LaTeX-Filename
1453 FileName const path(temppath());
1454 string const name = addName(path.absFilename(), latexName());
1455 string const org_path = filePath();
1457 PathChanger p(path); // path to LaTeX file
1458 message(_("Running chktex..."));
1460 // Generate the LaTeX file if neccessary
1461 OutputParams runparams(¶ms().encoding());
1462 runparams.flavor = OutputParams::LATEX;
1463 runparams.nice = false;
1464 makeLaTeXFile(FileName(name), org_path, runparams);
1467 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1468 int const res = chktex.run(terr); // run chktex
1471 Alert::error(_("chktex failure"),
1472 _("Could not run chktex successfully."));
1473 } else if (res > 0) {
1474 ErrorList & errlist = d->errorLists["ChkTeX"];
1476 bufferErrors(terr, errlist);
1487 void Buffer::validate(LaTeXFeatures & features) const
1489 params().validate(features);
1493 for_each(paragraphs().begin(), paragraphs().end(),
1494 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1496 if (lyxerr.debugging(Debug::LATEX)) {
1497 features.showStruct();
1502 void Buffer::getLabelList(vector<docstring> & list) const
1504 // If this is a child document, use the parent's list instead.
1505 Buffer const * const pbuf = d->parent();
1507 pbuf->getLabelList(list);
1512 Toc & toc = d->toc_backend.toc("label");
1513 TocIterator toc_it = toc.begin();
1514 TocIterator end = toc.end();
1515 for (; toc_it != end; ++toc_it) {
1516 if (toc_it->depth() == 0)
1517 list.push_back(toc_it->str());
1522 void Buffer::updateBibfilesCache(UpdateScope scope) const
1524 // If this is a child document, use the parent's cache instead.
1525 Buffer const * const pbuf = d->parent();
1526 if (pbuf && scope != UpdateChildOnly) {
1527 pbuf->updateBibfilesCache();
1531 d->bibfilesCache_.clear();
1532 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1533 if (it->lyxCode() == BIBTEX_CODE) {
1534 InsetBibtex const & inset =
1535 static_cast<InsetBibtex const &>(*it);
1536 support::FileNameList const bibfiles = inset.getBibFiles();
1537 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1540 } else if (it->lyxCode() == INCLUDE_CODE) {
1541 InsetInclude & inset =
1542 static_cast<InsetInclude &>(*it);
1543 inset.updateBibfilesCache();
1544 support::FileNameList const & bibfiles =
1545 inset.getBibfilesCache();
1546 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1551 // the bibinfo cache is now invalid
1552 d->bibinfoCacheValid_ = false;
1556 void Buffer::invalidateBibinfoCache()
1558 d->bibinfoCacheValid_ = false;
1562 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1564 // If this is a child document, use the parent's cache instead.
1565 Buffer const * const pbuf = d->parent();
1566 if (pbuf && scope != UpdateChildOnly)
1567 return pbuf->getBibfilesCache();
1569 // We update the cache when first used instead of at loading time.
1570 if (d->bibfilesCache_.empty())
1571 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1573 return d->bibfilesCache_;
1577 BiblioInfo const & Buffer::masterBibInfo() const
1579 // if this is a child document and the parent is already loaded
1580 // use the parent's list instead [ale990412]
1581 Buffer const * const tmp = masterBuffer();
1584 return tmp->masterBibInfo();
1585 return localBibInfo();
1589 BiblioInfo const & Buffer::localBibInfo() const
1591 if (d->bibinfoCacheValid_) {
1592 support::FileNameList const & bibfilesCache = getBibfilesCache();
1593 // compare the cached timestamps with the actual ones.
1594 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1595 support::FileNameList::const_iterator en = bibfilesCache.end();
1596 for (; ei != en; ++ ei) {
1597 time_t lastw = ei->lastModified();
1598 if (lastw != d->bibfileStatus_[*ei]) {
1599 d->bibinfoCacheValid_ = false;
1600 d->bibfileStatus_[*ei] = lastw;
1606 if (!d->bibinfoCacheValid_) {
1607 d->bibinfo_.clear();
1608 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1609 it->fillWithBibKeys(d->bibinfo_, it);
1610 d->bibinfoCacheValid_ = true;
1616 bool Buffer::isDepClean(string const & name) const
1618 DepClean::const_iterator const it = d->dep_clean.find(name);
1619 if (it == d->dep_clean.end())
1625 void Buffer::markDepClean(string const & name)
1627 d->dep_clean[name] = true;
1631 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1633 switch (cmd.action) {
1634 case LFUN_BUFFER_EXPORT: {
1635 docstring const arg = cmd.argument();
1636 bool enable = arg == "custom" || isExportable(to_utf8(arg));
1638 flag.message(bformat(
1639 _("Don't know how to export to format: %1$s"), arg));
1640 flag.setEnabled(enable);
1644 case LFUN_BRANCH_ACTIVATE:
1645 case LFUN_BRANCH_DEACTIVATE: {
1646 BranchList const & branchList = params().branchlist();
1647 docstring const branchName = cmd.argument();
1648 flag.setEnabled(!branchName.empty()
1649 && branchList.find(branchName));
1653 case LFUN_BRANCH_ADD:
1654 case LFUN_BRANCHES_RENAME:
1655 case LFUN_BUFFER_PRINT:
1656 // if no Buffer is present, then of course we won't be called!
1657 flag.setEnabled(true);
1667 void Buffer::dispatch(string const & command, DispatchResult & result)
1669 return dispatch(lyxaction.lookupFunc(command), result);
1673 // NOTE We can end up here even if we have no GUI, because we are called
1674 // by LyX::exec to handled command-line requests. So we may need to check
1675 // whether we have a GUI or not. The boolean use_gui holds this information.
1676 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1678 // We'll set this back to false if need be.
1679 bool dispatched = true;
1681 switch (func.action) {
1682 case LFUN_BUFFER_EXPORT: {
1683 bool success = doExport(to_utf8(func.argument()), false);
1684 dr.setError(success);
1686 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1691 case LFUN_BRANCH_ADD: {
1692 BranchList & branchList = params().branchlist();
1693 docstring const branchName = func.argument();
1694 if (branchName.empty()) {
1698 Branch * branch = branchList.find(branchName);
1700 LYXERR0("Branch " << branchName << " does already exist.");
1702 docstring const msg =
1703 bformat(_("Branch \"%1$s\" does already exist."), branchName);
1706 branchList.add(branchName);
1708 dr.update(Update::Force);
1713 case LFUN_BRANCH_ACTIVATE:
1714 case LFUN_BRANCH_DEACTIVATE: {
1715 BranchList & branchList = params().branchlist();
1716 docstring const branchName = func.argument();
1717 // the case without a branch name is handled elsewhere
1718 if (branchName.empty()) {
1722 Branch * branch = branchList.find(branchName);
1724 LYXERR0("Branch " << branchName << " does not exist.");
1726 docstring const msg =
1727 bformat(_("Branch \"%1$s\" does not exist."), branchName);
1730 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1732 dr.update(Update::Force);
1737 case LFUN_BRANCHES_RENAME: {
1738 if (func.argument().empty())
1741 docstring const oldname = from_utf8(func.getArg(0));
1742 docstring const newname = from_utf8(func.getArg(1));
1743 InsetIterator it = inset_iterator_begin(inset());
1744 InsetIterator const end = inset_iterator_end(inset());
1745 bool success = false;
1746 for (; it != end; ++it) {
1747 if (it->lyxCode() == BRANCH_CODE) {
1748 InsetBranch & ins = static_cast<InsetBranch &>(*it);
1749 if (ins.branch() == oldname) {
1750 undo().recordUndo(it);
1751 ins.rename(newname);
1756 if (it->lyxCode() == INCLUDE_CODE) {
1757 // get buffer of external file
1758 InsetInclude const & ins =
1759 static_cast<InsetInclude const &>(*it);
1760 Buffer * child = ins.getChildBuffer();
1763 child->dispatch(func, dr);
1768 dr.update(Update::Force);
1772 case LFUN_BUFFER_PRINT: {
1773 // we'll assume there's a problem until we succeed
1775 string target = func.getArg(0);
1776 string target_name = func.getArg(1);
1777 string command = func.getArg(2);
1780 || target_name.empty()
1781 || command.empty()) {
1782 LYXERR0("Unable to parse " << func.argument());
1783 docstring const msg =
1784 bformat(_("Unable to parse \"%1$s\""), func.argument());
1788 if (target != "printer" && target != "file") {
1789 LYXERR0("Unrecognized target \"" << target << '"');
1790 docstring const msg =
1791 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
1796 if (!doExport("dvi", true)) {
1797 showPrintError(absFileName());
1798 dr.setMessage(_("Error exporting to DVI."));
1802 // Push directory path.
1803 string const path = temppath();
1804 // Prevent the compiler from optimizing away p
1808 // there are three cases here:
1809 // 1. we print to a file
1810 // 2. we print directly to a printer
1811 // 3. we print using a spool command (print to file first)
1814 string const dviname = changeExtension(latexName(true), "dvi");
1816 if (target == "printer") {
1817 if (!lyxrc.print_spool_command.empty()) {
1818 // case 3: print using a spool
1819 string const psname = changeExtension(dviname,".ps");
1820 command += ' ' + lyxrc.print_to_file
1823 + quoteName(dviname);
1825 string command2 = lyxrc.print_spool_command + ' ';
1826 if (target_name != "default") {
1827 command2 += lyxrc.print_spool_printerprefix
1831 command2 += quoteName(psname);
1833 // If successful, then spool command
1834 res = one.startscript(Systemcall::Wait, command);
1837 // If there's no GUI, we have to wait on this command. Otherwise,
1838 // LyX deletes the temporary directory, and with it the spooled
1839 // file, before it can be printed!!
1840 Systemcall::Starttype stype = use_gui ?
1841 Systemcall::DontWait : Systemcall::Wait;
1842 res = one.startscript(stype, command2);
1845 // case 2: print directly to a printer
1846 if (target_name != "default")
1847 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
1849 Systemcall::Starttype stype = use_gui ?
1850 Systemcall::DontWait : Systemcall::Wait;
1851 res = one.startscript(stype, command + quoteName(dviname));
1855 // case 1: print to a file
1856 FileName const filename(makeAbsPath(target_name, filePath()));
1857 FileName const dvifile(makeAbsPath(dviname, path));
1858 if (filename.exists()) {
1859 docstring text = bformat(
1860 _("The file %1$s already exists.\n\n"
1861 "Do you want to overwrite that file?"),
1862 makeDisplayPath(filename.absFilename()));
1863 if (Alert::prompt(_("Overwrite file?"),
1864 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
1867 command += ' ' + lyxrc.print_to_file
1868 + quoteName(filename.toFilesystemEncoding())
1870 + quoteName(dvifile.toFilesystemEncoding());
1872 Systemcall::Starttype stype = use_gui ?
1873 Systemcall::DontWait : Systemcall::Wait;
1874 res = one.startscript(stype, command);
1880 dr.setMessage(_("Error running external commands."));
1881 showPrintError(absFileName());
1890 dr.dispatched(dispatched);
1894 void Buffer::changeLanguage(Language const * from, Language const * to)
1896 LASSERT(from, /**/);
1899 for_each(par_iterator_begin(),
1901 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1905 bool Buffer::isMultiLingual() const
1907 ParConstIterator end = par_iterator_end();
1908 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1909 if (it->isMultiLingual(params()))
1916 DocIterator Buffer::getParFromID(int const id) const
1918 Buffer * buf = const_cast<Buffer *>(this);
1920 // John says this is called with id == -1 from undo
1921 lyxerr << "getParFromID(), id: " << id << endl;
1922 return doc_iterator_end(buf);
1925 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
1926 if (it.paragraph().id() == id)
1929 return doc_iterator_end(buf);
1933 bool Buffer::hasParWithID(int const id) const
1935 return !getParFromID(id).atEnd();
1939 ParIterator Buffer::par_iterator_begin()
1941 return ParIterator(doc_iterator_begin(this));
1945 ParIterator Buffer::par_iterator_end()
1947 return ParIterator(doc_iterator_end(this));
1951 ParConstIterator Buffer::par_iterator_begin() const
1953 return ParConstIterator(doc_iterator_begin(this));
1957 ParConstIterator Buffer::par_iterator_end() const
1959 return ParConstIterator(doc_iterator_end(this));
1963 Language const * Buffer::language() const
1965 return params().language;
1969 docstring const Buffer::B_(string const & l10n) const
1971 return params().B_(l10n);
1975 bool Buffer::isClean() const
1977 return d->lyx_clean;
1981 bool Buffer::isBakClean() const
1983 return d->bak_clean;
1987 bool Buffer::isExternallyModified(CheckMethod method) const
1989 LASSERT(d->filename.exists(), /**/);
1990 // if method == timestamp, check timestamp before checksum
1991 return (method == checksum_method
1992 || d->timestamp_ != d->filename.lastModified())
1993 && d->checksum_ != d->filename.checksum();
1997 void Buffer::saveCheckSum(FileName const & file) const
1999 if (file.exists()) {
2000 d->timestamp_ = file.lastModified();
2001 d->checksum_ = file.checksum();
2003 // in the case of save to a new file.
2010 void Buffer::markClean() const
2012 if (!d->lyx_clean) {
2013 d->lyx_clean = true;
2016 // if the .lyx file has been saved, we don't need an
2018 d->bak_clean = true;
2022 void Buffer::markBakClean() const
2024 d->bak_clean = true;
2028 void Buffer::setUnnamed(bool flag)
2034 bool Buffer::isUnnamed() const
2040 // FIXME: this function should be moved to buffer_pimpl.C
2041 void Buffer::markDirty()
2044 d->lyx_clean = false;
2047 d->bak_clean = false;
2049 DepClean::iterator it = d->dep_clean.begin();
2050 DepClean::const_iterator const end = d->dep_clean.end();
2052 for (; it != end; ++it)
2057 FileName Buffer::fileName() const
2063 string Buffer::absFileName() const
2065 return d->filename.absFilename();
2069 string Buffer::filePath() const
2071 return d->filename.onlyPath().absFilename() + "/";
2075 bool Buffer::isReadonly() const
2077 return d->read_only;
2081 void Buffer::setParent(Buffer const * buffer)
2083 // Avoids recursive include.
2084 d->setParent(buffer == this ? 0 : buffer);
2089 Buffer const * Buffer::parent() const
2095 void Buffer::collectRelatives(BufferSet & bufs) const
2099 parent()->collectRelatives(bufs);
2101 // loop over children
2102 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2103 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2104 for (; it != end; ++it)
2105 bufs.insert(const_cast<Buffer *>(it->first));
2109 std::vector<Buffer const *> Buffer::allRelatives() const
2112 collectRelatives(bufs);
2113 BufferSet::iterator it = bufs.begin();
2114 std::vector<Buffer const *> ret;
2115 for (; it != bufs.end(); ++it)
2121 Buffer const * Buffer::masterBuffer() const
2123 Buffer const * const pbuf = d->parent();
2127 return pbuf->masterBuffer();
2131 bool Buffer::isChild(Buffer * child) const
2133 return d->children_positions.find(child) != d->children_positions.end();
2137 DocIterator Buffer::firstChildPosition(Buffer const * child)
2139 Impl::BufferPositionMap::iterator it;
2140 it = d->children_positions.find(child);
2141 if (it == d->children_positions.end())
2142 return DocIterator(this);
2147 std::vector<Buffer *> Buffer::getChildren() const
2149 std::vector<Buffer *> clist;
2150 // loop over children
2151 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2152 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2153 for (; it != end; ++it) {
2154 Buffer * child = const_cast<Buffer *>(it->first);
2155 clist.push_back(child);
2156 // there might be grandchildren
2157 std::vector<Buffer *> glist = child->getChildren();
2158 for (vector<Buffer *>::const_iterator git = glist.begin();
2159 git != glist.end(); ++git)
2160 clist.push_back(*git);
2166 template<typename M>
2167 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
2172 typename M::iterator it = m.lower_bound(x);
2173 if (it == m.begin())
2181 MacroData const * Buffer::getBufferMacro(docstring const & name,
2182 DocIterator const & pos) const
2184 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2186 // if paragraphs have no macro context set, pos will be empty
2190 // we haven't found anything yet
2191 DocIterator bestPos = par_iterator_begin();
2192 MacroData const * bestData = 0;
2194 // find macro definitions for name
2195 Impl::NamePositionScopeMacroMap::iterator nameIt
2196 = d->macros.find(name);
2197 if (nameIt != d->macros.end()) {
2198 // find last definition in front of pos or at pos itself
2199 Impl::PositionScopeMacroMap::const_iterator it
2200 = greatest_below(nameIt->second, pos);
2201 if (it != nameIt->second.end()) {
2203 // scope ends behind pos?
2204 if (pos < it->second.first) {
2205 // Looks good, remember this. If there
2206 // is no external macro behind this,
2207 // we found the right one already.
2208 bestPos = it->first;
2209 bestData = &it->second.second;
2213 // try previous macro if there is one
2214 if (it == nameIt->second.begin())
2221 // find macros in included files
2222 Impl::PositionScopeBufferMap::const_iterator it
2223 = greatest_below(d->position_to_children, pos);
2224 if (it == d->position_to_children.end())
2225 // no children before
2229 // do we know something better (i.e. later) already?
2230 if (it->first < bestPos )
2233 // scope ends behind pos?
2234 if (pos < it->second.first) {
2235 // look for macro in external file
2236 d->macro_lock = true;
2237 MacroData const * data
2238 = it->second.second->getMacro(name, false);
2239 d->macro_lock = false;
2241 bestPos = it->first;
2247 // try previous file if there is one
2248 if (it == d->position_to_children.begin())
2253 // return the best macro we have found
2258 MacroData const * Buffer::getMacro(docstring const & name,
2259 DocIterator const & pos, bool global) const
2264 // query buffer macros
2265 MacroData const * data = getBufferMacro(name, pos);
2269 // If there is a master buffer, query that
2270 Buffer const * const pbuf = d->parent();
2272 d->macro_lock = true;
2273 MacroData const * macro = pbuf->getMacro(
2274 name, *this, false);
2275 d->macro_lock = false;
2281 data = MacroTable::globalMacros().get(name);
2290 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2292 // set scope end behind the last paragraph
2293 DocIterator scope = par_iterator_begin();
2294 scope.pit() = scope.lastpit() + 1;
2296 return getMacro(name, scope, global);
2300 MacroData const * Buffer::getMacro(docstring const & name,
2301 Buffer const & child, bool global) const
2303 // look where the child buffer is included first
2304 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2305 if (it == d->children_positions.end())
2308 // check for macros at the inclusion position
2309 return getMacro(name, it->second, global);
2313 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
2315 pit_type lastpit = it.lastpit();
2317 // look for macros in each paragraph
2318 while (it.pit() <= lastpit) {
2319 Paragraph & par = it.paragraph();
2321 // iterate over the insets of the current paragraph
2322 InsetList const & insets = par.insetList();
2323 InsetList::const_iterator iit = insets.begin();
2324 InsetList::const_iterator end = insets.end();
2325 for (; iit != end; ++iit) {
2326 it.pos() = iit->pos;
2328 // is it a nested text inset?
2329 if (iit->inset->asInsetText()) {
2330 // Inset needs its own scope?
2331 InsetText const * itext = iit->inset->asInsetText();
2332 bool newScope = itext->isMacroScope();
2334 // scope which ends just behind the inset
2335 DocIterator insetScope = it;
2338 // collect macros in inset
2339 it.push_back(CursorSlice(*iit->inset));
2340 updateMacros(it, newScope ? insetScope : scope);
2345 // is it an external file?
2346 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2347 // get buffer of external file
2348 InsetInclude const & inset =
2349 static_cast<InsetInclude const &>(*iit->inset);
2350 d->macro_lock = true;
2351 Buffer * child = inset.getChildBuffer();
2352 d->macro_lock = false;
2356 // register its position, but only when it is
2357 // included first in the buffer
2358 if (d->children_positions.find(child) ==
2359 d->children_positions.end())
2360 d->children_positions[child] = it;
2362 // register child with its scope
2363 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
2367 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2371 MathMacroTemplate & macroTemplate =
2372 static_cast<MathMacroTemplate &>(*iit->inset);
2373 MacroContext mc(*this, it);
2374 macroTemplate.updateToContext(mc);
2377 bool valid = macroTemplate.validMacro();
2378 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2379 // then the BufferView's cursor will be invalid in
2380 // some cases which leads to crashes.
2385 d->macros[macroTemplate.name()][it] =
2386 Impl::ScopeMacro(scope, MacroData(*this, it));
2396 void Buffer::updateMacros() const
2401 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2403 // start with empty table
2405 d->children_positions.clear();
2406 d->position_to_children.clear();
2408 // Iterate over buffer, starting with first paragraph
2409 // The scope must be bigger than any lookup DocIterator
2410 // later. For the global lookup, lastpit+1 is used, hence
2411 // we use lastpit+2 here.
2412 DocIterator it = par_iterator_begin();
2413 DocIterator outerScope = it;
2414 outerScope.pit() = outerScope.lastpit() + 2;
2415 updateMacros(it, outerScope);
2419 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2421 InsetIterator it = inset_iterator_begin(inset());
2422 InsetIterator const end = inset_iterator_end(inset());
2423 for (; it != end; ++it) {
2424 if (it->lyxCode() == BRANCH_CODE) {
2425 InsetBranch & br = static_cast<InsetBranch &>(*it);
2426 docstring const name = br.branch();
2427 if (!from_master && !params().branchlist().find(name))
2428 result.push_back(name);
2429 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2430 result.push_back(name);
2433 if (it->lyxCode() == INCLUDE_CODE) {
2434 // get buffer of external file
2435 InsetInclude const & ins =
2436 static_cast<InsetInclude const &>(*it);
2437 Buffer * child = ins.getChildBuffer();
2440 child->getUsedBranches(result, true);
2443 // remove duplicates
2448 void Buffer::updateMacroInstances() const
2450 LYXERR(Debug::MACROS, "updateMacroInstances for "
2451 << d->filename.onlyFileName());
2452 DocIterator it = doc_iterator_begin(this);
2453 DocIterator end = doc_iterator_end(this);
2454 for (; it != end; it.forwardPos()) {
2455 // look for MathData cells in InsetMathNest insets
2456 Inset * inset = it.nextInset();
2460 InsetMath * minset = inset->asInsetMath();
2464 // update macro in all cells of the InsetMathNest
2465 DocIterator::idx_type n = minset->nargs();
2466 MacroContext mc = MacroContext(*this, it);
2467 for (DocIterator::idx_type i = 0; i < n; ++i) {
2468 MathData & data = minset->cell(i);
2469 data.updateMacros(0, mc);
2475 void Buffer::listMacroNames(MacroNameSet & macros) const
2480 d->macro_lock = true;
2482 // loop over macro names
2483 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2484 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2485 for (; nameIt != nameEnd; ++nameIt)
2486 macros.insert(nameIt->first);
2488 // loop over children
2489 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2490 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2491 for (; it != end; ++it)
2492 it->first->listMacroNames(macros);
2495 Buffer const * const pbuf = d->parent();
2497 pbuf->listMacroNames(macros);
2499 d->macro_lock = false;
2503 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2505 Buffer const * const pbuf = d->parent();
2510 pbuf->listMacroNames(names);
2513 MacroNameSet::iterator it = names.begin();
2514 MacroNameSet::iterator end = names.end();
2515 for (; it != end; ++it) {
2517 MacroData const * data =
2518 pbuf->getMacro(*it, *this, false);
2520 macros.insert(data);
2522 // we cannot access the original MathMacroTemplate anymore
2523 // here to calls validate method. So we do its work here manually.
2524 // FIXME: somehow make the template accessible here.
2525 if (data->optionals() > 0)
2526 features.require("xargs");
2532 Buffer::References & Buffer::references(docstring const & label)
2535 return const_cast<Buffer *>(masterBuffer())->references(label);
2537 RefCache::iterator it = d->ref_cache_.find(label);
2538 if (it != d->ref_cache_.end())
2539 return it->second.second;
2541 static InsetLabel const * dummy_il = 0;
2542 static References const dummy_refs;
2543 it = d->ref_cache_.insert(
2544 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2545 return it->second.second;
2549 Buffer::References const & Buffer::references(docstring const & label) const
2551 return const_cast<Buffer *>(this)->references(label);
2555 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2557 masterBuffer()->d->ref_cache_[label].first = il;
2561 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2563 return masterBuffer()->d->ref_cache_[label].first;
2567 void Buffer::clearReferenceCache() const
2570 d->ref_cache_.clear();
2574 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2577 //FIXME: This does not work for child documents yet.
2578 LASSERT(code == CITE_CODE, /**/);
2579 // Check if the label 'from' appears more than once
2580 vector<docstring> labels;
2582 BiblioInfo const & keys = masterBibInfo();
2583 BiblioInfo::const_iterator bit = keys.begin();
2584 BiblioInfo::const_iterator bend = keys.end();
2586 for (; bit != bend; ++bit)
2588 labels.push_back(bit->first);
2591 if (count(labels.begin(), labels.end(), from) > 1)
2594 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2595 if (it->lyxCode() == code) {
2596 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2597 docstring const oldValue = inset.getParam(paramName);
2598 if (oldValue == from)
2599 inset.setParam(paramName, to);
2605 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2606 pit_type par_end, bool full_source) const
2608 OutputParams runparams(¶ms().encoding());
2609 runparams.nice = true;
2610 runparams.flavor = params().useXetex ?
2611 OutputParams::XETEX : OutputParams::LATEX;
2612 runparams.linelen = lyxrc.plaintext_linelen;
2613 // No side effect of file copying and image conversion
2614 runparams.dryrun = true;
2617 os << "% " << _("Preview source code") << "\n\n";
2619 d->texrow.newline();
2620 d->texrow.newline();
2622 writeDocBookSource(os, absFileName(), runparams, false);
2624 // latex or literate
2625 writeLaTeXSource(os, string(), runparams, true, true);
2627 runparams.par_begin = par_begin;
2628 runparams.par_end = par_end;
2629 if (par_begin + 1 == par_end) {
2631 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2635 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2636 convert<docstring>(par_begin),
2637 convert<docstring>(par_end - 1))
2644 // output paragraphs
2646 docbookParagraphs(text(), *this, os, runparams);
2648 // latex or literate
2649 latexParagraphs(*this, text(), os, texrow, runparams);
2654 ErrorList & Buffer::errorList(string const & type) const
2656 static ErrorList emptyErrorList;
2657 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2658 if (I == d->errorLists.end())
2659 return emptyErrorList;
2665 void Buffer::updateTocItem(std::string const & type,
2666 DocIterator const & dit) const
2669 gui_->updateTocItem(type, dit);
2673 void Buffer::structureChanged() const
2676 gui_->structureChanged();
2680 void Buffer::errors(string const & err, bool from_master) const
2683 gui_->errors(err, from_master);
2687 void Buffer::message(docstring const & msg) const
2694 void Buffer::setBusy(bool on) const
2701 void Buffer::setReadOnly(bool on) const
2704 d->wa_->setReadOnly(on);
2708 void Buffer::updateTitles() const
2711 d->wa_->updateTitles();
2715 void Buffer::resetAutosaveTimers() const
2718 gui_->resetAutosaveTimers();
2722 bool Buffer::hasGuiDelegate() const
2728 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2737 class AutoSaveBuffer : public ForkedProcess {
2740 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2741 : buffer_(buffer), fname_(fname) {}
2743 virtual boost::shared_ptr<ForkedProcess> clone() const
2745 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2750 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2751 from_utf8(fname_.absFilename())));
2752 return run(DontWait);
2756 virtual int generateChild();
2758 Buffer const & buffer_;
2763 int AutoSaveBuffer::generateChild()
2765 // tmp_ret will be located (usually) in /tmp
2766 // will that be a problem?
2767 // Note that this calls ForkedCalls::fork(), so it's
2768 // ok cross-platform.
2769 pid_t const pid = fork();
2770 // If you want to debug the autosave
2771 // you should set pid to -1, and comment out the fork.
2772 if (pid != 0 && pid != -1)
2775 // pid = -1 signifies that lyx was unable
2776 // to fork. But we will do the save
2778 bool failed = false;
2779 FileName const tmp_ret = FileName::tempName("lyxauto");
2780 if (!tmp_ret.empty()) {
2781 buffer_.writeFile(tmp_ret);
2782 // assume successful write of tmp_ret
2783 if (!tmp_ret.moveTo(fname_))
2789 // failed to write/rename tmp_ret so try writing direct
2790 if (!buffer_.writeFile(fname_)) {
2791 // It is dangerous to do this in the child,
2792 // but safe in the parent, so...
2793 if (pid == -1) // emit message signal.
2794 buffer_.message(_("Autosave failed!"));
2798 if (pid == 0) // we are the child so...
2807 FileName Buffer::getAutosaveFilename() const
2809 // if the document is unnamed try to save in the backup dir, else
2810 // in the default document path, and as a last try in the filePath,
2811 // which will most often be the temporary directory
2814 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
2815 : lyxrc.backupdir_path;
2816 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
2819 string const fname = "#" + d->filename.onlyFileName() + "#";
2820 return makeAbsPath(fname, fpath);
2824 void Buffer::removeAutosaveFile() const
2826 FileName const f = getAutosaveFilename();
2832 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
2834 FileName const newauto = getAutosaveFilename();
2835 if (!(oldauto == newauto || oldauto.moveTo(newauto)))
2836 LYXERR0("Unable to remove autosave file `" << oldauto << "'!");
2840 // Perfect target for a thread...
2841 void Buffer::autoSave() const
2843 if (isBakClean() || isReadonly()) {
2844 // We don't save now, but we'll try again later
2845 resetAutosaveTimers();
2849 // emit message signal.
2850 message(_("Autosaving current document..."));
2851 AutoSaveBuffer autosave(*this, getAutosaveFilename());
2855 resetAutosaveTimers();
2859 string Buffer::bufferFormat() const
2861 string format = params().documentClass().outputFormat();
2862 if (format == "latex") {
2863 if (params().useXetex)
2865 if (params().encoding().package() == Encoding::japanese)
2872 string Buffer::getDefaultOutputFormat() const
2874 if (!params().defaultOutputFormat.empty()
2875 && params().defaultOutputFormat != "default")
2876 return params().defaultOutputFormat;
2877 typedef vector<Format const *> Formats;
2878 Formats formats = exportableFormats(true);
2881 || params().useXetex
2882 || params().encoding().package() == Encoding::japanese) {
2883 if (formats.empty())
2885 // return the first we find
2886 return formats.front()->name();
2888 return lyxrc.default_view_format;
2893 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2894 string & result_file) const
2896 string backend_format;
2897 OutputParams runparams(¶ms().encoding());
2898 runparams.flavor = OutputParams::LATEX;
2899 runparams.linelen = lyxrc.plaintext_linelen;
2900 vector<string> backs = backends();
2901 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2902 // Get shortest path to format
2903 Graph::EdgePath path;
2904 for (vector<string>::const_iterator it = backs.begin();
2905 it != backs.end(); ++it) {
2906 Graph::EdgePath p = theConverters().getPath(*it, format);
2907 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2908 backend_format = *it;
2913 runparams.flavor = theConverters().getFlavor(path);
2915 Alert::error(_("Couldn't export file"),
2916 bformat(_("No information for exporting the format %1$s."),
2917 formats.prettyName(format)));
2921 backend_format = format;
2922 // FIXME: Don't hardcode format names here, but use a flag
2923 if (backend_format == "pdflatex")
2924 runparams.flavor = OutputParams::PDFLATEX;
2927 string filename = latexName(false);
2928 filename = addName(temppath(), filename);
2929 filename = changeExtension(filename,
2930 formats.extension(backend_format));
2933 updateMacroInstances();
2935 // Plain text backend
2936 if (backend_format == "text")
2937 writePlaintextFile(*this, FileName(filename), runparams);
2939 else if (backend_format == "xhtml")
2940 makeLyXHTMLFile(FileName(filename), runparams);
2941 else if (backend_format == "lyx")
2942 writeFile(FileName(filename));
2944 else if (isDocBook()) {
2945 runparams.nice = !put_in_tempdir;
2946 makeDocBookFile(FileName(filename), runparams);
2949 else if (backend_format == format) {
2950 runparams.nice = true;
2951 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2953 } else if (!lyxrc.tex_allows_spaces
2954 && contains(filePath(), ' ')) {
2955 Alert::error(_("File name error"),
2956 _("The directory path to the document cannot contain spaces."));
2959 runparams.nice = false;
2960 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2964 string const error_type = (format == "program")
2965 ? "Build" : bufferFormat();
2966 ErrorList & error_list = d->errorLists[error_type];
2967 string const ext = formats.extension(format);
2968 FileName const tmp_result_file(changeExtension(filename, ext));
2969 bool const success = theConverters().convert(this, FileName(filename),
2970 tmp_result_file, FileName(absFileName()), backend_format, format,
2972 // Emit the signal to show the error list.
2973 if (format != backend_format) {
2975 // also to the children, in case of master-buffer-view
2976 std::vector<Buffer *> clist = getChildren();
2977 for (vector<Buffer *>::const_iterator cit = clist.begin();
2978 cit != clist.end(); ++cit)
2979 (*cit)->errors(error_type, true);
2984 if (put_in_tempdir) {
2985 result_file = tmp_result_file.absFilename();
2989 result_file = changeExtension(exportFileName().absFilename(), ext);
2990 // We need to copy referenced files (e. g. included graphics
2991 // if format == "dvi") to the result dir.
2992 vector<ExportedFile> const files =
2993 runparams.exportdata->externalFiles(format);
2994 string const dest = onlyPath(result_file);
2995 CopyStatus status = SUCCESS;
2996 for (vector<ExportedFile>::const_iterator it = files.begin();
2997 it != files.end() && status != CANCEL; ++it) {
2998 string const fmt = formats.getFormatFromFile(it->sourceName);
2999 status = copyFile(fmt, it->sourceName,
3000 makeAbsPath(it->exportName, dest),
3001 it->exportName, status == FORCE);
3003 if (status == CANCEL) {
3004 message(_("Document export cancelled."));
3005 } else if (tmp_result_file.exists()) {
3006 // Finally copy the main file
3007 status = copyFile(format, tmp_result_file,
3008 FileName(result_file), result_file,
3010 message(bformat(_("Document exported as %1$s "
3012 formats.prettyName(format),
3013 makeDisplayPath(result_file)));
3015 // This must be a dummy converter like fax (bug 1888)
3016 message(bformat(_("Document exported as %1$s"),
3017 formats.prettyName(format)));
3024 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
3027 return doExport(format, put_in_tempdir, result_file);
3031 bool Buffer::preview(string const & format) const
3034 if (!doExport(format, true, result_file))
3036 return formats.view(*this, FileName(result_file), format);
3040 bool Buffer::isExportable(string const & format) const
3042 vector<string> backs = backends();
3043 for (vector<string>::const_iterator it = backs.begin();
3044 it != backs.end(); ++it)
3045 if (theConverters().isReachable(*it, format))
3051 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3053 vector<string> backs = backends();
3054 vector<Format const *> result =
3055 theConverters().getReachable(backs[0], only_viewable, true);
3056 for (vector<string>::const_iterator it = backs.begin() + 1;
3057 it != backs.end(); ++it) {
3058 vector<Format const *> r =
3059 theConverters().getReachable(*it, only_viewable, false);
3060 result.insert(result.end(), r.begin(), r.end());
3066 vector<string> Buffer::backends() const
3069 if (params().baseClass()->isTeXClassAvailable()) {
3070 v.push_back(bufferFormat());
3071 // FIXME: Don't hardcode format names here, but use a flag
3072 if (v.back() == "latex")
3073 v.push_back("pdflatex");
3075 v.push_back("text");
3076 v.push_back("xhtml");
3082 bool Buffer::readFileHelper(FileName const & s)
3084 // File information about normal file
3086 docstring const file = makeDisplayPath(s.absFilename(), 50);
3087 docstring text = bformat(_("The specified document\n%1$s"
3088 "\ncould not be read."), file);
3089 Alert::error(_("Could not read document"), text);
3093 // Check if emergency save file exists and is newer.
3094 FileName const e(s.absFilename() + ".emergency");
3096 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3097 docstring const file = makeDisplayPath(s.absFilename(), 20);
3098 docstring const text =
3099 bformat(_("An emergency save of the document "
3101 "Recover emergency save?"), file);
3102 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3103 _("&Recover"), _("&Load Original"),
3107 // the file is not saved if we load the emergency file.
3112 if ((res = readFile(e)) == success)
3113 str = _("Document was successfully recovered.");
3115 str = _("Document was NOT successfully recovered.");
3116 str += "\n\n" + _("Remove emergency file now?");
3118 if (!Alert::prompt(_("Delete emergency file?"), str, 1, 1,
3119 _("&Remove"), _("&Keep it"))) {
3122 Alert::warning(_("Emergency file deleted"),
3123 _("Do not forget to save your file now!"), true);
3128 if (!Alert::prompt(_("Delete emergency file?"),
3129 _("Remove emergency file now?"), 1, 1,
3130 _("&Remove"), _("&Keep it")))
3138 // Now check if autosave file is newer.
3139 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3141 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3142 docstring const file = makeDisplayPath(s.absFilename(), 20);
3143 docstring const text =
3144 bformat(_("The backup of the document "
3145 "%1$s is newer.\n\nLoad the "
3146 "backup instead?"), file);
3147 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3148 _("&Load backup"), _("Load &original"),
3152 // the file is not saved if we load the autosave file.
3156 // Here we delete the autosave
3167 bool Buffer::loadLyXFile(FileName const & s)
3169 if (s.isReadableFile()) {
3170 if (readFileHelper(s)) {
3171 lyxvc().file_found_hook(s);
3172 if (!s.isWritable())
3177 docstring const file = makeDisplayPath(s.absFilename(), 20);
3178 // Here we probably should run
3179 if (LyXVC::file_not_found_hook(s)) {
3180 docstring const text =
3181 bformat(_("Do you want to retrieve the document"
3182 " %1$s from version control?"), file);
3183 int const ret = Alert::prompt(_("Retrieve from version control?"),
3184 text, 0, 1, _("&Retrieve"), _("&Cancel"));
3187 // How can we know _how_ to do the checkout?
3188 // With the current VC support it has to be,
3189 // a RCS file since CVS do not have special ,v files.
3191 return loadLyXFile(s);
3199 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3201 TeXErrors::Errors::const_iterator cit = terr.begin();
3202 TeXErrors::Errors::const_iterator end = terr.end();
3204 for (; cit != end; ++cit) {
3207 int errorRow = cit->error_in_line;
3208 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3214 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3215 } while (found && id_start == id_end && pos_start == pos_end);
3217 errorList.push_back(ErrorItem(cit->error_desc,
3218 cit->error_text, id_start, pos_start, pos_end));
3223 void Buffer::setBuffersForInsets() const
3225 inset().setBuffer(const_cast<Buffer &>(*this));
3229 void Buffer::updateLabels(UpdateScope scope) const
3231 // Use the master text class also for child documents
3232 Buffer const * const master = masterBuffer();
3233 DocumentClass const & textclass = master->params().documentClass();
3235 // keep the buffers to be children in this set. If the call from the
3236 // master comes back we can see which of them were actually seen (i.e.
3237 // via an InsetInclude). The remaining ones in the set need still be updated.
3238 static std::set<Buffer const *> bufToUpdate;
3239 if (scope == UpdateMaster) {
3240 // If this is a child document start with the master
3241 if (master != this) {
3242 bufToUpdate.insert(this);
3243 master->updateLabels();
3244 // Do this here in case the master has no gui associated with it. Then,
3245 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3249 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3250 if (bufToUpdate.find(this) == bufToUpdate.end())
3254 // start over the counters in the master
3255 textclass.counters().reset();
3258 // update will be done below for this buffer
3259 bufToUpdate.erase(this);
3261 // update all caches
3262 clearReferenceCache();
3265 Buffer & cbuf = const_cast<Buffer &>(*this);
3267 LASSERT(!text().paragraphs().empty(), /**/);
3270 ParIterator parit = cbuf.par_iterator_begin();
3271 updateLabels(parit);
3274 // TocBackend update will be done later.
3277 cbuf.tocBackend().update();
3278 if (scope == UpdateMaster)
3279 cbuf.structureChanged();
3283 static depth_type getDepth(DocIterator const & it)
3285 depth_type depth = 0;
3286 for (size_t i = 0 ; i < it.depth() ; ++i)
3287 if (!it[i].inset().inMathed())
3288 depth += it[i].paragraph().getDepth() + 1;
3289 // remove 1 since the outer inset does not count
3293 static depth_type getItemDepth(ParIterator const & it)
3295 Paragraph const & par = *it;
3296 LabelType const labeltype = par.layout().labeltype;
3298 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3301 // this will hold the lowest depth encountered up to now.
3302 depth_type min_depth = getDepth(it);
3303 ParIterator prev_it = it;
3306 --prev_it.top().pit();
3308 // start of nested inset: go to outer par
3310 if (prev_it.empty()) {
3311 // start of document: nothing to do
3316 // We search for the first paragraph with same label
3317 // that is not more deeply nested.
3318 Paragraph & prev_par = *prev_it;
3319 depth_type const prev_depth = getDepth(prev_it);
3320 if (labeltype == prev_par.layout().labeltype) {
3321 if (prev_depth < min_depth)
3322 return prev_par.itemdepth + 1;
3323 if (prev_depth == min_depth)
3324 return prev_par.itemdepth;
3326 min_depth = min(min_depth, prev_depth);
3327 // small optimization: if we are at depth 0, we won't
3328 // find anything else
3329 if (prev_depth == 0)
3335 static bool needEnumCounterReset(ParIterator const & it)
3337 Paragraph const & par = *it;
3338 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3339 depth_type const cur_depth = par.getDepth();
3340 ParIterator prev_it = it;
3341 while (prev_it.pit()) {
3342 --prev_it.top().pit();
3343 Paragraph const & prev_par = *prev_it;
3344 if (prev_par.getDepth() <= cur_depth)
3345 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3347 // start of nested inset: reset
3352 // set the label of a paragraph. This includes the counters.
3353 static void setLabel(Buffer const & buf, ParIterator & it)
3355 BufferParams const & bp = buf.masterBuffer()->params();
3356 DocumentClass const & textclass = bp.documentClass();
3357 Paragraph & par = it.paragraph();
3358 Layout const & layout = par.layout();
3359 Counters & counters = textclass.counters();
3361 if (par.params().startOfAppendix()) {
3362 // FIXME: only the counter corresponding to toplevel
3363 // sectionning should be reset
3365 counters.appendix(true);
3367 par.params().appendix(counters.appendix());
3369 // Compute the item depth of the paragraph
3370 par.itemdepth = getItemDepth(it);
3372 if (layout.margintype == MARGIN_MANUAL
3373 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3374 if (par.params().labelWidthString().empty())
3375 par.params().labelWidthString(par.expandLabel(layout, bp));
3377 par.params().labelWidthString(docstring());
3380 switch(layout.labeltype) {
3382 if (layout.toclevel <= bp.secnumdepth
3383 && (layout.latextype != LATEX_ENVIRONMENT
3384 || it.text()->isFirstInSequence(it.pit()))) {
3385 counters.step(layout.counter);
3386 par.params().labelString(
3387 par.expandLabel(layout, bp));
3389 par.params().labelString(docstring());
3392 case LABEL_ITEMIZE: {
3393 // At some point of time we should do something more
3394 // clever here, like:
3395 // par.params().labelString(
3396 // bp.user_defined_bullet(par.itemdepth).getText());
3397 // for now, use a simple hardcoded label
3398 docstring itemlabel;
3399 switch (par.itemdepth) {
3401 itemlabel = char_type(0x2022);
3404 itemlabel = char_type(0x2013);
3407 itemlabel = char_type(0x2217);
3410 itemlabel = char_type(0x2219); // or 0x00b7
3413 par.params().labelString(itemlabel);
3417 case LABEL_ENUMERATE: {
3418 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3420 switch (par.itemdepth) {
3429 enumcounter += "iv";
3432 // not a valid enumdepth...
3436 // Maybe we have to reset the enumeration counter.
3437 if (needEnumCounterReset(it))
3438 counters.reset(enumcounter);
3439 counters.step(enumcounter);
3441 string const & lang = par.getParLanguage(bp)->code();
3442 par.params().labelString(counters.theCounter(enumcounter, lang));
3447 case LABEL_SENSITIVE: {
3448 string const & type = counters.current_float();
3449 docstring full_label;
3451 full_label = buf.B_("Senseless!!! ");
3453 docstring name = buf.B_(textclass.floats().getType(type).name());
3454 if (counters.hasCounter(from_utf8(type))) {
3455 string const & lang = par.getParLanguage(bp)->code();
3456 counters.step(from_utf8(type));
3457 full_label = bformat(from_ascii("%1$s %2$s:"),
3459 counters.theCounter(from_utf8(type), lang));
3461 full_label = bformat(from_ascii("%1$s #:"), name);
3463 par.params().labelString(full_label);
3467 case LABEL_NO_LABEL:
3468 par.params().labelString(docstring());
3472 case LABEL_TOP_ENVIRONMENT:
3473 case LABEL_CENTERED_TOP_ENVIRONMENT:
3476 par.params().labelString(par.expandLabel(layout, bp));
3482 void Buffer::updateLabels(ParIterator & parit) const
3484 LASSERT(parit.pit() == 0, /**/);
3486 // set the position of the text in the buffer to be able
3487 // to resolve macros in it. This has nothing to do with
3488 // labels, but by putting it here we avoid implementing
3489 // a whole bunch of traversal routines just for this call.
3490 parit.text()->setMacrocontextPosition(parit);
3492 depth_type maxdepth = 0;
3493 pit_type const lastpit = parit.lastpit();
3494 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3495 // reduce depth if necessary
3496 parit->params().depth(min(parit->params().depth(), maxdepth));
3497 maxdepth = parit->getMaxDepthAfter();
3499 // set the counter for this paragraph
3500 setLabel(*this, parit);
3503 InsetList::const_iterator iit = parit->insetList().begin();
3504 InsetList::const_iterator end = parit->insetList().end();
3505 for (; iit != end; ++iit) {
3506 parit.pos() = iit->pos;
3507 iit->inset->updateLabels(parit);
3513 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3514 WordLangTuple & word_lang, docstring_list & suggestions) const
3518 suggestions.clear();
3519 word_lang = WordLangTuple();
3520 // OK, we start from here.
3521 DocIterator const end = doc_iterator_end(this);
3522 for (; from != end; from.forwardPos()) {
3523 // We are only interested in text so remove the math CursorSlice.
3524 while (from.inMathed())
3525 from.forwardInset();
3527 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {