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 "TocBackend.h"
54 #include "insets/InsetBibitem.h"
55 #include "insets/InsetBibtex.h"
56 #include "insets/InsetInclude.h"
57 #include "insets/InsetText.h"
59 #include "mathed/MathMacroTemplate.h"
60 #include "mathed/MacroTable.h"
61 #include "mathed/MathSupport.h"
63 #include "frontends/alert.h"
65 #include "graphics/Previews.h"
67 #include "support/types.h"
68 #include "support/lyxalgo.h"
69 #include "support/filetools.h"
70 #include "support/fs_extras.h"
71 #include "support/lyxlib.h"
72 #include "support/os.h"
73 #include "support/Path.h"
74 #include "support/textutils.h"
75 #include "support/convert.h"
77 #include <boost/iostreams/filtering_stream.hpp>
78 #include <boost/iostreams/filter/gzip.hpp>
79 #include <boost/iostreams/device/file.hpp>
80 #include <boost/bind.hpp>
81 #include <boost/filesystem/exception.hpp>
82 #include <boost/filesystem/operations.hpp>
84 #if defined (HAVE_UTIME_H)
86 #elif defined (HAVE_SYS_UTIME_H)
87 #include <sys/utime.h>
98 using support::addName;
99 using support::bformat;
100 using support::changeExtension;
101 using support::cmd_ret;
102 using support::createBufferTmpDir;
103 using support::destroyDir;
104 using support::FileName;
105 using support::getFormatFromContents;
106 using support::libFileSearch;
107 using support::latex_path;
108 using support::ltrim;
109 using support::makeAbsPath;
110 using support::makeDisplayPath;
111 using support::makeLatexName;
112 using support::onlyFilename;
113 using support::onlyPath;
114 using support::quoteName;
115 using support::removeAutosaveFile;
116 using support::rename;
117 using support::runCommand;
118 using support::split;
119 using support::subst;
120 using support::tempName;
123 namespace Alert = frontend::Alert;
124 namespace os = support::os;
125 namespace fs = boost::filesystem;
126 namespace io = boost::iostreams;
130 using std::make_pair;
135 using std::ostringstream;
145 int const LYX_FORMAT = 271;
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;
199 Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
200 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
201 filename(file), file_fully_loaded(false), inset(params),
204 inset.setAutoBreakRows(true);
205 lyxvc.buffer(&parent);
206 temppath = createBufferTmpDir();
207 params.filepath = onlyPath(file.absFilename());
208 // FIXME: And now do something if temppath == string(), because we
209 // assume from now on that temppath points to a valid temp dir.
210 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
214 Buffer::Buffer(string const & file, bool readonly)
215 : pimpl_(new Impl(*this, FileName(file), readonly))
217 LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
223 LYXERR(Debug::INFO) << "Buffer::~Buffer()" << endl;
224 // here the buffer should take care that it is
225 // saved properly, before it goes into the void.
229 if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
230 Alert::warning(_("Could not remove temporary directory"),
231 bformat(_("Could not remove the temporary directory %1$s"),
232 from_utf8(temppath())));
235 // Remove any previewed LaTeX snippets associated with this buffer.
236 graphics::Previews::get().removeLoader(*this);
240 Text & Buffer::text() const
242 return const_cast<Text &>(pimpl_->inset.text_);
246 Inset & Buffer::inset() const
248 return const_cast<InsetText &>(pimpl_->inset);
252 limited_stack<Undo> & Buffer::undostack()
254 return pimpl_->undostack;
258 limited_stack<Undo> const & Buffer::undostack() const
260 return pimpl_->undostack;
264 limited_stack<Undo> & Buffer::redostack()
266 return pimpl_->redostack;
270 limited_stack<Undo> const & Buffer::redostack() const
272 return pimpl_->redostack;
276 BufferParams & Buffer::params()
278 return pimpl_->params;
282 BufferParams const & Buffer::params() const
284 return pimpl_->params;
288 ParagraphList & Buffer::paragraphs()
290 return text().paragraphs();
294 ParagraphList const & Buffer::paragraphs() const
296 return text().paragraphs();
300 LyXVC & Buffer::lyxvc()
302 return pimpl_->lyxvc;
306 LyXVC const & Buffer::lyxvc() const
308 return pimpl_->lyxvc;
312 string const & Buffer::temppath() const
314 return pimpl_->temppath;
318 TexRow & Buffer::texrow()
320 return pimpl_->texrow;
324 TexRow const & Buffer::texrow() const
326 return pimpl_->texrow;
330 TocBackend & Buffer::tocBackend()
332 return pimpl_->toc_backend;
336 TocBackend const & Buffer::tocBackend() const
338 return pimpl_->toc_backend;
342 string const Buffer::getLatexName(bool const no_path) const
344 string const name = changeExtension(makeLatexName(fileName()), ".tex");
345 return no_path ? onlyFilename(name) : name;
349 pair<Buffer::LogType, string> const Buffer::getLogName() const
351 string const filename = getLatexName(false);
353 if (filename.empty())
354 return make_pair(Buffer::latexlog, string());
356 string const path = temppath();
358 FileName const fname(addName(temppath(),
359 onlyFilename(changeExtension(filename,
361 FileName const bname(
362 addName(path, onlyFilename(
363 changeExtension(filename,
364 formats.extension("literate") + ".out"))));
366 // If no Latex log or Build log is newer, show Build log
368 if (fs::exists(bname.toFilesystemEncoding()) &&
369 (!fs::exists(fname.toFilesystemEncoding()) ||
370 fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
371 LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
372 return make_pair(Buffer::buildlog, bname.absFilename());
374 LYXERR(Debug::FILES) << "Log name calculated as: " << fname << endl;
375 return make_pair(Buffer::latexlog, fname.absFilename());
379 void Buffer::setReadonly(bool const flag)
381 if (pimpl_->read_only != flag) {
382 pimpl_->read_only = flag;
388 void Buffer::setFileName(string const & newfile)
390 pimpl_->filename = makeAbsPath(newfile);
391 params().filepath = onlyPath(pimpl_->filename.absFilename());
392 setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
397 // We'll remove this later. (Lgb)
400 void unknownClass(string const & unknown)
402 Alert::warning(_("Unknown document class"),
403 bformat(_("Using the default document class, because the "
404 "class %1$s is unknown."), from_utf8(unknown)));
410 int Buffer::readHeader(Lexer & lex)
412 int unknown_tokens = 0;
414 int begin_header_line = -1;
416 // Initialize parameters that may be/go lacking in header:
417 params().branchlist().clear();
418 params().preamble.erase();
419 params().options.erase();
420 params().float_placement.erase();
421 params().paperwidth.erase();
422 params().paperheight.erase();
423 params().leftmargin.erase();
424 params().rightmargin.erase();
425 params().topmargin.erase();
426 params().bottommargin.erase();
427 params().headheight.erase();
428 params().headsep.erase();
429 params().footskip.erase();
430 for (int i = 0; i < 4; ++i) {
431 params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
432 params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
435 ErrorList & errorList = errorLists_["Parse"];
439 string const token = lex.getString();
444 if (token == "\\end_header")
448 if (token == "\\begin_header") {
449 begin_header_line = line;
453 LYXERR(Debug::PARSER) << "Handling document header token: `"
454 << token << '\'' << endl;
456 string unknown = params().readToken(lex, token);
457 if (!unknown.empty()) {
458 if (unknown[0] != '\\' && token == "\\textclass") {
459 unknownClass(unknown);
462 docstring const s = bformat(_("Unknown token: "
466 errorList.push_back(ErrorItem(_("Document header error"),
471 if (begin_header_line) {
472 docstring const s = _("\\begin_header is missing");
473 errorList.push_back(ErrorItem(_("Document header error"),
477 return unknown_tokens;
482 // changed to be public and have one parameter
483 // Returns false if "\end_document" is not read (Asger)
484 bool Buffer::readDocument(Lexer & lex)
486 ErrorList & errorList = errorLists_["Parse"];
490 string const token = lex.getString();
491 if (token != "\\begin_document") {
492 docstring const s = _("\\begin_document is missing");
493 errorList.push_back(ErrorItem(_("Document header error"),
497 // we are reading in a brand new document
498 BOOST_ASSERT(paragraphs().empty());
501 if (!params().getTextClass().load(filePath())) {
502 string theclass = params().getTextClass().name();
503 Alert::error(_("Can't load document class"), bformat(
504 _("Using the default document class, because the "
505 "class %1$s could not be loaded."), from_utf8(theclass)));
506 params().textclass = 0;
509 if (params().outputChanges) {
510 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
511 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
512 LaTeXFeatures::isAvailable("xcolor");
514 if (!dvipost && !xcolorsoul) {
515 Alert::warning(_("Changes not shown in LaTeX output"),
516 _("Changes will not be highlighted in LaTeX output, "
517 "because neither dvipost nor xcolor/soul are installed.\n"
518 "Please install these packages or redefine "
519 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
520 } else if (!xcolorsoul) {
521 Alert::warning(_("Changes not shown in LaTeX output"),
522 _("Changes will not be highlighted in LaTeX output "
523 "when using pdflatex, because xcolor and soul are not installed.\n"
524 "Please install both packages or redefine "
525 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
529 bool const res = text().read(*this, lex, errorList);
530 for_each(text().paragraphs().begin(),
531 text().paragraphs().end(),
532 bind(&Paragraph::setInsetOwner, _1, &inset()));
538 // needed to insert the selection
539 void Buffer::insertStringAsLines(ParagraphList & pars,
540 pit_type & pit, pos_type & pos,
541 Font const & fn, docstring const & str, bool autobreakrows)
545 // insert the string, don't insert doublespace
546 bool space_inserted = true;
547 for (docstring::const_iterator cit = str.begin();
548 cit != str.end(); ++cit) {
549 Paragraph & par = pars[pit];
551 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
552 breakParagraph(params(), pars, pit, pos,
553 par.layout()->isEnvironment());
556 space_inserted = true;
560 // do not insert consecutive spaces if !free_spacing
561 } else if ((*cit == ' ' || *cit == '\t') &&
562 space_inserted && !par.isFreeSpacing()) {
564 } else if (*cit == '\t') {
565 if (!par.isFreeSpacing()) {
566 // tabs are like spaces here
567 par.insertChar(pos, ' ', font, params().trackChanges);
569 space_inserted = true;
571 const pos_type n = 8 - pos % 8;
572 for (pos_type i = 0; i < n; ++i) {
573 par.insertChar(pos, ' ', font, params().trackChanges);
576 space_inserted = true;
578 } else if (!isPrintable(*cit)) {
579 // Ignore unprintables
582 // just insert the character
583 par.insertChar(pos, *cit, font, params().trackChanges);
585 space_inserted = (*cit == ' ');
592 bool Buffer::readString(std::string const & s)
594 params().compressed = false;
596 // remove dummy empty par
597 paragraphs().clear();
599 std::istringstream is(s);
601 FileName const name(tempName());
602 switch (readFile(lex, name, true)) {
606 // We need to call lyx2lyx, so write the input to a file
607 std::ofstream os(name.toFilesystemEncoding().c_str());
610 return readFile(name);
620 bool Buffer::readFile(FileName const & filename)
622 // Check if the file is compressed.
623 string const format = getFormatFromContents(filename);
624 if (format == "gzip" || format == "zip" || format == "compress") {
625 params().compressed = true;
628 // remove dummy empty par
629 paragraphs().clear();
631 lex.setFile(filename);
632 if (readFile(lex, filename) != success)
639 bool Buffer::fully_loaded() const
641 return pimpl_->file_fully_loaded;
645 void Buffer::fully_loaded(bool const value)
647 pimpl_->file_fully_loaded = value;
651 Buffer::ReadStatus Buffer::readFile(Lexer & lex, FileName const & filename,
654 BOOST_ASSERT(!filename.empty());
657 Alert::error(_("Document could not be read"),
658 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
663 string const token(lex.getString());
666 Alert::error(_("Document could not be read"),
667 bformat(_("%1$s could not be read."), from_utf8(filename.absFilename())));
671 // the first token _must_ be...
672 if (token != "\\lyxformat") {
673 lyxerr << "Token: " << token << endl;
675 Alert::error(_("Document format failure"),
676 bformat(_("%1$s is not a LyX document."),
677 from_utf8(filename.absFilename())));
682 string tmp_format = lex.getString();
683 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
684 // if present remove ".," from string.
685 string::size_type dot = tmp_format.find_first_of(".,");
686 //lyxerr << " dot found at " << dot << endl;
687 if (dot != string::npos)
688 tmp_format.erase(dot, 1);
689 int const file_format = convert<int>(tmp_format);
690 //lyxerr << "format: " << file_format << endl;
692 if (file_format != LYX_FORMAT) {
695 // lyx2lyx would fail
698 FileName const tmpfile(tempName());
699 if (tmpfile.empty()) {
700 Alert::error(_("Conversion failed"),
701 bformat(_("%1$s is from a different"
702 " version of LyX, but a temporary"
703 " file for converting it could"
705 from_utf8(filename.absFilename())));
708 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
709 if (lyx2lyx.empty()) {
710 Alert::error(_("Conversion script not found"),
711 bformat(_("%1$s is from a different"
712 " version of LyX, but the"
713 " conversion script lyx2lyx"
714 " could not be found."),
715 from_utf8(filename.absFilename())));
718 ostringstream command;
719 command << os::python()
720 << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
721 << " -t " << convert<string>(LYX_FORMAT)
722 << " -o " << quoteName(tmpfile.toFilesystemEncoding())
723 << ' ' << quoteName(filename.toFilesystemEncoding());
724 string const command_str = command.str();
726 LYXERR(Debug::INFO) << "Running '"
727 << command_str << '\''
730 cmd_ret const ret = runCommand(command_str);
731 if (ret.first != 0) {
732 Alert::error(_("Conversion script failed"),
733 bformat(_("%1$s is from a different version"
734 " of LyX, but the lyx2lyx script"
735 " failed to convert it."),
736 from_utf8(filename.absFilename())));
739 bool const ret = readFile(tmpfile);
740 // Do stuff with tmpfile name and buffer name here.
741 return ret ? success : failure;
746 if (readDocument(lex)) {
747 Alert::error(_("Document format failure"),
748 bformat(_("%1$s ended unexpectedly, which means"
749 " that it is probably corrupted."),
750 from_utf8(filename.absFilename())));
753 //lyxerr << "removing " << MacroTable::localMacros().size()
754 // << " temporary macro entries" << endl;
755 //MacroTable::localMacros().clear();
757 pimpl_->file_fully_loaded = true;
762 // Should probably be moved to somewhere else: BufferView? LyXView?
763 bool Buffer::save() const
765 // We don't need autosaves in the immediate future. (Asger)
766 resetAutosaveTimers();
768 string const encodedFilename = pimpl_->filename.toFilesystemEncoding();
771 bool madeBackup = false;
773 // make a backup if the file already exists
774 if (lyxrc.make_backup && fs::exists(encodedFilename)) {
775 backupName = FileName(fileName() + '~');
776 if (!lyxrc.backupdir_path.empty())
777 backupName = FileName(addName(lyxrc.backupdir_path,
778 subst(os::internal_path(backupName.absFilename()), '/', '!')));
781 fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
783 } catch (fs::filesystem_error const & fe) {
784 Alert::error(_("Backup failure"),
785 bformat(_("Cannot create backup file %1$s.\n"
786 "Please check whether the directory exists and is writeable."),
787 from_utf8(backupName.absFilename())));
788 LYXERR(Debug::DEBUG) << "Fs error: " << fe.what() << endl;
792 if (writeFile(pimpl_->filename)) {
794 removeAutosaveFile(fileName());
797 // Saving failed, so backup is not backup
799 rename(backupName, pimpl_->filename);
805 bool Buffer::writeFile(FileName const & fname) const
807 if (pimpl_->read_only && fname == pimpl_->filename)
812 if (params().compressed) {
813 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname.toFilesystemEncoding()));
819 ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
830 bool Buffer::write(ostream & ofs) const
833 // Use the standard "C" locale for file output.
834 ofs.imbue(std::locale::classic());
837 // The top of the file should not be written by params().
839 // write out a comment in the top of the file
840 ofs << "#LyX " << lyx_version
841 << " created this file. For more info see http://www.lyx.org/\n"
842 << "\\lyxformat " << LYX_FORMAT << "\n"
843 << "\\begin_document\n";
845 // now write out the buffer parameters.
846 ofs << "\\begin_header\n";
847 params().writeFile(ofs);
848 ofs << "\\end_header\n";
851 ofs << "\n\\begin_body\n";
852 text().write(*this, ofs);
853 ofs << "\n\\end_body\n";
855 // Write marker that shows file is complete
856 ofs << "\\end_document" << endl;
858 // Shouldn't really be needed....
861 // how to check if close went ok?
862 // Following is an attempt... (BE 20001011)
864 // good() returns false if any error occured, including some
866 // bad() returns true if something bad happened in the buffer,
867 // which should include file system full errors.
872 lyxerr << "File was not closed properly." << endl;
879 bool Buffer::makeLaTeXFile(FileName const & fname,
880 string const & original_path,
881 OutputParams const & runparams,
882 bool output_preamble, bool output_body)
884 string const encoding = runparams.encoding->iconvName();
885 LYXERR(Debug::LATEX) << "makeLaTeXFile encoding: "
886 << encoding << "..." << endl;
888 odocfstream ofs(encoding);
889 if (!openFileWrite(ofs, fname))
892 bool failed_export = false;
894 writeLaTeXSource(ofs, original_path,
895 runparams, output_preamble, output_body);
897 catch (iconv_codecvt_facet_exception & e) {
898 lyxerr << "Caught iconv exception: " << e.what() << endl;
899 failed_export = true;
901 catch (std::exception const & e) {
902 lyxerr << "Caught \"normal\" exception: " << e.what() << endl;
903 failed_export = true;
906 lyxerr << "Caught some really weird exception..." << endl;
907 LyX::cref().emergencyCleanup();
913 failed_export = true;
914 lyxerr << "File '" << fname << "' was not closed properly." << endl;
918 Alert::error(_("Encoding error"),
919 _("Some characters of your document are probably not "
920 "representable in the chosen encoding.\n"
921 "Changing the document encoding to utf8 could help."));
928 void Buffer::writeLaTeXSource(odocstream & os,
929 string const & original_path,
930 OutputParams const & runparams_in,
931 bool const output_preamble, bool const output_body)
933 OutputParams runparams = runparams_in;
935 // validate the buffer.
936 LYXERR(Debug::LATEX) << " Validating buffer..." << endl;
937 LaTeXFeatures features(*this, params(), runparams);
939 LYXERR(Debug::LATEX) << " Buffer validation done." << endl;
943 // The starting paragraph of the coming rows is the
944 // first paragraph of the document. (Asger)
945 texrow().start(paragraphs().begin()->id(), 0);
947 if (output_preamble && runparams.nice) {
948 os << "%% LyX " << lyx_version << " created this file. "
949 "For more info, see http://www.lyx.org/.\n"
950 "%% Do not edit unless you really know what "
955 LYXERR(Debug::INFO) << "lyx document header finished" << endl;
956 // There are a few differences between nice LaTeX and usual files:
957 // usual is \batchmode and has a
958 // special input@path to allow the including of figures
959 // with either \input or \includegraphics (what figinsets do).
960 // input@path is set when the actual parameter
961 // original_path is set. This is done for usual tex-file, but not
962 // for nice-latex-file. (Matthias 250696)
963 // Note that input@path is only needed for something the user does
964 // in the preamble, included .tex files or ERT, files included by
965 // LyX work without it.
966 if (output_preamble) {
967 if (!runparams.nice) {
968 // code for usual, NOT nice-latex-file
969 os << "\\batchmode\n"; // changed
973 if (!original_path.empty()) {
975 // We don't know the encoding of inputpath
976 docstring const inputpath = from_utf8(latex_path(original_path));
977 os << "\\makeatletter\n"
978 << "\\def\\input@path{{"
979 << inputpath << "/}}\n"
980 << "\\makeatother\n";
986 // Write the preamble
987 runparams.use_babel = params().writeLaTeX(os, features, texrow());
993 os << "\\begin{document}\n";
996 LYXERR(Debug::INFO) << "preamble finished, now the body." << endl;
998 if (!lyxrc.language_auto_begin &&
999 !params().language->babel().empty()) {
1001 os << from_utf8(subst(lyxrc.language_command_begin,
1003 params().language->babel()))
1008 Encoding const & encoding = params().encoding();
1009 if (encoding.package() == Encoding::CJK) {
1010 // Open a CJK environment, since in contrast to the encodings
1011 // handled by inputenc the document encoding is not set in
1012 // the preamble if it is handled by CJK.sty.
1013 os << "\\begin{CJK}{" << from_ascii(encoding.latexName())
1018 // if we are doing a real file with body, even if this is the
1019 // child of some other buffer, let's cut the link here.
1020 // This happens for example if only a child document is printed.
1021 string save_parentname;
1022 if (output_preamble) {
1023 save_parentname = params().parentname;
1024 params().parentname.erase();
1028 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1030 // Restore the parenthood if needed
1031 if (output_preamble)
1032 params().parentname = save_parentname;
1034 // add this just in case after all the paragraphs
1038 if (encoding.package() == Encoding::CJK) {
1039 // Close the open CJK environment.
1040 // latexParagraphs will have opened one even if the last text
1042 os << "\\end{CJK}\n";
1046 if (!lyxrc.language_auto_end &&
1047 !params().language->babel().empty()) {
1048 os << from_utf8(subst(lyxrc.language_command_end,
1050 params().language->babel()))
1055 if (output_preamble) {
1056 os << "\\end{document}\n";
1059 LYXERR(Debug::LATEX) << "makeLaTeXFile...done" << endl;
1061 LYXERR(Debug::LATEX) << "LaTeXFile for inclusion made."
1064 runparams_in.encoding = runparams.encoding;
1066 // Just to be sure. (Asger)
1069 LYXERR(Debug::INFO) << "Finished making LaTeX file." << endl;
1070 LYXERR(Debug::INFO) << "Row count was " << texrow().rows() - 1
1075 bool Buffer::isLatex() const
1077 return params().getTextClass().outputType() == LATEX;
1081 bool Buffer::isLiterate() const
1083 return params().getTextClass().outputType() == LITERATE;
1087 bool Buffer::isDocBook() const
1089 return params().getTextClass().outputType() == DOCBOOK;
1093 void Buffer::makeDocBookFile(FileName const & fname,
1094 OutputParams const & runparams,
1095 bool const body_only)
1097 LYXERR(Debug::LATEX) << "makeDocBookFile..." << endl;
1101 if (!openFileWrite(ofs, fname))
1104 writeDocBookSource(ofs, fname.absFilename(), runparams, body_only);
1108 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1112 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1113 OutputParams const & runparams,
1114 bool const only_body)
1116 LaTeXFeatures features(*this, params(), runparams);
1121 TextClass const & tclass = params().getTextClass();
1122 string const top_element = tclass.latexname();
1125 if (runparams.flavor == OutputParams::XML)
1126 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1129 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1132 if (! tclass.class_header().empty())
1133 os << from_ascii(tclass.class_header());
1134 else if (runparams.flavor == OutputParams::XML)
1135 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1136 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1138 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1140 docstring preamble = from_utf8(params().preamble);
1141 if (runparams.flavor != OutputParams::XML ) {
1142 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1143 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1144 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1145 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1148 string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
1150 preamble += features.getIncludedFiles(name);
1151 preamble += features.getLyXSGMLEntities();
1153 if (!preamble.empty()) {
1154 os << "\n [ " << preamble << " ]";
1159 string top = top_element;
1161 if (runparams.flavor == OutputParams::XML)
1162 top += params().language->code();
1164 top += params().language->code().substr(0,2);
1167 if (!params().options.empty()) {
1169 top += params().options;
1172 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1173 << " file was created by LyX " << lyx_version
1174 << "\n See http://www.lyx.org/ for more information -->\n";
1176 params().getTextClass().counters().reset();
1178 sgml::openTag(os, top);
1180 docbookParagraphs(paragraphs(), *this, os, runparams);
1181 sgml::closeTag(os, top_element);
1185 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1186 // Other flags: -wall -v0 -x
1187 int Buffer::runChktex()
1191 // get LaTeX-Filename
1192 FileName const path(temppath());
1193 string const name = addName(path.absFilename(), getLatexName());
1194 string const org_path = filePath();
1196 support::Path p(path); // path to LaTeX file
1197 message(_("Running chktex..."));
1199 // Generate the LaTeX file if neccessary
1200 OutputParams runparams(¶ms().encoding());
1201 runparams.flavor = OutputParams::LATEX;
1202 runparams.nice = false;
1203 makeLaTeXFile(FileName(name), org_path, runparams);
1206 Chktex chktex(lyxrc.chktex_command, onlyFilename(name), filePath());
1207 int const res = chktex.run(terr); // run chktex
1210 Alert::error(_("chktex failure"),
1211 _("Could not run chktex successfully."));
1212 } else if (res > 0) {
1213 ErrorList & errorList = errorLists_["ChkTeX"];
1214 // Clear out old errors
1216 // Fill-in the error list with the TeX errors
1217 bufferErrors(*this, terr, errorList);
1228 void Buffer::validate(LaTeXFeatures & features) const
1230 TextClass const & tclass = params().getTextClass();
1232 if (params().outputChanges) {
1233 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1234 bool xcolorsoul = LaTeXFeatures::isAvailable("soul") &&
1235 LaTeXFeatures::isAvailable("xcolor");
1237 if (features.runparams().flavor == OutputParams::LATEX) {
1239 features.require("ct-dvipost");
1240 features.require("dvipost");
1241 } else if (xcolorsoul) {
1242 features.require("ct-xcolor-soul");
1243 features.require("soul");
1244 features.require("xcolor");
1246 features.require("ct-none");
1248 } else if (features.runparams().flavor == OutputParams::PDFLATEX ) {
1250 features.require("ct-xcolor-soul");
1251 features.require("soul");
1252 features.require("xcolor");
1253 features.require("pdfcolmk"); // improves color handling in PDF output
1255 features.require("ct-none");
1260 // AMS Style is at document level
1261 if (params().use_amsmath == BufferParams::package_on
1262 || tclass.provides("amsmath"))
1263 features.require("amsmath");
1264 if (params().use_esint == BufferParams::package_on)
1265 features.require("esint");
1267 for_each(paragraphs().begin(), paragraphs().end(),
1268 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1270 // the bullet shapes are buffer level not paragraph level
1271 // so they are tested here
1272 for (int i = 0; i < 4; ++i) {
1273 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1274 int const font = params().user_defined_bullet(i).getFont();
1276 int const c = params()
1277 .user_defined_bullet(i)
1284 features.require("latexsym");
1286 } else if (font == 1) {
1287 features.require("amssymb");
1288 } else if ((font >= 2 && font <= 5)) {
1289 features.require("pifont");
1294 if (lyxerr.debugging(Debug::LATEX)) {
1295 features.showStruct();
1300 void Buffer::getLabelList(vector<docstring> & list) const
1302 /// if this is a child document and the parent is already loaded
1303 /// Use the parent's list instead [ale990407]
1304 Buffer const * tmp = getMasterBuffer();
1306 lyxerr << "getMasterBuffer() failed!" << endl;
1310 tmp->getLabelList(list);
1314 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1315 it.nextInset()->getLabelList(*this, list);
1319 // This is also a buffer property (ale)
1320 void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
1323 /// if this is a child document and the parent is already loaded
1324 /// use the parent's list instead [ale990412]
1325 Buffer const * tmp = getMasterBuffer();
1328 tmp->fillWithBibKeys(keys);
1332 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1333 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1334 InsetBibtex const & inset =
1335 static_cast<InsetBibtex const &>(*it);
1336 inset.fillWithBibKeys(*this, keys);
1337 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1338 InsetInclude const & inset =
1339 static_cast<InsetInclude const &>(*it);
1340 inset.fillWithBibKeys(*this, keys);
1341 } else if (it->lyxCode() == Inset::BIBITEM_CODE) {
1342 InsetBibitem const & inset =
1343 static_cast<InsetBibitem const &>(*it);
1345 string const key = to_utf8(inset.getParam("key"));
1346 docstring const label = inset.getParam("label");
1347 DocIterator doc_it(it); doc_it.forwardPos();
1348 docstring const ref = doc_it.paragraph().asString(*this, false);
1349 docstring const info = label + "TheBibliographyRef" + ref;
1350 keys.push_back(pair<string, docstring>(key, info));
1356 void Buffer::updateBibfilesCache()
1358 // if this is a child document and the parent is already loaded
1359 // update the parent's cache instead
1360 Buffer * tmp = getMasterBuffer();
1363 tmp->updateBibfilesCache();
1367 bibfilesCache_.clear();
1368 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1369 if (it->lyxCode() == Inset::BIBTEX_CODE) {
1370 InsetBibtex const & inset =
1371 static_cast<InsetBibtex const &>(*it);
1372 vector<FileName> const bibfiles = inset.getFiles(*this);
1373 bibfilesCache_.insert(bibfilesCache_.end(),
1376 } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
1377 InsetInclude & inset =
1378 static_cast<InsetInclude &>(*it);
1379 inset.updateBibfilesCache(*this);
1380 vector<FileName> const & bibfiles =
1381 inset.getBibfilesCache(*this);
1382 bibfilesCache_.insert(bibfilesCache_.end(),
1390 vector<FileName> const & Buffer::getBibfilesCache() const
1392 // if this is a child document and the parent is already loaded
1393 // use the parent's cache instead
1394 Buffer const * tmp = getMasterBuffer();
1397 return tmp->getBibfilesCache();
1399 // We update the cache when first used instead of at loading time.
1400 if (bibfilesCache_.empty())
1401 const_cast<Buffer *>(this)->updateBibfilesCache();
1403 return bibfilesCache_;
1407 bool Buffer::isDepClean(string const & name) const
1409 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1410 if (it == pimpl_->dep_clean.end())
1416 void Buffer::markDepClean(string const & name)
1418 pimpl_->dep_clean[name] = true;
1422 bool Buffer::dispatch(string const & command, bool * result)
1424 return dispatch(lyxaction.lookupFunc(command), result);
1428 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1430 bool dispatched = true;
1432 switch (func.action) {
1433 case LFUN_BUFFER_EXPORT: {
1434 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1447 void Buffer::changeLanguage(Language const * from, Language const * to)
1452 for_each(par_iterator_begin(),
1454 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1456 text().current_font.setLanguage(to);
1457 text().real_current_font.setLanguage(to);
1461 bool Buffer::isMultiLingual() const
1463 ParConstIterator end = par_iterator_end();
1464 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1465 if (it->isMultiLingual(params()))
1472 ParIterator Buffer::getParFromID(int const id) const
1474 ParConstIterator it = par_iterator_begin();
1475 ParConstIterator const end = par_iterator_end();
1478 // John says this is called with id == -1 from undo
1479 lyxerr << "getParFromID(), id: " << id << endl;
1483 for (; it != end; ++it)
1491 bool Buffer::hasParWithID(int const id) const
1493 ParConstIterator const it = getParFromID(id);
1494 return it != par_iterator_end();
1498 ParIterator Buffer::par_iterator_begin()
1500 return lyx::par_iterator_begin(inset());
1504 ParIterator Buffer::par_iterator_end()
1506 return lyx::par_iterator_end(inset());
1510 ParConstIterator Buffer::par_iterator_begin() const
1512 return lyx::par_const_iterator_begin(inset());
1516 ParConstIterator Buffer::par_iterator_end() const
1518 return lyx::par_const_iterator_end(inset());
1522 Language const * Buffer::getLanguage() const
1524 return params().language;
1528 docstring const Buffer::B_(string const & l10n) const
1530 return params().B_(l10n);
1534 bool Buffer::isClean() const
1536 return pimpl_->lyx_clean;
1540 bool Buffer::isBakClean() const
1542 return pimpl_->bak_clean;
1546 void Buffer::markClean() const
1548 if (!pimpl_->lyx_clean) {
1549 pimpl_->lyx_clean = true;
1552 // if the .lyx file has been saved, we don't need an
1554 pimpl_->bak_clean = true;
1558 void Buffer::markBakClean()
1560 pimpl_->bak_clean = true;
1564 void Buffer::setUnnamed(bool flag)
1566 pimpl_->unnamed = flag;
1570 bool Buffer::isUnnamed() const
1572 return pimpl_->unnamed;
1576 #ifdef WITH_WARNINGS
1577 #warning this function should be moved to buffer_pimpl.C
1579 void Buffer::markDirty()
1581 if (pimpl_->lyx_clean) {
1582 pimpl_->lyx_clean = false;
1585 pimpl_->bak_clean = false;
1587 DepClean::iterator it = pimpl_->dep_clean.begin();
1588 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1590 for (; it != end; ++it)
1595 string const Buffer::fileName() const
1597 return pimpl_->filename.absFilename();
1601 string const & Buffer::filePath() const
1603 return params().filepath;
1607 bool Buffer::isReadonly() const
1609 return pimpl_->read_only;
1613 void Buffer::setParentName(string const & name)
1615 params().parentname = name;
1619 Buffer const * Buffer::getMasterBuffer() const
1621 if (!params().parentname.empty()
1622 && theBufferList().exists(params().parentname)) {
1623 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1625 return buf->getMasterBuffer();
1632 Buffer * Buffer::getMasterBuffer()
1634 if (!params().parentname.empty()
1635 && theBufferList().exists(params().parentname)) {
1636 Buffer * buf = theBufferList().getBuffer(params().parentname);
1638 return buf->getMasterBuffer();
1645 MacroData const & Buffer::getMacro(docstring const & name) const
1647 return pimpl_->macros.get(name);
1651 bool Buffer::hasMacro(docstring const & name) const
1653 return pimpl_->macros.has(name);
1657 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1659 MacroTable::globalMacros().insert(name, data);
1660 pimpl_->macros.insert(name, data);
1664 void Buffer::buildMacros()
1666 // Start with global table.
1667 pimpl_->macros = MacroTable::globalMacros();
1670 ParagraphList const & pars = text().paragraphs();
1671 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1672 //lyxerr << "searching main par " << i
1673 // << " for macro definitions" << std::endl;
1674 InsetList const & insets = pars[i].insetlist;
1675 InsetList::const_iterator it = insets.begin();
1676 InsetList::const_iterator end = insets.end();
1677 for ( ; it != end; ++it) {
1678 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1679 if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
1680 MathMacroTemplate const & mac
1681 = static_cast<MathMacroTemplate const &>(*it->inset);
1682 insertMacro(mac.name(), mac.asMacroData());
1689 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1696 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1699 //FIXME: This does not work for child documents yet.
1700 BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
1701 // Check if the label 'from' appears more than once
1702 vector<docstring> labels;
1704 if (code == Inset::CITE_CODE) {
1705 vector<pair<string, docstring> > keys;
1706 fillWithBibKeys(keys);
1707 vector<pair<string, docstring> >::const_iterator bit = keys.begin();
1708 vector<pair<string, docstring> >::const_iterator bend = keys.end();
1710 for (; bit != bend; ++bit)
1712 labels.push_back(from_utf8(bit->first));
1714 getLabelList(labels);
1716 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1719 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1720 if (it->lyxCode() == code) {
1721 InsetCommand & inset = static_cast<InsetCommand &>(*it);
1722 inset.replaceContents(to_utf8(from), to_utf8(to));
1728 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1729 pit_type par_end, bool full_source)
1731 OutputParams runparams(¶ms().encoding());
1732 runparams.nice = true;
1733 runparams.flavor = OutputParams::LATEX;
1734 runparams.linelen = lyxrc.plaintext_linelen;
1735 // No side effect of file copying and image conversion
1736 runparams.dryrun = true;
1739 os << "% Preview source code\n\n";
1741 writeLaTeXSource(os, filePath(), runparams, true, true);
1743 writeDocBookSource(os, fileName(), runparams, false);
1746 runparams.par_begin = par_begin;
1747 runparams.par_end = par_end;
1748 if (par_begin + 1 == par_end)
1749 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1751 os << "% Preview source code from paragraph " << par_begin
1752 << " to " << par_end - 1 << "\n\n";
1753 // output paragraphs
1756 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1759 docbookParagraphs(paragraphs(), *this, os, runparams);
1765 ErrorList const & Buffer::errorList(string const & type) const
1767 static ErrorList const emptyErrorList;
1768 std::map<string, ErrorList>::const_iterator I = errorLists_.find(type);
1769 if (I == errorLists_.end())
1770 return emptyErrorList;
1776 ErrorList & Buffer::errorList(string const & type)
1778 return errorLists_[type];