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"
53 #include "insets/insetbibitem.h"
54 #include "insets/insetbibtex.h"
55 #include "insets/insetinclude.h"
56 #include "insets/insettext.h"
58 #include "mathed/MathMacroTemplate.h"
59 #include "mathed/MathMacroTable.h"
60 #include "mathed/MathSupport.h"
62 #include "frontends/Alert.h"
64 #include "graphics/Previews.h"
66 #include "support/types.h"
67 #include "support/lyxalgo.h"
68 #include "support/filetools.h"
69 #include "support/fs_extras.h"
70 #include "support/lyxlib.h"
71 #include "support/os.h"
72 #include "support/path.h"
73 #include "support/textutils.h"
74 #include "support/convert.h"
76 #include <boost/iostreams/filtering_stream.hpp>
77 #include <boost/iostreams/filter/gzip.hpp>
78 #include <boost/iostreams/device/file.hpp>
79 #include <boost/bind.hpp>
80 #include <boost/filesystem/exception.hpp>
81 #include <boost/filesystem/operations.hpp>
83 #if defined (HAVE_UTIME_H)
85 #elif defined (HAVE_SYS_UTIME_H)
86 #include <sys/utime.h>
96 using lyx::odocfstream;
97 using lyx::odocstream;
101 using lyx::support::addName;
102 using lyx::support::bformat;
103 using lyx::support::changeExtension;
104 using lyx::support::cmd_ret;
105 using lyx::support::createBufferTmpDir;
106 using lyx::support::destroyDir;
107 using lyx::support::getFormatFromContents;
108 using lyx::support::isDirWriteable;
109 using lyx::support::libFileSearch;
110 using lyx::support::latex_path;
111 using lyx::support::ltrim;
112 using lyx::support::makeAbsPath;
113 using lyx::support::makeDisplayPath;
114 using lyx::support::makeLatexName;
115 using lyx::support::onlyFilename;
116 using lyx::support::onlyPath;
117 using lyx::support::quoteName;
118 using lyx::support::removeAutosaveFile;
119 using lyx::support::rename;
120 using lyx::support::runCommand;
121 using lyx::support::split;
122 using lyx::support::subst;
123 using lyx::support::tempName;
124 using lyx::support::trim;
126 namespace Alert = lyx::frontend::Alert;
127 namespace os = lyx::support::os;
128 namespace fs = boost::filesystem;
129 namespace io = boost::iostreams;
133 using std::make_pair;
139 using std::ostringstream;
149 int const LYX_FORMAT = 252;
154 typedef std::map<string, bool> DepClean;
159 Impl(Buffer & parent, string const & file, bool readonly);
161 limited_stack<Undo> undostack;
162 limited_stack<Undo> redostack;
168 /// need to regenerate .tex?
172 mutable bool lyx_clean;
174 /// is autosave needed?
175 mutable bool bak_clean;
177 /// is this a unnamed file (New...)?
183 /// name of the file the buffer is associated with.
186 boost::scoped_ptr<Messages> messages;
188 /** Set to true only when the file is fully loaded.
189 * Used to prevent the premature generation of previews
190 * and by the citation inset.
192 bool file_fully_loaded;
194 /// our LyXText that should be wrapped in an InsetText
202 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
203 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
204 filename(file), file_fully_loaded(false),
207 inset.setAutoBreakRows(true);
208 lyxvc.buffer(&parent);
209 temppath = createBufferTmpDir();
210 params.filepath = onlyPath(file);
211 // FIXME: And now do something if temppath == string(), because we
212 // assume from now on that temppath points to a valid temp dir.
213 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
217 Buffer::Buffer(string const & file, bool readonly)
218 : pimpl_(new Impl(*this, file, readonly))
220 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
226 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
227 // here the buffer should take care that it is
228 // saved properly, before it goes into the void.
232 if (!temppath().empty() && !destroyDir(temppath())) {
233 Alert::warning(_("Could not remove temporary directory"),
234 bformat(_("Could not remove the temporary directory %1$s"),
235 lyx::from_utf8(temppath())));
238 // Remove any previewed LaTeX snippets associated with this buffer.
239 lyx::graphics::Previews::get().removeLoader(*this);
243 LyXText & Buffer::text() const
245 return const_cast<LyXText &>(pimpl_->inset.text_);
249 InsetBase & Buffer::inset() const
251 return const_cast<InsetText &>(pimpl_->inset);
255 limited_stack<Undo> & Buffer::undostack()
257 return pimpl_->undostack;
261 limited_stack<Undo> const & Buffer::undostack() const
263 return pimpl_->undostack;
267 limited_stack<Undo> & Buffer::redostack()
269 return pimpl_->redostack;
273 limited_stack<Undo> const & Buffer::redostack() const
275 return pimpl_->redostack;
279 BufferParams & Buffer::params()
281 return pimpl_->params;
285 BufferParams const & Buffer::params() const
287 return pimpl_->params;
291 ParagraphList & Buffer::paragraphs()
293 return text().paragraphs();
297 ParagraphList const & Buffer::paragraphs() const
299 return text().paragraphs();
303 LyXVC & Buffer::lyxvc()
305 return pimpl_->lyxvc;
309 LyXVC const & Buffer::lyxvc() const
311 return pimpl_->lyxvc;
315 string const & Buffer::temppath() const
317 return pimpl_->temppath;
321 TexRow & Buffer::texrow()
323 return pimpl_->texrow;
327 TexRow const & Buffer::texrow() const
329 return pimpl_->texrow;
333 string const Buffer::getLatexName(bool const no_path) const
335 string const name = changeExtension(makeLatexName(fileName()), ".tex");
336 return no_path ? onlyFilename(name) : name;
340 pair<Buffer::LogType, string> const Buffer::getLogName() const
342 string const filename = getLatexName(false);
344 if (filename.empty())
345 return make_pair(Buffer::latexlog, string());
347 string const path = temppath();
349 string const fname = addName(path,
350 onlyFilename(changeExtension(filename,
353 addName(path, onlyFilename(
354 changeExtension(filename,
355 formats.extension("literate") + ".out")));
357 // If no Latex log or Build log is newer, show Build log
359 if (fs::exists(bname) &&
360 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
361 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
362 return make_pair(Buffer::buildlog, bname);
364 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
365 return make_pair(Buffer::latexlog, fname);
369 void Buffer::setReadonly(bool const flag)
371 if (pimpl_->read_only != flag) {
372 pimpl_->read_only = flag;
378 void Buffer::setFileName(string const & newfile)
380 pimpl_->filename = makeAbsPath(newfile);
381 params().filepath = onlyPath(pimpl_->filename);
382 setReadonly(fs::is_readonly(pimpl_->filename));
387 // We'll remove this later. (Lgb)
390 void unknownClass(string const & unknown)
392 Alert::warning(_("Unknown document class"),
393 bformat(_("Using the default document class, because the "
394 "class %1$s is unknown."), lyx::from_utf8(unknown)));
400 int Buffer::readHeader(LyXLex & lex)
402 int unknown_tokens = 0;
404 int begin_header_line = -1;
406 // Initialize parameters that may be/go lacking in header:
407 params().branchlist().clear();
408 params().preamble.erase();
409 params().options.erase();
410 params().float_placement.erase();
411 params().paperwidth.erase();
412 params().paperheight.erase();
413 params().leftmargin.erase();
414 params().rightmargin.erase();
415 params().topmargin.erase();
416 params().bottommargin.erase();
417 params().headheight.erase();
418 params().headsep.erase();
419 params().footskip.erase();
421 ErrorList & errorList = errorLists_["Parse"];
425 string const token = lex.getString();
430 if (token == "\\end_header")
434 if (token == "\\begin_header") {
435 begin_header_line = line;
439 lyxerr[Debug::PARSER] << "Handling document header token: `"
440 << token << '\'' << endl;
442 string unknown = params().readToken(lex, token);
443 if (!unknown.empty()) {
444 if (unknown[0] != '\\' && token == "\\textclass") {
445 unknownClass(unknown);
448 docstring const s = bformat(_("Unknown token: "
450 lyx::from_utf8(token),
451 lyx::from_utf8(lex.getString()));
452 errorList.push_back(ErrorItem(_("Document header error"),
457 if (begin_header_line) {
458 docstring const s = _("\\begin_header is missing");
459 errorList.push_back(ErrorItem(_("Document header error"),
463 return unknown_tokens;
468 // changed to be public and have one parameter
469 // Returns false if "\end_document" is not read (Asger)
470 bool Buffer::readDocument(LyXLex & lex)
472 ErrorList & errorList = errorLists_["Parse"];
476 string const token = lex.getString();
477 if (token != "\\begin_document") {
478 docstring const s = _("\\begin_document is missing");
479 errorList.push_back(ErrorItem(_("Document header error"),
483 // we are reading in a brand new document
484 BOOST_ASSERT(paragraphs().empty());
487 if (!params().getLyXTextClass().load(filePath())) {
488 string theclass = params().getLyXTextClass().name();
489 Alert::error(_("Can't load document class"), bformat(
490 _("Using the default document class, because the "
491 " class %1$s could not be loaded."), lyx::from_utf8(theclass)));
492 params().textclass = 0;
495 bool const res = text().read(*this, lex, errorList);
496 for_each(text().paragraphs().begin(),
497 text().paragraphs().end(),
498 bind(&Paragraph::setInsetOwner, _1, &inset()));
499 updateBibfilesCache();
505 // needed to insert the selection
506 void Buffer::insertStringAsLines(ParagraphList & pars,
507 pit_type & pit, pos_type & pos,
508 LyXFont const & fn, docstring const & str, bool autobreakrows)
512 // insert the string, don't insert doublespace
513 bool space_inserted = true;
514 for (docstring::const_iterator cit = str.begin();
515 cit != str.end(); ++cit) {
516 Paragraph & par = pars[pit];
518 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
519 breakParagraph(params(), pars, pit, pos,
520 par.layout()->isEnvironment());
523 space_inserted = true;
527 // do not insert consecutive spaces if !free_spacing
528 } else if ((*cit == ' ' || *cit == '\t') &&
529 space_inserted && !par.isFreeSpacing()) {
531 } else if (*cit == '\t') {
532 if (!par.isFreeSpacing()) {
533 // tabs are like spaces here
534 par.insertChar(pos, ' ', font, params().trackChanges);
536 space_inserted = true;
538 const pos_type n = 8 - pos % 8;
539 for (pos_type i = 0; i < n; ++i) {
540 par.insertChar(pos, ' ', font, params().trackChanges);
543 space_inserted = true;
545 /* FIXME: not needed anymore?
546 } else if (!isPrintable(*cit)) {
547 // Ignore unprintables
551 // just insert the character
552 par.insertChar(pos, *cit, font, params().trackChanges);
554 space_inserted = (*cit == ' ');
561 bool Buffer::readFile(string const & filename)
563 // Check if the file is compressed.
564 string const format = getFormatFromContents(filename);
565 if (format == "gzip" || format == "zip" || format == "compress") {
566 params().compressed = true;
569 // remove dummy empty par
570 paragraphs().clear();
572 lex.setFile(filename);
573 if (!readFile(lex, filename))
576 // After we have read a file, we must ensure that the buffer
577 // language is set and used in the gui.
578 // If you know of a better place to put this, please tell me. (Lgb)
579 updateDocLang(params().language);
585 bool Buffer::fully_loaded() const
587 return pimpl_->file_fully_loaded;
591 void Buffer::fully_loaded(bool const value)
593 pimpl_->file_fully_loaded = value;
597 bool Buffer::readFile(LyXLex & lex, string const & filename)
599 BOOST_ASSERT(!filename.empty());
602 Alert::error(_("Document could not be read"),
603 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
608 string const token(lex.getString());
611 Alert::error(_("Document could not be read"),
612 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
616 // the first token _must_ be...
617 if (token != "\\lyxformat") {
618 lyxerr << "Token: " << token << endl;
620 Alert::error(_("Document format failure"),
621 bformat(_("%1$s is not a LyX document."),
622 lyx::from_utf8(filename)));
627 string tmp_format = lex.getString();
628 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
629 // if present remove ".," from string.
630 string::size_type dot = tmp_format.find_first_of(".,");
631 //lyxerr << " dot found at " << dot << endl;
632 if (dot != string::npos)
633 tmp_format.erase(dot, 1);
634 int const file_format = convert<int>(tmp_format);
635 //lyxerr << "format: " << file_format << endl;
637 if (file_format != LYX_FORMAT) {
638 string const tmpfile = tempName();
639 if (tmpfile.empty()) {
640 Alert::error(_("Conversion failed"),
641 bformat(_("%1$s is from an earlier"
642 " version of LyX, but a temporary"
643 " file for converting it could"
645 lyx::from_utf8(filename)));
648 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
649 if (lyx2lyx.empty()) {
650 Alert::error(_("Conversion script not found"),
651 bformat(_("%1$s is from an earlier"
652 " version of LyX, but the"
653 " conversion script lyx2lyx"
654 " could not be found."),
655 lyx::from_utf8(filename)));
658 ostringstream command;
659 command << os::python() << ' ' << quoteName(lyx2lyx)
660 << " -t " << convert<string>(LYX_FORMAT)
661 << " -o " << quoteName(tmpfile) << ' '
662 << quoteName(filename);
663 string const command_str = command.str();
665 lyxerr[Debug::INFO] << "Running '"
666 << command_str << '\''
669 cmd_ret const ret = runCommand(command_str);
670 if (ret.first != 0) {
671 Alert::error(_("Conversion script failed"),
672 bformat(_("%1$s is from an earlier version"
673 " of LyX, but the lyx2lyx script"
674 " failed to convert it."),
675 lyx::from_utf8(filename)));
678 bool const ret = readFile(tmpfile);
679 // Do stuff with tmpfile name and buffer name here.
685 if (readDocument(lex)) {
686 Alert::error(_("Document format failure"),
687 bformat(_("%1$s ended unexpectedly, which means"
688 " that it is probably corrupted."),
689 lyx::from_utf8(filename)));
692 //lyxerr << "removing " << MacroTable::localMacros().size()
693 // << " temporary macro entries" << endl;
694 //MacroTable::localMacros().clear();
696 pimpl_->file_fully_loaded = true;
701 // Should probably be moved to somewhere else: BufferView? LyXView?
702 bool Buffer::save() const
704 // We don't need autosaves in the immediate future. (Asger)
705 resetAutosaveTimers();
709 if (lyxrc.make_backup) {
710 s = fileName() + '~';
711 if (!lyxrc.backupdir_path.empty())
712 s = addName(lyxrc.backupdir_path,
713 subst(os::internal_path(s),'/','!'));
715 // It might very well be that this variant is just
716 // good enough. (Lgb)
717 // But to use this we need fs::copy_file to actually do a copy,
718 // even when the target file exists. (Lgb)
720 fs::copy_file(fileName(), s, false);
722 catch (fs::filesystem_error const & fe) {
723 Alert::error(_("Backup failure"),
724 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
725 "Please check if the directory exists and is writeable."),
726 lyx::from_utf8(fs::path(s).branch_path().native_directory_string())));
727 lyxerr[Debug::DEBUG] << "Fs error: "
728 << fe.what() << endl;
732 if (writeFile(fileName())) {
734 removeAutosaveFile(fileName());
736 // Saving failed, so backup is not backup
737 if (lyxrc.make_backup)
738 rename(s, fileName());
745 bool Buffer::writeFile(string const & fname) const
747 if (pimpl_->read_only && fname == fileName())
752 if (params().compressed) {
753 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
757 retval = do_writeFile(ofs);
759 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
763 retval = do_writeFile(ofs);
770 bool Buffer::do_writeFile(ostream & ofs) const
773 // Use the standard "C" locale for file output.
774 ofs.imbue(std::locale::classic());
777 // The top of the file should not be written by params().
779 // write out a comment in the top of the file
780 ofs << "#LyX " << lyx_version
781 << " created this file. For more info see http://www.lyx.org/\n"
782 << "\\lyxformat " << LYX_FORMAT << "\n"
783 << "\\begin_document\n";
785 // now write out the buffer parameters.
786 ofs << "\\begin_header\n";
787 params().writeFile(ofs);
788 ofs << "\\end_header\n";
791 ofs << "\n\\begin_body\n";
792 text().write(*this, ofs);
793 ofs << "\n\\end_body\n";
795 // Write marker that shows file is complete
796 ofs << "\\end_document" << endl;
798 // Shouldn't really be needed....
801 // how to check if close went ok?
802 // Following is an attempt... (BE 20001011)
804 // good() returns false if any error occured, including some
806 // bad() returns true if something bad happened in the buffer,
807 // which should include file system full errors.
812 lyxerr << "File was not closed properly." << endl;
819 void Buffer::makeLaTeXFile(string const & fname,
820 string const & original_path,
821 OutputParams const & runparams,
822 bool output_preamble, bool output_body)
824 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
827 // This creates an utf8 encoded file, but the inputenc commands
828 // specify other encodings
829 lyx::odocfstream ofs;
830 if (!openFileWrite(ofs, fname))
833 writeLaTeXSource(ofs, original_path,
834 runparams, output_preamble, output_body);
838 lyxerr << "File '" << fname << "' was not closed properly." << endl;
842 void Buffer::writeLaTeXSource(odocstream & os,
843 string const & original_path,
844 OutputParams const & runparams_in,
845 bool const output_preamble, bool const output_body)
847 OutputParams runparams = runparams_in;
849 // validate the buffer.
850 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
851 LaTeXFeatures features(*this, params(), runparams);
853 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
857 // The starting paragraph of the coming rows is the
858 // first paragraph of the document. (Asger)
859 texrow().start(paragraphs().begin()->id(), 0);
861 if (output_preamble && runparams.nice) {
862 os << "%% LyX " << lyx_version << " created this file. "
863 "For more info, see http://www.lyx.org/.\n"
864 "%% Do not edit unless you really know what "
869 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
870 // There are a few differences between nice LaTeX and usual files:
871 // usual is \batchmode and has a
872 // special input@path to allow the including of figures
873 // with either \input or \includegraphics (what figinsets do).
874 // input@path is set when the actual parameter
875 // original_path is set. This is done for usual tex-file, but not
876 // for nice-latex-file. (Matthias 250696)
877 // Note that input@path is only needed for something the user does
878 // in the preamble, included .tex files or ERT, files included by
879 // LyX work without it.
880 if (output_preamble) {
881 if (!runparams.nice) {
882 // code for usual, NOT nice-latex-file
883 os << "\\batchmode\n"; // changed
887 if (!original_path.empty()) {
889 // We don't know the encoding of inputpath
890 docstring const inputpath = lyx::from_utf8(latex_path(original_path));
891 os << "\\makeatletter\n"
892 << "\\def\\input@path{{"
893 << inputpath << "/}}\n"
894 << "\\makeatother\n";
900 // Write the preamble
901 runparams.use_babel = params().writeLaTeX(os, features, texrow());
907 os << "\\begin{document}\n";
910 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
912 if (!lyxrc.language_auto_begin) {
914 os << lyx::from_utf8(subst(lyxrc.language_command_begin,
916 params().language->babel()))
921 // if we are doing a real file with body, even if this is the
922 // child of some other buffer, let's cut the link here.
923 // This happens for example if only a child document is printed.
924 string save_parentname;
925 if (output_preamble) {
926 save_parentname = params().parentname;
927 params().parentname.erase();
931 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
933 // Restore the parenthood if needed
935 params().parentname = save_parentname;
937 // add this just in case after all the paragraphs
941 if (!lyxrc.language_auto_end) {
942 os << lyx::from_utf8(subst(lyxrc.language_command_end,
944 params().language->babel()))
949 if (output_preamble) {
950 os << "\\end{document}\n";
953 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
955 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
959 // Just to be sure. (Asger)
962 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
963 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
968 bool Buffer::isLatex() const
970 return params().getLyXTextClass().outputType() == LATEX;
974 bool Buffer::isLiterate() const
976 return params().getLyXTextClass().outputType() == LITERATE;
980 bool Buffer::isDocBook() const
982 return params().getLyXTextClass().outputType() == DOCBOOK;
986 void Buffer::makeDocBookFile(string const & fname,
987 OutputParams const & runparams,
988 bool const body_only)
990 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
994 if (!openFileWrite(ofs, fname))
997 writeDocBookSource(ofs, fname, runparams, body_only);
1001 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1005 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1006 OutputParams const & runparams,
1007 bool const only_body)
1009 LaTeXFeatures features(*this, params(), runparams);
1014 LyXTextClass const & tclass = params().getLyXTextClass();
1015 string const top_element = tclass.latexname();
1018 if (runparams.flavor == OutputParams::XML)
1019 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1022 os << "<!DOCTYPE " << lyx::from_ascii(top_element) << ' ';
1025 if (! tclass.class_header().empty())
1026 os << lyx::from_ascii(tclass.class_header());
1027 else if (runparams.flavor == OutputParams::XML)
1028 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1029 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1031 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1033 string preamble = params().preamble;
1034 if (runparams.flavor != OutputParams::XML ) {
1035 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1036 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1037 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1038 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1041 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1043 preamble += features.getIncludedFiles(name);
1044 preamble += features.getLyXSGMLEntities();
1046 if (!preamble.empty()) {
1047 os << "\n [ " << lyx::from_ascii(preamble) << " ]";
1052 string top = top_element;
1054 if (runparams.flavor == OutputParams::XML)
1055 top += params().language->code();
1057 top += params().language->code().substr(0,2);
1060 if (!params().options.empty()) {
1062 top += params().options;
1065 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1066 << " file was created by LyX " << lyx_version
1067 << "\n See http://www.lyx.org/ for more information -->\n";
1069 params().getLyXTextClass().counters().reset();
1071 sgml::openTag(os, top);
1073 docbookParagraphs(paragraphs(), *this, os, runparams);
1074 sgml::closeTag(os, top_element);
1078 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1079 // Other flags: -wall -v0 -x
1080 int Buffer::runChktex()
1084 // get LaTeX-Filename
1085 string const name = getLatexName();
1086 string const path = temppath();
1087 string const org_path = filePath();
1089 lyx::support::Path p(path); // path to LaTeX file
1090 message(_("Running chktex..."));
1092 // Generate the LaTeX file if neccessary
1093 OutputParams runparams;
1094 runparams.flavor = OutputParams::LATEX;
1095 runparams.nice = false;
1096 makeLaTeXFile(name, org_path, runparams);
1099 Chktex chktex(lyxrc.chktex_command, name, filePath());
1100 int const res = chktex.run(terr); // run chktex
1103 Alert::error(_("chktex failure"),
1104 _("Could not run chktex successfully."));
1105 } else if (res > 0) {
1106 // Fill-in the error list with the TeX errors
1107 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1118 void Buffer::validate(LaTeXFeatures & features) const
1120 LyXTextClass const & tclass = params().getLyXTextClass();
1122 if (features.isAvailable("dvipost") && params().outputChanges)
1123 features.require("dvipost");
1125 // AMS Style is at document level
1126 if (params().use_amsmath == BufferParams::AMS_ON
1127 || tclass.provides(LyXTextClass::amsmath))
1128 features.require("amsmath");
1130 for_each(paragraphs().begin(), paragraphs().end(),
1131 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1133 // the bullet shapes are buffer level not paragraph level
1134 // so they are tested here
1135 for (int i = 0; i < 4; ++i) {
1136 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1137 int const font = params().user_defined_bullet(i).getFont();
1139 int const c = params()
1140 .user_defined_bullet(i)
1147 features.require("latexsym");
1149 } else if (font == 1) {
1150 features.require("amssymb");
1151 } else if ((font >= 2 && font <= 5)) {
1152 features.require("pifont");
1157 if (lyxerr.debugging(Debug::LATEX)) {
1158 features.showStruct();
1163 void Buffer::getLabelList(vector<docstring> & list) const
1165 /// if this is a child document and the parent is already loaded
1166 /// Use the parent's list instead [ale990407]
1167 Buffer const * tmp = getMasterBuffer();
1169 lyxerr << "getMasterBuffer() failed!" << endl;
1173 tmp->getLabelList(list);
1177 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1178 it.nextInset()->getLabelList(*this, list);
1182 // This is also a buffer property (ale)
1183 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1186 /// if this is a child document and the parent is already loaded
1187 /// use the parent's list instead [ale990412]
1188 Buffer const * tmp = getMasterBuffer();
1191 tmp->fillWithBibKeys(keys);
1195 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1196 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1197 InsetBibtex const & inset =
1198 dynamic_cast<InsetBibtex const &>(*it);
1199 inset.fillWithBibKeys(*this, keys);
1200 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1201 InsetInclude const & inset =
1202 dynamic_cast<InsetInclude const &>(*it);
1203 inset.fillWithBibKeys(*this, keys);
1204 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1205 InsetBibitem const & inset =
1206 dynamic_cast<InsetBibitem const &>(*it);
1207 string const key = inset.getContents();
1208 string const opt = inset.getOptions();
1209 string const ref; // = pit->asString(this, false);
1210 string const info = opt + "TheBibliographyRef" + ref;
1211 keys.push_back(pair<string, string>(key, info));
1217 void Buffer::updateBibfilesCache()
1219 // if this is a child document and the parent is already loaded
1220 // update the parent's cache instead
1221 Buffer * tmp = getMasterBuffer();
1224 tmp->updateBibfilesCache();
1228 bibfilesCache_.clear();
1229 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1230 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1231 InsetBibtex const & inset =
1232 dynamic_cast<InsetBibtex const &>(*it);
1233 vector<string> const bibfiles = inset.getFiles(*this);
1234 bibfilesCache_.insert(bibfilesCache_.end(),
1237 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1238 InsetInclude & inset =
1239 dynamic_cast<InsetInclude &>(*it);
1240 inset.updateBibfilesCache(*this);
1241 vector<string> const & bibfiles =
1242 inset.getBibfilesCache(*this);
1243 bibfilesCache_.insert(bibfilesCache_.end(),
1251 vector<string> const & Buffer::getBibfilesCache() const
1253 // if this is a child document and the parent is already loaded
1254 // use the parent's cache instead
1255 Buffer const * tmp = getMasterBuffer();
1258 return tmp->getBibfilesCache();
1260 return bibfilesCache_;
1264 bool Buffer::isDepClean(string const & name) const
1266 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1267 if (it == pimpl_->dep_clean.end())
1273 void Buffer::markDepClean(string const & name)
1275 pimpl_->dep_clean[name] = true;
1279 bool Buffer::dispatch(string const & command, bool * result)
1281 return dispatch(lyxaction.lookupFunc(command), result);
1285 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1287 bool dispatched = true;
1289 switch (func.action) {
1290 case LFUN_BUFFER_EXPORT: {
1291 bool const tmp = Exporter::Export(this, lyx::to_utf8(func.argument()), false);
1304 void Buffer::changeLanguage(Language const * from, Language const * to)
1309 // Take care of l10n/i18n
1312 for_each(par_iterator_begin(),
1314 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1316 text().current_font.setLanguage(to);
1317 text().real_current_font.setLanguage(to);
1321 void Buffer::updateDocLang(Language const * nlang)
1323 BOOST_ASSERT(nlang);
1325 pimpl_->messages.reset(new Messages(nlang->code()));
1327 updateLabels(*this);
1331 bool Buffer::isMultiLingual() const
1333 ParConstIterator end = par_iterator_end();
1334 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1335 if (it->isMultiLingual(params()))
1342 ParIterator Buffer::getParFromID(int const id) const
1344 ParConstIterator it = par_iterator_begin();
1345 ParConstIterator const end = par_iterator_end();
1348 // John says this is called with id == -1 from undo
1349 lyxerr << "getParFromID(), id: " << id << endl;
1353 for (; it != end; ++it)
1361 bool Buffer::hasParWithID(int const id) const
1363 ParConstIterator const it = getParFromID(id);
1364 return it != par_iterator_end();
1368 ParIterator Buffer::par_iterator_begin()
1370 return ::par_iterator_begin(inset());
1374 ParIterator Buffer::par_iterator_end()
1376 return ::par_iterator_end(inset());
1380 ParConstIterator Buffer::par_iterator_begin() const
1382 return ::par_const_iterator_begin(inset());
1386 ParConstIterator Buffer::par_iterator_end() const
1388 return ::par_const_iterator_end(inset());
1392 Language const * Buffer::getLanguage() const
1394 return params().language;
1398 docstring const Buffer::B_(string const & l10n) const
1400 if (pimpl_->messages.get()) {
1401 return pimpl_->messages->get(l10n);
1408 bool Buffer::isClean() const
1410 return pimpl_->lyx_clean;
1414 bool Buffer::isBakClean() const
1416 return pimpl_->bak_clean;
1420 void Buffer::markClean() const
1422 if (!pimpl_->lyx_clean) {
1423 pimpl_->lyx_clean = true;
1426 // if the .lyx file has been saved, we don't need an
1428 pimpl_->bak_clean = true;
1432 void Buffer::markBakClean()
1434 pimpl_->bak_clean = true;
1438 void Buffer::setUnnamed(bool flag)
1440 pimpl_->unnamed = flag;
1444 bool Buffer::isUnnamed() const
1446 return pimpl_->unnamed;
1450 #ifdef WITH_WARNINGS
1451 #warning this function should be moved to buffer_pimpl.C
1453 void Buffer::markDirty()
1455 if (pimpl_->lyx_clean) {
1456 pimpl_->lyx_clean = false;
1459 pimpl_->bak_clean = false;
1461 DepClean::iterator it = pimpl_->dep_clean.begin();
1462 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1464 for (; it != end; ++it) {
1470 string const & Buffer::fileName() const
1472 return pimpl_->filename;
1476 string const & Buffer::filePath() const
1478 return params().filepath;
1482 bool Buffer::isReadonly() const
1484 return pimpl_->read_only;
1488 void Buffer::setParentName(string const & name)
1490 params().parentname = name;
1494 Buffer const * Buffer::getMasterBuffer() const
1496 if (!params().parentname.empty()
1497 && theBufferList().exists(params().parentname)) {
1498 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1500 return buf->getMasterBuffer();
1507 Buffer * Buffer::getMasterBuffer()
1509 if (!params().parentname.empty()
1510 && theBufferList().exists(params().parentname)) {
1511 Buffer * buf = theBufferList().getBuffer(params().parentname);
1513 return buf->getMasterBuffer();
1520 MacroData const & Buffer::getMacro(std::string const & name) const
1522 return pimpl_->macros.get(name);
1526 bool Buffer::hasMacro(string const & name) const
1528 return pimpl_->macros.has(name);
1532 void Buffer::insertMacro(string const & name, MacroData const & data)
1534 MacroTable::globalMacros().insert(name, data);
1535 pimpl_->macros.insert(name, data);
1539 void Buffer::buildMacros()
1541 // Start with global table.
1542 pimpl_->macros = MacroTable::globalMacros();
1545 ParagraphList const & pars = text().paragraphs();
1546 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1547 //lyxerr << "searching main par " << i
1548 // << " for macro definitions" << std::endl;
1549 InsetList const & insets = pars[i].insetlist;
1550 InsetList::const_iterator it = insets.begin();
1551 InsetList::const_iterator end = insets.end();
1552 for ( ; it != end; ++it) {
1553 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1554 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1555 MathMacroTemplate const & mac
1556 = static_cast<MathMacroTemplate const &>(*it->inset);
1557 insertMacro(mac.name(), mac.asMacroData());
1564 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1571 void Buffer::changeRefsIfUnique(string const & from, string const & to, InsetBase::Code code)
1573 //FIXME: This does not work for child documents yet.
1574 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1575 // Check if the label 'from' appears more than once
1576 vector<docstring> labels;
1578 if (code == InsetBase::CITE_CODE) {
1579 vector<pair<string, string> > keys;
1580 fillWithBibKeys(keys);
1581 vector<pair<string, string> >::const_iterator bit = keys.begin();
1582 vector<pair<string, string> >::const_iterator bend = keys.end();
1584 for (; bit != bend; ++bit)
1586 labels.push_back(lyx::from_utf8(bit->first));
1588 getLabelList(labels);
1591 if (lyx::count(labels.begin(), labels.end(), lyx::from_utf8(from)) > 1)
1594 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1595 if (it->lyxCode() == code) {
1596 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1597 inset.replaceContents(from, to);
1603 void Buffer::getSourceCode(odocstream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1605 OutputParams runparams;
1606 runparams.nice = true;
1607 runparams.flavor = OutputParams::LATEX;
1608 runparams.linelen = lyxrc.ascii_linelen;
1609 // No side effect of file copying and image conversion
1610 runparams.dryrun = true;
1612 /* Support for docbook temprarily commented out. */
1614 os << "% Preview source code\n\n";
1616 writeLaTeXSource(os, filePath(), runparams, true, true);
1618 writeDocBookSource(os, fileName(), runparams, false);
1621 runparams.par_begin = par_begin;
1622 runparams.par_end = par_end;
1623 if (par_begin + 1 == par_end)
1624 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1626 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1627 // output paragraphs
1630 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1633 docbookParagraphs(paragraphs(), *this, os, runparams);
1639 ErrorList const & Buffer::errorList(string const & type) const
1641 static ErrorList const emptyErrorList;
1642 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1643 if (I == errorLists_.end())
1644 return emptyErrorList;
1650 ErrorList & Buffer::errorList(string const & type)
1652 return errorLists_[type];