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 "BranchList.h"
17 #include "buffer_funcs.h"
18 #include "BufferList.h"
19 #include "BufferParams.h"
25 #include "ErrorList.h"
28 #include "FuncRequest.h"
30 #include "InsetIterator.h"
33 #include "LaTeXFeatures.h"
34 #include "LyXAction.h"
42 #include "output_docbook.h"
43 #include "output_latex.h"
44 #include "Paragraph.h"
45 #include "paragraph_funcs.h"
46 #include "ParagraphParameters.h"
47 #include "ParIterator.h"
50 #include "TexStream.h"
51 #include "TocBackend.h"
55 #include "insets/InsetBibitem.h"
56 #include "insets/InsetBibtex.h"
57 #include "insets/InsetInclude.h"
58 #include "insets/InsetText.h"
60 #include "mathed/MathMacroTemplate.h"
61 #include "mathed/MacroTable.h"
62 #include "mathed/MathSupport.h"
64 #include "frontends/alert.h"
66 #include "graphics/Previews.h"
68 #include "support/types.h"
69 #include "support/lyxalgo.h"
70 #include "support/filetools.h"
71 #include "support/fs_extras.h"
72 #include "support/gzstream.h"
73 #include "support/lyxlib.h"
74 #include "support/os.h"
75 #include "support/Path.h"
76 #include "support/textutils.h"
77 #include "support/convert.h"
79 #include <boost/bind.hpp>
80 #include <boost/filesystem/exception.hpp>
81 #include <boost/filesystem/operations.hpp>
96 using std::ostringstream;
107 using support::addName;
108 using support::bformat;
109 using support::changeExtension;
110 using support::cmd_ret;
111 using support::createBufferTmpDir;
112 using support::destroyDir;
113 using support::FileName;
114 using support::getFormatFromContents;
115 using support::libFileSearch;
116 using support::latex_path;
117 using support::ltrim;
118 using support::makeAbsPath;
119 using support::makeDisplayPath;
120 using support::makeLatexName;
121 using support::onlyFilename;
122 using support::onlyPath;
123 using support::quoteName;
124 using support::removeAutosaveFile;
125 using support::rename;
126 using support::runCommand;
127 using support::split;
128 using support::subst;
129 using support::tempName;
133 namespace Alert = frontend::Alert;
134 namespace os = support::os;
135 namespace fs = boost::filesystem;
139 int const LYX_FORMAT = 278;
144 typedef std::map<string, bool> DepClean;
149 Impl(Buffer & parent, FileName const & file, bool readonly);
151 limited_stack<Undo> undostack;
152 limited_stack<Undo> redostack;
158 /// need to regenerate .tex?
162 mutable bool lyx_clean;
164 /// is autosave needed?
165 mutable bool bak_clean;
167 /// is this a unnamed file (New...)?
173 /// name of the file the buffer is associated with.
176 /** Set to true only when the file is fully loaded.
177 * Used to prevent the premature generation of previews
178 * and by the citation inset.
180 bool file_fully_loaded;
182 /// our Text that should be wrapped in an InsetText
189 TocBackend toc_backend;
191 /// Container for all sort of Buffer dependant errors.
192 map<string, ErrorList> errorLists;
194 /// timestamp and checksum used to test if the file has been externally
195 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
197 unsigned long checksum_;
201 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
202 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
203 filename(file), file_fully_loaded(false), inset(params),
204 toc_backend(&parent), timestamp_(0), checksum_(0)
206 inset.setAutoBreakRows(true);
207 lyxvc.buffer(&parent);
208 temppath = createBufferTmpDir();
209 params.filepath = onlyPath(file.absFilename());
210 // FIXME: And now do something if temppath == string(), because we
211 // assume from now on that temppath points to a valid temp dir.
212 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
216 Buffer::Buffer(string const & file, bool readonly)
217 : pimpl_(new Impl(*this, FileName(file), readonly))
219 LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
225 LYXERR(Debug::INFO) << "Buffer::~Buffer()" << endl;
226 // here the buffer should take care that it is
227 // saved properly, before it goes into the void.
231 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
232 Alert::warning(_("Could not remove temporary directory"),
233 bformat(_("Could not remove the temporary directory %1$s"),
234 from_utf8(temppath())));
237 // Remove any previewed LaTeX snippets associated with this buffer.
238 graphics::Previews::get().removeLoader(*this);
242 Text & Buffer::text() const
244 return const_cast<Text &>(pimpl_->inset.text_);
248 Inset & Buffer::inset() const
250 return const_cast<InsetText &>(pimpl_->inset);
254 limited_stack<Undo> & Buffer::undostack()
256 return pimpl_->undostack;
260 limited_stack<Undo> const & Buffer::undostack() const
262 return pimpl_->undostack;
266 limited_stack<Undo> & Buffer::redostack()
268 return pimpl_->redostack;
272 limited_stack<Undo> const & Buffer::redostack() const
274 return pimpl_->redostack;
278 BufferParams & Buffer::params()
280 return pimpl_->params;
284 BufferParams const & Buffer::params() const
286 return pimpl_->params;
290 ParagraphList & Buffer::paragraphs()
292 return text().paragraphs();
296 ParagraphList const & Buffer::paragraphs() const
298 return text().paragraphs();
302 LyXVC & Buffer::lyxvc()
304 return pimpl_->lyxvc;
308 LyXVC const & Buffer::lyxvc() const
310 return pimpl_->lyxvc;
314 string const & Buffer::temppath() const
316 return pimpl_->temppath;
320 TexRow & Buffer::texrow()
322 return pimpl_->texrow;
326 TexRow const & Buffer::texrow() const
328 return pimpl_->texrow;
332 TocBackend & Buffer::tocBackend()
334 return pimpl_->toc_backend;
338 TocBackend const & Buffer::tocBackend() const
340 return pimpl_->toc_backend;
344 string const Buffer::getLatexName(bool const no_path) const
346 string const name = changeExtension(makeLatexName(fileName()), ".tex");
347 return no_path ? onlyFilename(name) : name;
351 pair<Buffer::LogType, string> const Buffer::getLogName() const
353 string const filename = getLatexName(false);
355 if (filename.empty())
356 return make_pair(Buffer::latexlog, string());
358 string const path = temppath();
360 FileName const fname(addName(temppath(),
361 onlyFilename(changeExtension(filename,
363 FileName const bname(
364 addName(path, onlyFilename(
365 changeExtension(filename,
366 formats.extension("literate") + ".out"))));
368 // If no Latex log or Build log is newer, show Build log
370 if (fs::exists(bname.toFilesystemEncoding()) &&
371 (!fs::exists(fname.toFilesystemEncoding()) ||
372 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
373 LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
374 return make_pair(Buffer::buildlog, bname.absFilename());
376 LYXERR(Debug::FILES) << "Log name calculated as: " << fname << endl;
377 return make_pair(Buffer::latexlog, fname.absFilename());
381 void Buffer::setReadonly(bool const flag)
383 if (pimpl_->read_only != flag) {
384 pimpl_->read_only = flag;
390 void Buffer::setFileName(string const & newfile)
392 pimpl_->filename = makeAbsPath(newfile);
393 params().filepath = onlyPath(pimpl_->filename.absFilename());
394 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
399 // We'll remove this later. (Lgb)
402 void unknownClass(string const & unknown)
404 Alert::warning(_("Unknown document class"),
405 bformat(_("Using the default document class, because the "
406 "class %1$s is unknown."), from_utf8(unknown)));
412 int Buffer::readHeader(Lexer & lex)
414 int unknown_tokens = 0;
416 int begin_header_line = -1;
418 // Initialize parameters that may be/go lacking in header:
419 params().branchlist().clear();
420 params().preamble.erase();
421 params().options.erase();
422 params().float_placement.erase();
423 params().paperwidth.erase();
424 params().paperheight.erase();
425 params().leftmargin.erase();
426 params().rightmargin.erase();
427 params().topmargin.erase();
428 params().bottommargin.erase();
429 params().headheight.erase();
430 params().headsep.erase();
431 params().footskip.erase();
432 params().listings_params.clear();
433 for (int i = 0; i < 4; ++i) {
434 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
435 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
438 ErrorList & errorList = pimpl_->errorLists["Parse"];
442 string const token = lex.getString();
447 if (token == "\\end_header")
451 if (token == "\\begin_header") {
452 begin_header_line = line;
456 LYXERR(Debug::PARSER) << "Handling document header token: `"
457 << token << '\'' << endl;
459 string unknown = params().readToken(lex, token);
460 if (!unknown.empty()) {
461 if (unknown[0] != '\\' && token == "\\textclass") {
462 unknownClass(unknown);
465 docstring const s = bformat(_("Unknown token: "
469 errorList.push_back(ErrorItem(_("Document header error"),
474 if (begin_header_line) {
475 docstring const s = _("\\begin_header is missing");
476 errorList.push_back(ErrorItem(_("Document header error"),
480 return unknown_tokens;
485 // changed to be public and have one parameter
486 // Returns false if "\end_document" is not read (Asger)
487 bool Buffer::readDocument(Lexer & lex)
489 ErrorList & errorList = pimpl_->errorLists["Parse"];
493 string const token = lex.getString();
494 if (token != "\\begin_document") {
495 docstring const s = _("\\begin_document is missing");
496 errorList.push_back(ErrorItem(_("Document header error"),
500 // we are reading in a brand new document
501 BOOST_ASSERT(paragraphs().empty());
504 if (!params().getTextClass().load(filePath())) {
505 string theclass = params().getTextClass().name();
506 Alert::error(_("Can't load document class"), bformat(
507 _("Using the default document class, because the "
508 "class %1$s could not be loaded."), from_utf8(theclass)));
509 params().textclass = 0;
512 if (params().outputChanges) {
513 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
514 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
515 LaTeXFeatures::isAvailable("xcolor");
517 if (!dvipost && !xcolorsoul) {
518 Alert::warning(_("Changes not shown in LaTeX output"),
519 _("Changes will not be highlighted in LaTeX output, "
520 "because neither dvipost nor xcolor/soul are installed.\n"
521 "Please install these packages or redefine "
522 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
523 } else if (!xcolorsoul) {
524 Alert::warning(_("Changes not shown in LaTeX output"),
525 _("Changes will not be highlighted in LaTeX output "
526 "when using pdflatex, because xcolor and soul are not installed.\n"
527 "Please install both packages or redefine "
528 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
532 bool const res = text().read(*this, lex, errorList);
533 for_each(text().paragraphs().begin(),
534 text().paragraphs().end(),
535 bind(&Paragraph::setInsetOwner, _1, &inset()));
541 // needed to insert the selection
542 void Buffer::insertStringAsLines(ParagraphList & pars,
543 pit_type & pit, pos_type & pos,
544 Font const & fn, docstring const & str, bool autobreakrows)
548 // insert the string, don't insert doublespace
549 bool space_inserted = true;
550 for (docstring::const_iterator cit = str.begin();
551 cit != str.end(); ++cit) {
552 Paragraph & par = pars[pit];
554 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
555 breakParagraph(params(), pars, pit, pos,
556 par.layout()->isEnvironment());
559 space_inserted = true;
563 // do not insert consecutive spaces if !free_spacing
564 } else if ((*cit == ' ' || *cit == '\t') &&
565 space_inserted && !par.isFreeSpacing()) {
567 } else if (*cit == '\t') {
568 if (!par.isFreeSpacing()) {
569 // tabs are like spaces here
570 par.insertChar(pos, ' ', font, params().trackChanges);
572 space_inserted = true;
574 const pos_type n = 8 - pos % 8;
575 for (pos_type i = 0; i < n; ++i) {
576 par.insertChar(pos, ' ', font, params().trackChanges);
579 space_inserted = true;
581 } else if (!isPrintable(*cit)) {
582 // Ignore unprintables
585 // just insert the character
586 par.insertChar(pos, *cit, font, params().trackChanges);
588 space_inserted = (*cit == ' ');
595 bool Buffer::readString(std::string const & s)
597 params().compressed = false;
599 // remove dummy empty par
600 paragraphs().clear();
602 std::istringstream is(s);
604 FileName const name(tempName());
605 switch (readFile(lex, name, true)) {
609 // We need to call lyx2lyx, so write the input to a file
610 std::ofstream os(name.toFilesystemEncoding().c_str());
613 return readFile(name);
623 bool Buffer::readFile(FileName const & filename)
625 // Check if the file is compressed.
626 string const format = getFormatFromContents(filename);
627 if (format == "gzip" || format == "zip" || format == "compress") {
628 params().compressed = true;
631 // remove dummy empty par
632 paragraphs().clear();
634 lex.setFile(filename);
635 if (readFile(lex, filename) != success)
642 bool Buffer::fully_loaded() const
644 return pimpl_->file_fully_loaded;
648 void Buffer::fully_loaded(bool const value)
650 pimpl_->file_fully_loaded = value;
654 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
657 BOOST_ASSERT(!filename.empty());
660 Alert::error(_("Document could not be read"),
661 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
666 string const token(lex.getString());
669 Alert::error(_("Document could not be read"),
670 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
674 // the first token _must_ be...
675 if (token != "\\lyxformat") {
676 lyxerr << "Token: " << token << endl;
678 Alert::error(_("Document format failure"),
679 bformat(_("%1$s is not a LyX document."),
680 from_utf8(filename.absFilename())));
685 string tmp_format = lex.getString();
686 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
687 // if present remove ".," from string.
688 string::size_type dot = tmp_format.find_first_of(".,");
689 //lyxerr << " dot found at " << dot << endl;
690 if (dot != string::npos)
691 tmp_format.erase(dot, 1);
692 int const file_format = convert<int>(tmp_format);
693 //lyxerr << "format: " << file_format << endl;
695 if (file_format != LYX_FORMAT) {
698 // lyx2lyx would fail
701 FileName const tmpfile(tempName());
702 if (tmpfile.empty()) {
703 Alert::error(_("Conversion failed"),
704 bformat(_("%1$s is from a different"
705 " version of LyX, but a temporary"
706 " file for converting it could"
708 from_utf8(filename.absFilename())));
711 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
712 if (lyx2lyx.empty()) {
713 Alert::error(_("Conversion script not found"),
714 bformat(_("%1$s is from a different"
715 " version of LyX, but the"
716 " conversion script lyx2lyx"
717 " could not be found."),
718 from_utf8(filename.absFilename())));
721 ostringstream command;
722 command << os::python()
723 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
724 << " -t " << convert<string>(LYX_FORMAT)
725 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
726 << ' ' << quoteName(filename.toFilesystemEncoding());
727 string const command_str = command.str();
729 LYXERR(Debug::INFO) << "Running '"
730 << command_str << '\''
733 cmd_ret const ret = runCommand(command_str);
734 if (ret.first != 0) {
735 Alert::error(_("Conversion script failed"),
736 bformat(_("%1$s is from a different version"
737 " of LyX, but the lyx2lyx script"
738 " failed to convert it."),
739 from_utf8(filename.absFilename())));
742 bool const ret = readFile(tmpfile);
743 // Do stuff with tmpfile name and buffer name here.
744 return ret ? success : failure;
749 if (readDocument(lex)) {
750 Alert::error(_("Document format failure"),
751 bformat(_("%1$s ended unexpectedly, which means"
752 " that it is probably corrupted."),
753 from_utf8(filename.absFilename())));
756 //lyxerr << "removing " << MacroTable::localMacros().size()
757 // << " temporary macro entries" << endl;
758 //MacroTable::localMacros().clear();
760 pimpl_->file_fully_loaded = true;
761 // save the timestamp and checksum of disk file
762 pimpl_->timestamp_ = fs::last_write_time(filename.toFilesystemEncoding());
763 pimpl_->checksum_ = sum(filename);
768 // Should probably be moved to somewhere else: BufferView? LyXView?
769 bool Buffer::save() const
771 // We don't need autosaves in the immediate future. (Asger)
772 resetAutosaveTimers();
774 string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
777 bool madeBackup = false;
779 // make a backup if the file already exists
780 if (lyxrc.make_backup && fs::exists(encodedFilename)) {
781 backupName = FileName(fileName() + '~');
782 if (!lyxrc.backupdir_path.empty())
783 backupName = FileName(addName(lyxrc.backupdir_path,
784 subst(os::internal_path(backupName.absFilename()), '/', '!')));
787 fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
789 } catch (fs::filesystem_error const & fe) {
790 Alert::error(_("Backup failure"),
791 bformat(_("Cannot create backup file %1$s.\n"
792 "Please check whether the directory exists and is writeable."),
793 from_utf8(backupName.absFilename())));
794 LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
798 // ask if the disk file has been externally modified (use checksum method)
799 if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
800 docstring const file = makeDisplayPath(fileName(), 20);
801 docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
802 "you want to overwrite this file?"), file);
803 int const ret = Alert::prompt(_("Overwrite modified file?"),
804 text, 1, 1, _("&Overwrite"), _("&Cancel"));
809 if (writeFile(pimpl_->filename)) {
811 removeAutosaveFile(fileName());
812 pimpl_->timestamp_ = fs::last_write_time(pimpl_->filename.toFilesystemEncoding());
813 pimpl_->checksum_ = sum(pimpl_->filename);
816 // Saving failed, so backup is not backup
818 rename(backupName, pimpl_->filename);
824 bool Buffer::writeFile(FileName const & fname) const
826 if (pimpl_->read_only && fname == pimpl_->filename)
831 if (params().compressed) {
832 gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
838 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
849 bool Buffer::write(ostream & ofs) const
852 // Use the standard "C" locale for file output.
853 ofs.imbue(std::locale::classic());
856 // The top of the file should not be written by params().
858 // write out a comment in the top of the file
859 ofs << "#LyX " << lyx_version
860 << " created this file. For more info see http://www.lyx.org/\n"
861 << "\\lyxformat " << LYX_FORMAT << "\n"
862 << "\\begin_document\n";
865 /// For each author, set 'used' to true if there is a change
866 /// by this author in the document; otherwise set it to 'false'.
867 AuthorList::Authors::const_iterator a_it = params().authors().begin();
868 AuthorList::Authors::const_iterator a_end = params().authors().end();
869 for (; a_it != a_end; ++a_it)
870 a_it->second.used(false);
872 ParIterator const end = par_iterator_end();
873 ParIterator it = par_iterator_begin();
874 for ( ; it != end; ++it)
875 it->checkAuthors(params().authors());
877 // now write out the buffer parameters.
878 ofs << "\\begin_header\n";
879 params().writeFile(ofs);
880 ofs << "\\end_header\n";
883 ofs << "\n\\begin_body\n";
884 text().write(*this, ofs);
885 ofs << "\n\\end_body\n";
887 // Write marker that shows file is complete
888 ofs << "\\end_document" << endl;
890 // Shouldn't really be needed....
893 // how to check if close went ok?
894 // Following is an attempt... (BE 20001011)
896 // good() returns false if any error occured, including some
898 // bad() returns true if something bad happened in the buffer,
899 // which should include file system full errors.
904 lyxerr << "File was not closed properly." << endl;
911 bool Buffer::makeLaTeXFile(FileName const & fname,
912 string const & original_path,
913 OutputParams const & runparams,
914 bool output_preamble, bool output_body)
916 string const encoding = runparams.encoding->iconvName();
917 LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
918 << encoding << "..." << endl;
920 odocfstream ofs(encoding);
921 if (!openFileWrite(ofs, fname))
924 //TexStream ts(ofs.rdbuf(), &texrow());
926 bool failed_export = false;
929 writeLaTeXSource(ofs, original_path,
930 runparams, output_preamble, output_body);
932 catch (iconv_codecvt_facet_exception & e) {
933 lyxerr << "Caught iconv exception: " << e.what() << endl;
934 failed_export = true;
936 catch (std::exception const & e) {
937 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
938 failed_export = true;
941 lyxerr << "Caught some really weird exception..." << endl;
942 LyX::cref().emergencyCleanup();
948 failed_export = true;
949 lyxerr << "File '" << fname << "' was not closed properly." << endl;
953 Alert::error(_("Encoding error"),
954 _("Some characters of your document are probably not "
955 "representable in the chosen encoding.\n"
956 "Changing the document encoding to utf8 could help."));
963 void Buffer::writeLaTeXSource(odocstream & os,
964 string const & original_path,
965 OutputParams const & runparams_in,
966 bool const output_preamble, bool const output_body)
968 OutputParams runparams = runparams_in;
970 // validate the buffer.
971 LYXERR(Debug::LATEX) << " Validating buffer..." << endl;
972 LaTeXFeatures features(*this, params(), runparams);
974 LYXERR(Debug::LATEX) << " Buffer validation done." << endl;
976 // The starting paragraph of the coming rows is the
977 // first paragraph of the document. (Asger)
978 if (output_preamble && runparams.nice) {
979 os << "%% LyX " << lyx_version << " created this file. "
980 "For more info, see http://www.lyx.org/.\n"
981 "%% Do not edit unless you really know what "
986 LYXERR(Debug::INFO) << "lyx document header finished" << endl;
987 // There are a few differences between nice LaTeX and usual files:
988 // usual is \batchmode and has a
989 // special input@path to allow the including of figures
990 // with either \input or \includegraphics (what figinsets do).
991 // input@path is set when the actual parameter
992 // original_path is set. This is done for usual tex-file, but not
993 // for nice-latex-file. (Matthias 250696)
994 // Note that input@path is only needed for something the user does
995 // in the preamble, included .tex files or ERT, files included by
996 // LyX work without it.
997 if (output_preamble) {
998 if (!runparams.nice) {
999 // code for usual, NOT nice-latex-file
1000 os << "\\batchmode\n"; // changed
1001 // from \nonstopmode
1004 if (!original_path.empty()) {
1006 // We don't know the encoding of inputpath
1007 docstring const inputpath = from_utf8(latex_path(original_path));
1008 os << "\\makeatletter\n"
1009 << "\\def\\input@path{{"
1010 << inputpath << "/}}\n"
1011 << "\\makeatother\n";
1017 // Write the preamble
1018 runparams.use_babel = params().writeLaTeX(os, features, texrow());
1024 os << "\\begin{document}\n";
1026 } // output_preamble
1028 texrow().start(paragraphs().begin()->id(), 0);
1030 LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
1032 if (!lyxrc.language_auto_begin &&
1033 !params().language->babel().empty()) {
1035 os << from_utf8(subst(lyxrc.language_command_begin,
1037 params().language->babel()))
1042 Encoding const & encoding = params().encoding();
1043 if (encoding.package() == Encoding::CJK) {
1044 // Open a CJK environment, since in contrast to the encodings
1045 // handled by inputenc the document encoding is not set in
1046 // the preamble if it is handled by CJK.sty.
1047 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1052 // if we are doing a real file with body, even if this is the
1053 // child of some other buffer, let's cut the link here.
1054 // This happens for example if only a child document is printed.
1055 string save_parentname;
1056 if (output_preamble) {
1057 save_parentname = params().parentname;
1058 params().parentname.erase();
1062 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1064 // Restore the parenthood if needed
1065 if (output_preamble)
1066 params().parentname = save_parentname;
1068 // add this just in case after all the paragraphs
1072 if (encoding.package() == Encoding::CJK) {
1073 // Close the open CJK environment.
1074 // latexParagraphs will have opened one even if the last text
1076 os << "\\end{CJK}\n";
1080 if (!lyxrc.language_auto_end &&
1081 !params().language->babel().empty()) {
1082 os << from_utf8(subst(lyxrc.language_command_end,
1084 params().language->babel()))
1089 if (output_preamble) {
1090 os << "\\end{document}\n";
1093 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1095 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1098 runparams_in.encoding = runparams.encoding;
1100 // Just to be sure. (Asger)
1103 LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1104 LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1109 bool Buffer::isLatex() const
1111 return params().getTextClass().outputType() == LATEX;
1115 bool Buffer::isLiterate() const
1117 return params().getTextClass().outputType() == LITERATE;
1121 bool Buffer::isDocBook() const
1123 return params().getTextClass().outputType() == DOCBOOK;
1127 void Buffer::makeDocBookFile(FileName const & fname,
1128 OutputParams const & runparams,
1129 bool const body_only)
1131 LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1135 if (!openFileWrite(ofs, fname))
1138 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1142 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1146 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1147 OutputParams const & runparams,
1148 bool const only_body)
1150 LaTeXFeatures features(*this, params(), runparams);
1155 TextClass const & tclass = params().getTextClass();
1156 string const top_element = tclass.latexname();
1159 if (runparams.flavor == OutputParams::XML)
1160 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1163 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1166 if (! tclass.class_header().empty())
1167 os << from_ascii(tclass.class_header());
1168 else if (runparams.flavor == OutputParams::XML)
1169 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1170 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1172 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1174 docstring preamble = from_utf8(params().preamble);
1175 if (runparams.flavor != OutputParams::XML ) {
1176 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1177 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1178 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1179 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1182 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1184 preamble += features.getIncludedFiles(name);
1185 preamble += features.getLyXSGMLEntities();
1187 if (!preamble.empty()) {
1188 os << "\n [ " << preamble << " ]";
1193 string top = top_element;
1195 if (runparams.flavor == OutputParams::XML)
1196 top += params().language->code();
1198 top += params().language->code().substr(0,2);
1201 if (!params().options.empty()) {
1203 top += params().options;
1206 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1207 << " file was created by LyX " << lyx_version
1208 << "\n See http://www.lyx.org/ for more information -->\n";
1210 params().getTextClass().counters().reset();
1212 sgml::openTag(os, top);
1214 docbookParagraphs(paragraphs(), *this, os, runparams);
1215 sgml::closeTag(os, top_element);
1219 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1220 // Other flags: -wall -v0 -x
1221 int Buffer::runChktex()
1225 // get LaTeX-Filename
1226 FileName const path(temppath());
1227 string const name = addName(path.absFilename(), getLatexName());
1228 string const org_path = filePath();
1230 support::Path p(path); // path to LaTeX file
1231 message(_("Running chktex..."));
1233 // Generate the LaTeX file if neccessary
1234 OutputParams runparams(¶ms().encoding());
1235 runparams.flavor = OutputParams::LATEX;
1236 runparams.nice = false;
1237 makeLaTeXFile(FileName(name), org_path, runparams);
1240 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1241 int const res = chktex.run(terr); // run chktex
1244 Alert::error(_("chktex failure"),
1245 _("Could not run chktex successfully."));
1246 } else if (res > 0) {
1247 ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
1248 // Clear out old errors
1250 // Fill-in the error list with the TeX errors
1251 bufferErrors(*this, terr, errorList);
1262 void Buffer::validate(LaTeXFeatures & features) const
1264 TextClass const & tclass = params().getTextClass();
1266 if (params().outputChanges) {
1267 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1268 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1269 LaTeXFeatures::isAvailable("xcolor");
1271 if (features.runparams().flavor == OutputParams::LATEX) {
1273 features.require("ct-dvipost");
1274 features.require("dvipost");
1275 } else if (xcolorsoul) {
1276 features.require("ct-xcolor-soul");
1277 features.require("soul");
1278 features.require("xcolor");
1280 features.require("ct-none");
1282 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1284 features.require("ct-xcolor-soul");
1285 features.require("soul");
1286 features.require("xcolor");
1287 features.require("pdfcolmk"); // improves color handling in PDF output
1289 features.require("ct-none");
1294 // AMS Style is at document level
1295 if (params().use_amsmath == BufferParams::package_on
1296 || tclass.provides("amsmath"))
1297 features.require("amsmath");
1298 if (params().use_esint == BufferParams::package_on)
1299 features.require("esint");
1301 for_each(paragraphs().begin(), paragraphs().end(),
1302 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1304 // the bullet shapes are buffer level not paragraph level
1305 // so they are tested here
1306 for (int i = 0; i < 4; ++i) {
1307 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1308 int const font = params().user_defined_bullet(i).getFont();
1310 int const c = params()
1311 .user_defined_bullet(i)
1318 features.require("latexsym");
1320 } else if (font == 1) {
1321 features.require("amssymb");
1322 } else if ((font >= 2 && font <= 5)) {
1323 features.require("pifont");
1328 if (lyxerr.debugging(Debug::LATEX)) {
1329 features.showStruct();
1334 void Buffer::getLabelList(vector<docstring> & list) const
1336 /// if this is a child document and the parent is already loaded
1337 /// Use the parent's list instead [ale990407]
1338 Buffer const * tmp = getMasterBuffer();
1340 lyxerr << "getMasterBuffer() failed!" << endl;
1344 tmp->getLabelList(list);
1348 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1349 it.nextInset()->getLabelList(*this, list);
1353 // This is also a buffer property (ale)
1354 void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
1357 biblio::fillWithBibKeys(this, keys);
1361 void Buffer::updateBibfilesCache()
1363 // if this is a child document and the parent is already loaded
1364 // update the parent's cache instead
1365 Buffer * tmp = getMasterBuffer();
1368 tmp->updateBibfilesCache();
1372 bibfilesCache_.clear();
1373 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1374 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1375 InsetBibtex const & inset =
1376 static_cast<InsetBibtex const &>(*it);
1377 vector<FileName> const bibfiles = inset.getFiles(*this);
1378 bibfilesCache_.insert(bibfilesCache_.end(),
1381 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1382 InsetInclude & inset =
1383 static_cast<InsetInclude &>(*it);
1384 inset.updateBibfilesCache(*this);
1385 vector<FileName> const & bibfiles =
1386 inset.getBibfilesCache(*this);
1387 bibfilesCache_.insert(bibfilesCache_.end(),
1395 vector<FileName> const & Buffer::getBibfilesCache() const
1397 // if this is a child document and the parent is already loaded
1398 // use the parent's cache instead
1399 Buffer const * tmp = getMasterBuffer();
1402 return tmp->getBibfilesCache();
1404 // We update the cache when first used instead of at loading time.
1405 if (bibfilesCache_.empty())
1406 const_cast<Buffer *>(this)->updateBibfilesCache();
1408 return bibfilesCache_;
1412 bool Buffer::isDepClean(string const & name) const
1414 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1415 if (it == pimpl_->dep_clean.end())
1421 void Buffer::markDepClean(string const & name)
1423 pimpl_->dep_clean[name] = true;
1427 bool Buffer::dispatch(string const & command, bool * result)
1429 return dispatch(lyxaction.lookupFunc(command), result);
1433 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1435 bool dispatched = true;
1437 switch (func.action) {
1438 case LFUN_BUFFER_EXPORT: {
1439 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1452 void Buffer::changeLanguage(Language const * from, Language const * to)
1457 for_each(par_iterator_begin(),
1459 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1461 text().current_font.setLanguage(to);
1462 text().real_current_font.setLanguage(to);
1466 bool Buffer::isMultiLingual() const
1468 ParConstIterator end = par_iterator_end();
1469 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1470 if (it->isMultiLingual(params()))
1477 ParIterator Buffer::getParFromID(int const id) const
1479 ParConstIterator it = par_iterator_begin();
1480 ParConstIterator const end = par_iterator_end();
1483 // John says this is called with id == -1 from undo
1484 lyxerr << "getParFromID(), id: " << id << endl;
1488 for (; it != end; ++it)
1496 bool Buffer::hasParWithID(int const id) const
1498 ParConstIterator const it = getParFromID(id);
1499 return it != par_iterator_end();
1503 ParIterator Buffer::par_iterator_begin()
1505 return lyx::par_iterator_begin(inset());
1509 ParIterator Buffer::par_iterator_end()
1511 return lyx::par_iterator_end(inset());
1515 ParConstIterator Buffer::par_iterator_begin() const
1517 return lyx::par_const_iterator_begin(inset());
1521 ParConstIterator Buffer::par_iterator_end() const
1523 return lyx::par_const_iterator_end(inset());
1527 Language const * Buffer::getLanguage() const
1529 return params().language;
1533 docstring const Buffer::B_(string const & l10n) const
1535 return params().B_(l10n);
1539 bool Buffer::isClean() const
1541 return pimpl_->lyx_clean;
1545 bool Buffer::isBakClean() const
1547 return pimpl_->bak_clean;
1551 bool Buffer::isExternallyModified(CheckMethod method) const
1553 BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
1554 // if method == timestamp, check timestamp before checksum
1555 return (method == checksum_method
1556 || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
1557 && pimpl_->checksum_ != sum(pimpl_->filename);
1561 void Buffer::markClean() const
1563 if (!pimpl_->lyx_clean) {
1564 pimpl_->lyx_clean = true;
1567 // if the .lyx file has been saved, we don't need an
1569 pimpl_->bak_clean = true;
1573 void Buffer::markBakClean()
1575 pimpl_->bak_clean = true;
1579 void Buffer::setUnnamed(bool flag)
1581 pimpl_->unnamed = flag;
1585 bool Buffer::isUnnamed() const
1587 return pimpl_->unnamed;
1591 // FIXME: this function should be moved to buffer_pimpl.C
1592 void Buffer::markDirty()
1594 if (pimpl_->lyx_clean) {
1595 pimpl_->lyx_clean = false;
1598 pimpl_->bak_clean = false;
1600 DepClean::iterator it = pimpl_->dep_clean.begin();
1601 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1603 for (; it != end; ++it)
1608 string const Buffer::fileName() const
1610 return pimpl_->filename.absFilename();
1614 string const & Buffer::filePath() const
1616 return params().filepath;
1620 bool Buffer::isReadonly() const
1622 return pimpl_->read_only;
1626 void Buffer::setParentName(string const & name)
1628 if (name == pimpl_->filename.absFilename())
1629 // Avoids recursive include.
1630 params().parentname.clear();
1632 params().parentname = name;
1636 Buffer const * Buffer::getMasterBuffer() const
1638 if (!params().parentname.empty()
1639 && theBufferList().exists(params().parentname)) {
1640 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1641 //We need to check if the parent is us...
1642 //FIXME RECURSIVE INCLUDE
1643 //This is not sufficient, since recursive includes could be downstream.
1644 if (buf && buf != this)
1645 return buf->getMasterBuffer();
1652 Buffer * Buffer::getMasterBuffer()
1654 if (!params().parentname.empty()
1655 && theBufferList().exists(params().parentname)) {
1656 Buffer * buf = theBufferList().getBuffer(params().parentname);
1658 return buf->getMasterBuffer();
1665 MacroData const & Buffer::getMacro(docstring const & name) const
1667 return pimpl_->macros.get(name);
1671 bool Buffer::hasMacro(docstring const & name) const
1673 return pimpl_->macros.has(name);
1677 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1679 MacroTable::globalMacros().insert(name, data);
1680 pimpl_->macros.insert(name, data);
1684 void Buffer::buildMacros()
1686 // Start with global table.
1687 pimpl_->macros = MacroTable::globalMacros();
1690 ParagraphList const & pars = text().paragraphs();
1691 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1692 //lyxerr << "searching main par " << i
1693 // << " for macro definitions" << std::endl;
1694 InsetList const & insets = pars[i].insetlist;
1695 InsetList::const_iterator it = insets.begin();
1696 InsetList::const_iterator end = insets.end();
1697 for ( ; it != end; ++it) {
1698 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1699 if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1700 MathMacroTemplate const & mac
1701 = static_cast<MathMacroTemplate const &>(*it->inset);
1702 insertMacro(mac.name(), mac.asMacroData());
1709 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1716 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1719 //FIXME: This does not work for child documents yet.
1720 BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1721 // Check if the label 'from' appears more than once
1722 vector<docstring> labels;
1724 if (code == Inset::CITE_CODE) {
1725 vector<pair<string, docstring> > keys;
1726 fillWithBibKeys(keys);
1727 vector<pair<string, docstring> >::const_iterator bit = keys.begin();
1728 vector<pair<string, docstring> >::const_iterator bend = keys.end();
1730 for (; bit != bend; ++bit)
1732 labels.push_back(from_utf8(bit->first));
1734 getLabelList(labels);
1736 if (std::count(labels.begin(), labels.end(), from) > 1)
1739 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1740 if (it->lyxCode() == code) {
1741 InsetCommand & inset = static_cast<InsetCommand &>(*it);
1742 inset.replaceContents(to_utf8(from), to_utf8(to));
1748 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1749 pit_type par_end, bool full_source)
1751 OutputParams runparams(¶ms().encoding());
1752 runparams.nice = true;
1753 runparams.flavor = OutputParams::LATEX;
1754 runparams.linelen = lyxrc.plaintext_linelen;
1755 // No side effect of file copying and image conversion
1756 runparams.dryrun = true;
1760 os << "% " << _("Preview source code") << "\n\n";
1764 writeLaTeXSource(os, filePath(), runparams, true, true);
1766 writeDocBookSource(os, fileName(), runparams, false);
1769 runparams.par_begin = par_begin;
1770 runparams.par_end = par_end;
1771 if (par_begin + 1 == par_end)
1773 << bformat(_("Preview source code for paragraph %1$d"), par_begin)
1777 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
1778 convert<docstring>(par_begin),
1779 convert<docstring>(par_end - 1))
1783 // output paragraphs
1785 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1788 docbookParagraphs(paragraphs(), *this, os, runparams);
1794 ErrorList const & Buffer::errorList(string const & type) const
1796 static ErrorList const emptyErrorList;
1797 std::map<string, ErrorList>::const_iterator I = pimpl_->errorLists.find(type);
1798 if (I == pimpl_->errorLists.end())
1799 return emptyErrorList;
1805 ErrorList & Buffer::errorList(string const & type)
1807 return pimpl_->errorLists[type];