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_funcs.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
56 #include "PDFOptions.h"
57 #include "SpellChecker.h"
60 #include "TexStream.h"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibitem.h"
71 #include "insets/InsetBibtex.h"
72 #include "insets/InsetBranch.h"
73 #include "insets/InsetInclude.h"
74 #include "insets/InsetText.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "frontends/alert.h"
81 #include "frontends/Delegates.h"
82 #include "frontends/WorkAreaManager.h"
84 #include "graphics/Previews.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include <boost/bind.hpp>
107 #include <boost/shared_ptr.hpp>
119 using namespace lyx::support;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
128 // Do not remove the comment below, so we get merge conflict in
129 // independent branches. Instead add your own.
130 int const LYX_FORMAT = 362; // jspitzm: support applemac encoding
132 typedef map<string, bool> DepClean;
133 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
135 void showPrintError(string const & name)
137 docstring str = bformat(_("Could not print the document %1$s.\n"
138 "Check that your printer is set up correctly."),
139 makeDisplayPath(name, 50));
140 Alert::error(_("Print document failed"), str);
145 class BufferSet : public std::set<Buffer const *> {};
150 Impl(Buffer & parent, FileName const & file, bool readonly);
164 mutable TexRow texrow;
166 /// need to regenerate .tex?
170 mutable bool lyx_clean;
172 /// is autosave needed?
173 mutable bool bak_clean;
175 /// is this a unnamed file (New...)?
181 /// name of the file the buffer is associated with.
184 /** Set to true only when the file is fully loaded.
185 * Used to prevent the premature generation of previews
186 * and by the citation inset.
188 bool file_fully_loaded;
191 mutable TocBackend toc_backend;
194 typedef pair<DocIterator, MacroData> ScopeMacro;
195 typedef map<DocIterator, ScopeMacro> PositionScopeMacroMap;
196 typedef map<docstring, PositionScopeMacroMap> NamePositionScopeMacroMap;
197 /// map from the macro name to the position map,
198 /// which maps the macro definition position to the scope and the MacroData.
199 NamePositionScopeMacroMap macros;
202 /// positions of child buffers in the buffer
203 typedef map<Buffer const * const, DocIterator> BufferPositionMap;
204 typedef pair<DocIterator, Buffer const *> ScopeBuffer;
205 typedef map<DocIterator, ScopeBuffer> PositionScopeBufferMap;
206 /// position of children buffers in this buffer
207 BufferPositionMap children_positions;
208 /// map from children inclusion positions to their scope and their buffer
209 PositionScopeBufferMap position_to_children;
211 /// Container for all sort of Buffer dependant errors.
212 map<string, ErrorList> errorLists;
214 /// timestamp and checksum used to test if the file has been externally
215 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
217 unsigned long checksum_;
220 frontend::WorkAreaManager * wa_;
225 /// A cache for the bibfiles (including bibfiles of loaded child
226 /// documents), needed for appropriate update of natbib labels.
227 mutable support::FileNameList bibfilesCache_;
229 // FIXME The caching mechanism could be improved. At present, we have a
230 // cache for each Buffer, that caches all the bibliography info for that
231 // Buffer. A more efficient solution would be to have a global cache per
232 // file, and then to construct the Buffer's bibinfo from that.
233 /// A cache for bibliography info
234 mutable BiblioInfo bibinfo_;
235 /// whether the bibinfo cache is valid
236 bool bibinfoCacheValid_;
237 /// Cache of timestamps of .bib files
238 map<FileName, time_t> bibfileStatus_;
240 mutable RefCache ref_cache_;
242 /// our Text that should be wrapped in an InsetText
245 /// This is here to force the test to be done whenever parent_buffer
247 Buffer const * parent() const {
248 // if parent_buffer is not loaded, then it has been unloaded,
249 // which means that parent_buffer is an invalid pointer. So we
250 // set it to null in that case.
251 if (!theBufferList().isLoaded(parent_buffer))
253 return parent_buffer;
256 void setParent(Buffer const * pb) { parent_buffer = pb; }
258 /// So we can force access via the accessors.
259 mutable Buffer const * parent_buffer;
263 /// Creates the per buffer temporary directory
264 static FileName createBufferTmpDir()
267 // We are in our own directory. Why bother to mangle name?
268 // In fact I wrote this code to circumvent a problematic behaviour
269 // (bug?) of EMX mkstemp().
270 FileName tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
271 convert<string>(count++));
273 if (!tmpfl.createDirectory(0777)) {
274 throw ExceptionMessage(WarningException, _("Disk Error: "), bformat(
275 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
276 from_utf8(tmpfl.absFilename())));
282 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
283 : lyx_clean(true), bak_clean(true), unnamed(false),
284 read_only(readonly_), filename(file), file_fully_loaded(false),
285 toc_backend(&parent), macro_lock(false), timestamp_(0),
286 checksum_(0), wa_(0), undo_(parent), bibinfoCacheValid_(false),
289 temppath = createBufferTmpDir();
290 lyxvc.setBuffer(&parent);
292 wa_ = new frontend::WorkAreaManager;
296 Buffer::Buffer(string const & file, bool readonly)
297 : d(new Impl(*this, FileName(file), readonly)), gui_(0)
299 LYXERR(Debug::INFO, "Buffer::Buffer()");
301 d->inset = new InsetText(*this);
302 d->inset->setAutoBreakRows(true);
303 d->inset->getText(0)->setMacrocontextPosition(par_iterator_begin());
309 LYXERR(Debug::INFO, "Buffer::~Buffer()");
310 // here the buffer should take care that it is
311 // saved properly, before it goes into the void.
313 // GuiView already destroyed
316 if (d->unnamed && d->filename.extension() == "internal") {
317 // No need to do additional cleanups for internal buffer.
322 // loop over children
323 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
324 Impl::BufferPositionMap::iterator end = d->children_positions.end();
325 for (; it != end; ++it) {
326 Buffer * child = const_cast<Buffer *>(it->first);
327 // The child buffer might have been closed already.
328 if (theBufferList().isLoaded(child))
329 theBufferList().releaseChild(this, child);
332 // clear references to children in macro tables
333 d->children_positions.clear();
334 d->position_to_children.clear();
336 if (!d->temppath.destroyDirectory()) {
337 Alert::warning(_("Could not remove temporary directory"),
338 bformat(_("Could not remove the temporary directory %1$s"),
339 from_utf8(d->temppath.absFilename())));
342 // Remove any previewed LaTeX snippets associated with this buffer.
343 thePreviews().removeLoader(*this);
349 void Buffer::changed() const
356 frontend::WorkAreaManager & Buffer::workAreaManager() const
358 LASSERT(d->wa_, /**/);
363 Text & Buffer::text() const
365 return d->inset->text();
369 Inset & Buffer::inset() const
375 BufferParams & Buffer::params()
381 BufferParams const & Buffer::params() const
387 ParagraphList & Buffer::paragraphs()
389 return text().paragraphs();
393 ParagraphList const & Buffer::paragraphs() const
395 return text().paragraphs();
399 LyXVC & Buffer::lyxvc()
405 LyXVC const & Buffer::lyxvc() const
411 string const Buffer::temppath() const
413 return d->temppath.absFilename();
417 TexRow & Buffer::texrow()
423 TexRow const & Buffer::texrow() const
429 TocBackend & Buffer::tocBackend() const
431 return d->toc_backend;
435 Undo & Buffer::undo()
441 string Buffer::latexName(bool const no_path) const
443 FileName latex_name = makeLatexName(d->filename);
444 return no_path ? latex_name.onlyFileName()
445 : latex_name.absFilename();
449 string Buffer::logName(LogType * type) const
451 string const filename = latexName(false);
453 if (filename.empty()) {
459 string const path = temppath();
461 FileName const fname(addName(temppath(),
462 onlyFilename(changeExtension(filename,
465 // FIXME: how do we know this is the name of the build log?
466 FileName const bname(
467 addName(path, onlyFilename(
468 changeExtension(filename,
469 formats.extension(bufferFormat()) + ".out"))));
471 // Also consider the master buffer log file
472 FileName masterfname = fname;
474 if (masterBuffer() != this) {
475 string const mlogfile = masterBuffer()->logName(&mtype);
476 masterfname = FileName(mlogfile);
479 // If no Latex log or Build log is newer, show Build log
480 if (bname.exists() &&
481 ((!fname.exists() && !masterfname.exists())
482 || (fname.lastModified() < bname.lastModified()
483 && masterfname.lastModified() < bname.lastModified()))) {
484 LYXERR(Debug::FILES, "Log name calculated as: " << bname);
487 return bname.absFilename();
488 // If we have a newer master file log or only a master log, show this
489 } else if (fname != masterfname
490 && (!fname.exists() && masterfname.exists()
491 || fname.lastModified() < masterfname.lastModified())) {
492 LYXERR(Debug::FILES, "Log name calculated as: " << masterfname);
495 return masterfname.absFilename();
497 LYXERR(Debug::FILES, "Log name calculated as: " << fname);
500 return fname.absFilename();
504 void Buffer::setReadonly(bool const flag)
506 if (d->read_only != flag) {
513 void Buffer::setFileName(string const & newfile)
515 d->filename = makeAbsPath(newfile);
516 setReadonly(d->filename.isReadOnly());
521 int Buffer::readHeader(Lexer & lex)
523 int unknown_tokens = 0;
525 int begin_header_line = -1;
527 // Initialize parameters that may be/go lacking in header:
528 params().branchlist().clear();
529 params().preamble.erase();
530 params().options.erase();
531 params().master.erase();
532 params().float_placement.erase();
533 params().paperwidth.erase();
534 params().paperheight.erase();
535 params().leftmargin.erase();
536 params().rightmargin.erase();
537 params().topmargin.erase();
538 params().bottommargin.erase();
539 params().headheight.erase();
540 params().headsep.erase();
541 params().footskip.erase();
542 params().columnsep.erase();
543 params().fontsCJK.erase();
544 params().listings_params.clear();
545 params().clearLayoutModules();
546 params().clearRemovedModules();
547 params().pdfoptions().clear();
548 params().indiceslist().clear();
549 params().backgroundcolor = lyx::rgbFromHexName("#ffffff");
551 for (int i = 0; i < 4; ++i) {
552 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
553 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
556 ErrorList & errorList = d->errorLists["Parse"];
565 if (token == "\\end_header")
569 if (token == "\\begin_header") {
570 begin_header_line = line;
574 LYXERR(Debug::PARSER, "Handling document header token: `"
577 string unknown = params().readToken(lex, token, d->filename.onlyPath());
578 if (!unknown.empty()) {
579 if (unknown[0] != '\\' && token == "\\textclass") {
580 Alert::warning(_("Unknown document class"),
581 bformat(_("Using the default document class, because the "
582 "class %1$s is unknown."), from_utf8(unknown)));
585 docstring const s = bformat(_("Unknown token: "
589 errorList.push_back(ErrorItem(_("Document header error"),
594 if (begin_header_line) {
595 docstring const s = _("\\begin_header is missing");
596 errorList.push_back(ErrorItem(_("Document header error"),
600 params().makeDocumentClass();
602 return unknown_tokens;
607 // changed to be public and have one parameter
608 // Returns true if "\end_document" is not read (Asger)
609 bool Buffer::readDocument(Lexer & lex)
611 ErrorList & errorList = d->errorLists["Parse"];
614 if (!lex.checkFor("\\begin_document")) {
615 docstring const s = _("\\begin_document is missing");
616 errorList.push_back(ErrorItem(_("Document header error"),
620 // we are reading in a brand new document
621 LASSERT(paragraphs().empty(), /**/);
625 if (params().outputChanges) {
626 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
627 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
628 LaTeXFeatures::isAvailable("xcolor");
630 if (!dvipost && !xcolorulem) {
631 Alert::warning(_("Changes not shown in LaTeX output"),
632 _("Changes will not be highlighted in LaTeX output, "
633 "because neither dvipost nor xcolor/ulem are installed.\n"
634 "Please install these packages or redefine "
635 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
636 } else if (!xcolorulem) {
637 Alert::warning(_("Changes not shown in LaTeX output"),
638 _("Changes will not be highlighted in LaTeX output "
639 "when using pdflatex, because xcolor and ulem are not installed.\n"
640 "Please install both packages or redefine "
641 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
645 if (!params().master.empty()) {
646 FileName const master_file = makeAbsPath(params().master,
647 onlyPath(absFileName()));
648 if (isLyXFilename(master_file.absFilename())) {
650 checkAndLoadLyXFile(master_file, true);
652 // necessary e.g. after a reload
653 // to re-register the child (bug 5873)
654 // FIXME: clean up updateMacros (here, only
655 // child registering is needed).
656 master->updateMacros();
657 // set master as master buffer, but only
658 // if we are a real child
659 if (master->isChild(this))
661 // if the master is not fully loaded
662 // it is probably just loading this
663 // child. No warning needed then.
664 else if (master->isFullyLoaded())
665 LYXERR0("The master '"
667 << "' assigned to this document ("
669 << ") does not include "
670 "this document. Ignoring the master assignment.");
676 bool const res = text().read(*this, lex, errorList, d->inset);
679 updateMacroInstances();
684 // needed to insert the selection
685 void Buffer::insertStringAsLines(ParagraphList & pars,
686 pit_type & pit, pos_type & pos,
687 Font const & fn, docstring const & str, bool autobreakrows)
691 // insert the string, don't insert doublespace
692 bool space_inserted = true;
693 for (docstring::const_iterator cit = str.begin();
694 cit != str.end(); ++cit) {
695 Paragraph & par = pars[pit];
697 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
698 breakParagraph(params(), pars, pit, pos,
699 par.layout().isEnvironment());
702 space_inserted = true;
706 // do not insert consecutive spaces if !free_spacing
707 } else if ((*cit == ' ' || *cit == '\t') &&
708 space_inserted && !par.isFreeSpacing()) {
710 } else if (*cit == '\t') {
711 if (!par.isFreeSpacing()) {
712 // tabs are like spaces here
713 par.insertChar(pos, ' ', font, params().trackChanges);
715 space_inserted = true;
717 par.insertChar(pos, *cit, font, params().trackChanges);
719 space_inserted = true;
721 } else if (!isPrintable(*cit)) {
722 // Ignore unprintables
725 // just insert the character
726 par.insertChar(pos, *cit, font, params().trackChanges);
728 space_inserted = (*cit == ' ');
735 bool Buffer::readString(string const & s)
737 params().compressed = false;
739 // remove dummy empty par
740 paragraphs().clear();
744 FileName const name = FileName::tempName("Buffer_readString");
745 switch (readFile(lex, name, true)) {
749 // We need to call lyx2lyx, so write the input to a file
750 ofstream os(name.toFilesystemEncoding().c_str());
753 return readFile(name);
763 bool Buffer::readFile(FileName const & filename)
765 FileName fname(filename);
767 params().compressed = fname.isZippedFile();
769 // remove dummy empty par
770 paragraphs().clear();
773 if (readFile(lex, fname) != success)
780 bool Buffer::isFullyLoaded() const
782 return d->file_fully_loaded;
786 void Buffer::setFullyLoaded(bool value)
788 d->file_fully_loaded = value;
792 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
795 LASSERT(!filename.empty(), /**/);
797 // the first (non-comment) token _must_ be...
798 if (!lex.checkFor("\\lyxformat")) {
799 Alert::error(_("Document format failure"),
800 bformat(_("%1$s is not a readable LyX document."),
801 from_utf8(filename.absFilename())));
807 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
808 // if present remove ".," from string.
809 size_t dot = tmp_format.find_first_of(".,");
810 //lyxerr << " dot found at " << dot << endl;
811 if (dot != string::npos)
812 tmp_format.erase(dot, 1);
813 int const file_format = convert<int>(tmp_format);
814 //lyxerr << "format: " << file_format << endl;
816 // save timestamp and checksum of the original disk file, making sure
817 // to not overwrite them with those of the file created in the tempdir
818 // when it has to be converted to the current format.
820 // Save the timestamp and checksum of disk file. If filename is an
821 // emergency file, save the timestamp and checksum of the original lyx file
822 // because isExternallyModified will check for this file. (BUG4193)
823 string diskfile = filename.absFilename();
824 if (suffixIs(diskfile, ".emergency"))
825 diskfile = diskfile.substr(0, diskfile.size() - 10);
826 saveCheckSum(FileName(diskfile));
829 if (file_format != LYX_FORMAT) {
832 // lyx2lyx would fail
835 FileName const tmpfile = FileName::tempName("Buffer_readFile");
836 if (tmpfile.empty()) {
837 Alert::error(_("Conversion failed"),
838 bformat(_("%1$s is from a different"
839 " version of LyX, but a temporary"
840 " file for converting it could"
842 from_utf8(filename.absFilename())));
845 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
846 if (lyx2lyx.empty()) {
847 Alert::error(_("Conversion script not found"),
848 bformat(_("%1$s is from a different"
849 " version of LyX, but the"
850 " conversion script lyx2lyx"
851 " could not be found."),
852 from_utf8(filename.absFilename())));
855 ostringstream command;
856 command << os::python()
857 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
858 << " -t " << convert<string>(LYX_FORMAT)
859 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
860 << ' ' << quoteName(filename.toFilesystemEncoding());
861 string const command_str = command.str();
863 LYXERR(Debug::INFO, "Running '" << command_str << '\'');
865 cmd_ret const ret = runCommand(command_str);
866 if (ret.first != 0) {
867 Alert::error(_("Conversion script failed"),
868 bformat(_("%1$s is from a different version"
869 " of LyX, but the lyx2lyx script"
870 " failed to convert it."),
871 from_utf8(filename.absFilename())));
874 bool const ret = readFile(tmpfile);
875 // Do stuff with tmpfile name and buffer name here.
876 return ret ? success : failure;
881 if (readDocument(lex)) {
882 Alert::error(_("Document format failure"),
883 bformat(_("%1$s ended unexpectedly, which means"
884 " that it is probably corrupted."),
885 from_utf8(filename.absFilename())));
888 d->file_fully_loaded = true;
893 // Should probably be moved to somewhere else: BufferView? LyXView?
894 bool Buffer::save() const
896 // We don't need autosaves in the immediate future. (Asger)
897 resetAutosaveTimers();
899 string const encodedFilename = d->filename.toFilesystemEncoding();
902 bool madeBackup = false;
904 // make a backup if the file already exists
905 if (lyxrc.make_backup && fileName().exists()) {
906 backupName = FileName(absFileName() + '~');
907 if (!lyxrc.backupdir_path.empty()) {
908 string const mangledName =
909 subst(subst(backupName.absFilename(), '/', '!'), ':', '!');
910 backupName = FileName(addName(lyxrc.backupdir_path,
913 if (fileName().copyTo(backupName)) {
916 Alert::error(_("Backup failure"),
917 bformat(_("Cannot create backup file %1$s.\n"
918 "Please check whether the directory exists and is writeable."),
919 from_utf8(backupName.absFilename())));
920 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
924 // ask if the disk file has been externally modified (use checksum method)
925 if (fileName().exists() && isExternallyModified(checksum_method)) {
926 docstring const file = makeDisplayPath(absFileName(), 20);
927 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
928 "you want to overwrite this file?"), file);
929 int const ret = Alert::prompt(_("Overwrite modified file?"),
930 text, 1, 1, _("&Overwrite"), _("&Cancel"));
935 if (writeFile(d->filename)) {
939 // Saving failed, so backup is not backup
941 backupName.moveTo(d->filename);
947 bool Buffer::writeFile(FileName const & fname) const
949 if (d->read_only && fname == d->filename)
954 docstring const str = bformat(_("Saving document %1$s..."),
955 makeDisplayPath(fname.absFilename()));
958 if (params().compressed) {
959 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
960 retval = ofs && write(ofs);
962 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
963 retval = ofs && write(ofs);
967 message(str + _(" could not write file!"));
971 removeAutosaveFile();
973 saveCheckSum(d->filename);
974 message(str + _(" done."));
980 bool Buffer::write(ostream & ofs) const
983 // Use the standard "C" locale for file output.
984 ofs.imbue(locale::classic());
987 // The top of the file should not be written by params().
989 // write out a comment in the top of the file
990 ofs << "#LyX " << lyx_version
991 << " created this file. For more info see http://www.lyx.org/\n"
992 << "\\lyxformat " << LYX_FORMAT << "\n"
993 << "\\begin_document\n";
995 /// For each author, set 'used' to true if there is a change
996 /// by this author in the document; otherwise set it to 'false'.
997 AuthorList::Authors::const_iterator a_it = params().authors().begin();
998 AuthorList::Authors::const_iterator a_end = params().authors().end();
999 for (; a_it != a_end; ++a_it)
1000 a_it->second.setUsed(false);
1002 ParIterator const end = const_cast<Buffer *>(this)->par_iterator_end();
1003 ParIterator it = const_cast<Buffer *>(this)->par_iterator_begin();
1004 for ( ; it != end; ++it)
1005 it->checkAuthors(params().authors());
1007 // now write out the buffer parameters.
1008 ofs << "\\begin_header\n";
1009 params().writeFile(ofs);
1010 ofs << "\\end_header\n";
1013 ofs << "\n\\begin_body\n";
1014 text().write(*this, ofs);
1015 ofs << "\n\\end_body\n";
1017 // Write marker that shows file is complete
1018 ofs << "\\end_document" << endl;
1020 // Shouldn't really be needed....
1023 // how to check if close went ok?
1024 // Following is an attempt... (BE 20001011)
1026 // good() returns false if any error occured, including some
1027 // formatting error.
1028 // bad() returns true if something bad happened in the buffer,
1029 // which should include file system full errors.
1034 lyxerr << "File was not closed properly." << endl;
1041 bool Buffer::makeLaTeXFile(FileName const & fname,
1042 string const & original_path,
1043 OutputParams const & runparams_in,
1044 bool output_preamble, bool output_body) const
1046 OutputParams runparams = runparams_in;
1047 if (params().useXetex)
1048 runparams.flavor = OutputParams::XETEX;
1050 string const encoding = runparams.encoding->iconvName();
1051 LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
1054 try { ofs.reset(encoding); }
1055 catch (iconv_codecvt_facet_exception & e) {
1056 lyxerr << "Caught iconv exception: " << e.what() << endl;
1057 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1058 "verify that the support software for your encoding (%1$s) is "
1059 "properly installed"), from_ascii(encoding)));
1062 if (!openFileWrite(ofs, fname))
1065 //TexStream ts(ofs.rdbuf(), &texrow());
1066 ErrorList & errorList = d->errorLists["Export"];
1068 bool failed_export = false;
1071 writeLaTeXSource(ofs, original_path,
1072 runparams, output_preamble, output_body);
1074 catch (EncodingException & e) {
1075 odocstringstream ods;
1076 ods.put(e.failed_char);
1078 oss << "0x" << hex << e.failed_char << dec;
1079 docstring msg = bformat(_("Could not find LaTeX command for character '%1$s'"
1080 " (code point %2$s)"),
1081 ods.str(), from_utf8(oss.str()));
1082 errorList.push_back(ErrorItem(msg, _("Some characters of your document are probably not "
1083 "representable in the chosen encoding.\n"
1084 "Changing the document encoding to utf8 could help."),
1085 e.par_id, e.pos, e.pos + 1));
1086 failed_export = true;
1088 catch (iconv_codecvt_facet_exception & e) {
1089 errorList.push_back(ErrorItem(_("iconv conversion failed"),
1090 _(e.what()), -1, 0, 0));
1091 failed_export = true;
1093 catch (exception const & e) {
1094 errorList.push_back(ErrorItem(_("conversion failed"),
1095 _(e.what()), -1, 0, 0));
1096 failed_export = true;
1099 lyxerr << "Caught some really weird exception..." << endl;
1105 failed_export = true;
1106 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1110 return !failed_export;
1114 void Buffer::writeLaTeXSource(odocstream & os,
1115 string const & original_path,
1116 OutputParams const & runparams_in,
1117 bool const output_preamble, bool const output_body) const
1119 // The child documents, if any, shall be already loaded at this point.
1121 OutputParams runparams = runparams_in;
1123 // Classify the unicode characters appearing in math insets
1124 Encodings::initUnicodeMath(*this);
1126 // validate the buffer.
1127 LYXERR(Debug::LATEX, " Validating buffer...");
1128 LaTeXFeatures features(*this, params(), runparams);
1130 LYXERR(Debug::LATEX, " Buffer validation done.");
1132 // The starting paragraph of the coming rows is the
1133 // first paragraph of the document. (Asger)
1134 if (output_preamble && runparams.nice) {
1135 os << "%% LyX " << lyx_version << " created this file. "
1136 "For more info, see http://www.lyx.org/.\n"
1137 "%% Do not edit unless you really know what "
1139 d->texrow.newline();
1140 d->texrow.newline();
1142 LYXERR(Debug::INFO, "lyx document header finished");
1144 // Don't move this behind the parent_buffer=0 code below,
1145 // because then the macros will not get the right "redefinition"
1146 // flag as they don't see the parent macros which are output before.
1149 // fold macros if possible, still with parent buffer as the
1150 // macros will be put in the prefix anyway.
1151 updateMacroInstances();
1153 // There are a few differences between nice LaTeX and usual files:
1154 // usual is \batchmode and has a
1155 // special input@path to allow the including of figures
1156 // with either \input or \includegraphics (what figinsets do).
1157 // input@path is set when the actual parameter
1158 // original_path is set. This is done for usual tex-file, but not
1159 // for nice-latex-file. (Matthias 250696)
1160 // Note that input@path is only needed for something the user does
1161 // in the preamble, included .tex files or ERT, files included by
1162 // LyX work without it.
1163 if (output_preamble) {
1164 if (!runparams.nice) {
1165 // code for usual, NOT nice-latex-file
1166 os << "\\batchmode\n"; // changed
1167 // from \nonstopmode
1168 d->texrow.newline();
1170 if (!original_path.empty()) {
1172 // We don't know the encoding of inputpath
1173 docstring const inputpath = from_utf8(latex_path(original_path));
1174 os << "\\makeatletter\n"
1175 << "\\def\\input@path{{"
1176 << inputpath << "/}}\n"
1177 << "\\makeatother\n";
1178 d->texrow.newline();
1179 d->texrow.newline();
1180 d->texrow.newline();
1183 // get parent macros (if this buffer has a parent) which will be
1184 // written at the document begin further down.
1185 MacroSet parentMacros;
1186 listParentMacros(parentMacros, features);
1188 // Write the preamble
1189 runparams.use_babel = params().writeLaTeX(os, features, d->texrow);
1191 runparams.use_japanese = features.isRequired("japanese");
1197 os << "\\begin{document}\n";
1198 d->texrow.newline();
1200 // output the parent macros
1201 MacroSet::iterator it = parentMacros.begin();
1202 MacroSet::iterator end = parentMacros.end();
1203 for (; it != end; ++it)
1204 (*it)->write(os, true);
1205 } // output_preamble
1207 d->texrow.start(paragraphs().begin()->id(), 0);
1209 LYXERR(Debug::INFO, "preamble finished, now the body.");
1211 // if we are doing a real file with body, even if this is the
1212 // child of some other buffer, let's cut the link here.
1213 // This happens for example if only a child document is printed.
1214 Buffer const * save_parent = 0;
1215 if (output_preamble) {
1216 save_parent = d->parent();
1221 latexParagraphs(*this, text(), os, d->texrow, runparams);
1223 // Restore the parenthood if needed
1224 if (output_preamble)
1225 d->setParent(save_parent);
1227 // add this just in case after all the paragraphs
1229 d->texrow.newline();
1231 if (output_preamble) {
1232 os << "\\end{document}\n";
1233 d->texrow.newline();
1234 LYXERR(Debug::LATEX, "makeLaTeXFile...done");
1236 LYXERR(Debug::LATEX, "LaTeXFile for inclusion made.");
1238 runparams_in.encoding = runparams.encoding;
1240 // Just to be sure. (Asger)
1241 d->texrow.newline();
1243 LYXERR(Debug::INFO, "Finished making LaTeX file.");
1244 LYXERR(Debug::INFO, "Row count was " << d->texrow.rows() - 1 << '.');
1248 bool Buffer::isLatex() const
1250 return params().documentClass().outputType() == LATEX;
1254 bool Buffer::isLiterate() const
1256 return params().documentClass().outputType() == LITERATE;
1260 bool Buffer::isDocBook() const
1262 return params().documentClass().outputType() == DOCBOOK;
1266 void Buffer::makeDocBookFile(FileName const & fname,
1267 OutputParams const & runparams,
1268 bool const body_only) const
1270 LYXERR(Debug::LATEX, "makeDocBookFile...");
1273 if (!openFileWrite(ofs, fname))
1276 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1280 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1284 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1285 OutputParams const & runparams,
1286 bool const only_body) const
1288 LaTeXFeatures features(*this, params(), runparams);
1293 DocumentClass const & tclass = params().documentClass();
1294 string const top_element = tclass.latexname();
1297 if (runparams.flavor == OutputParams::XML)
1298 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1301 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1304 if (! tclass.class_header().empty())
1305 os << from_ascii(tclass.class_header());
1306 else if (runparams.flavor == OutputParams::XML)
1307 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1308 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1310 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1312 docstring preamble = from_utf8(params().preamble);
1313 if (runparams.flavor != OutputParams::XML ) {
1314 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1315 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1316 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1317 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1320 string const name = runparams.nice
1321 ? changeExtension(absFileName(), ".sgml") : fname;
1322 preamble += features.getIncludedFiles(name);
1323 preamble += features.getLyXSGMLEntities();
1325 if (!preamble.empty()) {
1326 os << "\n [ " << preamble << " ]";
1331 string top = top_element;
1333 if (runparams.flavor == OutputParams::XML)
1334 top += params().language->code();
1336 top += params().language->code().substr(0, 2);
1339 if (!params().options.empty()) {
1341 top += params().options;
1344 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1345 << " file was created by LyX " << lyx_version
1346 << "\n See http://www.lyx.org/ for more information -->\n";
1348 params().documentClass().counters().reset();
1352 sgml::openTag(os, top);
1354 docbookParagraphs(paragraphs(), *this, os, runparams);
1355 sgml::closeTag(os, top_element);
1359 void Buffer::makeLyXHTMLFile(FileName const & fname,
1360 OutputParams const & runparams,
1361 bool const body_only) const
1363 LYXERR(Debug::LATEX, "makeLYXHTMLFile...");
1366 if (!openFileWrite(ofs, fname))
1369 writeLyXHTMLSource(ofs, runparams, body_only);
1373 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1377 void Buffer::writeLyXHTMLSource(odocstream & os,
1378 OutputParams const & runparams,
1379 bool const only_body) const
1381 LaTeXFeatures features(*this, params(), runparams);
1387 os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" <<
1388 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
1389 // FIXME Language should be set properly.
1390 os << "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n";
1393 // FIXME Presumably need to set this right
1394 os << "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1395 // FIXME Get this during validation? What about other meta-data?
1396 os << "<title>TBA</title>\n";
1398 os << features.getTClassHTMLPreamble();
1402 docstring const styleinfo = features.getTClassHTMLStyles();
1403 if (!styleinfo.empty()) {
1404 os << "<style type='text/css'>\n";
1408 os << "</head>\n<body>\n";
1411 params().documentClass().counters().reset();
1412 xhtmlParagraphs(paragraphs(), *this, os, runparams);
1414 os << "</body>\n</html>\n";
1418 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1419 // Other flags: -wall -v0 -x
1420 int Buffer::runChktex()
1424 // get LaTeX-Filename
1425 FileName const path(temppath());
1426 string const name = addName(path.absFilename(), latexName());
1427 string const org_path = filePath();
1429 PathChanger p(path); // path to LaTeX file
1430 message(_("Running chktex..."));
1432 // Generate the LaTeX file if neccessary
1433 OutputParams runparams(¶ms().encoding());
1434 runparams.flavor = OutputParams::LATEX;
1435 runparams.nice = false;
1436 makeLaTeXFile(FileName(name), org_path, runparams);
1439 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1440 int const res = chktex.run(terr); // run chktex
1443 Alert::error(_("chktex failure"),
1444 _("Could not run chktex successfully."));
1445 } else if (res > 0) {
1446 ErrorList & errlist = d->errorLists["ChkTeX"];
1448 bufferErrors(terr, errlist);
1459 void Buffer::validate(LaTeXFeatures & features) const
1461 params().validate(features);
1465 for_each(paragraphs().begin(), paragraphs().end(),
1466 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1468 if (lyxerr.debugging(Debug::LATEX)) {
1469 features.showStruct();
1474 void Buffer::getLabelList(vector<docstring> & list) const
1476 // If this is a child document, use the parent's list instead.
1477 Buffer const * const pbuf = d->parent();
1479 pbuf->getLabelList(list);
1484 Toc & toc = d->toc_backend.toc("label");
1485 TocIterator toc_it = toc.begin();
1486 TocIterator end = toc.end();
1487 for (; toc_it != end; ++toc_it) {
1488 if (toc_it->depth() == 0)
1489 list.push_back(toc_it->str());
1494 void Buffer::updateBibfilesCache(UpdateScope scope) const
1496 // If this is a child document, use the parent's cache instead.
1497 Buffer const * const pbuf = d->parent();
1498 if (pbuf && scope != UpdateChildOnly) {
1499 pbuf->updateBibfilesCache();
1503 d->bibfilesCache_.clear();
1504 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1505 if (it->lyxCode() == BIBTEX_CODE) {
1506 InsetBibtex const & inset =
1507 static_cast<InsetBibtex const &>(*it);
1508 support::FileNameList const bibfiles = inset.getBibFiles();
1509 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1512 } else if (it->lyxCode() == INCLUDE_CODE) {
1513 InsetInclude & inset =
1514 static_cast<InsetInclude &>(*it);
1515 inset.updateBibfilesCache();
1516 support::FileNameList const & bibfiles =
1517 inset.getBibfilesCache();
1518 d->bibfilesCache_.insert(d->bibfilesCache_.end(),
1523 // the bibinfo cache is now invalid
1524 d->bibinfoCacheValid_ = false;
1528 void Buffer::invalidateBibinfoCache()
1530 d->bibinfoCacheValid_ = false;
1534 support::FileNameList const & Buffer::getBibfilesCache(UpdateScope scope) const
1536 // If this is a child document, use the parent's cache instead.
1537 Buffer const * const pbuf = d->parent();
1538 if (pbuf && scope != UpdateChildOnly)
1539 return pbuf->getBibfilesCache();
1541 // We update the cache when first used instead of at loading time.
1542 if (d->bibfilesCache_.empty())
1543 const_cast<Buffer *>(this)->updateBibfilesCache(scope);
1545 return d->bibfilesCache_;
1549 BiblioInfo const & Buffer::masterBibInfo() const
1551 // if this is a child document and the parent is already loaded
1552 // use the parent's list instead [ale990412]
1553 Buffer const * const tmp = masterBuffer();
1556 return tmp->masterBibInfo();
1557 return localBibInfo();
1561 BiblioInfo const & Buffer::localBibInfo() const
1563 if (d->bibinfoCacheValid_) {
1564 support::FileNameList const & bibfilesCache = getBibfilesCache();
1565 // compare the cached timestamps with the actual ones.
1566 support::FileNameList::const_iterator ei = bibfilesCache.begin();
1567 support::FileNameList::const_iterator en = bibfilesCache.end();
1568 for (; ei != en; ++ ei) {
1569 time_t lastw = ei->lastModified();
1570 if (lastw != d->bibfileStatus_[*ei]) {
1571 d->bibinfoCacheValid_ = false;
1572 d->bibfileStatus_[*ei] = lastw;
1578 if (!d->bibinfoCacheValid_) {
1579 d->bibinfo_.clear();
1580 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1581 it->fillWithBibKeys(d->bibinfo_, it);
1582 d->bibinfoCacheValid_ = true;
1588 bool Buffer::isDepClean(string const & name) const
1590 DepClean::const_iterator const it = d->dep_clean.find(name);
1591 if (it == d->dep_clean.end())
1597 void Buffer::markDepClean(string const & name)
1599 d->dep_clean[name] = true;
1603 bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
1605 switch (cmd.action) {
1606 case LFUN_BUFFER_EXPORT: {
1607 docstring const arg = cmd.argument();
1608 bool enable = arg == "custom" || isExportable(to_utf8(arg));
1610 flag.message(bformat(
1611 _("Don't know how to export to format: %1$s"), arg));
1612 flag.setEnabled(enable);
1616 case LFUN_BRANCH_ACTIVATE:
1617 case LFUN_BRANCH_DEACTIVATE: {
1618 BranchList const & branchList = params().branchlist();
1619 docstring const branchName = cmd.argument();
1620 flag.setEnabled(!branchName.empty()
1621 && branchList.find(branchName));
1625 case LFUN_BRANCH_ADD:
1626 case LFUN_BRANCHES_RENAME:
1627 case LFUN_BUFFER_PRINT:
1628 // if no Buffer is present, then of course we won't be called!
1629 flag.setEnabled(true);
1639 void Buffer::dispatch(string const & command, DispatchResult & result)
1641 return dispatch(lyxaction.lookupFunc(command), result);
1645 // NOTE We can end up here even if we have no GUI, because we are called
1646 // by LyX::exec to handled command-line requests. So we may need to check
1647 // whether we have a GUI or not. The boolean use_gui holds this information.
1648 void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
1650 // We'll set this back to false if need be.
1651 bool dispatched = true;
1653 switch (func.action) {
1654 case LFUN_BUFFER_EXPORT: {
1655 bool success = doExport(to_utf8(func.argument()), false);
1656 dr.setError(success);
1658 dr.setMessage(bformat(_("Error exporting to format: %1$s."),
1663 case LFUN_BRANCH_ADD: {
1664 BranchList & branchList = params().branchlist();
1665 docstring const branchName = func.argument();
1666 if (branchName.empty()) {
1670 Branch * branch = branchList.find(branchName);
1672 LYXERR0("Branch " << branchName << " does already exist.");
1674 docstring const msg =
1675 bformat(_("Branch \"%1$s\" does already exist."), branchName);
1678 branchList.add(branchName);
1680 dr.update(Update::Force);
1685 case LFUN_BRANCH_ACTIVATE:
1686 case LFUN_BRANCH_DEACTIVATE: {
1687 BranchList & branchList = params().branchlist();
1688 docstring const branchName = func.argument();
1689 // the case without a branch name is handled elsewhere
1690 if (branchName.empty()) {
1694 Branch * branch = branchList.find(branchName);
1696 LYXERR0("Branch " << branchName << " does not exist.");
1698 docstring const msg =
1699 bformat(_("Branch \"%1$s\" does not exist."), branchName);
1702 branch->setSelected(func.action == LFUN_BRANCH_ACTIVATE);
1704 dr.update(Update::Force);
1709 case LFUN_BRANCHES_RENAME: {
1710 docstring const oldname = from_utf8(func.getArg(0));
1711 docstring const newname = from_utf8(func.getArg(1));
1712 renameBranches(oldname, newname);
1716 case LFUN_BUFFER_PRINT: {
1717 // we'll assume there's a problem until we succeed
1719 string target = func.getArg(0);
1720 string target_name = func.getArg(1);
1721 string command = func.getArg(2);
1724 || target_name.empty()
1725 || command.empty()) {
1726 LYXERR0("Unable to parse " << func.argument());
1727 docstring const msg =
1728 bformat(_("Unable to parse \"%1$s\""), func.argument());
1732 if (target != "printer" && target != "file") {
1733 LYXERR0("Unrecognized target \"" << target << '"');
1734 docstring const msg =
1735 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target));
1740 if (!doExport("dvi", true)) {
1741 showPrintError(absFileName());
1742 dr.setMessage(_("Error exporting to DVI."));
1746 // Push directory path.
1747 string const path = temppath();
1748 // Prevent the compiler from optimizing away p
1752 // there are three cases here:
1753 // 1. we print to a file
1754 // 2. we print directly to a printer
1755 // 3. we print using a spool command (print to file first)
1758 string const dviname = changeExtension(latexName(true), "dvi");
1760 if (target == "printer") {
1761 if (!lyxrc.print_spool_command.empty()) {
1762 // case 3: print using a spool
1763 string const psname = changeExtension(dviname,".ps");
1764 command += ' ' + lyxrc.print_to_file
1767 + quoteName(dviname);
1769 string command2 = lyxrc.print_spool_command + ' ';
1770 if (target_name != "default") {
1771 command2 += lyxrc.print_spool_printerprefix
1775 command2 += quoteName(psname);
1777 // If successful, then spool command
1778 res = one.startscript(Systemcall::Wait, command);
1781 // If there's no GUI, we have to wait on this command. Otherwise,
1782 // LyX deletes the temporary directory, and with it the spooled
1783 // file, before it can be printed!!
1784 Systemcall::Starttype stype = use_gui ?
1785 Systemcall::DontWait : Systemcall::Wait;
1786 res = one.startscript(stype, command2);
1789 // case 2: print directly to a printer
1790 if (target_name != "default")
1791 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
1793 Systemcall::Starttype stype = use_gui ?
1794 Systemcall::DontWait : Systemcall::Wait;
1795 res = one.startscript(stype, command + quoteName(dviname));
1799 // case 1: print to a file
1800 FileName const filename(makeAbsPath(target_name, filePath()));
1801 FileName const dvifile(makeAbsPath(dviname, path));
1802 if (filename.exists()) {
1803 docstring text = bformat(
1804 _("The file %1$s already exists.\n\n"
1805 "Do you want to overwrite that file?"),
1806 makeDisplayPath(filename.absFilename()));
1807 if (Alert::prompt(_("Overwrite file?"),
1808 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
1811 command += ' ' + lyxrc.print_to_file
1812 + quoteName(filename.toFilesystemEncoding())
1814 + quoteName(dvifile.toFilesystemEncoding());
1816 Systemcall::Starttype stype = use_gui ?
1817 Systemcall::DontWait : Systemcall::Wait;
1818 res = one.startscript(stype, command);
1824 dr.setMessage(_("Error running external commands."));
1825 showPrintError(absFileName());
1834 dr.dispatched(dispatched);
1838 void Buffer::changeLanguage(Language const * from, Language const * to)
1840 LASSERT(from, /**/);
1843 for_each(par_iterator_begin(),
1845 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1849 bool Buffer::isMultiLingual() const
1851 ParConstIterator end = par_iterator_end();
1852 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1853 if (it->isMultiLingual(params()))
1860 DocIterator Buffer::getParFromID(int const id) const
1862 Buffer * buf = const_cast<Buffer *>(this);
1864 // John says this is called with id == -1 from undo
1865 lyxerr << "getParFromID(), id: " << id << endl;
1866 return doc_iterator_end(buf);
1869 for (DocIterator it = doc_iterator_begin(buf); !it.atEnd(); it.forwardPar())
1870 if (it.paragraph().id() == id)
1873 return doc_iterator_end(buf);
1877 bool Buffer::hasParWithID(int const id) const
1879 return !getParFromID(id).atEnd();
1883 ParIterator Buffer::par_iterator_begin()
1885 return ParIterator(doc_iterator_begin(this));
1889 ParIterator Buffer::par_iterator_end()
1891 return ParIterator(doc_iterator_end(this));
1895 ParConstIterator Buffer::par_iterator_begin() const
1897 return ParConstIterator(doc_iterator_begin(this));
1901 ParConstIterator Buffer::par_iterator_end() const
1903 return ParConstIterator(doc_iterator_end(this));
1907 Language const * Buffer::language() const
1909 return params().language;
1913 docstring const Buffer::B_(string const & l10n) const
1915 return params().B_(l10n);
1919 bool Buffer::isClean() const
1921 return d->lyx_clean;
1925 bool Buffer::isBakClean() const
1927 return d->bak_clean;
1931 bool Buffer::isExternallyModified(CheckMethod method) const
1933 LASSERT(d->filename.exists(), /**/);
1934 // if method == timestamp, check timestamp before checksum
1935 return (method == checksum_method
1936 || d->timestamp_ != d->filename.lastModified())
1937 && d->checksum_ != d->filename.checksum();
1941 void Buffer::saveCheckSum(FileName const & file) const
1943 if (file.exists()) {
1944 d->timestamp_ = file.lastModified();
1945 d->checksum_ = file.checksum();
1947 // in the case of save to a new file.
1954 void Buffer::markClean() const
1956 if (!d->lyx_clean) {
1957 d->lyx_clean = true;
1960 // if the .lyx file has been saved, we don't need an
1962 d->bak_clean = true;
1966 void Buffer::markBakClean() const
1968 d->bak_clean = true;
1972 void Buffer::setUnnamed(bool flag)
1978 bool Buffer::isUnnamed() const
1984 // FIXME: this function should be moved to buffer_pimpl.C
1985 void Buffer::markDirty()
1988 d->lyx_clean = false;
1991 d->bak_clean = false;
1993 DepClean::iterator it = d->dep_clean.begin();
1994 DepClean::const_iterator const end = d->dep_clean.end();
1996 for (; it != end; ++it)
2001 FileName Buffer::fileName() const
2007 string Buffer::absFileName() const
2009 return d->filename.absFilename();
2013 string Buffer::filePath() const
2015 return d->filename.onlyPath().absFilename() + "/";
2019 bool Buffer::isReadonly() const
2021 return d->read_only;
2025 void Buffer::setParent(Buffer const * buffer)
2027 // Avoids recursive include.
2028 d->setParent(buffer == this ? 0 : buffer);
2033 Buffer const * Buffer::parent() const
2039 void Buffer::collectRelatives(BufferSet & bufs) const
2043 parent()->collectRelatives(bufs);
2045 // loop over children
2046 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2047 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2048 for (; it != end; ++it)
2049 bufs.insert(const_cast<Buffer *>(it->first));
2053 std::vector<Buffer const *> Buffer::allRelatives() const
2056 collectRelatives(bufs);
2057 BufferSet::iterator it = bufs.begin();
2058 std::vector<Buffer const *> ret;
2059 for (; it != bufs.end(); ++it)
2065 Buffer const * Buffer::masterBuffer() const
2067 Buffer const * const pbuf = d->parent();
2071 return pbuf->masterBuffer();
2075 bool Buffer::isChild(Buffer * child) const
2077 return d->children_positions.find(child) != d->children_positions.end();
2081 DocIterator Buffer::firstChildPosition(Buffer const * child)
2083 Impl::BufferPositionMap::iterator it;
2084 it = d->children_positions.find(child);
2085 if (it == d->children_positions.end())
2086 return DocIterator(this);
2091 std::vector<Buffer *> Buffer::getChildren() const
2093 std::vector<Buffer *> clist;
2094 // loop over children
2095 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2096 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2097 for (; it != end; ++it) {
2098 Buffer * child = const_cast<Buffer *>(it->first);
2099 clist.push_back(child);
2100 // there might be grandchildren
2101 std::vector<Buffer *> glist = child->getChildren();
2102 for (vector<Buffer *>::const_iterator git = glist.begin();
2103 git != glist.end(); ++git)
2104 clist.push_back(*git);
2110 template<typename M>
2111 typename M::iterator greatest_below(M & m, typename M::key_type const & x)
2116 typename M::iterator it = m.lower_bound(x);
2117 if (it == m.begin())
2125 MacroData const * Buffer::getBufferMacro(docstring const & name,
2126 DocIterator const & pos) const
2128 LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
2130 // if paragraphs have no macro context set, pos will be empty
2134 // we haven't found anything yet
2135 DocIterator bestPos = par_iterator_begin();
2136 MacroData const * bestData = 0;
2138 // find macro definitions for name
2139 Impl::NamePositionScopeMacroMap::iterator nameIt
2140 = d->macros.find(name);
2141 if (nameIt != d->macros.end()) {
2142 // find last definition in front of pos or at pos itself
2143 Impl::PositionScopeMacroMap::const_iterator it
2144 = greatest_below(nameIt->second, pos);
2145 if (it != nameIt->second.end()) {
2147 // scope ends behind pos?
2148 if (pos < it->second.first) {
2149 // Looks good, remember this. If there
2150 // is no external macro behind this,
2151 // we found the right one already.
2152 bestPos = it->first;
2153 bestData = &it->second.second;
2157 // try previous macro if there is one
2158 if (it == nameIt->second.begin())
2165 // find macros in included files
2166 Impl::PositionScopeBufferMap::const_iterator it
2167 = greatest_below(d->position_to_children, pos);
2168 if (it == d->position_to_children.end())
2169 // no children before
2173 // do we know something better (i.e. later) already?
2174 if (it->first < bestPos )
2177 // scope ends behind pos?
2178 if (pos < it->second.first) {
2179 // look for macro in external file
2180 d->macro_lock = true;
2181 MacroData const * data
2182 = it->second.second->getMacro(name, false);
2183 d->macro_lock = false;
2185 bestPos = it->first;
2191 // try previous file if there is one
2192 if (it == d->position_to_children.begin())
2197 // return the best macro we have found
2202 MacroData const * Buffer::getMacro(docstring const & name,
2203 DocIterator const & pos, bool global) const
2208 // query buffer macros
2209 MacroData const * data = getBufferMacro(name, pos);
2213 // If there is a master buffer, query that
2214 Buffer const * const pbuf = d->parent();
2216 d->macro_lock = true;
2217 MacroData const * macro = pbuf->getMacro(
2218 name, *this, false);
2219 d->macro_lock = false;
2225 data = MacroTable::globalMacros().get(name);
2234 MacroData const * Buffer::getMacro(docstring const & name, bool global) const
2236 // set scope end behind the last paragraph
2237 DocIterator scope = par_iterator_begin();
2238 scope.pit() = scope.lastpit() + 1;
2240 return getMacro(name, scope, global);
2244 MacroData const * Buffer::getMacro(docstring const & name,
2245 Buffer const & child, bool global) const
2247 // look where the child buffer is included first
2248 Impl::BufferPositionMap::iterator it = d->children_positions.find(&child);
2249 if (it == d->children_positions.end())
2252 // check for macros at the inclusion position
2253 return getMacro(name, it->second, global);
2257 void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
2259 pit_type lastpit = it.lastpit();
2261 // look for macros in each paragraph
2262 while (it.pit() <= lastpit) {
2263 Paragraph & par = it.paragraph();
2265 // iterate over the insets of the current paragraph
2266 InsetList const & insets = par.insetList();
2267 InsetList::const_iterator iit = insets.begin();
2268 InsetList::const_iterator end = insets.end();
2269 for (; iit != end; ++iit) {
2270 it.pos() = iit->pos;
2272 // is it a nested text inset?
2273 if (iit->inset->asInsetText()) {
2274 // Inset needs its own scope?
2275 InsetText const * itext = iit->inset->asInsetText();
2276 bool newScope = itext->isMacroScope();
2278 // scope which ends just behind the inset
2279 DocIterator insetScope = it;
2282 // collect macros in inset
2283 it.push_back(CursorSlice(*iit->inset));
2284 updateMacros(it, newScope ? insetScope : scope);
2289 // is it an external file?
2290 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2291 // get buffer of external file
2292 InsetInclude const & inset =
2293 static_cast<InsetInclude const &>(*iit->inset);
2294 d->macro_lock = true;
2295 Buffer * child = inset.getChildBuffer();
2296 d->macro_lock = false;
2300 // register its position, but only when it is
2301 // included first in the buffer
2302 if (d->children_positions.find(child) ==
2303 d->children_positions.end())
2304 d->children_positions[child] = it;
2306 // register child with its scope
2307 d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
2311 if (iit->inset->lyxCode() != MATHMACRO_CODE)
2315 MathMacroTemplate & macroTemplate =
2316 static_cast<MathMacroTemplate &>(*iit->inset);
2317 MacroContext mc(*this, it);
2318 macroTemplate.updateToContext(mc);
2321 bool valid = macroTemplate.validMacro();
2322 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2323 // then the BufferView's cursor will be invalid in
2324 // some cases which leads to crashes.
2329 d->macros[macroTemplate.name()][it] =
2330 Impl::ScopeMacro(scope, MacroData(*this, it));
2340 void Buffer::updateMacros() const
2345 LYXERR(Debug::MACROS, "updateMacro of " << d->filename.onlyFileName());
2347 // start with empty table
2349 d->children_positions.clear();
2350 d->position_to_children.clear();
2352 // Iterate over buffer, starting with first paragraph
2353 // The scope must be bigger than any lookup DocIterator
2354 // later. For the global lookup, lastpit+1 is used, hence
2355 // we use lastpit+2 here.
2356 DocIterator it = par_iterator_begin();
2357 DocIterator outerScope = it;
2358 outerScope.pit() = outerScope.lastpit() + 2;
2359 updateMacros(it, outerScope);
2363 void Buffer::getUsedBranches(std::list<docstring> & result, bool const from_master) const
2365 // Iterate over buffer, starting with first paragraph
2366 // The scope must be bigger than any lookup DocIterator
2367 // later. For the global lookup, lastpit+1 is used, hence
2368 // we use lastpit+2 here.
2369 DocIterator it = par_iterator_begin();
2370 DocIterator scope = it;
2371 scope.pit() = scope.lastpit() + 2;
2372 pit_type lastpit = it.lastpit();
2374 while (it.pit() <= lastpit) {
2375 Paragraph & par = it.paragraph();
2377 // iterate over the insets of the current paragraph
2378 InsetList const & insets = par.insetList();
2379 InsetList::const_iterator iit = insets.begin();
2380 InsetList::const_iterator end = insets.end();
2381 for (; iit != end; ++iit) {
2382 it.pos() = iit->pos;
2384 if (iit->inset->lyxCode() == BRANCH_CODE) {
2385 // get buffer of external file
2386 InsetBranch const & br =
2387 static_cast<InsetBranch const &>(*iit->inset);
2388 docstring const name = br.branch();
2389 if (!from_master && !params().branchlist().find(name))
2390 result.push_back(name);
2391 else if (from_master && !masterBuffer()->params().branchlist().find(name))
2392 result.push_back(name);
2396 // is it an external file?
2397 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2398 // get buffer of external file
2399 InsetInclude const & inset =
2400 static_cast<InsetInclude const &>(*iit->inset);
2401 Buffer * child = inset.getChildBuffer();
2404 child->getUsedBranches(result, true);
2411 // remove duplicates
2416 void Buffer::renameBranches(docstring const & oldname, docstring const & newname)
2418 // Iterate over buffer, starting with first paragraph
2419 // The scope must be bigger than any lookup DocIterator
2420 // later. For the global lookup, lastpit+1 is used, hence
2421 // we use lastpit+2 here.
2422 DocIterator it = par_iterator_begin();
2423 DocIterator scope = it;
2424 scope.pit() = scope.lastpit() + 2;
2425 pit_type lastpit = it.lastpit();
2427 while (it.pit() <= lastpit) {
2428 Paragraph & par = it.paragraph();
2430 // iterate over the insets of the current paragraph
2431 InsetList const & insets = par.insetList();
2432 InsetList::const_iterator iit = insets.begin();
2433 InsetList::const_iterator end = insets.end();
2434 for (; iit != end; ++iit) {
2435 it.pos() = iit->pos;
2437 if (iit->inset->lyxCode() == BRANCH_CODE) {
2438 // get buffer of external file
2440 static_cast<InsetBranch &>(*iit->inset);
2441 undo().recordUndo(it);
2442 if (br.branch() == oldname)
2447 // is it an external file?
2448 if (iit->inset->lyxCode() == INCLUDE_CODE) {
2449 // get buffer of external file
2450 InsetInclude const & inset =
2451 static_cast<InsetInclude const &>(*iit->inset);
2452 Buffer * child = inset.getChildBuffer();
2455 child->renameBranches(oldname, newname);
2465 void Buffer::updateMacroInstances() const
2467 LYXERR(Debug::MACROS, "updateMacroInstances for "
2468 << d->filename.onlyFileName());
2469 DocIterator it = doc_iterator_begin(this);
2470 DocIterator end = doc_iterator_end(this);
2471 for (; it != end; it.forwardPos()) {
2472 // look for MathData cells in InsetMathNest insets
2473 Inset * inset = it.nextInset();
2477 InsetMath * minset = inset->asInsetMath();
2481 // update macro in all cells of the InsetMathNest
2482 DocIterator::idx_type n = minset->nargs();
2483 MacroContext mc = MacroContext(*this, it);
2484 for (DocIterator::idx_type i = 0; i < n; ++i) {
2485 MathData & data = minset->cell(i);
2486 data.updateMacros(0, mc);
2492 void Buffer::listMacroNames(MacroNameSet & macros) const
2497 d->macro_lock = true;
2499 // loop over macro names
2500 Impl::NamePositionScopeMacroMap::iterator nameIt = d->macros.begin();
2501 Impl::NamePositionScopeMacroMap::iterator nameEnd = d->macros.end();
2502 for (; nameIt != nameEnd; ++nameIt)
2503 macros.insert(nameIt->first);
2505 // loop over children
2506 Impl::BufferPositionMap::iterator it = d->children_positions.begin();
2507 Impl::BufferPositionMap::iterator end = d->children_positions.end();
2508 for (; it != end; ++it)
2509 it->first->listMacroNames(macros);
2512 Buffer const * const pbuf = d->parent();
2514 pbuf->listMacroNames(macros);
2516 d->macro_lock = false;
2520 void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
2522 Buffer const * const pbuf = d->parent();
2527 pbuf->listMacroNames(names);
2530 MacroNameSet::iterator it = names.begin();
2531 MacroNameSet::iterator end = names.end();
2532 for (; it != end; ++it) {
2534 MacroData const * data =
2535 pbuf->getMacro(*it, *this, false);
2537 macros.insert(data);
2539 // we cannot access the original MathMacroTemplate anymore
2540 // here to calls validate method. So we do its work here manually.
2541 // FIXME: somehow make the template accessible here.
2542 if (data->optionals() > 0)
2543 features.require("xargs");
2549 Buffer::References & Buffer::references(docstring const & label)
2552 return const_cast<Buffer *>(masterBuffer())->references(label);
2554 RefCache::iterator it = d->ref_cache_.find(label);
2555 if (it != d->ref_cache_.end())
2556 return it->second.second;
2558 static InsetLabel const * dummy_il = 0;
2559 static References const dummy_refs;
2560 it = d->ref_cache_.insert(
2561 make_pair(label, make_pair(dummy_il, dummy_refs))).first;
2562 return it->second.second;
2566 Buffer::References const & Buffer::references(docstring const & label) const
2568 return const_cast<Buffer *>(this)->references(label);
2572 void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
2574 masterBuffer()->d->ref_cache_[label].first = il;
2578 InsetLabel const * Buffer::insetLabel(docstring const & label) const
2580 return masterBuffer()->d->ref_cache_[label].first;
2584 void Buffer::clearReferenceCache() const
2587 d->ref_cache_.clear();
2591 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
2594 //FIXME: This does not work for child documents yet.
2595 LASSERT(code == CITE_CODE, /**/);
2596 // Check if the label 'from' appears more than once
2597 vector<docstring> labels;
2599 BiblioInfo const & keys = masterBibInfo();
2600 BiblioInfo::const_iterator bit = keys.begin();
2601 BiblioInfo::const_iterator bend = keys.end();
2603 for (; bit != bend; ++bit)
2605 labels.push_back(bit->first);
2608 if (count(labels.begin(), labels.end(), from) > 1)
2611 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
2612 if (it->lyxCode() == code) {
2613 InsetCommand & inset = static_cast<InsetCommand &>(*it);
2614 docstring const oldValue = inset.getParam(paramName);
2615 if (oldValue == from)
2616 inset.setParam(paramName, to);
2622 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
2623 pit_type par_end, bool full_source) const
2625 OutputParams runparams(¶ms().encoding());
2626 runparams.nice = true;
2627 runparams.flavor = params().useXetex ?
2628 OutputParams::XETEX : OutputParams::LATEX;
2629 runparams.linelen = lyxrc.plaintext_linelen;
2630 // No side effect of file copying and image conversion
2631 runparams.dryrun = true;
2634 os << "% " << _("Preview source code") << "\n\n";
2636 d->texrow.newline();
2637 d->texrow.newline();
2639 writeDocBookSource(os, absFileName(), runparams, false);
2641 // latex or literate
2642 writeLaTeXSource(os, string(), runparams, true, true);
2644 runparams.par_begin = par_begin;
2645 runparams.par_end = par_end;
2646 if (par_begin + 1 == par_end) {
2648 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
2652 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2653 convert<docstring>(par_begin),
2654 convert<docstring>(par_end - 1))
2661 // output paragraphs
2663 docbookParagraphs(paragraphs(), *this, os, runparams);
2665 // latex or literate
2666 latexParagraphs(*this, text(), os, texrow, runparams);
2671 ErrorList & Buffer::errorList(string const & type) const
2673 static ErrorList emptyErrorList;
2674 map<string, ErrorList>::iterator I = d->errorLists.find(type);
2675 if (I == d->errorLists.end())
2676 return emptyErrorList;
2682 void Buffer::updateTocItem(std::string const & type,
2683 DocIterator const & dit) const
2686 gui_->updateTocItem(type, dit);
2690 void Buffer::structureChanged() const
2693 gui_->structureChanged();
2697 void Buffer::errors(string const & err, bool from_master) const
2700 gui_->errors(err, from_master);
2704 void Buffer::message(docstring const & msg) const
2711 void Buffer::setBusy(bool on) const
2718 void Buffer::setReadOnly(bool on) const
2721 d->wa_->setReadOnly(on);
2725 void Buffer::updateTitles() const
2728 d->wa_->updateTitles();
2732 void Buffer::resetAutosaveTimers() const
2735 gui_->resetAutosaveTimers();
2739 bool Buffer::hasGuiDelegate() const
2745 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
2754 class AutoSaveBuffer : public ForkedProcess {
2757 AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
2758 : buffer_(buffer), fname_(fname) {}
2760 virtual boost::shared_ptr<ForkedProcess> clone() const
2762 return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
2767 command_ = to_utf8(bformat(_("Auto-saving %1$s"),
2768 from_utf8(fname_.absFilename())));
2769 return run(DontWait);
2773 virtual int generateChild();
2775 Buffer const & buffer_;
2780 int AutoSaveBuffer::generateChild()
2782 // tmp_ret will be located (usually) in /tmp
2783 // will that be a problem?
2784 // Note that this calls ForkedCalls::fork(), so it's
2785 // ok cross-platform.
2786 pid_t const pid = fork();
2787 // If you want to debug the autosave
2788 // you should set pid to -1, and comment out the fork.
2789 if (pid != 0 && pid != -1)
2792 // pid = -1 signifies that lyx was unable
2793 // to fork. But we will do the save
2795 bool failed = false;
2796 FileName const tmp_ret = FileName::tempName("lyxauto");
2797 if (!tmp_ret.empty()) {
2798 buffer_.writeFile(tmp_ret);
2799 // assume successful write of tmp_ret
2800 if (!tmp_ret.moveTo(fname_))
2806 // failed to write/rename tmp_ret so try writing direct
2807 if (!buffer_.writeFile(fname_)) {
2808 // It is dangerous to do this in the child,
2809 // but safe in the parent, so...
2810 if (pid == -1) // emit message signal.
2811 buffer_.message(_("Autosave failed!"));
2815 if (pid == 0) // we are the child so...
2824 FileName Buffer::getAutosaveFilename() const
2826 // if the document is unnamed try to save in the backup dir, else
2827 // in the default document path, and as a last try in the filePath,
2828 // which will most often be the temporary directory
2831 fpath = lyxrc.backupdir_path.empty() ? lyxrc.document_path
2832 : lyxrc.backupdir_path;
2833 if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
2836 string const fname = "#" + d->filename.onlyFileName() + "#";
2837 return makeAbsPath(fname, fpath);
2841 void Buffer::removeAutosaveFile() const
2843 FileName const f = getAutosaveFilename();
2849 void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
2851 FileName const newauto = getAutosaveFilename();
2852 if (!(oldauto == newauto || oldauto.moveTo(newauto)))
2853 LYXERR0("Unable to remove autosave file `" << oldauto << "'!");
2857 // Perfect target for a thread...
2858 void Buffer::autoSave() const
2860 if (isBakClean() || isReadonly()) {
2861 // We don't save now, but we'll try again later
2862 resetAutosaveTimers();
2866 // emit message signal.
2867 message(_("Autosaving current document..."));
2868 AutoSaveBuffer autosave(*this, getAutosaveFilename());
2872 resetAutosaveTimers();
2876 string Buffer::bufferFormat() const
2878 string format = params().documentClass().outputFormat();
2879 if (format == "latex") {
2880 if (params().useXetex)
2882 if (params().encoding().package() == Encoding::japanese)
2889 string Buffer::getDefaultOutputFormat() const
2891 if (!params().defaultOutputFormat.empty()
2892 && params().defaultOutputFormat != "default")
2893 return params().defaultOutputFormat;
2894 typedef vector<Format const *> Formats;
2895 Formats formats = exportableFormats(true);
2898 || params().useXetex
2899 || params().encoding().package() == Encoding::japanese) {
2900 if (formats.empty())
2902 // return the first we find
2903 return formats.front()->name();
2905 return lyxrc.default_view_format;
2910 bool Buffer::doExport(string const & format, bool put_in_tempdir,
2911 string & result_file) const
2913 string backend_format;
2914 OutputParams runparams(¶ms().encoding());
2915 runparams.flavor = OutputParams::LATEX;
2916 runparams.linelen = lyxrc.plaintext_linelen;
2917 vector<string> backs = backends();
2918 if (find(backs.begin(), backs.end(), format) == backs.end()) {
2919 // Get shortest path to format
2920 Graph::EdgePath path;
2921 for (vector<string>::const_iterator it = backs.begin();
2922 it != backs.end(); ++it) {
2923 Graph::EdgePath p = theConverters().getPath(*it, format);
2924 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2925 backend_format = *it;
2930 runparams.flavor = theConverters().getFlavor(path);
2932 Alert::error(_("Couldn't export file"),
2933 bformat(_("No information for exporting the format %1$s."),
2934 formats.prettyName(format)));
2938 backend_format = format;
2939 // FIXME: Don't hardcode format names here, but use a flag
2940 if (backend_format == "pdflatex")
2941 runparams.flavor = OutputParams::PDFLATEX;
2944 string filename = latexName(false);
2945 filename = addName(temppath(), filename);
2946 filename = changeExtension(filename,
2947 formats.extension(backend_format));
2950 updateMacroInstances();
2952 // Plain text backend
2953 if (backend_format == "text")
2954 writePlaintextFile(*this, FileName(filename), runparams);
2956 else if (backend_format == "xhtml")
2957 makeLyXHTMLFile(FileName(filename), runparams);
2958 else if (backend_format == "lyx")
2959 writeFile(FileName(filename));
2961 else if (isDocBook()) {
2962 runparams.nice = !put_in_tempdir;
2963 makeDocBookFile(FileName(filename), runparams);
2966 else if (backend_format == format) {
2967 runparams.nice = true;
2968 if (!makeLaTeXFile(FileName(filename), string(), runparams))
2970 } else if (!lyxrc.tex_allows_spaces
2971 && contains(filePath(), ' ')) {
2972 Alert::error(_("File name error"),
2973 _("The directory path to the document cannot contain spaces."));
2976 runparams.nice = false;
2977 if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
2981 string const error_type = (format == "program")
2982 ? "Build" : bufferFormat();
2983 ErrorList & error_list = d->errorLists[error_type];
2984 string const ext = formats.extension(format);
2985 FileName const tmp_result_file(changeExtension(filename, ext));
2986 bool const success = theConverters().convert(this, FileName(filename),
2987 tmp_result_file, FileName(absFileName()), backend_format, format,
2989 // Emit the signal to show the error list.
2990 if (format != backend_format) {
2992 // also to the children, in case of master-buffer-view
2993 std::vector<Buffer *> clist = getChildren();
2994 for (vector<Buffer *>::const_iterator cit = clist.begin();
2995 cit != clist.end(); ++cit)
2996 (*cit)->errors(error_type, true);
3001 if (put_in_tempdir) {
3002 result_file = tmp_result_file.absFilename();
3006 result_file = changeExtension(absFileName(), ext);
3007 // We need to copy referenced files (e. g. included graphics
3008 // if format == "dvi") to the result dir.
3009 vector<ExportedFile> const files =
3010 runparams.exportdata->externalFiles(format);
3011 string const dest = onlyPath(result_file);
3012 CopyStatus status = SUCCESS;
3013 for (vector<ExportedFile>::const_iterator it = files.begin();
3014 it != files.end() && status != CANCEL; ++it) {
3015 string const fmt = formats.getFormatFromFile(it->sourceName);
3016 status = copyFile(fmt, it->sourceName,
3017 makeAbsPath(it->exportName, dest),
3018 it->exportName, status == FORCE);
3020 if (status == CANCEL) {
3021 message(_("Document export cancelled."));
3022 } else if (tmp_result_file.exists()) {
3023 // Finally copy the main file
3024 status = copyFile(format, tmp_result_file,
3025 FileName(result_file), result_file,
3027 message(bformat(_("Document exported as %1$s "
3029 formats.prettyName(format),
3030 makeDisplayPath(result_file)));
3032 // This must be a dummy converter like fax (bug 1888)
3033 message(bformat(_("Document exported as %1$s"),
3034 formats.prettyName(format)));
3041 bool Buffer::doExport(string const & format, bool put_in_tempdir) const
3044 return doExport(format, put_in_tempdir, result_file);
3048 bool Buffer::preview(string const & format) const
3051 if (!doExport(format, true, result_file))
3053 return formats.view(*this, FileName(result_file), format);
3057 bool Buffer::isExportable(string const & format) const
3059 vector<string> backs = backends();
3060 for (vector<string>::const_iterator it = backs.begin();
3061 it != backs.end(); ++it)
3062 if (theConverters().isReachable(*it, format))
3068 vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
3070 vector<string> backs = backends();
3071 vector<Format const *> result =
3072 theConverters().getReachable(backs[0], only_viewable, true);
3073 for (vector<string>::const_iterator it = backs.begin() + 1;
3074 it != backs.end(); ++it) {
3075 vector<Format const *> r =
3076 theConverters().getReachable(*it, only_viewable, false);
3077 result.insert(result.end(), r.begin(), r.end());
3083 vector<string> Buffer::backends() const
3086 if (params().baseClass()->isTeXClassAvailable()) {
3087 v.push_back(bufferFormat());
3088 // FIXME: Don't hardcode format names here, but use a flag
3089 if (v.back() == "latex")
3090 v.push_back("pdflatex");
3092 v.push_back("text");
3093 v.push_back("xhtml");
3099 bool Buffer::readFileHelper(FileName const & s)
3101 // File information about normal file
3103 docstring const file = makeDisplayPath(s.absFilename(), 50);
3104 docstring text = bformat(_("The specified document\n%1$s"
3105 "\ncould not be read."), file);
3106 Alert::error(_("Could not read document"), text);
3110 // Check if emergency save file exists and is newer.
3111 FileName const e(s.absFilename() + ".emergency");
3113 if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
3114 docstring const file = makeDisplayPath(s.absFilename(), 20);
3115 docstring const text =
3116 bformat(_("An emergency save of the document "
3118 "Recover emergency save?"), file);
3119 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
3120 _("&Recover"), _("&Load Original"),
3124 // the file is not saved if we load the emergency file.
3134 // Now check if autosave file is newer.
3135 FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
3137 if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
3138 docstring const file = makeDisplayPath(s.absFilename(), 20);
3139 docstring const text =
3140 bformat(_("The backup of the document "
3141 "%1$s is newer.\n\nLoad the "
3142 "backup instead?"), file);
3143 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
3144 _("&Load backup"), _("Load &original"),
3148 // the file is not saved if we load the autosave file.
3152 // Here we delete the autosave
3163 bool Buffer::loadLyXFile(FileName const & s)
3165 if (s.isReadableFile()) {
3166 if (readFileHelper(s)) {
3167 lyxvc().file_found_hook(s);
3168 if (!s.isWritable())
3173 docstring const file = makeDisplayPath(s.absFilename(), 20);
3174 // Here we probably should run
3175 if (LyXVC::file_not_found_hook(s)) {
3176 docstring const text =
3177 bformat(_("Do you want to retrieve the document"
3178 " %1$s from version control?"), file);
3179 int const ret = Alert::prompt(_("Retrieve from version control?"),
3180 text, 0, 1, _("&Retrieve"), _("&Cancel"));
3183 // How can we know _how_ to do the checkout?
3184 // With the current VC support it has to be,
3185 // a RCS file since CVS do not have special ,v files.
3187 return loadLyXFile(s);
3195 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
3197 TeXErrors::Errors::const_iterator cit = terr.begin();
3198 TeXErrors::Errors::const_iterator end = terr.end();
3200 for (; cit != end; ++cit) {
3203 int errorRow = cit->error_in_line;
3204 bool found = d->texrow.getIdFromRow(errorRow, id_start,
3210 found = d->texrow.getIdFromRow(errorRow, id_end, pos_end);
3211 } while (found && id_start == id_end && pos_start == pos_end);
3213 errorList.push_back(ErrorItem(cit->error_desc,
3214 cit->error_text, id_start, pos_start, pos_end));
3219 void Buffer::setBuffersForInsets() const
3221 inset().setBuffer(const_cast<Buffer &>(*this));
3225 void Buffer::updateLabels(UpdateScope scope) const
3227 // Use the master text class also for child documents
3228 Buffer const * const master = masterBuffer();
3229 DocumentClass const & textclass = master->params().documentClass();
3231 // keep the buffers to be children in this set. If the call from the
3232 // master comes back we can see which of them were actually seen (i.e.
3233 // via an InsetInclude). The remaining ones in the set need still be updated.
3234 static std::set<Buffer const *> bufToUpdate;
3235 if (scope == UpdateMaster) {
3236 // If this is a child document start with the master
3237 if (master != this) {
3238 bufToUpdate.insert(this);
3239 master->updateLabels();
3240 // Do this here in case the master has no gui associated with it. Then,
3241 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3245 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3246 if (bufToUpdate.find(this) == bufToUpdate.end())
3250 // start over the counters in the master
3251 textclass.counters().reset();
3254 // update will be done below for this buffer
3255 bufToUpdate.erase(this);
3257 // update all caches
3258 clearReferenceCache();
3261 Buffer & cbuf = const_cast<Buffer &>(*this);
3263 LASSERT(!text().paragraphs().empty(), /**/);
3266 ParIterator parit = cbuf.par_iterator_begin();
3267 updateLabels(parit);
3270 // TocBackend update will be done later.
3273 cbuf.tocBackend().update();
3274 if (scope == UpdateMaster)
3275 cbuf.structureChanged();
3279 static depth_type getDepth(DocIterator const & it)
3281 depth_type depth = 0;
3282 for (size_t i = 0 ; i < it.depth() ; ++i)
3283 if (!it[i].inset().inMathed())
3284 depth += it[i].paragraph().getDepth() + 1;
3285 // remove 1 since the outer inset does not count
3289 static depth_type getItemDepth(ParIterator const & it)
3291 Paragraph const & par = *it;
3292 LabelType const labeltype = par.layout().labeltype;
3294 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
3297 // this will hold the lowest depth encountered up to now.
3298 depth_type min_depth = getDepth(it);
3299 ParIterator prev_it = it;
3302 --prev_it.top().pit();
3304 // start of nested inset: go to outer par
3306 if (prev_it.empty()) {
3307 // start of document: nothing to do
3312 // We search for the first paragraph with same label
3313 // that is not more deeply nested.
3314 Paragraph & prev_par = *prev_it;
3315 depth_type const prev_depth = getDepth(prev_it);
3316 if (labeltype == prev_par.layout().labeltype) {
3317 if (prev_depth < min_depth)
3318 return prev_par.itemdepth + 1;
3319 if (prev_depth == min_depth)
3320 return prev_par.itemdepth;
3322 min_depth = min(min_depth, prev_depth);
3323 // small optimization: if we are at depth 0, we won't
3324 // find anything else
3325 if (prev_depth == 0)
3331 static bool needEnumCounterReset(ParIterator const & it)
3333 Paragraph const & par = *it;
3334 LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
3335 depth_type const cur_depth = par.getDepth();
3336 ParIterator prev_it = it;
3337 while (prev_it.pit()) {
3338 --prev_it.top().pit();
3339 Paragraph const & prev_par = *prev_it;
3340 if (prev_par.getDepth() <= cur_depth)
3341 return prev_par.layout().labeltype != LABEL_ENUMERATE;
3343 // start of nested inset: reset
3348 // set the label of a paragraph. This includes the counters.
3349 static void setLabel(Buffer const & buf, ParIterator & it)
3351 BufferParams const & bp = buf.masterBuffer()->params();
3352 DocumentClass const & textclass = bp.documentClass();
3353 Paragraph & par = it.paragraph();
3354 Layout const & layout = par.layout();
3355 Counters & counters = textclass.counters();
3357 if (par.params().startOfAppendix()) {
3358 // FIXME: only the counter corresponding to toplevel
3359 // sectionning should be reset
3361 counters.appendix(true);
3363 par.params().appendix(counters.appendix());
3365 // Compute the item depth of the paragraph
3366 par.itemdepth = getItemDepth(it);
3368 if (layout.margintype == MARGIN_MANUAL
3369 || layout.latextype == LATEX_BIB_ENVIRONMENT) {
3370 if (par.params().labelWidthString().empty())
3371 par.params().labelWidthString(par.translateIfPossible(layout.labelstring(), bp));
3373 par.params().labelWidthString(docstring());
3376 switch(layout.labeltype) {
3378 if (layout.toclevel <= bp.secnumdepth
3379 && (layout.latextype != LATEX_ENVIRONMENT
3380 || isFirstInSequence(it.pit(), it.plist()))) {
3381 counters.step(layout.counter);
3382 par.params().labelString(
3383 par.expandLabel(layout, bp));
3385 par.params().labelString(docstring());
3388 case LABEL_ITEMIZE: {
3389 // At some point of time we should do something more
3390 // clever here, like:
3391 // par.params().labelString(
3392 // bp.user_defined_bullet(par.itemdepth).getText());
3393 // for now, use a simple hardcoded label
3394 docstring itemlabel;
3395 switch (par.itemdepth) {
3397 itemlabel = char_type(0x2022);
3400 itemlabel = char_type(0x2013);
3403 itemlabel = char_type(0x2217);
3406 itemlabel = char_type(0x2219); // or 0x00b7
3409 par.params().labelString(itemlabel);
3413 case LABEL_ENUMERATE: {
3414 docstring enumcounter = layout.counter.empty() ? from_ascii("enum") : layout.counter;
3416 switch (par.itemdepth) {
3425 enumcounter += "iv";
3428 // not a valid enumdepth...
3432 // Maybe we have to reset the enumeration counter.
3433 if (needEnumCounterReset(it))
3434 counters.reset(enumcounter);
3435 counters.step(enumcounter);
3437 par.params().labelString(counters.theCounter(enumcounter));
3442 case LABEL_SENSITIVE: {
3443 string const & type = counters.current_float();
3444 docstring full_label;
3446 full_label = buf.B_("Senseless!!! ");
3448 docstring name = buf.B_(textclass.floats().getType(type).name());
3449 if (counters.hasCounter(from_utf8(type))) {
3450 counters.step(from_utf8(type));
3451 full_label = bformat(from_ascii("%1$s %2$s:"),
3453 counters.theCounter(from_utf8(type)));
3455 full_label = bformat(from_ascii("%1$s #:"), name);
3457 par.params().labelString(full_label);
3461 case LABEL_NO_LABEL:
3462 par.params().labelString(docstring());
3466 case LABEL_TOP_ENVIRONMENT:
3467 case LABEL_CENTERED_TOP_ENVIRONMENT:
3470 par.params().labelString(
3471 par.translateIfPossible(layout.labelstring(), bp));
3477 void Buffer::updateLabels(ParIterator & parit) const
3479 LASSERT(parit.pit() == 0, /**/);
3481 // set the position of the text in the buffer to be able
3482 // to resolve macros in it. This has nothing to do with
3483 // labels, but by putting it here we avoid implementing
3484 // a whole bunch of traversal routines just for this call.
3485 parit.text()->setMacrocontextPosition(parit);
3487 depth_type maxdepth = 0;
3488 pit_type const lastpit = parit.lastpit();
3489 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
3490 // reduce depth if necessary
3491 parit->params().depth(min(parit->params().depth(), maxdepth));
3492 maxdepth = parit->getMaxDepthAfter();
3494 // set the counter for this paragraph
3495 setLabel(*this, parit);
3498 InsetList::const_iterator iit = parit->insetList().begin();
3499 InsetList::const_iterator end = parit->insetList().end();
3500 for (; iit != end; ++iit) {
3501 parit.pos() = iit->pos;
3502 iit->inset->updateLabels(parit);
3508 int Buffer::spellCheck(DocIterator & from, DocIterator & to,
3509 WordLangTuple & word_lang, docstring_list & suggestions) const
3513 suggestions.clear();
3514 word_lang = WordLangTuple();
3515 // OK, we start from here.
3516 DocIterator const end = doc_iterator_end(this);
3517 for (; from != end; from.forwardPos()) {
3518 // We are only interested in text so remove the math CursorSlice.
3519 while (from.inMathed())
3520 from.forwardInset();
3522 if (from.paragraph().spellCheck(from.pos(), to.pos(), wl, suggestions)) {