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
8 * Full author contact details are available in file CREDITS.
16 #include "BiblioInfo.h"
17 #include "BranchList.h"
18 #include "buffer_funcs.h"
19 #include "BufferList.h"
20 #include "BufferParams.h"
25 #include "DocIterator.h"
27 #include "ErrorList.h"
30 #include "FuncRequest.h"
32 #include "InsetIterator.h"
35 #include "LaTeXFeatures.h"
36 #include "LyXAction.h"
44 #include "output_docbook.h"
45 #include "output_latex.h"
46 #include "Paragraph.h"
47 #include "paragraph_funcs.h"
48 #include "ParagraphParameters.h"
49 #include "ParIterator.h"
52 #include "TextClassList.h"
53 #include "TexStream.h"
54 #include "TocBackend.h"
57 #include "EmbeddedFiles.h"
58 #include "PDFOptions.h"
60 #include "insets/InsetBibitem.h"
61 #include "insets/InsetBibtex.h"
62 #include "insets/InsetInclude.h"
63 #include "insets/InsetText.h"
65 #include "mathed/MathMacroTemplate.h"
66 #include "mathed/MacroTable.h"
67 #include "mathed/MathSupport.h"
69 #include "frontends/alert.h"
71 #include "graphics/Previews.h"
73 #include "support/types.h"
74 #include "support/lyxalgo.h"
75 #include "support/filetools.h"
76 #include "support/fs_extras.h"
77 #include "support/gzstream.h"
78 #include "support/lyxlib.h"
79 #include "support/os.h"
80 #include "support/Path.h"
81 #include "support/textutils.h"
82 #include "support/convert.h"
84 #include <boost/bind.hpp>
85 #include <boost/filesystem/exception.hpp>
86 #include <boost/filesystem/operations.hpp>
101 using std::ostringstream;
113 using support::addName;
114 using support::bformat;
115 using support::changeExtension;
116 using support::cmd_ret;
117 using support::createBufferTmpDir;
118 using support::destroyDir;
119 using support::FileName;
120 using support::getFormatFromContents;
121 using support::libFileSearch;
122 using support::latex_path;
123 using support::ltrim;
124 using support::makeAbsPath;
125 using support::makeDisplayPath;
126 using support::makeLatexName;
127 using support::onlyFilename;
128 using support::onlyPath;
129 using support::quoteName;
130 using support::removeAutosaveFile;
131 using support::rename;
132 using support::runCommand;
133 using support::split;
134 using support::subst;
135 using support::tempName;
138 using support::suffixIs;
140 namespace Alert = frontend::Alert;
141 namespace os = support::os;
142 namespace fs = boost::filesystem;
146 int const LYX_FORMAT = 287;
151 typedef std::map<string, bool> DepClean;
156 Impl(Buffer & parent, FileName const & file, bool readonly);
158 limited_stack<Undo> undostack;
159 limited_stack<Undo> redostack;
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;
189 /// our Text that should be wrapped in an InsetText
196 TocBackend toc_backend;
198 /// Container for all sort of Buffer dependant errors.
199 map<string, ErrorList> errorLists;
201 /// all embedded files of this buffer
202 EmbeddedFiles embedded_files;
204 /// timestamp and checksum used to test if the file has been externally
205 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
207 unsigned long checksum_;
211 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
212 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
213 filename(file), file_fully_loaded(false), inset(params),
214 toc_backend(&parent), embedded_files(&parent), timestamp_(0), checksum_(0)
216 inset.setAutoBreakRows(true);
217 lyxvc.buffer(&parent);
218 temppath = createBufferTmpDir();
219 params.filepath = onlyPath(file.absFilename());
220 // FIXME: And now do something if temppath == string(), because we
221 // assume from now on that temppath points to a valid temp dir.
222 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
226 Buffer::Buffer(string const & file, bool readonly)
227 : pimpl_(new Impl(*this, FileName(file), readonly))
229 LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
235 LYXERR(Debug::INFO) << "Buffer::~Buffer()" << endl;
236 // here the buffer should take care that it is
237 // saved properly, before it goes into the void.
239 Buffer * master = getMasterBuffer();
240 if (master != this && use_gui)
241 // We are closing buf which was a child document so we
242 // must update the labels and section numbering of its master
244 updateLabels(*master);
246 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
247 Alert::warning(_("Could not remove temporary directory"),
248 bformat(_("Could not remove the temporary directory %1$s"),
249 from_utf8(temppath())));
252 // Remove any previewed LaTeX snippets associated with this buffer.
253 graphics::Previews::get().removeLoader(*this);
259 Text & Buffer::text() const
261 return const_cast<Text &>(pimpl_->inset.text_);
265 Inset & Buffer::inset() const
267 return const_cast<InsetText &>(pimpl_->inset);
271 limited_stack<Undo> & Buffer::undostack()
273 return pimpl_->undostack;
277 limited_stack<Undo> const & Buffer::undostack() const
279 return pimpl_->undostack;
283 limited_stack<Undo> & Buffer::redostack()
285 return pimpl_->redostack;
289 limited_stack<Undo> const & Buffer::redostack() const
291 return pimpl_->redostack;
295 BufferParams & Buffer::params()
297 return pimpl_->params;
301 BufferParams const & Buffer::params() const
303 return pimpl_->params;
307 ParagraphList & Buffer::paragraphs()
309 return text().paragraphs();
313 ParagraphList const & Buffer::paragraphs() const
315 return text().paragraphs();
319 LyXVC & Buffer::lyxvc()
321 return pimpl_->lyxvc;
325 LyXVC const & Buffer::lyxvc() const
327 return pimpl_->lyxvc;
331 string const & Buffer::temppath() const
333 return pimpl_->temppath;
337 TexRow & Buffer::texrow()
339 return pimpl_->texrow;
343 TexRow const & Buffer::texrow() const
345 return pimpl_->texrow;
349 TocBackend & Buffer::tocBackend()
351 return pimpl_->toc_backend;
355 TocBackend const & Buffer::tocBackend() const
357 return pimpl_->toc_backend;
361 EmbeddedFiles & Buffer::embeddedFiles()
363 return pimpl_->embedded_files;
367 EmbeddedFiles const & Buffer::embeddedFiles() const
369 return pimpl_->embedded_files;
373 string const Buffer::getLatexName(bool const no_path) const
375 string const name = changeExtension(makeLatexName(fileName()), ".tex");
376 return no_path ? onlyFilename(name) : name;
380 pair<Buffer::LogType, string> const Buffer::getLogName() const
382 string const filename = getLatexName(false);
384 if (filename.empty())
385 return make_pair(Buffer::latexlog, string());
387 string const path = temppath();
389 FileName const fname(addName(temppath(),
390 onlyFilename(changeExtension(filename,
392 FileName const bname(
393 addName(path, onlyFilename(
394 changeExtension(filename,
395 formats.extension("literate") + ".out"))));
397 // If no Latex log or Build log is newer, show Build log
399 if (fs::exists(bname.toFilesystemEncoding()) &&
400 (!fs::exists(fname.toFilesystemEncoding()) ||
401 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
402 LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
403 return make_pair(Buffer::buildlog, bname.absFilename());
405 LYXERR(Debug::FILES) << "Log name calculated as: " << fname << endl;
406 return make_pair(Buffer::latexlog, fname.absFilename());
410 void Buffer::setReadonly(bool const flag)
412 if (pimpl_->read_only != flag) {
413 pimpl_->read_only = flag;
419 void Buffer::setFileName(string const & newfile)
421 pimpl_->filename = makeAbsPath(newfile);
422 params().filepath = onlyPath(pimpl_->filename.absFilename());
423 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
428 // We'll remove this later. (Lgb)
431 void unknownClass(string const & unknown)
433 Alert::warning(_("Unknown document class"),
434 bformat(_("Using the default document class, because the "
435 "class %1$s is unknown."), from_utf8(unknown)));
441 int Buffer::readHeader(Lexer & lex)
443 int unknown_tokens = 0;
445 int begin_header_line = -1;
447 // Initialize parameters that may be/go lacking in header:
448 params().branchlist().clear();
449 params().preamble.erase();
450 params().options.erase();
451 params().float_placement.erase();
452 params().paperwidth.erase();
453 params().paperheight.erase();
454 params().leftmargin.erase();
455 params().rightmargin.erase();
456 params().topmargin.erase();
457 params().bottommargin.erase();
458 params().headheight.erase();
459 params().headsep.erase();
460 params().footskip.erase();
461 params().listings_params.clear();
462 params().clearLayoutModules();
463 params().pdfoptions().clear();
465 for (int i = 0; i < 4; ++i) {
466 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
467 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
470 ErrorList & errorList = pimpl_->errorLists["Parse"];
474 string const token = lex.getString();
479 if (token == "\\end_header")
483 if (token == "\\begin_header") {
484 begin_header_line = line;
488 LYXERR(Debug::PARSER) << "Handling document header token: `"
489 << token << '\'' << endl;
491 string unknown = params().readToken(lex, token);
492 if (!unknown.empty()) {
493 if (unknown[0] != '\\' && token == "\\textclass") {
494 unknownClass(unknown);
497 docstring const s = bformat(_("Unknown token: "
501 errorList.push_back(ErrorItem(_("Document header error"),
506 if (begin_header_line) {
507 docstring const s = _("\\begin_header is missing");
508 errorList.push_back(ErrorItem(_("Document header error"),
512 return unknown_tokens;
517 // changed to be public and have one parameter
518 // Returns false if "\end_document" is not read (Asger)
519 bool Buffer::readDocument(Lexer & lex)
521 ErrorList & errorList = pimpl_->errorLists["Parse"];
525 string const token = lex.getString();
526 if (token != "\\begin_document") {
527 docstring const s = _("\\begin_document is missing");
528 errorList.push_back(ErrorItem(_("Document header error"),
532 // we are reading in a brand new document
533 BOOST_ASSERT(paragraphs().empty());
536 TextClass const & baseClass = textclasslist[params().getBaseClass()];
537 if (!baseClass.load(filePath())) {
538 string theclass = baseClass.name();
539 Alert::error(_("Can't load document class"), bformat(
540 _("Using the default document class, because the "
541 "class %1$s could not be loaded."), from_utf8(theclass)));
542 params().setBaseClass(defaultTextclass());
545 if (params().outputChanges) {
546 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
547 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
548 LaTeXFeatures::isAvailable("xcolor");
550 if (!dvipost && !xcolorsoul) {
551 Alert::warning(_("Changes not shown in LaTeX output"),
552 _("Changes will not be highlighted in LaTeX output, "
553 "because neither dvipost nor xcolor/soul are installed.\n"
554 "Please install these packages or redefine "
555 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
556 } else if (!xcolorsoul) {
557 Alert::warning(_("Changes not shown in LaTeX output"),
558 _("Changes will not be highlighted in LaTeX output "
559 "when using pdflatex, because xcolor and soul are not installed.\n"
560 "Please install both packages or redefine "
561 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
564 // read manifest after header
565 embeddedFiles().readManifest(lex, errorList);
568 bool const res = text().read(*this, lex, errorList);
569 for_each(text().paragraphs().begin(),
570 text().paragraphs().end(),
571 bind(&Paragraph::setInsetOwner, _1, &inset()));
577 // needed to insert the selection
578 void Buffer::insertStringAsLines(ParagraphList & pars,
579 pit_type & pit, pos_type & pos,
580 Font const & fn, docstring const & str, bool autobreakrows)
584 // insert the string, don't insert doublespace
585 bool space_inserted = true;
586 for (docstring::const_iterator cit = str.begin();
587 cit != str.end(); ++cit) {
588 Paragraph & par = pars[pit];
590 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
591 breakParagraph(params(), pars, pit, pos,
592 par.layout()->isEnvironment());
595 space_inserted = true;
599 // do not insert consecutive spaces if !free_spacing
600 } else if ((*cit == ' ' || *cit == '\t') &&
601 space_inserted && !par.isFreeSpacing()) {
603 } else if (*cit == '\t') {
604 if (!par.isFreeSpacing()) {
605 // tabs are like spaces here
606 par.insertChar(pos, ' ', font, params().trackChanges);
608 space_inserted = true;
610 const pos_type n = 8 - pos % 8;
611 for (pos_type i = 0; i < n; ++i) {
612 par.insertChar(pos, ' ', font, params().trackChanges);
615 space_inserted = true;
617 } else if (!isPrintable(*cit)) {
618 // Ignore unprintables
621 // just insert the character
622 par.insertChar(pos, *cit, font, params().trackChanges);
624 space_inserted = (*cit == ' ');
631 bool Buffer::readString(std::string const & s)
633 params().compressed = false;
635 // remove dummy empty par
636 paragraphs().clear();
638 std::istringstream is(s);
640 FileName const name(tempName());
641 switch (readFile(lex, name, true)) {
645 // We need to call lyx2lyx, so write the input to a file
646 std::ofstream os(name.toFilesystemEncoding().c_str());
649 return readFile(name);
659 bool Buffer::readFile(FileName const & filename)
661 FileName fname(filename);
662 // Check if the file is compressed.
663 string format = getFormatFromContents(filename);
664 if (format == "zip") {
665 // decompress to a temp directory
666 LYXERR(Debug::FILES) << filename << " is in zip format. Unzip to " << temppath() << endl;
667 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
669 FileName lyxfile(addName(temppath(), "content.lyx"));
670 // if both manifest.txt and file.lyx exist, this is am embedded file
671 if (fs::exists(lyxfile.toFilesystemEncoding())) {
672 params().embedded = true;
676 // The embedded lyx file can also be compressed, for backward compatibility
677 format = getFormatFromContents(fname);
678 if (format == "gzip" || format == "zip" || format == "compress") {
679 params().compressed = true;
682 // remove dummy empty par
683 paragraphs().clear();
686 if (readFile(lex, fname) != success)
693 bool Buffer::fully_loaded() const
695 return pimpl_->file_fully_loaded;
699 void Buffer::fully_loaded(bool const value)
701 pimpl_->file_fully_loaded = value;
705 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
708 BOOST_ASSERT(!filename.empty());
711 Alert::error(_("Document could not be read"),
712 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
717 string const token(lex.getString());
720 Alert::error(_("Document could not be read"),
721 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
725 // the first token _must_ be...
726 if (token != "\\lyxformat") {
727 lyxerr << "Token: " << token << endl;
729 Alert::error(_("Document format failure"),
730 bformat(_("%1$s is not a LyX document."),
731 from_utf8(filename.absFilename())));
736 string tmp_format = lex.getString();
737 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
738 // if present remove ".," from string.
739 string::size_type dot = tmp_format.find_first_of(".,");
740 //lyxerr << " dot found at " << dot << endl;
741 if (dot != string::npos)
742 tmp_format.erase(dot, 1);
743 int const file_format = convert<int>(tmp_format);
744 //lyxerr << "format: " << file_format << endl;
746 // save timestamp and checksum of the original disk file, making sure
747 // to not overwrite them with those of the file created in the tempdir
748 // when it has to be converted to the current format.
749 if (!pimpl_->checksum_) {
750 // Save the timestamp and checksum of disk file. If filename is an
751 // emergency file, save the timestamp and sum of the original lyx file
752 // because isExternallyModified will check for this file. (BUG4193)
753 string diskfile = filename.toFilesystemEncoding();
754 if (suffixIs(diskfile, ".emergency"))
755 diskfile = diskfile.substr(0, diskfile.size() - 10);
756 saveCheckSum(diskfile);
759 if (file_format != LYX_FORMAT) {
762 // lyx2lyx would fail
765 FileName const tmpfile(tempName());
766 if (tmpfile.empty()) {
767 Alert::error(_("Conversion failed"),
768 bformat(_("%1$s is from a different"
769 " version of LyX, but a temporary"
770 " file for converting it could"
772 from_utf8(filename.absFilename())));
775 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
776 if (lyx2lyx.empty()) {
777 Alert::error(_("Conversion script not found"),
778 bformat(_("%1$s is from a different"
779 " version of LyX, but the"
780 " conversion script lyx2lyx"
781 " could not be found."),
782 from_utf8(filename.absFilename())));
785 ostringstream command;
786 command << os::python()
787 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
788 << " -t " << convert<string>(LYX_FORMAT)
789 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
790 << ' ' << quoteName(filename.toFilesystemEncoding());
791 string const command_str = command.str();
793 LYXERR(Debug::INFO) << "Running '"
794 << command_str << '\''
797 cmd_ret const ret = runCommand(command_str);
798 if (ret.first != 0) {
799 Alert::error(_("Conversion script failed"),
800 bformat(_("%1$s is from a different version"
801 " of LyX, but the lyx2lyx script"
802 " failed to convert it."),
803 from_utf8(filename.absFilename())));
806 bool const ret = readFile(tmpfile);
807 // Do stuff with tmpfile name and buffer name here.
808 return ret ? success : failure;
813 if (readDocument(lex)) {
814 Alert::error(_("Document format failure"),
815 bformat(_("%1$s ended unexpectedly, which means"
816 " that it is probably corrupted."),
817 from_utf8(filename.absFilename())));
820 //lyxerr << "removing " << MacroTable::localMacros().size()
821 // << " temporary macro entries" << endl;
822 //MacroTable::localMacros().clear();
824 pimpl_->file_fully_loaded = true;
829 // Should probably be moved to somewhere else: BufferView? LyXView?
830 bool Buffer::save() const
832 // We don't need autosaves in the immediate future. (Asger)
833 resetAutosaveTimers();
835 string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
838 bool madeBackup = false;
840 // make a backup if the file already exists
841 if (lyxrc.make_backup && fs::exists(encodedFilename)) {
842 backupName = FileName(fileName() + '~');
843 if (!lyxrc.backupdir_path.empty())
844 backupName = FileName(addName(lyxrc.backupdir_path,
845 subst(os::internal_path(backupName.absFilename()), '/', '!')));
848 fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
850 } catch (fs::filesystem_error const & fe) {
851 Alert::error(_("Backup failure"),
852 bformat(_("Cannot create backup file %1$s.\n"
853 "Please check whether the directory exists and is writeable."),
854 from_utf8(backupName.absFilename())));
855 LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
859 // ask if the disk file has been externally modified (use checksum method)
860 if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
861 docstring const file = makeDisplayPath(fileName(), 20);
862 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
863 "you want to overwrite this file?"), file);
864 int const ret = Alert::prompt(_("Overwrite modified file?"),
865 text, 1, 1, _("&Overwrite"), _("&Cancel"));
870 if (writeFile(pimpl_->filename)) {
872 removeAutosaveFile(fileName());
873 saveCheckSum(pimpl_->filename.toFilesystemEncoding());
876 // Saving failed, so backup is not backup
878 rename(backupName, pimpl_->filename);
884 bool Buffer::writeFile(FileName const & fname) const
886 if (pimpl_->read_only && fname == pimpl_->filename)
892 if (params().embedded)
893 // first write the .lyx file to the temporary directory
894 content = FileName(addName(temppath(), "content.lyx"));
898 if (params().compressed) {
899 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
905 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
912 if (retval && params().embedded) {
913 // write file.lyx and all the embedded files to the zip file fname
914 // if embedding is enabled
915 return pimpl_->embedded_files.writeFile(fname);
921 bool Buffer::write(ostream & ofs) const
924 // Use the standard "C" locale for file output.
925 ofs.imbue(std::locale::classic());
928 // The top of the file should not be written by params().
930 // write out a comment in the top of the file
931 ofs << "#LyX " << lyx_version
932 << " created this file. For more info see http://www.lyx.org/\n"
933 << "\\lyxformat " << LYX_FORMAT << "\n"
934 << "\\begin_document\n";
937 /// For each author, set 'used' to true if there is a change
938 /// by this author in the document; otherwise set it to 'false'.
939 AuthorList::Authors::const_iterator a_it = params().authors().begin();
940 AuthorList::Authors::const_iterator a_end = params().authors().end();
941 for (; a_it != a_end; ++a_it)
942 a_it->second.used(false);
944 ParIterator const end = par_iterator_end();
945 ParIterator it = par_iterator_begin();
946 for ( ; it != end; ++it)
947 it->checkAuthors(params().authors());
949 // now write out the buffer parameters.
950 ofs << "\\begin_header\n";
951 params().writeFile(ofs);
952 ofs << "\\end_header\n";
954 // write the manifest after header
955 ofs << "\n\\begin_manifest\n";
956 pimpl_->embedded_files.update();
957 embeddedFiles().writeManifest(ofs);
958 ofs << "\\end_manifest\n";
961 ofs << "\n\\begin_body\n";
962 text().write(*this, ofs);
963 ofs << "\n\\end_body\n";
965 // Write marker that shows file is complete
966 ofs << "\\end_document" << endl;
968 // Shouldn't really be needed....
971 // how to check if close went ok?
972 // Following is an attempt... (BE 20001011)
974 // good() returns false if any error occured, including some
976 // bad() returns true if something bad happened in the buffer,
977 // which should include file system full errors.
982 lyxerr << "File was not closed properly." << endl;
989 bool Buffer::makeLaTeXFile(FileName const & fname,
990 string const & original_path,
991 OutputParams const & runparams,
992 bool output_preamble, bool output_body)
994 string const encoding = runparams.encoding->iconvName();
995 LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
996 << encoding << "..." << endl;
998 odocfstream ofs(encoding);
999 if (!openFileWrite(ofs, fname))
1002 //TexStream ts(ofs.rdbuf(), &texrow());
1004 bool failed_export = false;
1007 writeLaTeXSource(ofs, original_path,
1008 runparams, output_preamble, output_body);
1010 catch (iconv_codecvt_facet_exception & e) {
1011 lyxerr << "Caught iconv exception: " << e.what() << endl;
1012 failed_export = true;
1014 catch (std::exception const & e) {
1015 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1016 failed_export = true;
1019 lyxerr << "Caught some really weird exception..." << endl;
1020 LyX::cref().emergencyCleanup();
1026 failed_export = true;
1027 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1030 if (failed_export) {
1031 Alert::error(_("Encoding error"),
1032 _("Some characters of your document are probably not "
1033 "representable in the chosen encoding.\n"
1034 "Changing the document encoding to utf8 could help."));
1041 void Buffer::writeLaTeXSource(odocstream & os,
1042 string const & original_path,
1043 OutputParams const & runparams_in,
1044 bool const output_preamble, bool const output_body)
1046 OutputParams runparams = runparams_in;
1048 // validate the buffer.
1049 LYXERR(Debug::LATEX) << " Validating buffer..." << endl;
1050 LaTeXFeatures features(*this, params(), runparams);
1052 LYXERR(Debug::LATEX) << " Buffer validation done." << endl;
1054 // The starting paragraph of the coming rows is the
1055 // first paragraph of the document. (Asger)
1056 if (output_preamble && runparams.nice) {
1057 os << "%% LyX " << lyx_version << " created this file. "
1058 "For more info, see http://www.lyx.org/.\n"
1059 "%% Do not edit unless you really know what "
1064 LYXERR(Debug::INFO) << "lyx document header finished" << endl;
1065 // There are a few differences between nice LaTeX and usual files:
1066 // usual is \batchmode and has a
1067 // special input@path to allow the including of figures
1068 // with either \input or \includegraphics (what figinsets do).
1069 // input@path is set when the actual parameter
1070 // original_path is set. This is done for usual tex-file, but not
1071 // for nice-latex-file. (Matthias 250696)
1072 // Note that input@path is only needed for something the user does
1073 // in the preamble, included .tex files or ERT, files included by
1074 // LyX work without it.
1075 if (output_preamble) {
1076 if (!runparams.nice) {
1077 // code for usual, NOT nice-latex-file
1078 os << "\\batchmode\n"; // changed
1079 // from \nonstopmode
1082 if (!original_path.empty()) {
1084 // We don't know the encoding of inputpath
1085 docstring const inputpath = from_utf8(latex_path(original_path));
1086 os << "\\makeatletter\n"
1087 << "\\def\\input@path{{"
1088 << inputpath << "/}}\n"
1089 << "\\makeatother\n";
1095 // Write the preamble
1096 runparams.use_babel = params().writeLaTeX(os, features, texrow());
1102 os << "\\begin{document}\n";
1104 } // output_preamble
1106 texrow().start(paragraphs().begin()->id(), 0);
1108 LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
1110 if (!lyxrc.language_auto_begin &&
1111 !params().language->babel().empty()) {
1113 os << from_utf8(subst(lyxrc.language_command_begin,
1115 params().language->babel()))
1120 Encoding const & encoding = params().encoding();
1121 if (encoding.package() == Encoding::CJK) {
1122 // Open a CJK environment, since in contrast to the encodings
1123 // handled by inputenc the document encoding is not set in
1124 // the preamble if it is handled by CJK.sty.
1125 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1130 // if we are doing a real file with body, even if this is the
1131 // child of some other buffer, let's cut the link here.
1132 // This happens for example if only a child document is printed.
1133 string save_parentname;
1134 if (output_preamble) {
1135 save_parentname = params().parentname;
1136 params().parentname.erase();
1139 loadChildDocuments(*this);
1142 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1144 // Restore the parenthood if needed
1145 if (output_preamble)
1146 params().parentname = save_parentname;
1148 // add this just in case after all the paragraphs
1152 if (encoding.package() == Encoding::CJK) {
1153 // Close the open CJK environment.
1154 // latexParagraphs will have opened one even if the last text
1156 os << "\\end{CJK}\n";
1160 if (!lyxrc.language_auto_end &&
1161 !params().language->babel().empty()) {
1162 os << from_utf8(subst(lyxrc.language_command_end,
1164 params().language->babel()))
1169 if (output_preamble) {
1170 os << "\\end{document}\n";
1173 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1175 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1178 runparams_in.encoding = runparams.encoding;
1180 // Just to be sure. (Asger)
1183 LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1184 LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1189 bool Buffer::isLatex() const
1191 return params().getTextClass().outputType() == LATEX;
1195 bool Buffer::isLiterate() const
1197 return params().getTextClass().outputType() == LITERATE;
1201 bool Buffer::isDocBook() const
1203 return params().getTextClass().outputType() == DOCBOOK;
1207 void Buffer::makeDocBookFile(FileName const & fname,
1208 OutputParams const & runparams,
1209 bool const body_only)
1211 LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1215 if (!openFileWrite(ofs, fname))
1218 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1222 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1226 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1227 OutputParams const & runparams,
1228 bool const only_body)
1230 LaTeXFeatures features(*this, params(), runparams);
1235 TextClass const & tclass = params().getTextClass();
1236 string const top_element = tclass.latexname();
1239 if (runparams.flavor == OutputParams::XML)
1240 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1243 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1246 if (! tclass.class_header().empty())
1247 os << from_ascii(tclass.class_header());
1248 else if (runparams.flavor == OutputParams::XML)
1249 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1250 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1252 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1254 docstring preamble = from_utf8(params().preamble);
1255 if (runparams.flavor != OutputParams::XML ) {
1256 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1257 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1258 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1259 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1262 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1264 preamble += features.getIncludedFiles(name);
1265 preamble += features.getLyXSGMLEntities();
1267 if (!preamble.empty()) {
1268 os << "\n [ " << preamble << " ]";
1273 string top = top_element;
1275 if (runparams.flavor == OutputParams::XML)
1276 top += params().language->code();
1278 top += params().language->code().substr(0,2);
1281 if (!params().options.empty()) {
1283 top += params().options;
1286 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1287 << " file was created by LyX " << lyx_version
1288 << "\n See http://www.lyx.org/ for more information -->\n";
1290 params().getTextClass().counters().reset();
1292 loadChildDocuments(*this);
1294 sgml::openTag(os, top);
1296 docbookParagraphs(paragraphs(), *this, os, runparams);
1297 sgml::closeTag(os, top_element);
1301 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1302 // Other flags: -wall -v0 -x
1303 int Buffer::runChktex()
1307 // get LaTeX-Filename
1308 FileName const path(temppath());
1309 string const name = addName(path.absFilename(), getLatexName());
1310 string const org_path = filePath();
1312 support::Path p(path); // path to LaTeX file
1313 message(_("Running chktex..."));
1315 // Generate the LaTeX file if neccessary
1316 OutputParams runparams(¶ms().encoding());
1317 runparams.flavor = OutputParams::LATEX;
1318 runparams.nice = false;
1319 makeLaTeXFile(FileName(name), org_path, runparams);
1322 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1323 int const res = chktex.run(terr); // run chktex
1326 Alert::error(_("chktex failure"),
1327 _("Could not run chktex successfully."));
1328 } else if (res > 0) {
1329 ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
1330 // Clear out old errors
1332 // Fill-in the error list with the TeX errors
1333 bufferErrors(*this, terr, errorList);
1344 void Buffer::validate(LaTeXFeatures & features) const
1346 TextClass const & tclass = params().getTextClass();
1348 if (params().outputChanges) {
1349 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1350 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1351 LaTeXFeatures::isAvailable("xcolor");
1353 if (features.runparams().flavor == OutputParams::LATEX) {
1355 features.require("ct-dvipost");
1356 features.require("dvipost");
1357 } else if (xcolorsoul) {
1358 features.require("ct-xcolor-soul");
1359 features.require("soul");
1360 features.require("xcolor");
1362 features.require("ct-none");
1364 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1366 features.require("ct-xcolor-soul");
1367 features.require("soul");
1368 features.require("xcolor");
1369 features.require("pdfcolmk"); // improves color handling in PDF output
1371 features.require("ct-none");
1376 // AMS Style is at document level
1377 if (params().use_amsmath == BufferParams::package_on
1378 || tclass.provides("amsmath"))
1379 features.require("amsmath");
1380 if (params().use_esint == BufferParams::package_on)
1381 features.require("esint");
1383 loadChildDocuments(*this);
1385 for_each(paragraphs().begin(), paragraphs().end(),
1386 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1388 // the bullet shapes are buffer level not paragraph level
1389 // so they are tested here
1390 for (int i = 0; i < 4; ++i) {
1391 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1392 int const font = params().user_defined_bullet(i).getFont();
1394 int const c = params()
1395 .user_defined_bullet(i)
1402 features.require("latexsym");
1404 } else if (font == 1) {
1405 features.require("amssymb");
1406 } else if ((font >= 2 && font <= 5)) {
1407 features.require("pifont");
1412 if (lyxerr.debugging(Debug::LATEX)) {
1413 features.showStruct();
1418 void Buffer::getLabelList(vector<docstring> & list) const
1420 /// if this is a child document and the parent is already loaded
1421 /// Use the parent's list instead [ale990407]
1422 Buffer const * tmp = getMasterBuffer();
1424 lyxerr << "getMasterBuffer() failed!" << endl;
1428 tmp->getLabelList(list);
1432 loadChildDocuments(*this);
1434 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1435 it.nextInset()->getLabelList(*this, list);
1439 void Buffer::updateBibfilesCache()
1441 // if this is a child document and the parent is already loaded
1442 // update the parent's cache instead
1443 Buffer * tmp = getMasterBuffer();
1446 tmp->updateBibfilesCache();
1450 bibfilesCache_.clear();
1451 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1452 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1453 InsetBibtex const & inset =
1454 static_cast<InsetBibtex const &>(*it);
1455 vector<FileName> const bibfiles = inset.getFiles(*this);
1456 bibfilesCache_.insert(bibfilesCache_.end(),
1459 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1460 InsetInclude & inset =
1461 static_cast<InsetInclude &>(*it);
1462 inset.updateBibfilesCache(*this);
1463 vector<FileName> const & bibfiles =
1464 inset.getBibfilesCache(*this);
1465 bibfilesCache_.insert(bibfilesCache_.end(),
1473 vector<FileName> const & Buffer::getBibfilesCache() const
1475 // if this is a child document and the parent is already loaded
1476 // use the parent's cache instead
1477 Buffer const * tmp = getMasterBuffer();
1480 return tmp->getBibfilesCache();
1482 // We update the cache when first used instead of at loading time.
1483 if (bibfilesCache_.empty())
1484 const_cast<Buffer *>(this)->updateBibfilesCache();
1486 return bibfilesCache_;
1490 bool Buffer::isDepClean(string const & name) const
1492 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1493 if (it == pimpl_->dep_clean.end())
1499 void Buffer::markDepClean(string const & name)
1501 pimpl_->dep_clean[name] = true;
1505 bool Buffer::dispatch(string const & command, bool * result)
1507 return dispatch(lyxaction.lookupFunc(command), result);
1511 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1513 bool dispatched = true;
1515 switch (func.action) {
1516 case LFUN_BUFFER_EXPORT: {
1517 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1530 void Buffer::changeLanguage(Language const * from, Language const * to)
1535 for_each(par_iterator_begin(),
1537 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1541 bool Buffer::isMultiLingual() const
1543 ParConstIterator end = par_iterator_end();
1544 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1545 if (it->isMultiLingual(params()))
1552 ParIterator Buffer::getParFromID(int const id) const
1554 ParConstIterator it = par_iterator_begin();
1555 ParConstIterator const end = par_iterator_end();
1558 // John says this is called with id == -1 from undo
1559 lyxerr << "getParFromID(), id: " << id << endl;
1563 for (; it != end; ++it)
1571 bool Buffer::hasParWithID(int const id) const
1573 ParConstIterator const it = getParFromID(id);
1574 return it != par_iterator_end();
1578 ParIterator Buffer::par_iterator_begin()
1580 return lyx::par_iterator_begin(inset());
1584 ParIterator Buffer::par_iterator_end()
1586 return lyx::par_iterator_end(inset());
1590 ParConstIterator Buffer::par_iterator_begin() const
1592 return lyx::par_const_iterator_begin(inset());
1596 ParConstIterator Buffer::par_iterator_end() const
1598 return lyx::par_const_iterator_end(inset());
1602 Language const * Buffer::getLanguage() const
1604 return params().language;
1608 docstring const Buffer::B_(string const & l10n) const
1610 return params().B_(l10n);
1614 bool Buffer::isClean() const
1616 return pimpl_->lyx_clean;
1620 bool Buffer::isBakClean() const
1622 return pimpl_->bak_clean;
1626 bool Buffer::isExternallyModified(CheckMethod method) const
1628 BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
1629 // if method == timestamp, check timestamp before checksum
1630 return (method == checksum_method
1631 || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
1632 && pimpl_->checksum_ != sum(pimpl_->filename);
1636 void Buffer::saveCheckSum(string const & file) const
1638 if (fs::exists(file)) {
1639 pimpl_->timestamp_ = fs::last_write_time(file);
1640 pimpl_->checksum_ = sum(FileName(file));
1642 // in the case of save to a new file.
1643 pimpl_->timestamp_ = 0;
1644 pimpl_->checksum_ = 0;
1649 void Buffer::markClean() const
1651 if (!pimpl_->lyx_clean) {
1652 pimpl_->lyx_clean = true;
1655 // if the .lyx file has been saved, we don't need an
1657 pimpl_->bak_clean = true;
1661 void Buffer::markBakClean()
1663 pimpl_->bak_clean = true;
1667 void Buffer::setUnnamed(bool flag)
1669 pimpl_->unnamed = flag;
1673 bool Buffer::isUnnamed() const
1675 return pimpl_->unnamed;
1679 // FIXME: this function should be moved to buffer_pimpl.C
1680 void Buffer::markDirty()
1682 if (pimpl_->lyx_clean) {
1683 pimpl_->lyx_clean = false;
1686 pimpl_->bak_clean = false;
1688 DepClean::iterator it = pimpl_->dep_clean.begin();
1689 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1691 for (; it != end; ++it)
1696 string const Buffer::fileName() const
1698 return pimpl_->filename.absFilename();
1702 string const & Buffer::filePath() const
1704 return params().filepath;
1708 bool Buffer::isReadonly() const
1710 return pimpl_->read_only;
1714 void Buffer::setParentName(string const & name)
1716 if (name == pimpl_->filename.absFilename())
1717 // Avoids recursive include.
1718 params().parentname.clear();
1720 params().parentname = name;
1724 Buffer const * Buffer::getMasterBuffer() const
1726 if (!params().parentname.empty()
1727 && theBufferList().exists(params().parentname)) {
1728 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1729 //We need to check if the parent is us...
1730 //FIXME RECURSIVE INCLUDE
1731 //This is not sufficient, since recursive includes could be downstream.
1732 if (buf && buf != this)
1733 return buf->getMasterBuffer();
1740 Buffer * Buffer::getMasterBuffer()
1742 if (!params().parentname.empty()
1743 && theBufferList().exists(params().parentname)) {
1744 Buffer * buf = theBufferList().getBuffer(params().parentname);
1745 //We need to check if the parent is us...
1746 //FIXME RECURSIVE INCLUDE
1747 //This is not sufficient, since recursive includes could be downstream.
1748 if (buf && buf != this)
1749 return buf->getMasterBuffer();
1756 MacroData const & Buffer::getMacro(docstring const & name) const
1758 return pimpl_->macros.get(name);
1762 bool Buffer::hasMacro(docstring const & name) const
1764 return pimpl_->macros.has(name);
1768 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1770 MacroTable::globalMacros().insert(name, data);
1771 pimpl_->macros.insert(name, data);
1775 void Buffer::buildMacros()
1777 // Start with global table.
1778 pimpl_->macros = MacroTable::globalMacros();
1781 ParagraphList const & pars = text().paragraphs();
1782 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1783 //lyxerr << "searching main par " << i
1784 // << " for macro definitions" << std::endl;
1785 InsetList const & insets = pars[i].insetlist;
1786 InsetList::const_iterator it = insets.begin();
1787 InsetList::const_iterator end = insets.end();
1788 for ( ; it != end; ++it) {
1789 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1790 if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1791 MathMacroTemplate const & mac
1792 = static_cast<MathMacroTemplate const &>(*it->inset);
1793 insertMacro(mac.name(), mac.asMacroData());
1800 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1803 //FIXME: This does not work for child documents yet.
1804 BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1805 // Check if the label 'from' appears more than once
1806 vector<docstring> labels;
1808 if (code == Inset::CITE_CODE) {
1810 keys.fillWithBibKeys(this);
1811 BiblioInfo::const_iterator bit = keys.begin();
1812 BiblioInfo::const_iterator bend = keys.end();
1814 for (; bit != bend; ++bit)
1816 labels.push_back(bit->first);
1818 getLabelList(labels);
1820 if (std::count(labels.begin(), labels.end(), from) > 1)
1823 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1824 if (it->lyxCode() == code) {
1825 InsetCommand & inset = static_cast<InsetCommand &>(*it);
1826 inset.replaceContents(to_utf8(from), to_utf8(to));
1832 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1833 pit_type par_end, bool full_source)
1835 OutputParams runparams(¶ms().encoding());
1836 runparams.nice = true;
1837 runparams.flavor = OutputParams::LATEX;
1838 runparams.linelen = lyxrc.plaintext_linelen;
1839 // No side effect of file copying and image conversion
1840 runparams.dryrun = true;
1844 os << "% " << _("Preview source code") << "\n\n";
1848 writeLaTeXSource(os, filePath(), runparams, true, true);
1850 writeDocBookSource(os, fileName(), runparams, false);
1853 runparams.par_begin = par_begin;
1854 runparams.par_end = par_end;
1855 if (par_begin + 1 == par_end)
1857 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1861 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1862 convert<docstring>(par_begin),
1863 convert<docstring>(par_end - 1))
1867 // output paragraphs
1869 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1872 docbookParagraphs(paragraphs(), *this, os, runparams);
1878 ErrorList const & Buffer::errorList(string const & type) const
1880 static ErrorList const emptyErrorList;
1881 std::map<string, ErrorList>::const_iterator I = pimpl_->errorLists.find(type);
1882 if (I == pimpl_->errorLists.end())
1883 return emptyErrorList;
1889 ErrorList & Buffer::errorList(string const & type)
1891 return pimpl_->errorLists[type];