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 <boost/iostreams/filtering_stream.hpp>
71 #include <boost/iostreams/filter/gzip.hpp>
72 #include <boost/iostreams/device/file.hpp>
73 namespace io = boost::iostreams;
74 #include "support/lyxlib.h"
75 #include "support/os.h"
76 #include "support/path.h"
77 #include "support/textutils.h"
78 #include "support/convert.h"
80 #include <boost/bind.hpp>
81 #include <boost/filesystem/exception.hpp>
82 #include <boost/filesystem/operations.hpp>
84 #if defined (HAVE_UTIME_H)
86 #elif defined (HAVE_SYS_UTIME_H)
87 #include <sys/utime.h>
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;
132 using std::make_pair;
138 using std::ostringstream;
148 int const LYX_FORMAT = 252;
153 typedef std::map<string, bool> DepClean;
158 Impl(Buffer & parent, string const & file, bool readonly);
160 limited_stack<Undo> undostack;
161 limited_stack<Undo> redostack;
167 /// need to regenerate .tex?
171 mutable bool lyx_clean;
173 /// is autosave needed?
174 mutable bool bak_clean;
176 /// is this a unnamed file (New...)?
182 /// name of the file the buffer is associated with.
185 boost::scoped_ptr<Messages> messages;
187 /** Set to true only when the file is fully loaded.
188 * Used to prevent the premature generation of previews
189 * and by the citation inset.
191 bool file_fully_loaded;
193 /// our LyXText that should be wrapped in an InsetText
201 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
202 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
203 filename(file), file_fully_loaded(false),
206 inset.setAutoBreakRows(true);
207 lyxvc.buffer(&parent);
208 temppath = createBufferTmpDir();
209 params.filepath = onlyPath(file);
210 // FIXME: And now do something if temppath == string(), because we
211 // assume from now on that temppath points to a valid temp dir.
212 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
216 Buffer::Buffer(string const & file, bool readonly)
217 : pimpl_(new Impl(*this, file, readonly))
219 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
225 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
226 // here the buffer should take care that it is
227 // saved properly, before it goes into the void.
231 if (!temppath().empty() && !destroyDir(temppath())) {
232 Alert::warning(_("Could not remove temporary directory"),
233 bformat(_("Could not remove the temporary directory %1$s"),
234 lyx::from_utf8(temppath())));
237 // Remove any previewed LaTeX snippets associated with this buffer.
238 lyx::graphics::Previews::get().removeLoader(*this);
242 LyXText & Buffer::text() const
244 return const_cast<LyXText &>(pimpl_->inset.text_);
248 InsetBase & Buffer::inset() const
250 return const_cast<InsetText &>(pimpl_->inset);
254 limited_stack<Undo> & Buffer::undostack()
256 return pimpl_->undostack;
260 limited_stack<Undo> const & Buffer::undostack() const
262 return pimpl_->undostack;
266 limited_stack<Undo> & Buffer::redostack()
268 return pimpl_->redostack;
272 limited_stack<Undo> const & Buffer::redostack() const
274 return pimpl_->redostack;
278 BufferParams & Buffer::params()
280 return pimpl_->params;
284 BufferParams const & Buffer::params() const
286 return pimpl_->params;
290 ParagraphList & Buffer::paragraphs()
292 return text().paragraphs();
296 ParagraphList const & Buffer::paragraphs() const
298 return text().paragraphs();
302 LyXVC & Buffer::lyxvc()
304 return pimpl_->lyxvc;
308 LyXVC const & Buffer::lyxvc() const
310 return pimpl_->lyxvc;
314 string const & Buffer::temppath() const
316 return pimpl_->temppath;
320 TexRow & Buffer::texrow()
322 return pimpl_->texrow;
326 TexRow const & Buffer::texrow() const
328 return pimpl_->texrow;
332 string const Buffer::getLatexName(bool const no_path) const
334 string const name = changeExtension(makeLatexName(fileName()), ".tex");
335 return no_path ? onlyFilename(name) : name;
339 pair<Buffer::LogType, string> const Buffer::getLogName() const
341 string const filename = getLatexName(false);
343 if (filename.empty())
344 return make_pair(Buffer::latexlog, string());
346 string const path = temppath();
348 string const fname = addName(path,
349 onlyFilename(changeExtension(filename,
352 addName(path, onlyFilename(
353 changeExtension(filename,
354 formats.extension("literate") + ".out")));
356 // If no Latex log or Build log is newer, show Build log
358 if (fs::exists(bname) &&
359 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
360 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
361 return make_pair(Buffer::buildlog, bname);
363 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
364 return make_pair(Buffer::latexlog, fname);
368 void Buffer::setReadonly(bool const flag)
370 if (pimpl_->read_only != flag) {
371 pimpl_->read_only = flag;
377 void Buffer::setFileName(string const & newfile)
379 pimpl_->filename = makeAbsPath(newfile);
380 params().filepath = onlyPath(pimpl_->filename);
381 setReadonly(fs::is_readonly(pimpl_->filename));
386 // We'll remove this later. (Lgb)
389 void unknownClass(string const & unknown)
391 Alert::warning(_("Unknown document class"),
392 bformat(_("Using the default document class, because the "
393 "class %1$s is unknown."), lyx::from_utf8(unknown)));
399 int Buffer::readHeader(LyXLex & lex)
401 int unknown_tokens = 0;
403 int begin_header_line = -1;
405 // Initialize parameters that may be/go lacking in header:
406 params().branchlist().clear();
407 params().preamble.erase();
408 params().options.erase();
409 params().float_placement.erase();
410 params().paperwidth.erase();
411 params().paperheight.erase();
412 params().leftmargin.erase();
413 params().rightmargin.erase();
414 params().topmargin.erase();
415 params().bottommargin.erase();
416 params().headheight.erase();
417 params().headsep.erase();
418 params().footskip.erase();
420 ErrorList & errorList = errorLists_["Parse"];
424 string const token = lex.getString();
429 if (token == "\\end_header")
433 if (token == "\\begin_header") {
434 begin_header_line = line;
438 lyxerr[Debug::PARSER] << "Handling document header token: `"
439 << token << '\'' << endl;
441 string unknown = params().readToken(lex, token);
442 if (!unknown.empty()) {
443 if (unknown[0] != '\\' && token == "\\textclass") {
444 unknownClass(unknown);
447 docstring const s = bformat(_("Unknown token: "
449 lyx::from_utf8(token),
450 lyx::from_utf8(lex.getString()));
451 errorList.push_back(ErrorItem(_("Document header error"),
456 if (begin_header_line) {
457 docstring const s = _("\\begin_header is missing");
458 errorList.push_back(ErrorItem(_("Document header error"),
462 return unknown_tokens;
467 // changed to be public and have one parameter
468 // Returns false if "\end_document" is not read (Asger)
469 bool Buffer::readDocument(LyXLex & lex)
471 ErrorList & errorList = errorLists_["Parse"];
475 string const token = lex.getString();
476 if (token != "\\begin_document") {
477 docstring const s = _("\\begin_document is missing");
478 errorList.push_back(ErrorItem(_("Document header error"),
482 // we are reading in a brand new document
483 BOOST_ASSERT(paragraphs().empty());
486 if (!params().getLyXTextClass().load(filePath())) {
487 string theclass = params().getLyXTextClass().name();
488 Alert::error(_("Can't load document class"), bformat(
489 _("Using the default document class, because the "
490 " class %1$s could not be loaded."), lyx::from_utf8(theclass)));
491 params().textclass = 0;
494 bool const res = text().read(*this, lex, errorList);
495 for_each(text().paragraphs().begin(),
496 text().paragraphs().end(),
497 bind(&Paragraph::setInsetOwner, _1, &inset()));
498 updateBibfilesCache();
504 // needed to insert the selection
505 void Buffer::insertStringAsLines(ParagraphList & pars,
506 pit_type & pit, pos_type & pos,
507 LyXFont const & fn, docstring const & str, bool autobreakrows)
511 // insert the string, don't insert doublespace
512 bool space_inserted = true;
513 for (docstring::const_iterator cit = str.begin();
514 cit != str.end(); ++cit) {
515 Paragraph & par = pars[pit];
517 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
518 breakParagraph(params(), pars, pit, pos,
519 par.layout()->isEnvironment());
522 space_inserted = true;
526 // do not insert consecutive spaces if !free_spacing
527 } else if ((*cit == ' ' || *cit == '\t') &&
528 space_inserted && !par.isFreeSpacing()) {
530 } else if (*cit == '\t') {
531 if (!par.isFreeSpacing()) {
532 // tabs are like spaces here
533 // FIXME: change tracking (MG)
534 par.insertChar(pos, ' ', font, Change(Change::INSERTED));
536 space_inserted = true;
538 const pos_type n = 8 - pos % 8;
539 for (pos_type i = 0; i < n; ++i) {
540 // FIXME: change tracking (MG)
541 par.insertChar(pos, ' ', font, Change(Change::INSERTED));
544 space_inserted = true;
546 /* FIXME: not needed anymore?
547 } else if (!isPrintable(*cit)) {
548 // Ignore unprintables
552 // just insert the character
553 // FIXME: change tracking (MG)
554 par.insertChar(pos, *cit, font, Change(Change::INSERTED));
556 space_inserted = (*cit == ' ');
563 bool Buffer::readFile(string const & filename)
565 // Check if the file is compressed.
566 string const format = getFormatFromContents(filename);
567 if (format == "gzip" || format == "zip" || format == "compress") {
568 params().compressed = true;
571 // remove dummy empty par
572 paragraphs().clear();
574 lex.setFile(filename);
575 if (!readFile(lex, filename))
578 // After we have read a file, we must ensure that the buffer
579 // language is set and used in the gui.
580 // If you know of a better place to put this, please tell me. (Lgb)
581 updateDocLang(params().language);
587 bool Buffer::fully_loaded() const
589 return pimpl_->file_fully_loaded;
593 void Buffer::fully_loaded(bool const value)
595 pimpl_->file_fully_loaded = value;
599 bool Buffer::readFile(LyXLex & lex, string const & filename)
601 BOOST_ASSERT(!filename.empty());
604 Alert::error(_("Document could not be read"),
605 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
610 string const token(lex.getString());
613 Alert::error(_("Document could not be read"),
614 bformat(_("%1$s could not be read."), lyx::from_utf8(filename)));
618 // the first token _must_ be...
619 if (token != "\\lyxformat") {
620 lyxerr << "Token: " << token << endl;
622 Alert::error(_("Document format failure"),
623 bformat(_("%1$s is not a LyX document."),
624 lyx::from_utf8(filename)));
629 string tmp_format = lex.getString();
630 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
631 // if present remove ".," from string.
632 string::size_type dot = tmp_format.find_first_of(".,");
633 //lyxerr << " dot found at " << dot << endl;
634 if (dot != string::npos)
635 tmp_format.erase(dot, 1);
636 int const file_format = convert<int>(tmp_format);
637 //lyxerr << "format: " << file_format << endl;
639 if (file_format != LYX_FORMAT) {
640 string const tmpfile = tempName();
641 if (tmpfile.empty()) {
642 Alert::error(_("Conversion failed"),
643 bformat(_("%1$s is from an earlier"
644 " version of LyX, but a temporary"
645 " file for converting it could"
647 lyx::from_utf8(filename)));
650 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
651 if (lyx2lyx.empty()) {
652 Alert::error(_("Conversion script not found"),
653 bformat(_("%1$s is from an earlier"
654 " version of LyX, but the"
655 " conversion script lyx2lyx"
656 " could not be found."),
657 lyx::from_utf8(filename)));
660 ostringstream command;
661 command << os::python() << ' ' << quoteName(lyx2lyx)
662 << " -t " << convert<string>(LYX_FORMAT)
663 << " -o " << quoteName(tmpfile) << ' '
664 << quoteName(filename);
665 string const command_str = command.str();
667 lyxerr[Debug::INFO] << "Running '"
668 << command_str << '\''
671 cmd_ret const ret = runCommand(command_str);
672 if (ret.first != 0) {
673 Alert::error(_("Conversion script failed"),
674 bformat(_("%1$s is from an earlier version"
675 " of LyX, but the lyx2lyx script"
676 " failed to convert it."),
677 lyx::from_utf8(filename)));
680 bool const ret = readFile(tmpfile);
681 // Do stuff with tmpfile name and buffer name here.
687 if (readDocument(lex)) {
688 Alert::error(_("Document format failure"),
689 bformat(_("%1$s ended unexpectedly, which means"
690 " that it is probably corrupted."),
691 lyx::from_utf8(filename)));
694 //lyxerr << "removing " << MacroTable::localMacros().size()
695 // << " temporary macro entries" << endl;
696 //MacroTable::localMacros().clear();
698 pimpl_->file_fully_loaded = true;
703 // Should probably be moved to somewhere else: BufferView? LyXView?
704 bool Buffer::save() const
706 // We don't need autosaves in the immediate future. (Asger)
707 resetAutosaveTimers();
711 if (lyxrc.make_backup) {
712 s = fileName() + '~';
713 if (!lyxrc.backupdir_path.empty())
714 s = addName(lyxrc.backupdir_path,
715 subst(os::internal_path(s),'/','!'));
717 // It might very well be that this variant is just
718 // good enough. (Lgb)
719 // But to use this we need fs::copy_file to actually do a copy,
720 // even when the target file exists. (Lgb)
722 fs::copy_file(fileName(), s, false);
724 catch (fs::filesystem_error const & fe) {
725 Alert::error(_("Backup failure"),
726 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
727 "Please check if the directory exists and is writeable."),
728 lyx::from_utf8(fs::path(s).branch_path().native_directory_string())));
729 lyxerr[Debug::DEBUG] << "Fs error: "
730 << fe.what() << endl;
734 if (writeFile(fileName())) {
736 removeAutosaveFile(fileName());
738 // Saving failed, so backup is not backup
739 if (lyxrc.make_backup)
740 rename(s, fileName());
747 bool Buffer::writeFile(string const & fname) const
749 if (pimpl_->read_only && fname == fileName())
754 if (params().compressed) {
755 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
759 retval = do_writeFile(ofs);
761 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
765 retval = do_writeFile(ofs);
772 bool Buffer::do_writeFile(ostream & ofs) const
775 // Use the standard "C" locale for file output.
776 ofs.imbue(std::locale::classic());
779 // The top of the file should not be written by params().
781 // write out a comment in the top of the file
782 ofs << "#LyX " << lyx_version
783 << " created this file. For more info see http://www.lyx.org/\n"
784 << "\\lyxformat " << LYX_FORMAT << "\n"
785 << "\\begin_document\n";
787 // now write out the buffer parameters.
788 ofs << "\\begin_header\n";
789 params().writeFile(ofs);
790 ofs << "\\end_header\n";
793 ofs << "\n\\begin_body\n";
794 text().write(*this, ofs);
795 ofs << "\n\\end_body\n";
797 // Write marker that shows file is complete
798 ofs << "\\end_document" << endl;
800 // Shouldn't really be needed....
803 // how to check if close went ok?
804 // Following is an attempt... (BE 20001011)
806 // good() returns false if any error occured, including some
808 // bad() returns true if something bad happened in the buffer,
809 // which should include file system full errors.
814 lyxerr << "File was not closed properly." << endl;
821 void Buffer::makeLaTeXFile(string const & fname,
822 string const & original_path,
823 OutputParams const & runparams,
824 bool output_preamble, bool output_body)
826 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
829 // This creates an utf8 encoded file, but the inputenc commands
830 // specify other encodings
831 lyx::odocfstream ofs;
832 if (!openFileWrite(ofs, fname))
835 writeLaTeXSource(ofs, original_path,
836 runparams, output_preamble, output_body);
840 lyxerr << "File '" << fname << "' was not closed properly." << endl;
844 void Buffer::writeLaTeXSource(odocstream & os,
845 string const & original_path,
846 OutputParams const & runparams_in,
847 bool const output_preamble, bool const output_body)
849 OutputParams runparams = runparams_in;
851 // validate the buffer.
852 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
853 LaTeXFeatures features(*this, params(), runparams);
855 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
859 // The starting paragraph of the coming rows is the
860 // first paragraph of the document. (Asger)
861 texrow().start(paragraphs().begin()->id(), 0);
863 if (output_preamble && runparams.nice) {
864 os << "%% LyX " << lyx_version << " created this file. "
865 "For more info, see http://www.lyx.org/.\n"
866 "%% Do not edit unless you really know what "
871 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
872 // There are a few differences between nice LaTeX and usual files:
873 // usual is \batchmode and has a
874 // special input@path to allow the including of figures
875 // with either \input or \includegraphics (what figinsets do).
876 // input@path is set when the actual parameter
877 // original_path is set. This is done for usual tex-file, but not
878 // for nice-latex-file. (Matthias 250696)
879 // Note that input@path is only needed for something the user does
880 // in the preamble, included .tex files or ERT, files included by
881 // LyX work without it.
882 if (output_preamble) {
883 if (!runparams.nice) {
884 // code for usual, NOT nice-latex-file
885 os << "\\batchmode\n"; // changed
889 if (!original_path.empty()) {
891 // We don't know the encoding of inputpath
892 docstring const inputpath = lyx::from_utf8(latex_path(original_path));
893 os << "\\makeatletter\n"
894 << "\\def\\input@path{{"
895 << inputpath << "/}}\n"
896 << "\\makeatother\n";
902 // Write the preamble
903 runparams.use_babel = params().writeLaTeX(os, features, texrow());
909 os << "\\begin{document}\n";
912 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
914 if (!lyxrc.language_auto_begin) {
916 os << lyx::from_utf8(subst(lyxrc.language_command_begin,
918 params().language->babel()))
923 // if we are doing a real file with body, even if this is the
924 // child of some other buffer, let's cut the link here.
925 // This happens for example if only a child document is printed.
926 string save_parentname;
927 if (output_preamble) {
928 save_parentname = params().parentname;
929 params().parentname.erase();
933 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
935 // Restore the parenthood if needed
937 params().parentname = save_parentname;
939 // add this just in case after all the paragraphs
943 if (!lyxrc.language_auto_end) {
944 os << lyx::from_utf8(subst(lyxrc.language_command_end,
946 params().language->babel()))
951 if (output_preamble) {
952 os << "\\end{document}\n";
955 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
957 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
961 // Just to be sure. (Asger)
964 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
965 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
970 bool Buffer::isLatex() const
972 return params().getLyXTextClass().outputType() == LATEX;
976 bool Buffer::isLiterate() const
978 return params().getLyXTextClass().outputType() == LITERATE;
982 bool Buffer::isDocBook() const
984 return params().getLyXTextClass().outputType() == DOCBOOK;
988 void Buffer::makeDocBookFile(string const & fname,
989 OutputParams const & runparams,
990 bool const body_only)
992 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
995 if (!openFileWrite(ofs, fname))
998 writeDocBookSource(ofs, fname, runparams, body_only);
1002 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1006 void Buffer::writeDocBookSource(ostream & os, string const & fname,
1007 OutputParams const & runparams,
1008 bool const only_body)
1010 LaTeXFeatures features(*this, params(), runparams);
1015 LyXTextClass const & tclass = params().getLyXTextClass();
1016 string const & top_element = tclass.latexname();
1019 if (runparams.flavor == OutputParams::XML)
1020 os << "<?xml version=\"1.0\" encoding=\""
1021 << params().language->encoding()->name() << "\"?>\n";
1023 os << "<!DOCTYPE " << top_element << " ";
1025 if (! tclass.class_header().empty()) os << tclass.class_header();
1026 else if (runparams.flavor == OutputParams::XML)
1027 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1028 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1030 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1032 string preamble = params().preamble;
1033 if (runparams.flavor != OutputParams::XML ) {
1034 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1035 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1036 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1037 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1040 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1042 preamble += features.getIncludedFiles(name);
1043 preamble += features.getLyXSGMLEntities();
1045 if (!preamble.empty()) {
1046 os << "\n [ " << preamble << " ]";
1051 string top = top_element;
1053 if (runparams.flavor == OutputParams::XML)
1054 top += params().language->code();
1056 top += params().language->code().substr(0,2);
1059 if (!params().options.empty()) {
1061 top += params().options;
1064 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1065 << " file was created by LyX " << lyx_version
1066 << "\n See http://www.lyx.org/ for more information -->\n";
1068 params().getLyXTextClass().counters().reset();
1070 sgml::openTag(os, top);
1072 docbookParagraphs(paragraphs(), *this, os, runparams);
1073 sgml::closeTag(os, top_element);
1077 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1078 // Other flags: -wall -v0 -x
1079 int Buffer::runChktex()
1083 // get LaTeX-Filename
1084 string const name = getLatexName();
1085 string const path = temppath();
1086 string const org_path = filePath();
1088 lyx::support::Path p(path); // path to LaTeX file
1089 message(_("Running chktex..."));
1091 // Generate the LaTeX file if neccessary
1092 OutputParams runparams;
1093 runparams.flavor = OutputParams::LATEX;
1094 runparams.nice = false;
1095 makeLaTeXFile(name, org_path, runparams);
1098 Chktex chktex(lyxrc.chktex_command, name, filePath());
1099 int const res = chktex.run(terr); // run chktex
1102 Alert::error(_("chktex failure"),
1103 _("Could not run chktex successfully."));
1104 } else if (res > 0) {
1105 // Fill-in the error list with the TeX errors
1106 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1117 void Buffer::validate(LaTeXFeatures & features) const
1119 LyXTextClass const & tclass = params().getLyXTextClass();
1121 if (features.isAvailable("dvipost") && params().outputChanges)
1122 features.require("dvipost");
1124 // AMS Style is at document level
1125 if (params().use_amsmath == BufferParams::AMS_ON
1126 || tclass.provides(LyXTextClass::amsmath))
1127 features.require("amsmath");
1129 for_each(paragraphs().begin(), paragraphs().end(),
1130 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1132 // the bullet shapes are buffer level not paragraph level
1133 // so they are tested here
1134 for (int i = 0; i < 4; ++i) {
1135 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1136 int const font = params().user_defined_bullet(i).getFont();
1138 int const c = params()
1139 .user_defined_bullet(i)
1146 features.require("latexsym");
1148 } else if (font == 1) {
1149 features.require("amssymb");
1150 } else if ((font >= 2 && font <= 5)) {
1151 features.require("pifont");
1156 if (lyxerr.debugging(Debug::LATEX)) {
1157 features.showStruct();
1162 void Buffer::getLabelList(vector<docstring> & list) const
1164 /// if this is a child document and the parent is already loaded
1165 /// Use the parent's list instead [ale990407]
1166 Buffer const * tmp = getMasterBuffer();
1168 lyxerr << "getMasterBuffer() failed!" << endl;
1172 tmp->getLabelList(list);
1176 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1177 it.nextInset()->getLabelList(*this, list);
1181 // This is also a buffer property (ale)
1182 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1185 /// if this is a child document and the parent is already loaded
1186 /// use the parent's list instead [ale990412]
1187 Buffer const * tmp = getMasterBuffer();
1190 tmp->fillWithBibKeys(keys);
1194 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1195 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1196 InsetBibtex const & inset =
1197 dynamic_cast<InsetBibtex const &>(*it);
1198 inset.fillWithBibKeys(*this, keys);
1199 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1200 InsetInclude const & inset =
1201 dynamic_cast<InsetInclude const &>(*it);
1202 inset.fillWithBibKeys(*this, keys);
1203 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1204 InsetBibitem const & inset =
1205 dynamic_cast<InsetBibitem const &>(*it);
1206 string const key = inset.getContents();
1207 string const opt = inset.getOptions();
1208 string const ref; // = pit->asString(this, false);
1209 string const info = opt + "TheBibliographyRef" + ref;
1210 keys.push_back(pair<string, string>(key, info));
1216 void Buffer::updateBibfilesCache()
1218 // if this is a child document and the parent is already loaded
1219 // update the parent's cache instead
1220 Buffer * tmp = getMasterBuffer();
1223 tmp->updateBibfilesCache();
1227 bibfilesCache_.clear();
1228 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1229 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1230 InsetBibtex const & inset =
1231 dynamic_cast<InsetBibtex const &>(*it);
1232 vector<string> const bibfiles = inset.getFiles(*this);
1233 bibfilesCache_.insert(bibfilesCache_.end(),
1236 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1237 InsetInclude & inset =
1238 dynamic_cast<InsetInclude &>(*it);
1239 inset.updateBibfilesCache(*this);
1240 vector<string> const & bibfiles =
1241 inset.getBibfilesCache(*this);
1242 bibfilesCache_.insert(bibfilesCache_.end(),
1250 vector<string> const & Buffer::getBibfilesCache() const
1252 // if this is a child document and the parent is already loaded
1253 // use the parent's cache instead
1254 Buffer const * tmp = getMasterBuffer();
1257 return tmp->getBibfilesCache();
1259 return bibfilesCache_;
1263 bool Buffer::isDepClean(string const & name) const
1265 DepClean::const_iterator const 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) {
1289 case LFUN_BUFFER_EXPORT: {
1290 bool const tmp = Exporter::Export(this, lyx::to_utf8(func.argument()), false);
1303 void Buffer::changeLanguage(Language const * from, Language const * to)
1308 // Take care of l10n/i18n
1311 for_each(par_iterator_begin(),
1313 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1315 text().current_font.setLanguage(to);
1316 text().real_current_font.setLanguage(to);
1320 void Buffer::updateDocLang(Language const * nlang)
1322 BOOST_ASSERT(nlang);
1324 pimpl_->messages.reset(new Messages(nlang->code()));
1326 updateLabels(*this);
1330 bool Buffer::isMultiLingual() const
1332 ParConstIterator end = par_iterator_end();
1333 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1334 if (it->isMultiLingual(params()))
1341 ParIterator Buffer::getParFromID(int const id) const
1343 ParConstIterator it = par_iterator_begin();
1344 ParConstIterator const end = par_iterator_end();
1347 // John says this is called with id == -1 from undo
1348 lyxerr << "getParFromID(), id: " << id << endl;
1352 for (; it != end; ++it)
1360 bool Buffer::hasParWithID(int const id) const
1362 ParConstIterator const it = getParFromID(id);
1363 return it != par_iterator_end();
1367 ParIterator Buffer::par_iterator_begin()
1369 return ::par_iterator_begin(inset());
1373 ParIterator Buffer::par_iterator_end()
1375 return ::par_iterator_end(inset());
1379 ParConstIterator Buffer::par_iterator_begin() const
1381 return ::par_const_iterator_begin(inset());
1385 ParConstIterator Buffer::par_iterator_end() const
1387 return ::par_const_iterator_end(inset());
1391 Language const * Buffer::getLanguage() const
1393 return params().language;
1397 docstring const Buffer::B_(string const & l10n) const
1399 if (pimpl_->messages.get()) {
1400 return pimpl_->messages->get(l10n);
1407 bool Buffer::isClean() const
1409 return pimpl_->lyx_clean;
1413 bool Buffer::isBakClean() const
1415 return pimpl_->bak_clean;
1419 void Buffer::markClean() const
1421 if (!pimpl_->lyx_clean) {
1422 pimpl_->lyx_clean = true;
1425 // if the .lyx file has been saved, we don't need an
1427 pimpl_->bak_clean = true;
1431 void Buffer::markBakClean()
1433 pimpl_->bak_clean = true;
1437 void Buffer::setUnnamed(bool flag)
1439 pimpl_->unnamed = flag;
1443 bool Buffer::isUnnamed() const
1445 return pimpl_->unnamed;
1449 #ifdef WITH_WARNINGS
1450 #warning this function should be moved to buffer_pimpl.C
1452 void Buffer::markDirty()
1454 if (pimpl_->lyx_clean) {
1455 pimpl_->lyx_clean = false;
1458 pimpl_->bak_clean = false;
1460 DepClean::iterator it = pimpl_->dep_clean.begin();
1461 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1463 for (; it != end; ++it) {
1469 string const & Buffer::fileName() const
1471 return pimpl_->filename;
1475 string const & Buffer::filePath() const
1477 return params().filepath;
1481 bool Buffer::isReadonly() const
1483 return pimpl_->read_only;
1487 void Buffer::setParentName(string const & name)
1489 params().parentname = name;
1493 Buffer const * Buffer::getMasterBuffer() const
1495 if (!params().parentname.empty()
1496 && theBufferList().exists(params().parentname)) {
1497 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1499 return buf->getMasterBuffer();
1506 Buffer * Buffer::getMasterBuffer()
1508 if (!params().parentname.empty()
1509 && theBufferList().exists(params().parentname)) {
1510 Buffer * buf = theBufferList().getBuffer(params().parentname);
1512 return buf->getMasterBuffer();
1519 MacroData const & Buffer::getMacro(std::string const & name) const
1521 return pimpl_->macros.get(name);
1525 bool Buffer::hasMacro(string const & name) const
1527 return pimpl_->macros.has(name);
1531 void Buffer::insertMacro(string const & name, MacroData const & data)
1533 MacroTable::globalMacros().insert(name, data);
1534 pimpl_->macros.insert(name, data);
1538 void Buffer::buildMacros()
1540 // Start with global table.
1541 pimpl_->macros = MacroTable::globalMacros();
1544 ParagraphList const & pars = text().paragraphs();
1545 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1546 //lyxerr << "searching main par " << i
1547 // << " for macro definitions" << std::endl;
1548 InsetList const & insets = pars[i].insetlist;
1549 InsetList::const_iterator it = insets.begin();
1550 InsetList::const_iterator end = insets.end();
1551 for ( ; it != end; ++it) {
1552 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1553 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1554 MathMacroTemplate const & mac
1555 = static_cast<MathMacroTemplate const &>(*it->inset);
1556 insertMacro(mac.name(), mac.asMacroData());
1563 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1570 void Buffer::changeRefsIfUnique(string const & from, string const & to, InsetBase::Code code)
1572 //FIXME: This does not work for child documents yet.
1573 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1574 // Check if the label 'from' appears more than once
1575 vector<docstring> labels;
1577 if (code == InsetBase::CITE_CODE) {
1578 vector<pair<string, string> > keys;
1579 fillWithBibKeys(keys);
1580 vector<pair<string, string> >::const_iterator bit = keys.begin();
1581 vector<pair<string, string> >::const_iterator bend = keys.end();
1583 for (; bit != bend; ++bit)
1585 labels.push_back(lyx::from_utf8(bit->first));
1587 getLabelList(labels);
1590 if (lyx::count(labels.begin(), labels.end(), lyx::from_utf8(from)) > 1)
1593 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1594 if (it->lyxCode() == code) {
1595 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1596 inset.replaceContents(from, to);
1602 void Buffer::getSourceCode(odocstream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
1604 OutputParams runparams;
1605 runparams.nice = true;
1606 runparams.flavor = OutputParams::LATEX;
1607 runparams.linelen = lyxrc.ascii_linelen;
1608 // No side effect of file copying and image conversion
1609 runparams.dryrun = true;
1612 os << "% Preview source code\n\n";
1614 writeLaTeXSource(os, filePath(), runparams, true, true);
1618 writeDocBookSource(oss, fileName(), runparams, false);
1619 os << lyx::from_utf8(oss.str());
1622 runparams.par_begin = par_begin;
1623 runparams.par_end = par_end;
1624 if (par_begin + 1 == par_end)
1625 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1627 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1628 // output paragraphs
1631 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1636 docbookParagraphs(paragraphs(), *this, oss, runparams);
1637 os << lyx::from_utf8(oss.str());
1643 ErrorList const & Buffer::errorList(string const & type) const
1645 static ErrorList const emptyErrorList;
1646 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1647 if (I == errorLists_.end())
1648 return emptyErrorList;
1654 ErrorList & Buffer::errorList(string const & type)
1656 return errorLists_[type];