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 "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
23 #include "errorlist.h"
26 #include "funcrequest.h"
28 #include "iterators.h"
31 #include "LaTeXFeatures.h"
32 #include "LyXAction.h"
39 #include "output_docbook.h"
40 #include "output_latex.h"
41 #include "output_linuxdoc.h"
42 #include "paragraph.h"
43 #include "paragraph_funcs.h"
44 #include "ParagraphParameters.h"
45 #include "PosIterator.h"
51 #include "insets/insetbibitem.h"
52 #include "insets/insetbibtex.h"
53 #include "insets/insetinclude.h"
54 #include "insets/insettext.h"
56 #include "frontends/Alert.h"
58 #include "graphics/Previews.h"
60 #include "support/FileInfo.h"
61 #include "support/filetools.h"
62 #include "support/gzstream.h"
63 #include "support/lyxlib.h"
64 #include "support/os.h"
65 #include "support/path.h"
66 #include "support/textutils.h"
67 #include "support/tostr.h"
69 #include <boost/bind.hpp>
71 #include "support/std_sstream.h"
83 using lyx::support::AddName;
84 using lyx::support::atoi;
85 using lyx::support::bformat;
86 using lyx::support::ChangeExtension;
87 using lyx::support::cmd_ret;
88 using lyx::support::CreateBufferTmpDir;
89 using lyx::support::destroyDir;
90 using lyx::support::FileInfo;
91 using lyx::support::FileInfo;
92 using lyx::support::getExtFromContents;
93 using lyx::support::IsDirWriteable;
94 using lyx::support::IsFileWriteable;
95 using lyx::support::LibFileSearch;
96 using lyx::support::ltrim;
97 using lyx::support::MakeAbsPath;
98 using lyx::support::MakeDisplayPath;
99 using lyx::support::MakeLatexName;
100 using lyx::support::OnlyFilename;
101 using lyx::support::OnlyPath;
102 using lyx::support::Path;
103 using lyx::support::QuoteName;
104 using lyx::support::removeAutosaveFile;
105 using lyx::support::rename;
106 using lyx::support::RunCommand;
107 using lyx::support::split;
108 using lyx::support::strToInt;
109 using lyx::support::subst;
110 using lyx::support::tempName;
111 using lyx::support::trim;
113 namespace os = lyx::support::os;
117 using std::make_pair;
122 using std::ostringstream;
130 // all these externs should eventually be removed.
131 extern BufferList bufferlist;
135 const int LYX_FORMAT = 227;
140 typedef std::map<string, bool> DepClean;
144 Impl(Buffer & parent, string const & file, bool readonly);
146 limited_stack<Undo> undostack;
147 limited_stack<Undo> redostack;
154 /// need to regenerate .tex ?
158 mutable bool lyx_clean;
160 /// is autosave needed
161 mutable bool bak_clean;
163 /// is this a unnamed file (New...)
169 /// name of the file the buffer is associated with.
172 /// The path to the document file.
175 boost::scoped_ptr<Messages> messages;
177 /** set to true only when the file is fully loaded.
178 * Used to prevent the premature generation of previews
179 * and by the citation inset.
181 bool file_fully_loaded;
188 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
190 lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
191 filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
194 lyxvc.buffer(&parent);
195 if (readonly_ || lyxrc.use_tempdir)
196 temppath = CreateBufferTmpDir();
200 Buffer::Buffer(string const & file, bool ronly)
201 : pimpl_(new Impl(*this, file, ronly))
203 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
209 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
210 // here the buffer should take care that it is
211 // saved properly, before it goes into the void.
215 if (!temppath().empty() && destroyDir(temppath()) != 0) {
216 Alert::warning(_("Could not remove temporary directory"),
217 bformat(_("Could not remove the temporary directory %1$s"), temppath()));
220 // Remove any previewed LaTeX snippets associated with this buffer.
221 lyx::graphics::Previews::get().removeLoader(*this);
225 LyXText & Buffer::text() const
227 return const_cast<LyXText &>(pimpl_->text);
231 limited_stack<Undo> & Buffer::undostack()
233 return pimpl_->undostack;
237 limited_stack<Undo> const & Buffer::undostack() const
239 return pimpl_->undostack;
243 limited_stack<Undo> & Buffer::redostack()
245 return pimpl_->redostack;
249 limited_stack<Undo> const & Buffer::redostack() const
251 return pimpl_->redostack;
255 BufferParams & Buffer::params()
257 return pimpl_->params;
261 BufferParams const & Buffer::params() const
263 return pimpl_->params;
267 ParagraphList & Buffer::paragraphs()
269 return pimpl_->text.paragraphs();
273 ParagraphList const & Buffer::paragraphs() const
275 return pimpl_->text.paragraphs();
279 LyXVC & Buffer::lyxvc()
281 return pimpl_->lyxvc;
285 LyXVC const & Buffer::lyxvc() const
287 return pimpl_->lyxvc;
291 string const & Buffer::temppath() const
293 return pimpl_->temppath;
297 bool & Buffer::niceFile()
299 return pimpl_->nicefile;
303 bool Buffer::niceFile() const
305 return pimpl_->nicefile;
309 TexRow & Buffer::texrow()
311 return pimpl_->texrow;
315 TexRow const & Buffer::texrow() const
317 return pimpl_->texrow;
321 string const Buffer::getLatexName(bool no_path) const
323 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
324 return no_path ? OnlyFilename(name) : name;
328 pair<Buffer::LogType, string> const Buffer::getLogName() const
330 string const filename = getLatexName(false);
332 if (filename.empty())
333 return make_pair(Buffer::latexlog, string());
335 string path = OnlyPath(filename);
337 if (lyxrc.use_tempdir || !IsDirWriteable(path))
340 string const fname = AddName(path,
341 OnlyFilename(ChangeExtension(filename,
344 AddName(path, OnlyFilename(
345 ChangeExtension(filename,
346 formats.extension("literate") + ".out")));
348 // If no Latex log or Build log is newer, show Build log
350 FileInfo const f_fi(fname);
351 FileInfo const b_fi(bname);
354 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
355 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
356 return make_pair(Buffer::buildlog, bname);
358 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
359 return make_pair(Buffer::latexlog, fname);
363 void Buffer::setReadonly(bool flag)
365 if (pimpl_->read_only != flag) {
366 pimpl_->read_only = flag;
372 void Buffer::setFileName(string const & newfile)
374 pimpl_->filename = MakeAbsPath(newfile);
375 pimpl_->filepath = OnlyPath(pimpl_->filename);
376 setReadonly(IsFileWriteable(pimpl_->filename) == 0);
381 // We'll remove this later. (Lgb)
384 void unknownClass(string const & unknown)
386 Alert::warning(_("Unknown document class"),
387 bformat(_("Using the default document class, because the "
388 "class %1$s is unknown."), unknown));
394 int Buffer::readHeader(LyXLex & lex)
396 int unknown_tokens = 0;
400 string const token = lex.getString();
405 if (token == "\\end_header")
408 lyxerr[Debug::PARSER] << "Handling header token: `"
409 << token << '\'' << endl;
412 string unknown = params().readToken(lex, token);
413 if (!unknown.empty()) {
414 if (unknown[0] != '\\') {
415 unknownClass(unknown);
418 string const s = bformat(_("Unknown token: "
422 error(ErrorItem(_("Header error"), s,
427 return unknown_tokens;
431 // candidate for move to BufferView
432 // (at least some parts in the beginning of the func)
435 // changed to be public and have one parameter
436 // if par = 0 normal behavior
437 // else insert behavior
438 // Returns false if "\end_document" is not read (Asger)
439 bool Buffer::readBody(LyXLex & lex)
441 bool the_end_read = false;
443 if (paragraphs().empty()) {
445 if (!params().getLyXTextClass().load()) {
446 string theclass = params().getLyXTextClass().name();
447 Alert::error(_("Can't load document class"), bformat(
448 "Using the default document class, because the "
449 " class %1$s could not be loaded.", theclass));
450 params().textclass = 0;
453 // We don't want to adopt the parameters from the
454 // document we insert, so read them into a temporary buffer
455 // and then discard it
457 Buffer tmpbuf("", false);
458 tmpbuf.readHeader(lex);
461 if (text().read(*this, lex))
468 // needed to insert the selection
469 void Buffer::insertStringAsLines(ParagraphList::iterator & par, pos_type & pos,
470 LyXFont const & fn, string const & str)
472 LyXLayout_ptr const & layout = par->layout();
476 par->checkInsertChar(font);
477 // insert the string, don't insert doublespace
478 bool space_inserted = true;
479 bool autobreakrows = !par->inInset() ||
480 static_cast<InsetText *>(par->inInset())->getAutoBreakRows();
481 for(string::const_iterator cit = str.begin();
482 cit != str.end(); ++cit) {
484 if (autobreakrows && (!par->empty() || par->allowEmpty())) {
485 breakParagraph(params(), paragraphs(), par, pos,
486 layout->isEnvironment());
489 space_inserted = true;
493 // do not insert consecutive spaces if !free_spacing
494 } else if ((*cit == ' ' || *cit == '\t') &&
495 space_inserted && !par->isFreeSpacing()) {
497 } else if (*cit == '\t') {
498 if (!par->isFreeSpacing()) {
499 // tabs are like spaces here
500 par->insertChar(pos, ' ', font);
502 space_inserted = true;
504 const pos_type nb = 8 - pos % 8;
505 for (pos_type a = 0; a < nb ; ++a) {
506 par->insertChar(pos, ' ', font);
509 space_inserted = true;
511 } else if (!IsPrintable(*cit)) {
512 // Ignore unprintables
515 // just insert the character
516 par->insertChar(pos, *cit, font);
518 space_inserted = (*cit == ' ');
525 bool Buffer::readFile(string const & filename)
527 // Check if the file is compressed.
528 string const format = getExtFromContents(filename);
529 if (format == "gzip" || format == "zip" || format == "compress") {
530 params().compressed = true;
533 bool ret = readFile(filename, paragraphs().begin());
535 // After we have read a file, we must ensure that the buffer
536 // language is set and used in the gui.
537 // If you know of a better place to put this, please tell me. (Lgb)
538 updateDocLang(params().language);
544 bool Buffer::readFile(string const & filename, ParagraphList::iterator pit)
547 lex.setFile(filename);
549 return readFile(lex, filename, pit);
553 bool Buffer::fully_loaded() const
555 return pimpl_->file_fully_loaded;
559 void Buffer::fully_loaded(bool value)
561 pimpl_->file_fully_loaded = value;
565 bool Buffer::readFile(LyXLex & lex, string const & filename,
566 ParagraphList::iterator pit)
568 BOOST_ASSERT(!filename.empty());
571 Alert::error(_("Document could not be read"),
572 bformat(_("%1$s could not be read."), filename));
577 string const token(lex.getString());
580 Alert::error(_("Document could not be read"),
581 bformat(_("%1$s could not be read."), filename));
585 // the first token _must_ be...
586 if (token != "\\lyxformat") {
587 lyxerr << "Token: " << token << endl;
589 Alert::error(_("Document format failure"),
590 bformat(_("%1$s is not a LyX document."),
596 string tmp_format = lex.getString();
597 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
598 // if present remove ".," from string.
599 string::size_type dot = tmp_format.find_first_of(".,");
600 //lyxerr << " dot found at " << dot << endl;
601 if (dot != string::npos)
602 tmp_format.erase(dot, 1);
603 int file_format = strToInt(tmp_format);
604 //lyxerr << "format: " << file_format << endl;
606 if (file_format > LYX_FORMAT) {
607 Alert::warning(_("Document format failure"),
608 bformat(_("%1$s was created with a newer"
609 " version of LyX. This is likely to"
612 } else if (file_format < LYX_FORMAT) {
613 string const tmpfile = tempName();
614 string command = LibFileSearch("lyx2lyx", "lyx2lyx");
615 if (command.empty()) {
616 Alert::error(_("Conversion script not found"),
617 bformat(_("%1$s is from an earlier"
618 " version of LyX, but the"
619 " conversion script lyx2lyx"
620 " could not be found."),
626 + " -o " + tmpfile + ' '
627 + QuoteName(filename);
628 lyxerr[Debug::INFO] << "Running '"
631 cmd_ret const ret = RunCommand(command);
632 if (ret.first != 0) {
633 Alert::error(_("Conversion script failed"),
634 bformat(_("%1$s is from an earlier version"
635 " of LyX, but the lyx2lyx script"
636 " failed to convert it."),
640 bool ret = readFile(tmpfile, pit);
641 // Do stuff with tmpfile name and buffer name here.
647 bool the_end = readBody(lex);
648 params().setPaperStuff();
651 Alert::error(_("Document format failure"),
652 bformat(_("%1$s ended unexpectedly, which means"
653 " that it is probably corrupted."),
656 pimpl_->file_fully_loaded = true;
661 // Should probably be moved to somewhere else: BufferView? LyXView?
662 bool Buffer::save() const
664 // We don't need autosaves in the immediate future. (Asger)
665 resetAutosaveTimers();
669 if (lyxrc.make_backup) {
670 s = fileName() + '~';
671 if (!lyxrc.backupdir_path.empty())
672 s = AddName(lyxrc.backupdir_path,
673 subst(os::slashify_path(s),'/','!'));
675 // Rename is the wrong way of making a backup,
676 // this is the correct way.
677 /* truss cp fil fil2:
678 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
679 stat("LyXVC.lyx", 0xEFFFF688) = 0
680 open("LyXVC.lyx", O_RDONLY) = 3
681 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
682 fstat(4, 0xEFFFF508) = 0
683 fstat(3, 0xEFFFF508) = 0
684 read(3, " # T h i s f i l e w".., 8192) = 5579
685 write(4, " # T h i s f i l e w".., 5579) = 5579
686 read(3, 0xEFFFD4A0, 8192) = 0
689 chmod("LyXVC3.lyx", 0100644) = 0
690 lseek(0, 0, SEEK_CUR) = 46440
694 // Should probably have some more error checking here.
695 // Doing it this way, also makes the inodes stay the same.
696 // This is still not a very good solution, in particular we
697 // might loose the owner of the backup.
698 FileInfo finfo(fileName());
700 mode_t fmode = finfo.getMode();
701 struct utimbuf times = {
702 finfo.getAccessTime(),
703 finfo.getModificationTime() };
705 ifstream ifs(fileName().c_str());
706 ofstream ofs(s.c_str(), ios::out|ios::trunc);
711 ::chmod(s.c_str(), fmode);
713 if (::utime(s.c_str(), ×)) {
714 lyxerr << "utime error." << endl;
717 lyxerr << "LyX was not able to make "
718 "backup copy. Beware." << endl;
723 if (writeFile(fileName())) {
725 removeAutosaveFile(fileName());
727 // Saving failed, so backup is not backup
728 if (lyxrc.make_backup) {
729 rename(s, fileName());
737 bool Buffer::writeFile(string const & fname) const
739 if (pimpl_->read_only && (fname == fileName())) {
743 FileInfo finfo(fname);
744 if (finfo.exist() && !finfo.writable()) {
750 if (params().compressed) {
751 gz::ogzstream ofs(fname.c_str());
756 retval = do_writeFile(ofs);
759 ofstream ofs(fname.c_str());
763 retval = do_writeFile(ofs);
770 bool Buffer::do_writeFile(ostream & ofs) const
774 // Use the standard "C" locale for file output.
775 ofs.imbue(std::locale::classic());
778 // The top of the file should not be written by params().
780 // write out a comment in the top of the file
781 ofs << "#LyX " << lyx_version
782 << " created this file. For more info see http://www.lyx.org/\n"
783 << "\\lyxformat " << LYX_FORMAT << "\n";
785 // now write out the buffer parameters.
786 params().writeFile(ofs);
788 ofs << "\\end_header\n";
791 text().write(*this, ofs);
793 // Write marker that shows file is complete
794 ofs << "\n\\end_document" << endl;
796 // Shouldn't really be needed....
799 // how to check if close went ok?
800 // Following is an attempt... (BE 20001011)
802 // good() returns false if any error occured, including some
804 // bad() returns true if something bad happened in the buffer,
805 // which should include file system full errors.
812 lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
814 lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
824 void Buffer::makeLaTeXFile(string const & fname,
825 string const & original_path,
826 OutputParams const & runparams,
827 bool output_preamble, bool output_body)
829 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
832 if (!openFileWrite(ofs, fname))
835 makeLaTeXFile(ofs, original_path,
836 runparams, output_preamble, output_body);
840 lyxerr << "File was not closed properly." << endl;
845 void Buffer::makeLaTeXFile(ostream & os,
846 string const & original_path,
847 OutputParams const & runparams_in,
848 bool output_preamble, bool output_body)
850 OutputParams runparams = runparams_in;
851 niceFile() = runparams.nice; // this will be used by Insetincludes.
853 // validate the buffer.
854 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
855 LaTeXFeatures features(*this, params());
857 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
860 // The starting paragraph of the coming rows is the
861 // first paragraph of the document. (Asger)
862 texrow().start(paragraphs().begin()->id(), 0);
864 if (output_preamble && runparams.nice) {
865 os << "%% LyX " << lyx_version << " created this file. "
866 "For more info, see http://www.lyx.org/.\n"
867 "%% Do not edit unless you really know what "
872 lyxerr[Debug::INFO] << "lyx header finished" << endl;
873 // There are a few differences between nice LaTeX and usual files:
874 // usual is \batchmode and has a
875 // special input@path to allow the including of figures
876 // with either \input or \includegraphics (what figinsets do).
877 // input@path is set when the actual parameter
878 // original_path is set. This is done for usual tex-file, but not
879 // for nice-latex-file. (Matthias 250696)
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()) {
888 string inputpath = os::external_path(original_path);
889 subst(inputpath, "~", "\\string~");
890 os << "\\makeatletter\n"
891 << "\\def\\input@path{{"
892 << inputpath << "/}}\n"
893 << "\\makeatother\n";
899 // Write the preamble
900 runparams.use_babel = params().writeLaTeX(os, features, texrow());
906 os << "\\begin{document}\n";
909 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
911 if (!lyxrc.language_auto_begin) {
912 os << subst(lyxrc.language_command_begin, "$$lang",
913 params().language->babel())
918 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
920 // add this just in case after all the paragraphs
924 if (!lyxrc.language_auto_end) {
925 os << subst(lyxrc.language_command_end, "$$lang",
926 params().language->babel())
931 if (output_preamble) {
932 os << "\\end{document}\n";
935 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
937 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
941 // Just to be sure. (Asger)
944 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
945 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
948 // we want this to be true outside previews (for insetexternal)
953 bool Buffer::isLatex() const
955 return params().getLyXTextClass().outputType() == LATEX;
959 bool Buffer::isLinuxDoc() const
961 return params().getLyXTextClass().outputType() == LINUXDOC;
965 bool Buffer::isLiterate() const
967 return params().getLyXTextClass().outputType() == LITERATE;
971 bool Buffer::isDocBook() const
973 return params().getLyXTextClass().outputType() == DOCBOOK;
977 bool Buffer::isSGML() const
979 LyXTextClass const & tclass = params().getLyXTextClass();
981 return tclass.outputType() == LINUXDOC ||
982 tclass.outputType() == DOCBOOK;
986 void Buffer::makeLinuxDocFile(string const & fname,
987 OutputParams const & runparams,
991 if (!openFileWrite(ofs, fname))
994 niceFile() = runparams.nice; // this will be used by included files.
996 LaTeXFeatures features(*this, params());
1002 LyXTextClass const & tclass = params().getLyXTextClass();
1004 string top_element = tclass.latexname();
1007 ofs << tclass.class_header();
1009 string preamble = params().preamble;
1010 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1012 preamble += features.getIncludedFiles(name);
1013 preamble += features.getLyXSGMLEntities();
1015 if (!preamble.empty()) {
1016 ofs << " [ " << preamble << " ]";
1020 if (params().options.empty())
1021 sgml::openTag(ofs, 0, false, top_element);
1023 string top = top_element;
1025 top += params().options;
1026 sgml::openTag(ofs, 0, false, top);
1030 ofs << "<!-- LyX " << lyx_version
1031 << " created this file. For more info see http://www.lyx.org/"
1034 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1038 sgml::closeTag(ofs, 0, false, top_element);
1042 // How to check for successful close
1044 // we want this to be true outside previews (for insetexternal)
1049 void Buffer::makeDocBookFile(string const & fname,
1050 OutputParams const & runparams,
1054 if (!openFileWrite(ofs, fname))
1057 niceFile() = runparams.nice; // this will be used by Insetincludes.
1059 LaTeXFeatures features(*this, params());
1064 LyXTextClass const & tclass = params().getLyXTextClass();
1065 string top_element = tclass.latexname();
1068 ofs << subst(tclass.class_header(), "#", top_element);
1070 string preamble = params().preamble;
1071 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1073 preamble += features.getIncludedFiles(name);
1074 preamble += features.getLyXSGMLEntities();
1076 if (!preamble.empty()) {
1077 ofs << "\n [ " << preamble << " ]";
1082 string top = top_element;
1084 top += params().language->code();
1087 if (!params().options.empty()) {
1089 top += params().options;
1091 sgml::openTag(ofs, 0, false, top);
1093 ofs << "<!-- SGML/XML file was created by LyX " << lyx_version
1094 << "\n See http://www.lyx.org/ for more information -->\n";
1096 params().getLyXTextClass().counters().reset();
1097 docbookParagraphs(*this, paragraphs(), ofs, runparams);
1100 sgml::closeTag(ofs, 0, false, top_element);
1103 // How to check for successful close
1105 // we want this to be true outside previews (for insetexternal)
1110 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1111 // Other flags: -wall -v0 -x
1112 int Buffer::runChktex()
1116 // get LaTeX-Filename
1117 string const name = getLatexName();
1118 string path = filePath();
1120 string const org_path = path;
1121 if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
1125 Path p(path); // path to LaTeX file
1126 message(_("Running chktex..."));
1128 // Generate the LaTeX file if neccessary
1129 OutputParams runparams;
1130 runparams.flavor = OutputParams::LATEX;
1131 runparams.nice = false;
1132 makeLaTeXFile(name, org_path, runparams);
1135 Chktex chktex(lyxrc.chktex_command, name, filePath());
1136 int res = chktex.run(terr); // run chktex
1139 Alert::error(_("chktex failure"),
1140 _("Could not run chktex successfully."));
1141 } else if (res > 0) {
1142 // Insert all errors as errors boxes
1143 bufferErrors(*this, terr);
1152 void Buffer::validate(LaTeXFeatures & features) const
1154 LyXTextClass const & tclass = params().getLyXTextClass();
1156 if (params().tracking_changes) {
1157 features.require("dvipost");
1158 features.require("color");
1161 // AMS Style is at document level
1162 if (params().use_amsmath == BufferParams::AMS_ON
1163 || tclass.provides(LyXTextClass::amsmath))
1164 features.require("amsmath");
1166 for_each(paragraphs().begin(), paragraphs().end(),
1167 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1169 // the bullet shapes are buffer level not paragraph level
1170 // so they are tested here
1171 for (int i = 0; i < 4; ++i) {
1172 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1173 int const font = params().user_defined_bullet(i).getFont();
1175 int const c = params()
1176 .user_defined_bullet(i)
1183 features.require("latexsym");
1185 } else if (font == 1) {
1186 features.require("amssymb");
1187 } else if ((font >= 2 && font <= 5)) {
1188 features.require("pifont");
1193 if (lyxerr.debugging(Debug::LATEX)) {
1194 features.showStruct();
1199 void Buffer::getLabelList(std::vector<string> & list) const
1201 /// if this is a child document and the parent is already loaded
1202 /// Use the parent's list instead [ale990407]
1203 if (!params().parentname.empty()
1204 && bufferlist.exists(params().parentname)) {
1205 Buffer const * tmp = bufferlist.getBuffer(params().parentname);
1207 tmp->getLabelList(list);
1212 for (inset_iterator it = inset_const_iterator_begin();
1213 it != inset_const_iterator_end(); ++it) {
1214 it->getLabelList(*this, list);
1219 // This is also a buffer property (ale)
1220 void Buffer::fillWithBibKeys(std::vector<std::pair<string, string> > & keys)
1223 /// if this is a child document and the parent is already loaded
1224 /// use the parent's list instead [ale990412]
1225 if (!params().parentname.empty() &&
1226 bufferlist.exists(params().parentname)) {
1227 Buffer const * tmp = bufferlist.getBuffer(params().parentname);
1229 tmp->fillWithBibKeys(keys);
1234 for (inset_iterator it = inset_const_iterator_begin();
1235 it != inset_const_iterator_end(); ++it) {
1236 if (it->lyxCode() == InsetOld::BIBTEX_CODE) {
1237 InsetBibtex const & inset =
1238 dynamic_cast<InsetBibtex const &>(*it);
1239 inset.fillWithBibKeys(*this, keys);
1240 } else if (it->lyxCode() == InsetOld::INCLUDE_CODE) {
1241 InsetInclude const & inset =
1242 dynamic_cast<InsetInclude const &>(*it);
1243 inset.fillWithBibKeys(*this, keys);
1244 } else if (it->lyxCode() == InsetOld::BIBITEM_CODE) {
1245 InsetBibitem const & inset =
1246 dynamic_cast<InsetBibitem const &>(*it);
1247 string const key = inset.getContents();
1248 string const opt = inset.getOptions();
1249 string const ref; // = pit->asString(this, false);
1250 string const info = opt + "TheBibliographyRef" + ref;
1251 keys.push_back(pair<string, string>(key, info));
1257 bool Buffer::isDepClean(string const & name) const
1259 DepClean::const_iterator it = pimpl_->dep_clean.find(name);
1260 if (it == pimpl_->dep_clean.end())
1266 void Buffer::markDepClean(string const & name)
1268 pimpl_->dep_clean[name] = true;
1272 bool Buffer::dispatch(string const & command, bool * result)
1274 return dispatch(lyxaction.lookupFunc(command), result);
1278 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1280 bool dispatched = true;
1282 switch (func.action) {
1284 bool const tmp = Exporter::Export(this, func.argument, false);
1297 void Buffer::changeLanguage(Language const * from, Language const * to)
1299 lyxerr << "Changing Language!" << endl;
1301 // Take care of l10n/i18n
1304 ParIterator end = par_iterator_end();
1305 for (ParIterator it = par_iterator_begin(); it != end; ++it)
1306 it->changeLanguage(params(), from, to);
1310 void Buffer::updateDocLang(Language const * nlang)
1312 pimpl_->messages.reset(new Messages(nlang->code()));
1316 bool Buffer::isMultiLingual()
1318 ParIterator end = par_iterator_end();
1319 for (ParIterator it = par_iterator_begin(); it != end; ++it)
1320 if (it->isMultiLingual(params()))
1327 void Buffer::inset_iterator::setParagraph()
1329 while (pit != pend) {
1330 it = pit->insetlist.begin();
1331 if (it != pit->insetlist.end())
1338 ParIterator Buffer::getParFromID(int id) const
1340 #warning FIXME: const correctness! (Andre)
1341 ParIterator it = const_cast<Buffer*>(this)->par_iterator_begin();
1342 ParIterator end = const_cast<Buffer*>(this)->par_iterator_end();
1344 #warning FIXME, perhaps this func should return a ParIterator? (Lgb)
1346 // John says this is called with id == -1 from undo
1347 lyxerr << "getParFromID(), id: " << id << endl;
1351 for (; it != end; ++it)
1359 bool Buffer::hasParWithID(int id) const
1361 ParConstIterator it = par_iterator_begin();
1362 ParConstIterator end = par_iterator_end();
1365 // John says this is called with id == -1 from undo
1366 lyxerr << "hasParWithID(), id: " << id << endl;
1370 for (; it != end; ++it)
1378 PosIterator Buffer::pos_iterator_begin()
1380 return PosIterator(¶graphs(), paragraphs().begin(), 0);
1384 PosIterator Buffer::pos_iterator_end()
1386 return PosIterator(¶graphs(), paragraphs().end(), 0);
1390 ParIterator Buffer::par_iterator_begin()
1392 return ParIterator(paragraphs().begin(), paragraphs());
1396 ParIterator Buffer::par_iterator_end()
1398 return ParIterator(paragraphs().end(), paragraphs());
1402 ParConstIterator Buffer::par_iterator_begin() const
1404 ParagraphList const & pars = paragraphs();
1405 return ParConstIterator(const_cast<ParagraphList&>(pars).begin(), pars);
1409 ParConstIterator Buffer::par_iterator_end() const
1411 ParagraphList const & pars = paragraphs();
1412 return ParConstIterator(const_cast<ParagraphList&>(pars).end(), pars);
1416 Language const * Buffer::getLanguage() const
1418 return params().language;
1422 string const Buffer::B_(string const & l10n) const
1424 if (pimpl_->messages.get()) {
1425 return pimpl_->messages->get(l10n);
1432 bool Buffer::isClean() const
1434 return pimpl_->lyx_clean;
1438 bool Buffer::isBakClean() const
1440 return pimpl_->bak_clean;
1444 void Buffer::markClean() const
1446 if (!pimpl_->lyx_clean) {
1447 pimpl_->lyx_clean = true;
1450 // if the .lyx file has been saved, we don't need an
1452 pimpl_->bak_clean = true;
1456 void Buffer::markBakClean()
1458 pimpl_->bak_clean = true;
1462 void Buffer::setUnnamed(bool flag)
1464 pimpl_->unnamed = flag;
1468 bool Buffer::isUnnamed()
1470 return pimpl_->unnamed;
1474 void Buffer::markDirty()
1476 if (pimpl_->lyx_clean) {
1477 pimpl_->lyx_clean = false;
1480 pimpl_->bak_clean = false;
1482 DepClean::iterator it = pimpl_->dep_clean.begin();
1483 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1485 for (; it != end; ++it) {
1491 string const & Buffer::fileName() const
1493 return pimpl_->filename;
1497 string const & Buffer::filePath() const
1499 return pimpl_->filepath;
1503 bool Buffer::isReadonly() const
1505 return pimpl_->read_only;
1509 void Buffer::setParentName(string const & name)
1511 params().parentname = name;
1515 Buffer::inset_iterator::inset_iterator()
1520 Buffer::inset_iterator::inset_iterator(base_type p, base_type e)
1527 Buffer::inset_iterator Buffer::inset_iterator_begin()
1529 return inset_iterator(paragraphs().begin(), paragraphs().end());
1533 Buffer::inset_iterator Buffer::inset_iterator_end()
1535 return inset_iterator(paragraphs().end(), paragraphs().end());
1539 Buffer::inset_iterator Buffer::inset_const_iterator_begin() const
1541 ParagraphList & pars = const_cast<ParagraphList&>(paragraphs());
1542 return inset_iterator(pars.begin(), pars.end());
1546 Buffer::inset_iterator Buffer::inset_const_iterator_end() const
1548 ParagraphList & pars = const_cast<ParagraphList&>(paragraphs());
1549 return inset_iterator(pars.end(), pars.end());
1553 Buffer::inset_iterator & Buffer::inset_iterator::operator++()
1557 if (it == pit->insetlist.end()) {
1566 Buffer::inset_iterator Buffer::inset_iterator::operator++(int)
1568 inset_iterator tmp = *this;
1574 Buffer::inset_iterator::reference Buffer::inset_iterator::operator*()
1580 Buffer::inset_iterator::pointer Buffer::inset_iterator::operator->()
1586 ParagraphList::iterator Buffer::inset_iterator::getPar() const
1592 lyx::pos_type Buffer::inset_iterator::getPos() const
1598 bool operator==(Buffer::inset_iterator const & iter1,
1599 Buffer::inset_iterator const & iter2)
1601 return iter1.pit == iter2.pit
1602 && (iter1.pit == iter1.pend || iter1.it == iter2.it);
1606 bool operator!=(Buffer::inset_iterator const & iter1,
1607 Buffer::inset_iterator const & iter2)
1609 return !(iter1 == iter2);