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"
59 #include "insets/InsetBibitem.h"
60 #include "insets/InsetBibtex.h"
61 #include "insets/InsetInclude.h"
62 #include "insets/InsetText.h"
64 #include "mathed/MathMacroTemplate.h"
65 #include "mathed/MacroTable.h"
66 #include "mathed/MathSupport.h"
68 #include "frontends/alert.h"
70 #include "graphics/Previews.h"
72 #include "support/types.h"
73 #include "support/lyxalgo.h"
74 #include "support/filetools.h"
75 #include "support/fs_extras.h"
76 #include "support/gzstream.h"
77 #include "support/lyxlib.h"
78 #include "support/os.h"
79 #include "support/Path.h"
80 #include "support/textutils.h"
81 #include "support/convert.h"
83 #include <boost/bind.hpp>
84 #include <boost/filesystem/exception.hpp>
85 #include <boost/filesystem/operations.hpp>
100 using std::ostringstream;
112 using support::addName;
113 using support::bformat;
114 using support::changeExtension;
115 using support::cmd_ret;
116 using support::createBufferTmpDir;
117 using support::destroyDir;
118 using support::FileName;
119 using support::getFormatFromContents;
120 using support::libFileSearch;
121 using support::latex_path;
122 using support::ltrim;
123 using support::makeAbsPath;
124 using support::makeDisplayPath;
125 using support::makeLatexName;
126 using support::onlyFilename;
127 using support::onlyPath;
128 using support::quoteName;
129 using support::removeAutosaveFile;
130 using support::rename;
131 using support::runCommand;
132 using support::split;
133 using support::subst;
134 using support::tempName;
137 using support::suffixIs;
139 namespace Alert = frontend::Alert;
140 namespace os = support::os;
141 namespace fs = boost::filesystem;
145 int const LYX_FORMAT = 285;
150 typedef std::map<string, bool> DepClean;
155 Impl(Buffer & parent, FileName const & file, bool readonly);
157 limited_stack<Undo> undostack;
158 limited_stack<Undo> redostack;
164 /// need to regenerate .tex?
168 mutable bool lyx_clean;
170 /// is autosave needed?
171 mutable bool bak_clean;
173 /// is this a unnamed file (New...)?
179 /// name of the file the buffer is associated with.
182 /** Set to true only when the file is fully loaded.
183 * Used to prevent the premature generation of previews
184 * and by the citation inset.
186 bool file_fully_loaded;
188 /// our Text that should be wrapped in an InsetText
195 TocBackend toc_backend;
197 /// Container for all sort of Buffer dependant errors.
198 map<string, ErrorList> errorLists;
200 /// all embedded files of this buffer
201 EmbeddedFiles embedded_files;
203 /// timestamp and checksum used to test if the file has been externally
204 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
206 unsigned long checksum_;
210 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
211 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
212 filename(file), file_fully_loaded(false), inset(params),
213 toc_backend(&parent), embedded_files(&parent), timestamp_(0), checksum_(0)
215 inset.setAutoBreakRows(true);
216 lyxvc.buffer(&parent);
217 temppath = createBufferTmpDir();
218 params.filepath = onlyPath(file.absFilename());
219 // FIXME: And now do something if temppath == string(), because we
220 // assume from now on that temppath points to a valid temp dir.
221 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
225 Buffer::Buffer(string const & file, bool readonly)
226 : pimpl_(new Impl(*this, FileName(file), readonly))
228 LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
234 LYXERR(Debug::INFO) << "Buffer::~Buffer()" << endl;
235 // here the buffer should take care that it is
236 // saved properly, before it goes into the void.
238 Buffer * master = getMasterBuffer();
239 if (master != this && use_gui)
240 // We are closing buf which was a child document so we
241 // must update the labels and section numbering of its master
243 updateLabels(*master);
245 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
246 Alert::warning(_("Could not remove temporary directory"),
247 bformat(_("Could not remove the temporary directory %1$s"),
248 from_utf8(temppath())));
251 // Remove any previewed LaTeX snippets associated with this buffer.
252 graphics::Previews::get().removeLoader(*this);
258 Text & Buffer::text() const
260 return const_cast<Text &>(pimpl_->inset.text_);
264 Inset & Buffer::inset() const
266 return const_cast<InsetText &>(pimpl_->inset);
270 limited_stack<Undo> & Buffer::undostack()
272 return pimpl_->undostack;
276 limited_stack<Undo> const & Buffer::undostack() const
278 return pimpl_->undostack;
282 limited_stack<Undo> & Buffer::redostack()
284 return pimpl_->redostack;
288 limited_stack<Undo> const & Buffer::redostack() const
290 return pimpl_->redostack;
294 BufferParams & Buffer::params()
296 return pimpl_->params;
300 BufferParams const & Buffer::params() const
302 return pimpl_->params;
306 ParagraphList & Buffer::paragraphs()
308 return text().paragraphs();
312 ParagraphList const & Buffer::paragraphs() const
314 return text().paragraphs();
318 LyXVC & Buffer::lyxvc()
320 return pimpl_->lyxvc;
324 LyXVC const & Buffer::lyxvc() const
326 return pimpl_->lyxvc;
330 string const & Buffer::temppath() const
332 return pimpl_->temppath;
336 TexRow & Buffer::texrow()
338 return pimpl_->texrow;
342 TexRow const & Buffer::texrow() const
344 return pimpl_->texrow;
348 TocBackend & Buffer::tocBackend()
350 return pimpl_->toc_backend;
354 TocBackend const & Buffer::tocBackend() const
356 return pimpl_->toc_backend;
360 EmbeddedFiles & Buffer::embeddedFiles()
362 return pimpl_->embedded_files;
366 EmbeddedFiles const & Buffer::embeddedFiles() const
368 return pimpl_->embedded_files;
372 string const Buffer::getLatexName(bool const no_path) const
374 string const name = changeExtension(makeLatexName(fileName()), ".tex");
375 return no_path ? onlyFilename(name) : name;
379 pair<Buffer::LogType, string> const Buffer::getLogName() const
381 string const filename = getLatexName(false);
383 if (filename.empty())
384 return make_pair(Buffer::latexlog, string());
386 string const path = temppath();
388 FileName const fname(addName(temppath(),
389 onlyFilename(changeExtension(filename,
391 FileName const bname(
392 addName(path, onlyFilename(
393 changeExtension(filename,
394 formats.extension("literate") + ".out"))));
396 // If no Latex log or Build log is newer, show Build log
398 if (fs::exists(bname.toFilesystemEncoding()) &&
399 (!fs::exists(fname.toFilesystemEncoding()) ||
400 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
401 LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
402 return make_pair(Buffer::buildlog, bname.absFilename());
404 LYXERR(Debug::FILES) << "Log name calculated as: " << fname << endl;
405 return make_pair(Buffer::latexlog, fname.absFilename());
409 void Buffer::setReadonly(bool const flag)
411 if (pimpl_->read_only != flag) {
412 pimpl_->read_only = flag;
418 void Buffer::setFileName(string const & newfile)
420 pimpl_->filename = makeAbsPath(newfile);
421 params().filepath = onlyPath(pimpl_->filename.absFilename());
422 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
427 // We'll remove this later. (Lgb)
430 void unknownClass(string const & unknown)
432 Alert::warning(_("Unknown document class"),
433 bformat(_("Using the default document class, because the "
434 "class %1$s is unknown."), from_utf8(unknown)));
440 int Buffer::readHeader(Lexer & lex)
442 int unknown_tokens = 0;
444 int begin_header_line = -1;
446 // Initialize parameters that may be/go lacking in header:
447 params().branchlist().clear();
448 params().preamble.erase();
449 params().options.erase();
450 params().float_placement.erase();
451 params().paperwidth.erase();
452 params().paperheight.erase();
453 params().leftmargin.erase();
454 params().rightmargin.erase();
455 params().topmargin.erase();
456 params().bottommargin.erase();
457 params().headheight.erase();
458 params().headsep.erase();
459 params().footskip.erase();
460 params().listings_params.clear();
461 params().clearLayoutModules();
463 for (int i = 0; i < 4; ++i) {
464 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
465 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
468 ErrorList & errorList = pimpl_->errorLists["Parse"];
472 string const token = lex.getString();
477 if (token == "\\end_header")
481 if (token == "\\begin_header") {
482 begin_header_line = line;
486 LYXERR(Debug::PARSER) << "Handling document header token: `"
487 << token << '\'' << endl;
489 string unknown = params().readToken(lex, token);
490 if (!unknown.empty()) {
491 if (unknown[0] != '\\' && token == "\\textclass") {
492 unknownClass(unknown);
495 docstring const s = bformat(_("Unknown token: "
499 errorList.push_back(ErrorItem(_("Document header error"),
504 if (begin_header_line) {
505 docstring const s = _("\\begin_header is missing");
506 errorList.push_back(ErrorItem(_("Document header error"),
510 return unknown_tokens;
515 // changed to be public and have one parameter
516 // Returns false if "\end_document" is not read (Asger)
517 bool Buffer::readDocument(Lexer & lex)
519 ErrorList & errorList = pimpl_->errorLists["Parse"];
523 string const token = lex.getString();
524 if (token != "\\begin_document") {
525 docstring const s = _("\\begin_document is missing");
526 errorList.push_back(ErrorItem(_("Document header error"),
530 // we are reading in a brand new document
531 BOOST_ASSERT(paragraphs().empty());
534 TextClass const & baseClass = textclasslist[params().getBaseClass()];
535 if (!baseClass.load(filePath())) {
536 string theclass = baseClass.name();
537 Alert::error(_("Can't load document class"), bformat(
538 _("Using the default document class, because the "
539 "class %1$s could not be loaded."), from_utf8(theclass)));
540 params().setBaseClass(defaultTextclass());
543 if (params().outputChanges) {
544 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
545 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
546 LaTeXFeatures::isAvailable("xcolor");
548 if (!dvipost && !xcolorsoul) {
549 Alert::warning(_("Changes not shown in LaTeX output"),
550 _("Changes will not be highlighted in LaTeX output, "
551 "because neither dvipost nor xcolor/soul are installed.\n"
552 "Please install these packages or redefine "
553 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
554 } else if (!xcolorsoul) {
555 Alert::warning(_("Changes not shown in LaTeX output"),
556 _("Changes will not be highlighted in LaTeX output "
557 "when using pdflatex, because xcolor and soul are not installed.\n"
558 "Please install both packages or redefine "
559 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
562 // read manifest after header
563 embeddedFiles().readManifest(lex, errorList);
566 bool const res = text().read(*this, lex, errorList);
567 for_each(text().paragraphs().begin(),
568 text().paragraphs().end(),
569 bind(&Paragraph::setInsetOwner, _1, &inset()));
575 // needed to insert the selection
576 void Buffer::insertStringAsLines(ParagraphList & pars,
577 pit_type & pit, pos_type & pos,
578 Font const & fn, docstring const & str, bool autobreakrows)
582 // insert the string, don't insert doublespace
583 bool space_inserted = true;
584 for (docstring::const_iterator cit = str.begin();
585 cit != str.end(); ++cit) {
586 Paragraph & par = pars[pit];
588 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
589 breakParagraph(params(), pars, pit, pos,
590 par.layout()->isEnvironment());
593 space_inserted = true;
597 // do not insert consecutive spaces if !free_spacing
598 } else if ((*cit == ' ' || *cit == '\t') &&
599 space_inserted && !par.isFreeSpacing()) {
601 } else if (*cit == '\t') {
602 if (!par.isFreeSpacing()) {
603 // tabs are like spaces here
604 par.insertChar(pos, ' ', font, params().trackChanges);
606 space_inserted = true;
608 const pos_type n = 8 - pos % 8;
609 for (pos_type i = 0; i < n; ++i) {
610 par.insertChar(pos, ' ', font, params().trackChanges);
613 space_inserted = true;
615 } else if (!isPrintable(*cit)) {
616 // Ignore unprintables
619 // just insert the character
620 par.insertChar(pos, *cit, font, params().trackChanges);
622 space_inserted = (*cit == ' ');
629 bool Buffer::readString(std::string const & s)
631 params().compressed = false;
633 // remove dummy empty par
634 paragraphs().clear();
636 std::istringstream is(s);
638 FileName const name(tempName());
639 switch (readFile(lex, name, true)) {
643 // We need to call lyx2lyx, so write the input to a file
644 std::ofstream os(name.toFilesystemEncoding().c_str());
647 return readFile(name);
657 bool Buffer::readFile(FileName const & filename)
659 FileName fname(filename);
660 // Check if the file is compressed.
661 string format = getFormatFromContents(filename);
662 if (format == "zip") {
663 // decompress to a temp directory
664 LYXERR(Debug::FILES) << filename << " is in zip format. Unzip to " << temppath() << endl;
665 ::unzipToDir(filename.toFilesystemEncoding(), temppath());
667 FileName lyxfile(addName(temppath(), "content.lyx"));
668 // if both manifest.txt and file.lyx exist, this is am embedded file
669 if (fs::exists(lyxfile.toFilesystemEncoding())) {
670 params().embedded = true;
674 // The embedded lyx file can also be compressed, for backward compatibility
675 format = getFormatFromContents(fname);
676 if (format == "gzip" || format == "zip" || format == "compress") {
677 params().compressed = true;
680 // remove dummy empty par
681 paragraphs().clear();
684 if (readFile(lex, fname) != success)
691 bool Buffer::fully_loaded() const
693 return pimpl_->file_fully_loaded;
697 void Buffer::fully_loaded(bool const value)
699 pimpl_->file_fully_loaded = value;
703 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
706 BOOST_ASSERT(!filename.empty());
709 Alert::error(_("Document could not be read"),
710 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
715 string const token(lex.getString());
718 Alert::error(_("Document could not be read"),
719 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
723 // the first token _must_ be...
724 if (token != "\\lyxformat") {
725 lyxerr << "Token: " << token << endl;
727 Alert::error(_("Document format failure"),
728 bformat(_("%1$s is not a LyX document."),
729 from_utf8(filename.absFilename())));
734 string tmp_format = lex.getString();
735 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
736 // if present remove ".," from string.
737 string::size_type dot = tmp_format.find_first_of(".,");
738 //lyxerr << " dot found at " << dot << endl;
739 if (dot != string::npos)
740 tmp_format.erase(dot, 1);
741 int const file_format = convert<int>(tmp_format);
742 //lyxerr << "format: " << file_format << endl;
744 // save timestamp and checksum of the original disk file, making sure
745 // to not overwrite them with those of the file created in the tempdir
746 // when it has to be converted to the current format.
747 if (!pimpl_->checksum_) {
748 // Save the timestamp and checksum of disk file. If filename is an
749 // emergency file, save the timestamp and sum of the original lyx file
750 // because isExternallyModified will check for this file. (BUG4193)
751 string diskfile = filename.toFilesystemEncoding();
752 if (suffixIs(diskfile, ".emergency"))
753 diskfile = diskfile.substr(0, diskfile.size() - 10);
754 saveCheckSum(diskfile);
757 if (file_format != LYX_FORMAT) {
760 // lyx2lyx would fail
763 FileName const tmpfile(tempName());
764 if (tmpfile.empty()) {
765 Alert::error(_("Conversion failed"),
766 bformat(_("%1$s is from a different"
767 " version of LyX, but a temporary"
768 " file for converting it could"
770 from_utf8(filename.absFilename())));
773 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
774 if (lyx2lyx.empty()) {
775 Alert::error(_("Conversion script not found"),
776 bformat(_("%1$s is from a different"
777 " version of LyX, but the"
778 " conversion script lyx2lyx"
779 " could not be found."),
780 from_utf8(filename.absFilename())));
783 ostringstream command;
784 command << os::python()
785 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
786 << " -t " << convert<string>(LYX_FORMAT)
787 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
788 << ' ' << quoteName(filename.toFilesystemEncoding());
789 string const command_str = command.str();
791 LYXERR(Debug::INFO) << "Running '"
792 << command_str << '\''
795 cmd_ret const ret = runCommand(command_str);
796 if (ret.first != 0) {
797 Alert::error(_("Conversion script failed"),
798 bformat(_("%1$s is from a different version"
799 " of LyX, but the lyx2lyx script"
800 " failed to convert it."),
801 from_utf8(filename.absFilename())));
804 bool const ret = readFile(tmpfile);
805 // Do stuff with tmpfile name and buffer name here.
806 return ret ? success : failure;
811 if (readDocument(lex)) {
812 Alert::error(_("Document format failure"),
813 bformat(_("%1$s ended unexpectedly, which means"
814 " that it is probably corrupted."),
815 from_utf8(filename.absFilename())));
818 //lyxerr << "removing " << MacroTable::localMacros().size()
819 // << " temporary macro entries" << endl;
820 //MacroTable::localMacros().clear();
822 pimpl_->file_fully_loaded = true;
827 // Should probably be moved to somewhere else: BufferView? LyXView?
828 bool Buffer::save() const
830 // We don't need autosaves in the immediate future. (Asger)
831 resetAutosaveTimers();
833 string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
836 bool madeBackup = false;
838 // make a backup if the file already exists
839 if (lyxrc.make_backup && fs::exists(encodedFilename)) {
840 backupName = FileName(fileName() + '~');
841 if (!lyxrc.backupdir_path.empty())
842 backupName = FileName(addName(lyxrc.backupdir_path,
843 subst(os::internal_path(backupName.absFilename()), '/', '!')));
846 fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
848 } catch (fs::filesystem_error const & fe) {
849 Alert::error(_("Backup failure"),
850 bformat(_("Cannot create backup file %1$s.\n"
851 "Please check whether the directory exists and is writeable."),
852 from_utf8(backupName.absFilename())));
853 LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
857 // ask if the disk file has been externally modified (use checksum method)
858 if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
859 docstring const file = makeDisplayPath(fileName(), 20);
860 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
861 "you want to overwrite this file?"), file);
862 int const ret = Alert::prompt(_("Overwrite modified file?"),
863 text, 1, 1, _("&Overwrite"), _("&Cancel"));
868 if (writeFile(pimpl_->filename)) {
870 removeAutosaveFile(fileName());
871 saveCheckSum(pimpl_->filename.toFilesystemEncoding());
874 // Saving failed, so backup is not backup
876 rename(backupName, pimpl_->filename);
882 bool Buffer::writeFile(FileName const & fname) const
884 if (pimpl_->read_only && fname == pimpl_->filename)
890 if (params().embedded)
891 // first write the .lyx file to the temporary directory
892 content = FileName(addName(temppath(), "content.lyx"));
896 if (params().compressed) {
897 gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
903 ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
910 if (retval && params().embedded) {
911 // write file.lyx and all the embedded files to the zip file fname
912 // if embedding is enabled
913 return pimpl_->embedded_files.writeFile(fname);
919 bool Buffer::write(ostream & ofs) const
922 // Use the standard "C" locale for file output.
923 ofs.imbue(std::locale::classic());
926 // The top of the file should not be written by params().
928 // write out a comment in the top of the file
929 ofs << "#LyX " << lyx_version
930 << " created this file. For more info see http://www.lyx.org/\n"
931 << "\\lyxformat " << LYX_FORMAT << "\n"
932 << "\\begin_document\n";
935 /// For each author, set 'used' to true if there is a change
936 /// by this author in the document; otherwise set it to 'false'.
937 AuthorList::Authors::const_iterator a_it = params().authors().begin();
938 AuthorList::Authors::const_iterator a_end = params().authors().end();
939 for (; a_it != a_end; ++a_it)
940 a_it->second.used(false);
942 ParIterator const end = par_iterator_end();
943 ParIterator it = par_iterator_begin();
944 for ( ; it != end; ++it)
945 it->checkAuthors(params().authors());
947 // now write out the buffer parameters.
948 ofs << "\\begin_header\n";
949 params().writeFile(ofs);
950 ofs << "\\end_header\n";
952 // write the manifest after header
953 ofs << "\n\\begin_manifest\n";
954 pimpl_->embedded_files.update();
955 embeddedFiles().writeManifest(ofs);
956 ofs << "\\end_manifest\n";
959 ofs << "\n\\begin_body\n";
960 text().write(*this, ofs);
961 ofs << "\n\\end_body\n";
963 // Write marker that shows file is complete
964 ofs << "\\end_document" << endl;
966 // Shouldn't really be needed....
969 // how to check if close went ok?
970 // Following is an attempt... (BE 20001011)
972 // good() returns false if any error occured, including some
974 // bad() returns true if something bad happened in the buffer,
975 // which should include file system full errors.
980 lyxerr << "File was not closed properly." << endl;
987 bool Buffer::makeLaTeXFile(FileName const & fname,
988 string const & original_path,
989 OutputParams const & runparams,
990 bool output_preamble, bool output_body)
992 string const encoding = runparams.encoding->iconvName();
993 LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
994 << encoding << "..." << endl;
996 odocfstream ofs(encoding);
997 if (!openFileWrite(ofs, fname))
1000 //TexStream ts(ofs.rdbuf(), &texrow());
1002 bool failed_export = false;
1005 writeLaTeXSource(ofs, original_path,
1006 runparams, output_preamble, output_body);
1008 catch (iconv_codecvt_facet_exception & e) {
1009 lyxerr << "Caught iconv exception: " << e.what() << endl;
1010 failed_export = true;
1012 catch (std::exception const & e) {
1013 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
1014 failed_export = true;
1017 lyxerr << "Caught some really weird exception..." << endl;
1018 LyX::cref().emergencyCleanup();
1024 failed_export = true;
1025 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1028 if (failed_export) {
1029 Alert::error(_("Encoding error"),
1030 _("Some characters of your document are probably not "
1031 "representable in the chosen encoding.\n"
1032 "Changing the document encoding to utf8 could help."));
1039 void Buffer::writeLaTeXSource(odocstream & os,
1040 string const & original_path,
1041 OutputParams const & runparams_in,
1042 bool const output_preamble, bool const output_body)
1044 OutputParams runparams = runparams_in;
1046 // validate the buffer.
1047 LYXERR(Debug::LATEX) << " Validating buffer..." << endl;
1048 LaTeXFeatures features(*this, params(), runparams);
1050 LYXERR(Debug::LATEX) << " Buffer validation done." << endl;
1052 // The starting paragraph of the coming rows is the
1053 // first paragraph of the document. (Asger)
1054 if (output_preamble && runparams.nice) {
1055 os << "%% LyX " << lyx_version << " created this file. "
1056 "For more info, see http://www.lyx.org/.\n"
1057 "%% Do not edit unless you really know what "
1062 LYXERR(Debug::INFO) << "lyx document header finished" << endl;
1063 // There are a few differences between nice LaTeX and usual files:
1064 // usual is \batchmode and has a
1065 // special input@path to allow the including of figures
1066 // with either \input or \includegraphics (what figinsets do).
1067 // input@path is set when the actual parameter
1068 // original_path is set. This is done for usual tex-file, but not
1069 // for nice-latex-file. (Matthias 250696)
1070 // Note that input@path is only needed for something the user does
1071 // in the preamble, included .tex files or ERT, files included by
1072 // LyX work without it.
1073 if (output_preamble) {
1074 if (!runparams.nice) {
1075 // code for usual, NOT nice-latex-file
1076 os << "\\batchmode\n"; // changed
1077 // from \nonstopmode
1080 if (!original_path.empty()) {
1082 // We don't know the encoding of inputpath
1083 docstring const inputpath = from_utf8(latex_path(original_path));
1084 os << "\\makeatletter\n"
1085 << "\\def\\input@path{{"
1086 << inputpath << "/}}\n"
1087 << "\\makeatother\n";
1093 // Write the preamble
1094 runparams.use_babel = params().writeLaTeX(os, features, texrow());
1100 os << "\\begin{document}\n";
1102 } // output_preamble
1104 texrow().start(paragraphs().begin()->id(), 0);
1106 LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
1108 if (!lyxrc.language_auto_begin &&
1109 !params().language->babel().empty()) {
1111 os << from_utf8(subst(lyxrc.language_command_begin,
1113 params().language->babel()))
1118 Encoding const & encoding = params().encoding();
1119 if (encoding.package() == Encoding::CJK) {
1120 // Open a CJK environment, since in contrast to the encodings
1121 // handled by inputenc the document encoding is not set in
1122 // the preamble if it is handled by CJK.sty.
1123 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1128 // if we are doing a real file with body, even if this is the
1129 // child of some other buffer, let's cut the link here.
1130 // This happens for example if only a child document is printed.
1131 string save_parentname;
1132 if (output_preamble) {
1133 save_parentname = params().parentname;
1134 params().parentname.erase();
1137 loadChildDocuments(*this);
1140 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1142 // Restore the parenthood if needed
1143 if (output_preamble)
1144 params().parentname = save_parentname;
1146 // add this just in case after all the paragraphs
1150 if (encoding.package() == Encoding::CJK) {
1151 // Close the open CJK environment.
1152 // latexParagraphs will have opened one even if the last text
1154 os << "\\end{CJK}\n";
1158 if (!lyxrc.language_auto_end &&
1159 !params().language->babel().empty()) {
1160 os << from_utf8(subst(lyxrc.language_command_end,
1162 params().language->babel()))
1167 if (output_preamble) {
1168 os << "\\end{document}\n";
1171 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1173 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1176 runparams_in.encoding = runparams.encoding;
1178 // Just to be sure. (Asger)
1181 LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1182 LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1187 bool Buffer::isLatex() const
1189 return params().getTextClass().outputType() == LATEX;
1193 bool Buffer::isLiterate() const
1195 return params().getTextClass().outputType() == LITERATE;
1199 bool Buffer::isDocBook() const
1201 return params().getTextClass().outputType() == DOCBOOK;
1205 void Buffer::makeDocBookFile(FileName const & fname,
1206 OutputParams const & runparams,
1207 bool const body_only)
1209 LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1213 if (!openFileWrite(ofs, fname))
1216 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1220 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1224 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1225 OutputParams const & runparams,
1226 bool const only_body)
1228 LaTeXFeatures features(*this, params(), runparams);
1233 TextClass const & tclass = params().getTextClass();
1234 string const top_element = tclass.latexname();
1237 if (runparams.flavor == OutputParams::XML)
1238 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1241 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1244 if (! tclass.class_header().empty())
1245 os << from_ascii(tclass.class_header());
1246 else if (runparams.flavor == OutputParams::XML)
1247 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1248 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1250 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1252 docstring preamble = from_utf8(params().preamble);
1253 if (runparams.flavor != OutputParams::XML ) {
1254 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1255 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1256 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1257 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1260 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1262 preamble += features.getIncludedFiles(name);
1263 preamble += features.getLyXSGMLEntities();
1265 if (!preamble.empty()) {
1266 os << "\n [ " << preamble << " ]";
1271 string top = top_element;
1273 if (runparams.flavor == OutputParams::XML)
1274 top += params().language->code();
1276 top += params().language->code().substr(0,2);
1279 if (!params().options.empty()) {
1281 top += params().options;
1284 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1285 << " file was created by LyX " << lyx_version
1286 << "\n See http://www.lyx.org/ for more information -->\n";
1288 params().getTextClass().counters().reset();
1290 loadChildDocuments(*this);
1292 sgml::openTag(os, top);
1294 docbookParagraphs(paragraphs(), *this, os, runparams);
1295 sgml::closeTag(os, top_element);
1299 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1300 // Other flags: -wall -v0 -x
1301 int Buffer::runChktex()
1305 // get LaTeX-Filename
1306 FileName const path(temppath());
1307 string const name = addName(path.absFilename(), getLatexName());
1308 string const org_path = filePath();
1310 support::Path p(path); // path to LaTeX file
1311 message(_("Running chktex..."));
1313 // Generate the LaTeX file if neccessary
1314 OutputParams runparams(¶ms().encoding());
1315 runparams.flavor = OutputParams::LATEX;
1316 runparams.nice = false;
1317 makeLaTeXFile(FileName(name), org_path, runparams);
1320 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1321 int const res = chktex.run(terr); // run chktex
1324 Alert::error(_("chktex failure"),
1325 _("Could not run chktex successfully."));
1326 } else if (res > 0) {
1327 ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
1328 // Clear out old errors
1330 // Fill-in the error list with the TeX errors
1331 bufferErrors(*this, terr, errorList);
1342 void Buffer::validate(LaTeXFeatures & features) const
1344 TextClass const & tclass = params().getTextClass();
1346 if (params().outputChanges) {
1347 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1348 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1349 LaTeXFeatures::isAvailable("xcolor");
1351 if (features.runparams().flavor == OutputParams::LATEX) {
1353 features.require("ct-dvipost");
1354 features.require("dvipost");
1355 } else if (xcolorsoul) {
1356 features.require("ct-xcolor-soul");
1357 features.require("soul");
1358 features.require("xcolor");
1360 features.require("ct-none");
1362 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1364 features.require("ct-xcolor-soul");
1365 features.require("soul");
1366 features.require("xcolor");
1367 features.require("pdfcolmk"); // improves color handling in PDF output
1369 features.require("ct-none");
1374 // AMS Style is at document level
1375 if (params().use_amsmath == BufferParams::package_on
1376 || tclass.provides("amsmath"))
1377 features.require("amsmath");
1378 if (params().use_esint == BufferParams::package_on)
1379 features.require("esint");
1381 loadChildDocuments(*this);
1383 for_each(paragraphs().begin(), paragraphs().end(),
1384 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1386 // the bullet shapes are buffer level not paragraph level
1387 // so they are tested here
1388 for (int i = 0; i < 4; ++i) {
1389 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1390 int const font = params().user_defined_bullet(i).getFont();
1392 int const c = params()
1393 .user_defined_bullet(i)
1400 features.require("latexsym");
1402 } else if (font == 1) {
1403 features.require("amssymb");
1404 } else if ((font >= 2 && font <= 5)) {
1405 features.require("pifont");
1410 if (lyxerr.debugging(Debug::LATEX)) {
1411 features.showStruct();
1416 void Buffer::getLabelList(vector<docstring> & list) const
1418 /// if this is a child document and the parent is already loaded
1419 /// Use the parent's list instead [ale990407]
1420 Buffer const * tmp = getMasterBuffer();
1422 lyxerr << "getMasterBuffer() failed!" << endl;
1426 tmp->getLabelList(list);
1430 loadChildDocuments(*this);
1432 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1433 it.nextInset()->getLabelList(*this, list);
1437 void Buffer::updateBibfilesCache()
1439 // if this is a child document and the parent is already loaded
1440 // update the parent's cache instead
1441 Buffer * tmp = getMasterBuffer();
1444 tmp->updateBibfilesCache();
1448 bibfilesCache_.clear();
1449 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1450 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1451 InsetBibtex const & inset =
1452 static_cast<InsetBibtex const &>(*it);
1453 vector<FileName> const bibfiles = inset.getFiles(*this);
1454 bibfilesCache_.insert(bibfilesCache_.end(),
1457 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1458 InsetInclude & inset =
1459 static_cast<InsetInclude &>(*it);
1460 inset.updateBibfilesCache(*this);
1461 vector<FileName> const & bibfiles =
1462 inset.getBibfilesCache(*this);
1463 bibfilesCache_.insert(bibfilesCache_.end(),
1471 vector<FileName> const & Buffer::getBibfilesCache() const
1473 // if this is a child document and the parent is already loaded
1474 // use the parent's cache instead
1475 Buffer const * tmp = getMasterBuffer();
1478 return tmp->getBibfilesCache();
1480 // We update the cache when first used instead of at loading time.
1481 if (bibfilesCache_.empty())
1482 const_cast<Buffer *>(this)->updateBibfilesCache();
1484 return bibfilesCache_;
1488 bool Buffer::isDepClean(string const & name) const
1490 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1491 if (it == pimpl_->dep_clean.end())
1497 void Buffer::markDepClean(string const & name)
1499 pimpl_->dep_clean[name] = true;
1503 bool Buffer::dispatch(string const & command, bool * result)
1505 return dispatch(lyxaction.lookupFunc(command), result);
1509 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1511 bool dispatched = true;
1513 switch (func.action) {
1514 case LFUN_BUFFER_EXPORT: {
1515 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1528 void Buffer::changeLanguage(Language const * from, Language const * to)
1533 for_each(par_iterator_begin(),
1535 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1539 bool Buffer::isMultiLingual() const
1541 ParConstIterator end = par_iterator_end();
1542 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1543 if (it->isMultiLingual(params()))
1550 ParIterator Buffer::getParFromID(int const id) const
1552 ParConstIterator it = par_iterator_begin();
1553 ParConstIterator const end = par_iterator_end();
1556 // John says this is called with id == -1 from undo
1557 lyxerr << "getParFromID(), id: " << id << endl;
1561 for (; it != end; ++it)
1569 bool Buffer::hasParWithID(int const id) const
1571 ParConstIterator const it = getParFromID(id);
1572 return it != par_iterator_end();
1576 ParIterator Buffer::par_iterator_begin()
1578 return lyx::par_iterator_begin(inset());
1582 ParIterator Buffer::par_iterator_end()
1584 return lyx::par_iterator_end(inset());
1588 ParConstIterator Buffer::par_iterator_begin() const
1590 return lyx::par_const_iterator_begin(inset());
1594 ParConstIterator Buffer::par_iterator_end() const
1596 return lyx::par_const_iterator_end(inset());
1600 Language const * Buffer::getLanguage() const
1602 return params().language;
1606 docstring const Buffer::B_(string const & l10n) const
1608 return params().B_(l10n);
1612 bool Buffer::isClean() const
1614 return pimpl_->lyx_clean;
1618 bool Buffer::isBakClean() const
1620 return pimpl_->bak_clean;
1624 bool Buffer::isExternallyModified(CheckMethod method) const
1626 BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
1627 // if method == timestamp, check timestamp before checksum
1628 return (method == checksum_method
1629 || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
1630 && pimpl_->checksum_ != sum(pimpl_->filename);
1634 void Buffer::saveCheckSum(string const & file) const
1636 if (fs::exists(file)) {
1637 pimpl_->timestamp_ = fs::last_write_time(file);
1638 pimpl_->checksum_ = sum(FileName(file));
1640 // in the case of save to a new file.
1641 pimpl_->timestamp_ = 0;
1642 pimpl_->checksum_ = 0;
1647 void Buffer::markClean() const
1649 if (!pimpl_->lyx_clean) {
1650 pimpl_->lyx_clean = true;
1653 // if the .lyx file has been saved, we don't need an
1655 pimpl_->bak_clean = true;
1659 void Buffer::markBakClean()
1661 pimpl_->bak_clean = true;
1665 void Buffer::setUnnamed(bool flag)
1667 pimpl_->unnamed = flag;
1671 bool Buffer::isUnnamed() const
1673 return pimpl_->unnamed;
1677 // FIXME: this function should be moved to buffer_pimpl.C
1678 void Buffer::markDirty()
1680 if (pimpl_->lyx_clean) {
1681 pimpl_->lyx_clean = false;
1684 pimpl_->bak_clean = false;
1686 DepClean::iterator it = pimpl_->dep_clean.begin();
1687 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1689 for (; it != end; ++it)
1694 string const Buffer::fileName() const
1696 return pimpl_->filename.absFilename();
1700 string const & Buffer::filePath() const
1702 return params().filepath;
1706 bool Buffer::isReadonly() const
1708 return pimpl_->read_only;
1712 void Buffer::setParentName(string const & name)
1714 if (name == pimpl_->filename.absFilename())
1715 // Avoids recursive include.
1716 params().parentname.clear();
1718 params().parentname = name;
1722 Buffer const * Buffer::getMasterBuffer() const
1724 if (!params().parentname.empty()
1725 && theBufferList().exists(params().parentname)) {
1726 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1727 //We need to check if the parent is us...
1728 //FIXME RECURSIVE INCLUDE
1729 //This is not sufficient, since recursive includes could be downstream.
1730 if (buf && buf != this)
1731 return buf->getMasterBuffer();
1738 Buffer * Buffer::getMasterBuffer()
1740 if (!params().parentname.empty()
1741 && theBufferList().exists(params().parentname)) {
1742 Buffer * buf = theBufferList().getBuffer(params().parentname);
1743 //We need to check if the parent is us...
1744 //FIXME RECURSIVE INCLUDE
1745 //This is not sufficient, since recursive includes could be downstream.
1746 if (buf && buf != this)
1747 return buf->getMasterBuffer();
1754 MacroData const & Buffer::getMacro(docstring const & name) const
1756 return pimpl_->macros.get(name);
1760 bool Buffer::hasMacro(docstring const & name) const
1762 return pimpl_->macros.has(name);
1766 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1768 MacroTable::globalMacros().insert(name, data);
1769 pimpl_->macros.insert(name, data);
1773 void Buffer::buildMacros()
1775 // Start with global table.
1776 pimpl_->macros = MacroTable::globalMacros();
1779 ParagraphList const & pars = text().paragraphs();
1780 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1781 //lyxerr << "searching main par " << i
1782 // << " for macro definitions" << std::endl;
1783 InsetList const & insets = pars[i].insetlist;
1784 InsetList::const_iterator it = insets.begin();
1785 InsetList::const_iterator end = insets.end();
1786 for ( ; it != end; ++it) {
1787 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1788 if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1789 MathMacroTemplate const & mac
1790 = static_cast<MathMacroTemplate const &>(*it->inset);
1791 insertMacro(mac.name(), mac.asMacroData());
1798 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1801 //FIXME: This does not work for child documents yet.
1802 BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1803 // Check if the label 'from' appears more than once
1804 vector<docstring> labels;
1806 if (code == Inset::CITE_CODE) {
1808 keys.fillWithBibKeys(this);
1809 BiblioInfo::const_iterator bit = keys.begin();
1810 BiblioInfo::const_iterator bend = keys.end();
1812 for (; bit != bend; ++bit)
1814 labels.push_back(bit->first);
1816 getLabelList(labels);
1818 if (std::count(labels.begin(), labels.end(), from) > 1)
1821 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1822 if (it->lyxCode() == code) {
1823 InsetCommand & inset = static_cast<InsetCommand &>(*it);
1824 inset.replaceContents(to_utf8(from), to_utf8(to));
1830 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1831 pit_type par_end, bool full_source)
1833 OutputParams runparams(¶ms().encoding());
1834 runparams.nice = true;
1835 runparams.flavor = OutputParams::LATEX;
1836 runparams.linelen = lyxrc.plaintext_linelen;
1837 // No side effect of file copying and image conversion
1838 runparams.dryrun = true;
1842 os << "% " << _("Preview source code") << "\n\n";
1846 writeLaTeXSource(os, filePath(), runparams, true, true);
1848 writeDocBookSource(os, fileName(), runparams, false);
1851 runparams.par_begin = par_begin;
1852 runparams.par_end = par_end;
1853 if (par_begin + 1 == par_end)
1855 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1859 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1860 convert<docstring>(par_begin),
1861 convert<docstring>(par_end - 1))
1865 // output paragraphs
1867 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1870 docbookParagraphs(paragraphs(), *this, os, runparams);
1876 ErrorList const & Buffer::errorList(string const & type) const
1878 static ErrorList const emptyErrorList;
1879 std::map<string, ErrorList>::const_iterator I = pimpl_->errorLists.find(type);
1880 if (I == pimpl_->errorLists.end())
1881 return emptyErrorList;
1887 ErrorList & Buffer::errorList(string const & type)
1889 return pimpl_->errorLists[type];