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"
24 #include "errorlist.h"
27 #include "funcrequest.h"
29 #include "insetiterator.h"
32 #include "LaTeXFeatures.h"
33 #include "LyXAction.h"
41 #include "output_docbook.h"
42 #include "output_latex.h"
43 #include "output_linuxdoc.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/math_macrotemplate.h"
59 #include "mathed/math_macrotable.h"
60 #include "mathed/math_support.h"
62 #include "frontends/Alert.h"
64 #include "graphics/Previews.h"
66 #include "support/FileInfo.h"
67 #include "support/filetools.h"
68 #include "support/gzstream.h"
69 #include "support/lyxlib.h"
70 #include "support/os.h"
71 #include "support/path.h"
72 #include "support/textutils.h"
73 #include "support/tostr.h"
74 #include "support/std_sstream.h"
76 #include <boost/bind.hpp>
86 using lyx::support::AddName;
87 using lyx::support::atoi;
88 using lyx::support::bformat;
89 using lyx::support::ChangeExtension;
90 using lyx::support::cmd_ret;
91 using lyx::support::createBufferTmpDir;
92 using lyx::support::destroyDir;
93 using lyx::support::FileInfo;
94 using lyx::support::FileInfo;
95 using lyx::support::getExtFromContents;
96 using lyx::support::IsDirWriteable;
97 using lyx::support::IsFileWriteable;
98 using lyx::support::LibFileSearch;
99 using lyx::support::ltrim;
100 using lyx::support::MakeAbsPath;
101 using lyx::support::MakeDisplayPath;
102 using lyx::support::MakeLatexName;
103 using lyx::support::OnlyFilename;
104 using lyx::support::OnlyPath;
105 using lyx::support::Path;
106 using lyx::support::QuoteName;
107 using lyx::support::removeAutosaveFile;
108 using lyx::support::rename;
109 using lyx::support::RunCommand;
110 using lyx::support::split;
111 using lyx::support::strToInt;
112 using lyx::support::subst;
113 using lyx::support::tempName;
114 using lyx::support::trim;
116 namespace os = lyx::support::os;
120 using std::make_pair;
126 using std::ostringstream;
134 // all these externs should eventually be removed.
135 extern BufferList bufferlist;
139 const int LYX_FORMAT = 235;
144 typedef std::map<string, bool> DepClean;
148 Impl(Buffer & parent, string const & file, bool readonly);
150 limited_stack<Undo> undostack;
151 limited_stack<Undo> redostack;
157 /// need to regenerate .tex?
161 mutable bool lyx_clean;
163 /// is autosave needed?
164 mutable bool bak_clean;
166 /// is this a unnamed file (New...)?
172 /// name of the file the buffer is associated with.
175 /// The path to the document file.
178 boost::scoped_ptr<Messages> messages;
180 /** Set to true only when the file is fully loaded.
181 * Used to prevent the premature generation of previews
182 * and by the citation inset.
184 bool file_fully_loaded;
186 /// our LyXText that should be wrapped in an InsetText
194 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
195 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
196 filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
199 lyxvc.buffer(&parent);
200 temppath = createBufferTmpDir();
201 // FIXME: And now do something if temppath == string(), because we
202 // assume from now on that temppath points to a valid temp dir.
203 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
207 Buffer::Buffer(string const & file, bool ronly)
208 : pimpl_(new Impl(*this, file, ronly))
210 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
216 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
217 // here the buffer should take care that it is
218 // saved properly, before it goes into the void.
222 if (!temppath().empty() && destroyDir(temppath()) != 0) {
223 Alert::warning(_("Could not remove temporary directory"),
224 bformat(_("Could not remove the temporary directory %1$s"), temppath()));
227 // Remove any previewed LaTeX snippets associated with this buffer.
228 lyx::graphics::Previews::get().removeLoader(*this);
232 LyXText & Buffer::text() const
234 return const_cast<LyXText &>(pimpl_->inset.text_);
238 InsetBase & Buffer::inset() const
240 return const_cast<InsetText &>(pimpl_->inset);
244 limited_stack<Undo> & Buffer::undostack()
246 return pimpl_->undostack;
250 limited_stack<Undo> const & Buffer::undostack() const
252 return pimpl_->undostack;
256 limited_stack<Undo> & Buffer::redostack()
258 return pimpl_->redostack;
262 limited_stack<Undo> const & Buffer::redostack() const
264 return pimpl_->redostack;
268 BufferParams & Buffer::params()
270 return pimpl_->params;
274 BufferParams const & Buffer::params() const
276 return pimpl_->params;
280 ParagraphList & Buffer::paragraphs()
282 return text().paragraphs();
286 ParagraphList const & Buffer::paragraphs() const
288 return text().paragraphs();
292 LyXVC & Buffer::lyxvc()
294 return pimpl_->lyxvc;
298 LyXVC const & Buffer::lyxvc() const
300 return pimpl_->lyxvc;
304 string const & Buffer::temppath() const
306 return pimpl_->temppath;
310 TexRow & Buffer::texrow()
312 return pimpl_->texrow;
316 TexRow const & Buffer::texrow() const
318 return pimpl_->texrow;
322 string const Buffer::getLatexName(bool no_path) const
324 string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
325 return no_path ? OnlyFilename(name) : name;
329 pair<Buffer::LogType, string> const Buffer::getLogName() const
331 string const filename = getLatexName(false);
333 if (filename.empty())
334 return make_pair(Buffer::latexlog, string());
336 string const path = temppath();
338 string const fname = AddName(path,
339 OnlyFilename(ChangeExtension(filename,
342 AddName(path, OnlyFilename(
343 ChangeExtension(filename,
344 formats.extension("literate") + ".out")));
346 // If no Latex log or Build log is newer, show Build log
348 FileInfo const f_fi(fname);
349 FileInfo const b_fi(bname);
352 (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
353 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
354 return make_pair(Buffer::buildlog, bname);
356 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
357 return make_pair(Buffer::latexlog, fname);
361 void Buffer::setReadonly(bool flag)
363 if (pimpl_->read_only != flag) {
364 pimpl_->read_only = flag;
370 void Buffer::setFileName(string const & newfile)
372 pimpl_->filename = MakeAbsPath(newfile);
373 pimpl_->filepath = OnlyPath(pimpl_->filename);
374 setReadonly(IsFileWriteable(pimpl_->filename) == 0);
379 // We'll remove this later. (Lgb)
382 void unknownClass(string const & unknown)
384 Alert::warning(_("Unknown document class"),
385 bformat(_("Using the default document class, because the "
386 "class %1$s is unknown."), unknown));
392 int Buffer::readHeader(LyXLex & lex)
394 int unknown_tokens = 0;
398 string const token = lex.getString();
403 if (token == "\\end_header")
406 lyxerr[Debug::PARSER] << "Handling header token: `"
407 << token << '\'' << endl;
410 string unknown = params().readToken(lex, token);
411 if (!unknown.empty()) {
412 if (unknown[0] != '\\') {
413 unknownClass(unknown);
416 string const s = bformat(_("Unknown token: "
420 error(ErrorItem(_("Header error"), s,
425 return unknown_tokens;
430 // changed to be public and have one parameter
431 // Returns false if "\end_document" is not read (Asger)
432 bool Buffer::readBody(LyXLex & lex)
434 if (paragraphs().empty()) {
436 if (!params().getLyXTextClass().load()) {
437 string theclass = params().getLyXTextClass().name();
438 Alert::error(_("Can't load document class"), bformat(
439 "Using the default document class, because the "
440 " class %1$s could not be loaded.", theclass));
441 params().textclass = 0;
444 // We don't want to adopt the parameters from the
445 // document we insert, so read them into a temporary buffer
446 // and then discard it
448 Buffer tmpbuf("", false);
449 tmpbuf.readHeader(lex);
452 return text().read(*this, lex);
456 // needed to insert the selection
457 void Buffer::insertStringAsLines(ParagraphList & pars,
458 par_type & par, pos_type & pos,
459 LyXFont const & fn, string const & str)
461 LyXLayout_ptr const & layout = pars[par].layout();
465 pars[par].checkInsertChar(font);
466 // insert the string, don't insert doublespace
467 bool space_inserted = true;
468 bool autobreakrows = pars[par].autoBreakRows();
469 for (string::const_iterator cit = str.begin();
470 cit != str.end(); ++cit) {
472 if (autobreakrows && (!pars[par].empty() || pars[par].allowEmpty())) {
473 breakParagraph(params(), paragraphs(), par, pos,
474 layout->isEnvironment());
477 space_inserted = true;
481 // do not insert consecutive spaces if !free_spacing
482 } else if ((*cit == ' ' || *cit == '\t') &&
483 space_inserted && !pars[par].isFreeSpacing()) {
485 } else if (*cit == '\t') {
486 if (!pars[par].isFreeSpacing()) {
487 // tabs are like spaces here
488 pars[par].insertChar(pos, ' ', font);
490 space_inserted = true;
492 const pos_type n = 8 - pos % 8;
493 for (pos_type i = 0; i < n; ++i) {
494 pars[par].insertChar(pos, ' ', font);
497 space_inserted = true;
499 } else if (!IsPrintable(*cit)) {
500 // Ignore unprintables
503 // just insert the character
504 pars[par].insertChar(pos, *cit, font);
506 space_inserted = (*cit == ' ');
513 bool Buffer::readFile(string const & filename)
515 // Check if the file is compressed.
516 string const format = getExtFromContents(filename);
517 if (format == "gzip" || format == "zip" || format == "compress") {
518 params().compressed = true;
521 // remove dummy empty par
522 paragraphs().clear();
523 bool ret = readFile(filename, paragraphs().size());
525 // After we have read a file, we must ensure that the buffer
526 // language is set and used in the gui.
527 // If you know of a better place to put this, please tell me. (Lgb)
528 updateDocLang(params().language);
534 bool Buffer::readFile(string const & filename, par_type pit)
537 lex.setFile(filename);
538 return readFile(lex, filename, pit);
542 bool Buffer::fully_loaded() const
544 return pimpl_->file_fully_loaded;
548 void Buffer::fully_loaded(bool value)
550 pimpl_->file_fully_loaded = value;
554 bool Buffer::readFile(LyXLex & lex, string const & filename, par_type pit)
556 BOOST_ASSERT(!filename.empty());
559 Alert::error(_("Document could not be read"),
560 bformat(_("%1$s could not be read."), filename));
565 string const token(lex.getString());
568 Alert::error(_("Document could not be read"),
569 bformat(_("%1$s could not be read."), filename));
573 // the first token _must_ be...
574 if (token != "\\lyxformat") {
575 lyxerr << "Token: " << token << endl;
577 Alert::error(_("Document format failure"),
578 bformat(_("%1$s is not a LyX document."),
584 string tmp_format = lex.getString();
585 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
586 // if present remove ".," from string.
587 string::size_type dot = tmp_format.find_first_of(".,");
588 //lyxerr << " dot found at " << dot << endl;
589 if (dot != string::npos)
590 tmp_format.erase(dot, 1);
591 int file_format = strToInt(tmp_format);
592 //lyxerr << "format: " << file_format << endl;
594 if (file_format > LYX_FORMAT) {
595 Alert::warning(_("Document format failure"),
596 bformat(_("%1$s was created with a newer"
597 " version of LyX. This is likely to"
600 } else if (file_format < LYX_FORMAT) {
601 string const tmpfile = tempName();
602 if (tmpfile.empty()) {
603 Alert::error(_("Conversion failed"),
604 bformat(_("%1$s is from an earlier"
605 " version of LyX, but a temporary"
606 " file for converting it could"
611 string command = LibFileSearch("lyx2lyx", "lyx2lyx");
612 if (command.empty()) {
613 Alert::error(_("Conversion script not found"),
614 bformat(_("%1$s is from an earlier"
615 " version of LyX, but the"
616 " conversion script lyx2lyx"
617 " could not be found."),
623 + " -o " + tmpfile + ' '
624 + QuoteName(filename);
625 lyxerr[Debug::INFO] << "Running '"
628 cmd_ret const ret = RunCommand(command);
629 if (ret.first != 0) {
630 Alert::error(_("Conversion script failed"),
631 bformat(_("%1$s is from an earlier version"
632 " of LyX, but the lyx2lyx script"
633 " failed to convert it."),
637 bool ret = readFile(tmpfile, pit);
638 // Do stuff with tmpfile name and buffer name here.
644 bool the_end = readBody(lex);
645 //lyxerr << "removing " << MacroTable::localMacros().size()
646 // << " temporary macro entries" << endl;
647 //MacroTable::localMacros().clear();
648 params().setPaperStuff();
654 if (token == "\\end_document")
658 Alert::error(_("Document format failure"),
659 bformat(_("%1$s ended unexpectedly, which means"
660 " that it is probably corrupted."),
664 pimpl_->file_fully_loaded = true;
669 // Should probably be moved to somewhere else: BufferView? LyXView?
670 bool Buffer::save() const
672 // We don't need autosaves in the immediate future. (Asger)
673 resetAutosaveTimers();
677 if (lyxrc.make_backup) {
678 s = fileName() + '~';
679 if (!lyxrc.backupdir_path.empty())
680 s = AddName(lyxrc.backupdir_path,
681 subst(os::slashify_path(s),'/','!'));
683 // Rename is the wrong way of making a backup,
684 // this is the correct way.
685 /* truss cp fil fil2:
686 lstat("LyXVC3.lyx", 0xEFFFF898) Err#2 ENOENT
687 stat("LyXVC.lyx", 0xEFFFF688) = 0
688 open("LyXVC.lyx", O_RDONLY) = 3
689 open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
690 fstat(4, 0xEFFFF508) = 0
691 fstat(3, 0xEFFFF508) = 0
692 read(3, " # T h i s f i l e w".., 8192) = 5579
693 write(4, " # T h i s f i l e w".., 5579) = 5579
694 read(3, 0xEFFFD4A0, 8192) = 0
697 chmod("LyXVC3.lyx", 0100644) = 0
698 lseek(0, 0, SEEK_CUR) = 46440
702 // Should probably have some more error checking here.
703 // Doing it this way, also makes the inodes stay the same.
704 // This is still not a very good solution, in particular we
705 // might loose the owner of the backup.
706 FileInfo finfo(fileName());
708 mode_t fmode = finfo.getMode();
709 struct utimbuf times = {
710 finfo.getAccessTime(),
711 finfo.getModificationTime() };
713 ifstream ifs(fileName().c_str());
714 ofstream ofs(s.c_str(), ios::out|ios::trunc);
719 ::chmod(s.c_str(), fmode);
721 if (::utime(s.c_str(), ×)) {
722 lyxerr << "utime error." << endl;
725 lyxerr << "LyX was not able to make "
726 "backup copy. Beware." << endl;
731 if (writeFile(fileName())) {
733 removeAutosaveFile(fileName());
735 // Saving failed, so backup is not backup
736 if (lyxrc.make_backup)
737 rename(s, fileName());
744 bool Buffer::writeFile(string const & fname) const
746 if (pimpl_->read_only && fname == fileName())
749 FileInfo finfo(fname);
750 if (finfo.exist() && !finfo.writable())
755 if (params().compressed) {
756 gz::ogzstream ofs(fname.c_str());
760 retval = do_writeFile(ofs);
763 ofstream ofs(fname.c_str());
767 retval = do_writeFile(ofs);
774 bool Buffer::do_writeFile(ostream & ofs) const
777 // Use the standard "C" locale for file output.
778 ofs.imbue(std::locale::classic());
781 // The top of the file should not be written by params().
783 // write out a comment in the top of the file
784 ofs << "#LyX " << lyx_version
785 << " created this file. For more info see http://www.lyx.org/\n"
786 << "\\lyxformat " << LYX_FORMAT << "\n";
788 // now write out the buffer parameters.
789 params().writeFile(ofs);
791 ofs << "\\end_header\n";
794 text().write(*this, ofs);
796 // Write marker that shows file is complete
797 ofs << "\n\\end_document" << endl;
799 // Shouldn't really be needed....
802 // how to check if close went ok?
803 // Following is an attempt... (BE 20001011)
805 // good() returns false if any error occured, including some
807 // bad() returns true if something bad happened in the buffer,
808 // which should include file system full errors.
813 lyxerr << "File was not closed properly." << endl;
820 void Buffer::makeLaTeXFile(string const & fname,
821 string const & original_path,
822 OutputParams const & runparams,
823 bool output_preamble, bool output_body)
825 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
828 if (!openFileWrite(ofs, fname))
831 makeLaTeXFile(ofs, original_path,
832 runparams, output_preamble, output_body);
836 lyxerr << "File '" << fname << "' was not closed properly." << endl;
840 void Buffer::makeLaTeXFile(ostream & os,
841 string const & original_path,
842 OutputParams const & runparams_in,
843 bool output_preamble, bool output_body)
845 OutputParams runparams = runparams_in;
847 // validate the buffer.
848 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
849 LaTeXFeatures features(*this, params(), runparams.nice);
851 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
854 // The starting paragraph of the coming rows is the
855 // first paragraph of the document. (Asger)
856 texrow().start(paragraphs().begin()->id(), 0);
858 if (output_preamble && runparams.nice) {
859 os << "%% LyX " << lyx_version << " created this file. "
860 "For more info, see http://www.lyx.org/.\n"
861 "%% Do not edit unless you really know what "
866 lyxerr[Debug::INFO] << "lyx header finished" << endl;
867 // There are a few differences between nice LaTeX and usual files:
868 // usual is \batchmode and has a
869 // special input@path to allow the including of figures
870 // with either \input or \includegraphics (what figinsets do).
871 // input@path is set when the actual parameter
872 // original_path is set. This is done for usual tex-file, but not
873 // for nice-latex-file. (Matthias 250696)
874 // Note that input@path is only needed for something the user does
875 // in the preamble, included .tex files or ERT, files included by
876 // LyX work without it.
877 if (output_preamble) {
878 if (!runparams.nice) {
879 // code for usual, NOT nice-latex-file
880 os << "\\batchmode\n"; // changed
884 if (!original_path.empty()) {
885 string inputpath = os::external_path(original_path);
886 subst(inputpath, "~", "\\string~");
887 os << "\\makeatletter\n"
888 << "\\def\\input@path{{"
889 << inputpath << "/}}\n"
890 << "\\makeatother\n";
896 // Write the preamble
897 runparams.use_babel = params().writeLaTeX(os, features, texrow());
903 os << "\\begin{document}\n";
906 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
908 if (!lyxrc.language_auto_begin) {
909 os << subst(lyxrc.language_command_begin, "$$lang",
910 params().language->babel())
915 // if we are doing a real file with body, even if this is the
916 // child of some other buffer, let's cut the link here.
917 // This happens for example if only a child document is printed.
918 string save_parentname;
919 if (output_preamble) {
920 save_parentname = params().parentname;
921 params().parentname.erase();
925 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
927 // Restore the parenthood if needed
929 params().parentname = save_parentname;
931 // add this just in case after all the paragraphs
935 if (!lyxrc.language_auto_end) {
936 os << subst(lyxrc.language_command_end, "$$lang",
937 params().language->babel())
942 if (output_preamble) {
943 os << "\\end{document}\n";
946 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
948 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
952 // Just to be sure. (Asger)
955 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
956 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
961 bool Buffer::isLatex() const
963 return params().getLyXTextClass().outputType() == LATEX;
967 bool Buffer::isLinuxDoc() const
969 return params().getLyXTextClass().outputType() == LINUXDOC;
973 bool Buffer::isLiterate() const
975 return params().getLyXTextClass().outputType() == LITERATE;
979 bool Buffer::isDocBook() const
981 return params().getLyXTextClass().outputType() == DOCBOOK;
985 bool Buffer::isSGML() const
987 LyXTextClass const & tclass = params().getLyXTextClass();
989 return tclass.outputType() == LINUXDOC ||
990 tclass.outputType() == DOCBOOK;
994 void Buffer::makeLinuxDocFile(string const & fname,
995 OutputParams const & runparams,
999 if (!openFileWrite(ofs, fname))
1002 LaTeXFeatures features(*this, params(), runparams.nice);
1007 LyXTextClass const & tclass = params().getLyXTextClass();
1009 string top_element = tclass.latexname();
1012 ofs << tclass.class_header();
1014 string preamble = params().preamble;
1015 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1017 preamble += features.getIncludedFiles(name);
1018 preamble += features.getLyXSGMLEntities();
1020 if (!preamble.empty()) {
1021 ofs << " [ " << preamble << " ]";
1025 if (params().options.empty())
1026 sgml::openTag(ofs, 0, false, top_element);
1028 string top = top_element;
1030 top += params().options;
1031 sgml::openTag(ofs, 0, false, top);
1035 ofs << "<!-- LyX " << lyx_version
1036 << " created this file. For more info see http://www.lyx.org/"
1039 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1043 sgml::closeTag(ofs, 0, false, top_element);
1048 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1052 void Buffer::makeDocBookFile(string const & fname,
1053 OutputParams const & runparams,
1057 if (!openFileWrite(ofs, fname))
1060 LaTeXFeatures features(*this, params(), runparams.nice);
1065 LyXTextClass const & tclass = params().getLyXTextClass();
1066 string top_element = tclass.latexname();
1069 if (runparams.flavor == OutputParams::XML)
1070 ofs << "<?xml version=\"1.0\" encoding=\""
1071 << params().language->encoding()->Name() << "\"?>\n";
1073 ofs << "<!DOCTYPE " << top_element << " ";
1075 if (! tclass.class_header().empty()) ofs << tclass.class_header();
1076 else if (runparams.flavor == OutputParams::XML)
1077 ofs << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1078 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1080 ofs << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1082 string preamble = params().preamble;
1083 string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
1085 preamble += features.getIncludedFiles(name);
1086 preamble += features.getLyXSGMLEntities();
1088 if (!preamble.empty()) {
1089 ofs << "\n [ " << preamble << " ]";
1094 string top = top_element;
1096 if (runparams.flavor == OutputParams::XML)
1097 top += params().language->code();
1099 top += params().language->code().substr(0,2);
1102 if (!params().options.empty()) {
1104 top += params().options;
1106 sgml::openTag(ofs, 0, false, top);
1108 ofs << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1109 << " file was created by LyX " << lyx_version
1110 << "\n See http://www.lyx.org/ for more information -->\n";
1112 params().getLyXTextClass().counters().reset();
1113 docbookParagraphs(*this, paragraphs(), ofs, runparams);
1116 sgml::closeTag(ofs, 0, false, top_element);
1120 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1124 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1125 // Other flags: -wall -v0 -x
1126 int Buffer::runChktex()
1130 // get LaTeX-Filename
1131 string const name = getLatexName();
1132 string const path = temppath();
1133 string const org_path = filePath();
1135 Path p(path); // path to LaTeX file
1136 message(_("Running chktex..."));
1138 // Generate the LaTeX file if neccessary
1139 OutputParams runparams;
1140 runparams.flavor = OutputParams::LATEX;
1141 runparams.nice = false;
1142 makeLaTeXFile(name, org_path, runparams);
1145 Chktex chktex(lyxrc.chktex_command, name, filePath());
1146 int res = chktex.run(terr); // run chktex
1149 Alert::error(_("chktex failure"),
1150 _("Could not run chktex successfully."));
1151 } else if (res > 0) {
1152 // Insert all errors as errors boxes
1153 bufferErrors(*this, terr);
1162 void Buffer::validate(LaTeXFeatures & features) const
1164 LyXTextClass const & tclass = params().getLyXTextClass();
1166 if (params().tracking_changes) {
1167 features.require("dvipost");
1168 features.require("color");
1171 // AMS Style is at document level
1172 if (params().use_amsmath == BufferParams::AMS_ON
1173 || tclass.provides(LyXTextClass::amsmath))
1174 features.require("amsmath");
1176 for_each(paragraphs().begin(), paragraphs().end(),
1177 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1179 // the bullet shapes are buffer level not paragraph level
1180 // so they are tested here
1181 for (int i = 0; i < 4; ++i) {
1182 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1183 int const font = params().user_defined_bullet(i).getFont();
1185 int const c = params()
1186 .user_defined_bullet(i)
1193 features.require("latexsym");
1195 } else if (font == 1) {
1196 features.require("amssymb");
1197 } else if ((font >= 2 && font <= 5)) {
1198 features.require("pifont");
1203 if (lyxerr.debugging(Debug::LATEX)) {
1204 features.showStruct();
1209 void Buffer::getLabelList(std::vector<string> & list) const
1211 /// if this is a child document and the parent is already loaded
1212 /// Use the parent's list instead [ale990407]
1213 Buffer const * tmp = getMasterBuffer();
1215 lyxerr << "getMasterBuffer() failed!" << endl;
1219 tmp->getLabelList(list);
1223 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1224 it.nextInset()->getLabelList(*this, list);
1228 // This is also a buffer property (ale)
1229 void Buffer::fillWithBibKeys(std::vector<std::pair<string, string> > & keys)
1232 /// if this is a child document and the parent is already loaded
1233 /// use the parent's list instead [ale990412]
1234 Buffer const * tmp = getMasterBuffer();
1237 tmp->fillWithBibKeys(keys);
1241 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1242 if (it->lyxCode() == InsetOld::BIBTEX_CODE) {
1243 InsetBibtex const & inset =
1244 dynamic_cast<InsetBibtex const &>(*it);
1245 inset.fillWithBibKeys(*this, keys);
1246 } else if (it->lyxCode() == InsetOld::INCLUDE_CODE) {
1247 InsetInclude const & inset =
1248 dynamic_cast<InsetInclude const &>(*it);
1249 inset.fillWithBibKeys(*this, keys);
1250 } else if (it->lyxCode() == InsetOld::BIBITEM_CODE) {
1251 InsetBibitem const & inset =
1252 dynamic_cast<InsetBibitem const &>(*it);
1253 string const key = inset.getContents();
1254 string const opt = inset.getOptions();
1255 string const ref; // = pit->asString(this, false);
1256 string const info = opt + "TheBibliographyRef" + ref;
1257 keys.push_back(pair<string, string>(key, info));
1263 bool Buffer::isDepClean(string const & name) const
1265 DepClean::const_iterator it = pimpl_->dep_clean.find(name);
1266 if (it == pimpl_->dep_clean.end())
1272 void Buffer::markDepClean(string const & name)
1274 pimpl_->dep_clean[name] = true;
1278 bool Buffer::dispatch(string const & command, bool * result)
1280 return dispatch(lyxaction.lookupFunc(command), result);
1284 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1286 bool dispatched = true;
1288 switch (func.action) {
1290 bool const tmp = Exporter::Export(this, func.argument, false);
1303 void Buffer::changeLanguage(Language const * from, Language const * to)
1305 lyxerr << "Changing Language!" << endl;
1307 // Take care of l10n/i18n
1310 ParIterator end = par_iterator_end();
1311 for (ParIterator it = par_iterator_begin(); it != end; ++it)
1312 it->changeLanguage(params(), from, to);
1316 void Buffer::updateDocLang(Language const * nlang)
1318 pimpl_->messages.reset(new Messages(nlang->code()));
1322 bool Buffer::isMultiLingual() const
1324 ParConstIterator end = par_iterator_end();
1325 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1326 if (it->isMultiLingual(params()))
1333 ParIterator Buffer::getParFromID(int id) const
1335 ParConstIterator it = par_iterator_begin();
1336 ParConstIterator end = par_iterator_end();
1339 // John says this is called with id == -1 from undo
1340 lyxerr << "getParFromID(), id: " << id << endl;
1344 for (; it != end; ++it)
1352 bool Buffer::hasParWithID(int id) const
1354 ParConstIterator it = par_iterator_begin();
1355 ParConstIterator end = par_iterator_end();
1358 // John says this is called with id == -1 from undo
1359 lyxerr << "hasParWithID(), id: " << id << endl;
1363 for (; it != end; ++it)
1371 ParIterator Buffer::par_iterator_begin()
1373 return ::par_iterator_begin(inset());
1377 ParIterator Buffer::par_iterator_end()
1379 return ::par_iterator_end(inset());
1383 ParConstIterator Buffer::par_iterator_begin() const
1385 return ::par_const_iterator_begin(inset());
1389 ParConstIterator Buffer::par_iterator_end() const
1391 return ::par_const_iterator_end(inset());
1395 Language const * Buffer::getLanguage() const
1397 return params().language;
1401 string const Buffer::B_(string const & l10n) const
1403 if (pimpl_->messages.get()) {
1404 return pimpl_->messages->get(l10n);
1411 bool Buffer::isClean() const
1413 return pimpl_->lyx_clean;
1417 bool Buffer::isBakClean() const
1419 return pimpl_->bak_clean;
1423 void Buffer::markClean() const
1425 if (!pimpl_->lyx_clean) {
1426 pimpl_->lyx_clean = true;
1429 // if the .lyx file has been saved, we don't need an
1431 pimpl_->bak_clean = true;
1435 void Buffer::markBakClean()
1437 pimpl_->bak_clean = true;
1441 void Buffer::setUnnamed(bool flag)
1443 pimpl_->unnamed = flag;
1447 bool Buffer::isUnnamed() const
1449 return pimpl_->unnamed;
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 pimpl_->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 && bufferlist.exists(params().parentname)) {
1498 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1500 return buf->getMasterBuffer();
1507 MacroData const & Buffer::getMacro(std::string const & name) const
1509 return pimpl_->macros.get(name);
1513 bool Buffer::hasMacro(string const & name) const
1515 return pimpl_->macros.has(name);
1519 void Buffer::insertMacro(string const & name, MacroData const & data)
1521 MacroTable::globalMacros().insert(name, data);
1522 pimpl_->macros.insert(name, data);
1526 void Buffer::buildMacros()
1528 // Start with global table.
1529 pimpl_->macros = MacroTable::globalMacros();
1532 ParagraphList & pars = text().paragraphs();
1533 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1534 //lyxerr << "searching main par " << i
1535 // << " for macro definitions" << std::endl;
1536 InsetList::iterator it = pars[i].insetlist.begin();
1537 InsetList::iterator end = pars[i].insetlist.end();
1538 for ( ; it != end; ++it) {
1539 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1540 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1541 MathMacroTemplate & mac
1542 = static_cast<MathMacroTemplate &>(*it->inset);
1543 insertMacro(mac.name(), mac.asMacroData());