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 "output_linuxdoc.h"
45 #include "paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "pariterator.h"
54 #include "insets/insetbibitem.h"
55 #include "insets/insetbibtex.h"
56 #include "insets/insetinclude.h"
57 #include "insets/insettext.h"
59 #include "mathed/math_macrotemplate.h"
60 #include "mathed/math_macrotable.h"
61 #include "mathed/math_support.h"
63 #include "frontends/Alert.h"
65 #include "graphics/Previews.h"
67 #include "support/types.h"
68 #include "support/lyxalgo.h"
69 #include "support/filetools.h"
70 #include "support/fs_extras.h"
71 # include <boost/iostreams/filtering_stream.hpp>
72 # include <boost/iostreams/filter/gzip.hpp>
73 # include <boost/iostreams/device/file.hpp>
74 namespace io = boost::iostreams;
75 #include "support/lyxlib.h"
76 #include "support/os.h"
77 #include "support/path.h"
78 #include "support/textutils.h"
79 #include "support/convert.h"
81 #include <boost/bind.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>
99 using lyx::support::addName;
100 using lyx::support::bformat;
101 using lyx::support::changeExtension;
102 using lyx::support::cmd_ret;
103 using lyx::support::createBufferTmpDir;
104 using lyx::support::destroyDir;
105 using lyx::support::getFormatFromContents;
106 using lyx::support::isDirWriteable;
107 using lyx::support::libFileSearch;
108 using lyx::support::latex_path;
109 using lyx::support::ltrim;
110 using lyx::support::makeAbsPath;
111 using lyx::support::makeDisplayPath;
112 using lyx::support::makeLatexName;
113 using lyx::support::onlyFilename;
114 using lyx::support::onlyPath;
115 using lyx::support::Path;
116 using lyx::support::quoteName;
117 using lyx::support::removeAutosaveFile;
118 using lyx::support::rename;
119 using lyx::support::runCommand;
120 using lyx::support::split;
121 using lyx::support::subst;
122 using lyx::support::tempName;
123 using lyx::support::trim;
125 namespace os = lyx::support::os;
126 namespace fs = boost::filesystem;
130 using std::make_pair;
136 using std::ostringstream;
144 // all these externs should eventually be removed.
145 extern BufferList bufferlist;
149 int const LYX_FORMAT = 246;
154 typedef std::map<string, bool> DepClean;
159 Impl(Buffer & parent, string const & file, bool readonly);
161 limited_stack<Undo> undostack;
162 limited_stack<Undo> redostack;
168 /// need to regenerate .tex?
172 mutable bool lyx_clean;
174 /// is autosave needed?
175 mutable bool bak_clean;
177 /// is this a unnamed file (New...)?
183 /// name of the file the buffer is associated with.
186 boost::scoped_ptr<Messages> messages;
188 /** Set to true only when the file is fully loaded.
189 * Used to prevent the premature generation of previews
190 * and by the citation inset.
192 bool file_fully_loaded;
194 /// our LyXText that should be wrapped in an InsetText
202 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
203 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
204 filename(file), file_fully_loaded(false),
207 inset.setAutoBreakRows(true);
208 lyxvc.buffer(&parent);
209 temppath = createBufferTmpDir();
210 params.filepath = onlyPath(file);
211 // FIXME: And now do something if temppath == string(), because we
212 // assume from now on that temppath points to a valid temp dir.
213 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
217 Buffer::Buffer(string const & file, bool readonly)
218 : pimpl_(new Impl(*this, file, readonly))
220 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
226 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
227 // here the buffer should take care that it is
228 // saved properly, before it goes into the void.
232 if (!temppath().empty() && !destroyDir(temppath())) {
233 Alert::warning(_("Could not remove temporary directory"),
234 bformat(_("Could not remove the temporary directory %1$s"), 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."), 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();
422 string const token = lex.getString();
427 if (token == "\\end_header")
431 if (token == "\\begin_header") {
432 begin_header_line = line;
436 lyxerr[Debug::PARSER] << "Handling document header token: `"
437 << token << '\'' << endl;
439 string unknown = params().readToken(lex, token);
440 if (!unknown.empty()) {
441 if (unknown[0] != '\\' && token == "\\textclass") {
442 unknownClass(unknown);
445 string const s = bformat(_("Unknown token: "
449 error(ErrorItem(_("Document header error"), s,
454 if (begin_header_line) {
455 string const s = _("\\begin_header is missing");
456 error(ErrorItem(_("Document header error"), s, -1, 0, 0));
458 return unknown_tokens;
463 // changed to be public and have one parameter
464 // Returns false if "\end_document" is not read (Asger)
465 bool Buffer::readDocument(LyXLex & lex)
468 string const token = lex.getString();
469 if (token != "\\begin_document") {
470 string const s = _("\\begin_document is missing");
471 error(ErrorItem(_("Document header error"), s, -1, 0, 0));
474 // we are reading in a brand new document
475 BOOST_ASSERT(paragraphs().empty());
478 if (!params().getLyXTextClass().load(filePath())) {
479 string theclass = params().getLyXTextClass().name();
480 Alert::error(_("Can't load document class"), bformat(
481 "Using the default document class, because the "
482 " class %1$s could not be loaded.", theclass));
483 params().textclass = 0;
486 bool const res = text().read(*this, lex);
487 for_each(text().paragraphs().begin(),
488 text().paragraphs().end(),
489 bind(&Paragraph::setInsetOwner, _1, &inset()));
490 updateBibfilesCache();
495 // needed to insert the selection
496 void Buffer::insertStringAsLines(ParagraphList & pars,
497 pit_type & pit, pos_type & pos,
498 LyXFont const & fn, string const & str, bool autobreakrows)
502 // insert the string, don't insert doublespace
503 bool space_inserted = true;
504 for (string::const_iterator cit = str.begin();
505 cit != str.end(); ++cit) {
506 Paragraph & par = pars[pit];
508 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
509 breakParagraph(params(), pars, pit, pos,
510 par.layout()->isEnvironment());
513 space_inserted = true;
517 // do not insert consecutive spaces if !free_spacing
518 } else if ((*cit == ' ' || *cit == '\t') &&
519 space_inserted && !par.isFreeSpacing()) {
521 } else if (*cit == '\t') {
522 if (!par.isFreeSpacing()) {
523 // tabs are like spaces here
524 par.insertChar(pos, ' ', font);
526 space_inserted = true;
528 const pos_type n = 8 - pos % 8;
529 for (pos_type i = 0; i < n; ++i) {
530 par.insertChar(pos, ' ', font);
533 space_inserted = true;
535 } else if (!isPrintable(*cit)) {
536 // Ignore unprintables
539 // just insert the character
540 par.insertChar(pos, *cit, font);
542 space_inserted = (*cit == ' ');
549 bool Buffer::readFile(string const & filename)
551 // Check if the file is compressed.
552 string const format = getFormatFromContents(filename);
553 if (format == "gzip" || format == "zip" || format == "compress") {
554 params().compressed = true;
557 // remove dummy empty par
558 paragraphs().clear();
560 lex.setFile(filename);
561 bool ret = readFile(lex, filename);
563 // After we have read a file, we must ensure that the buffer
564 // language is set and used in the gui.
565 // If you know of a better place to put this, please tell me. (Lgb)
566 updateDocLang(params().language);
572 bool Buffer::fully_loaded() const
574 return pimpl_->file_fully_loaded;
578 void Buffer::fully_loaded(bool const value)
580 pimpl_->file_fully_loaded = value;
584 bool Buffer::readFile(LyXLex & lex, string const & filename)
586 BOOST_ASSERT(!filename.empty());
589 Alert::error(_("Document could not be read"),
590 bformat(_("%1$s could not be read."), filename));
595 string const token(lex.getString());
598 Alert::error(_("Document could not be read"),
599 bformat(_("%1$s could not be read."), filename));
603 // the first token _must_ be...
604 if (token != "\\lyxformat") {
605 lyxerr << "Token: " << token << endl;
607 Alert::error(_("Document format failure"),
608 bformat(_("%1$s is not a LyX document."),
614 string tmp_format = lex.getString();
615 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
616 // if present remove ".," from string.
617 string::size_type dot = tmp_format.find_first_of(".,");
618 //lyxerr << " dot found at " << dot << endl;
619 if (dot != string::npos)
620 tmp_format.erase(dot, 1);
621 int const file_format = convert<int>(tmp_format);
622 //lyxerr << "format: " << file_format << endl;
624 if (file_format != LYX_FORMAT) {
625 string const tmpfile = tempName();
626 if (tmpfile.empty()) {
627 Alert::error(_("Conversion failed"),
628 bformat(_("%1$s is from an earlier"
629 " version of LyX, but a temporary"
630 " file for converting it could"
635 string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
636 if (lyx2lyx.empty()) {
637 Alert::error(_("Conversion script not found"),
638 bformat(_("%1$s is from an earlier"
639 " version of LyX, but the"
640 " conversion script lyx2lyx"
641 " could not be found."),
645 ostringstream command;
646 command << "python " << quoteName(lyx2lyx)
647 << " -t " << convert<string>(LYX_FORMAT)
648 << " -o " << quoteName(tmpfile) << ' '
649 << quoteName(filename);
650 string const command_str = command.str();
652 lyxerr[Debug::INFO] << "Running '"
653 << command_str << '\''
656 cmd_ret const ret = runCommand(command_str);
657 if (ret.first != 0) {
658 Alert::error(_("Conversion script failed"),
659 bformat(_("%1$s is from an earlier version"
660 " of LyX, but the lyx2lyx script"
661 " failed to convert it."),
665 bool const ret = readFile(tmpfile);
666 // Do stuff with tmpfile name and buffer name here.
672 if (readDocument(lex)) {
673 Alert::error(_("Document format failure"),
674 bformat(_("%1$s ended unexpectedly, which means"
675 " that it is probably corrupted."),
679 //lyxerr << "removing " << MacroTable::localMacros().size()
680 // << " temporary macro entries" << endl;
681 //MacroTable::localMacros().clear();
683 pimpl_->file_fully_loaded = true;
688 // Should probably be moved to somewhere else: BufferView? LyXView?
689 bool Buffer::save() const
691 // We don't need autosaves in the immediate future. (Asger)
692 resetAutosaveTimers();
696 if (lyxrc.make_backup) {
697 s = fileName() + '~';
698 if (!lyxrc.backupdir_path.empty())
699 s = addName(lyxrc.backupdir_path,
700 subst(os::internal_path(s),'/','!'));
702 // It might very well be that this variant is just
703 // good enough. (Lgb)
704 // But to use this we need fs::copy_file to actually do a copy,
705 // even when the target file exists. (Lgb)
706 if (fs::exists(fileName()) && fs::is_writable(fs::path(fileName()).branch_path())) {
708 fs::copy_file(fileName(), s, false);
710 //catch (fs::filesystem_error const & fe) {
711 //lyxerr << "LyX was not able to make backup copy. Beware.\n"
712 // << fe.what() << endl;
717 if (writeFile(fileName())) {
719 removeAutosaveFile(fileName());
721 // Saving failed, so backup is not backup
722 if (lyxrc.make_backup)
723 rename(s, fileName());
730 bool Buffer::writeFile(string const & fname) const
732 if (pimpl_->read_only && fname == fileName())
737 if (params().compressed) {
738 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
742 retval = do_writeFile(ofs);
744 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
748 retval = do_writeFile(ofs);
755 bool Buffer::do_writeFile(ostream & ofs) const
758 // Use the standard "C" locale for file output.
759 ofs.imbue(std::locale::classic());
762 // The top of the file should not be written by params().
764 // write out a comment in the top of the file
765 ofs << "#LyX " << lyx_version
766 << " created this file. For more info see http://www.lyx.org/\n"
767 << "\\lyxformat " << LYX_FORMAT << "\n"
768 << "\\begin_document\n";
770 // now write out the buffer parameters.
771 ofs << "\\begin_header\n";
772 params().writeFile(ofs);
773 ofs << "\\end_header\n";
776 ofs << "\n\\begin_body\n";
777 text().write(*this, ofs);
778 ofs << "\n\\end_body\n";
780 // Write marker that shows file is complete
781 ofs << "\\end_document" << endl;
783 // Shouldn't really be needed....
786 // how to check if close went ok?
787 // Following is an attempt... (BE 20001011)
789 // good() returns false if any error occured, including some
791 // bad() returns true if something bad happened in the buffer,
792 // which should include file system full errors.
797 lyxerr << "File was not closed properly." << endl;
804 void Buffer::makeLaTeXFile(string const & fname,
805 string const & original_path,
806 OutputParams const & runparams,
807 bool output_preamble, bool output_body)
809 lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
812 if (!openFileWrite(ofs, fname))
815 makeLaTeXFile(ofs, original_path,
816 runparams, output_preamble, output_body);
820 lyxerr << "File '" << fname << "' was not closed properly." << endl;
824 void Buffer::makeLaTeXFile(ostream & os,
825 string const & original_path,
826 OutputParams const & runparams_in,
827 bool const output_preamble, bool const output_body)
829 OutputParams runparams = runparams_in;
831 // validate the buffer.
832 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
833 LaTeXFeatures features(*this, params(), runparams);
835 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
839 // The starting paragraph of the coming rows is the
840 // first paragraph of the document. (Asger)
841 texrow().start(paragraphs().begin()->id(), 0);
843 if (output_preamble && runparams.nice) {
844 os << "%% LyX " << lyx_version << " created this file. "
845 "For more info, see http://www.lyx.org/.\n"
846 "%% Do not edit unless you really know what "
851 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
852 // There are a few differences between nice LaTeX and usual files:
853 // usual is \batchmode and has a
854 // special input@path to allow the including of figures
855 // with either \input or \includegraphics (what figinsets do).
856 // input@path is set when the actual parameter
857 // original_path is set. This is done for usual tex-file, but not
858 // for nice-latex-file. (Matthias 250696)
859 // Note that input@path is only needed for something the user does
860 // in the preamble, included .tex files or ERT, files included by
861 // LyX work without it.
862 if (output_preamble) {
863 if (!runparams.nice) {
864 // code for usual, NOT nice-latex-file
865 os << "\\batchmode\n"; // changed
869 if (!original_path.empty()) {
870 string const inputpath = latex_path(original_path);
871 os << "\\makeatletter\n"
872 << "\\def\\input@path{{"
873 << inputpath << "/}}\n"
874 << "\\makeatother\n";
880 // Write the preamble
881 runparams.use_babel = params().writeLaTeX(os, features, texrow());
887 os << "\\begin{document}\n";
890 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
892 if (!lyxrc.language_auto_begin) {
893 os << subst(lyxrc.language_command_begin, "$$lang",
894 params().language->babel())
899 // if we are doing a real file with body, even if this is the
900 // child of some other buffer, let's cut the link here.
901 // This happens for example if only a child document is printed.
902 string save_parentname;
903 if (output_preamble) {
904 save_parentname = params().parentname;
905 params().parentname.erase();
909 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
911 // Restore the parenthood if needed
913 params().parentname = save_parentname;
915 // add this just in case after all the paragraphs
919 if (!lyxrc.language_auto_end) {
920 os << subst(lyxrc.language_command_end, "$$lang",
921 params().language->babel())
926 if (output_preamble) {
927 os << "\\end{document}\n";
930 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
932 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
936 // Just to be sure. (Asger)
939 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
940 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
945 bool Buffer::isLatex() const
947 return params().getLyXTextClass().outputType() == LATEX;
951 bool Buffer::isLinuxDoc() const
953 return params().getLyXTextClass().outputType() == LINUXDOC;
957 bool Buffer::isLiterate() const
959 return params().getLyXTextClass().outputType() == LITERATE;
963 bool Buffer::isDocBook() const
965 return params().getLyXTextClass().outputType() == DOCBOOK;
969 bool Buffer::isSGML() const
971 LyXTextClass const & tclass = params().getLyXTextClass();
973 return tclass.outputType() == LINUXDOC ||
974 tclass.outputType() == DOCBOOK;
978 void Buffer::makeLinuxDocFile(string const & fname,
979 OutputParams const & runparams,
980 bool const body_only)
983 if (!openFileWrite(ofs, fname))
986 LaTeXFeatures features(*this, params(), runparams);
991 LyXTextClass const & tclass = params().getLyXTextClass();
993 string const & top_element = tclass.latexname();
996 ofs << tclass.class_header();
998 string preamble = params().preamble;
999 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1001 preamble += features.getIncludedFiles(name);
1002 preamble += features.getLyXSGMLEntities();
1004 if (!preamble.empty()) {
1005 ofs << " [ " << preamble << " ]";
1009 if (params().options.empty())
1010 sgml::openTag(ofs, top_element);
1012 string top = top_element;
1014 top += params().options;
1015 sgml::openTag(ofs, top);
1019 ofs << "<!-- LyX " << lyx_version
1020 << " created this file. For more info see http://www.lyx.org/"
1023 linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
1027 sgml::closeTag(ofs, top_element);
1032 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1036 void Buffer::makeDocBookFile(string const & fname,
1037 OutputParams const & runparams,
1038 bool const only_body)
1041 if (!openFileWrite(ofs, fname))
1044 LaTeXFeatures features(*this, params(), runparams);
1049 LyXTextClass const & tclass = params().getLyXTextClass();
1050 string const & top_element = tclass.latexname();
1053 if (runparams.flavor == OutputParams::XML)
1054 ofs << "<?xml version=\"1.0\" encoding=\""
1055 << params().language->encoding()->name() << "\"?>\n";
1057 ofs << "<!DOCTYPE " << top_element << " ";
1059 if (! tclass.class_header().empty()) ofs << tclass.class_header();
1060 else if (runparams.flavor == OutputParams::XML)
1061 ofs << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1062 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1064 ofs << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1066 string preamble = params().preamble;
1067 if (runparams.flavor != OutputParams::XML ) {
1068 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1069 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1070 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1071 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1074 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1076 preamble += features.getIncludedFiles(name);
1077 preamble += features.getLyXSGMLEntities();
1079 if (!preamble.empty()) {
1080 ofs << "\n [ " << preamble << " ]";
1085 string top = top_element;
1087 if (runparams.flavor == OutputParams::XML)
1088 top += params().language->code();
1090 top += params().language->code().substr(0,2);
1093 if (!params().options.empty()) {
1095 top += params().options;
1098 ofs << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1099 << " file was created by LyX " << lyx_version
1100 << "\n See http://www.lyx.org/ for more information -->\n";
1102 params().getLyXTextClass().counters().reset();
1104 sgml::openTag(ofs, top);
1106 docbookParagraphs(paragraphs(), *this, ofs, runparams);
1107 sgml::closeTag(ofs, top_element);
1111 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1115 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1116 // Other flags: -wall -v0 -x
1117 int Buffer::runChktex()
1121 // get LaTeX-Filename
1122 string const name = getLatexName();
1123 string const path = temppath();
1124 string const org_path = filePath();
1126 Path p(path); // path to LaTeX file
1127 message(_("Running chktex..."));
1129 // Generate the LaTeX file if neccessary
1130 OutputParams runparams;
1131 runparams.flavor = OutputParams::LATEX;
1132 runparams.nice = false;
1133 makeLaTeXFile(name, org_path, runparams);
1136 Chktex chktex(lyxrc.chktex_command, name, filePath());
1137 int const res = chktex.run(terr); // run chktex
1140 Alert::error(_("chktex failure"),
1141 _("Could not run chktex successfully."));
1142 } else if (res > 0) {
1143 // Insert all errors as errors boxes
1144 bufferErrors(*this, terr);
1153 void Buffer::validate(LaTeXFeatures & features) const
1155 LyXTextClass const & tclass = params().getLyXTextClass();
1157 if (features.isAvailable("dvipost") && params().tracking_changes
1158 && params().output_changes)
1159 features.require("dvipost");
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(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 Buffer const * tmp = getMasterBuffer();
1205 lyxerr << "getMasterBuffer() failed!" << endl;
1209 tmp->getLabelList(list);
1213 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1214 it.nextInset()->getLabelList(*this, list);
1218 // This is also a buffer property (ale)
1219 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1222 /// if this is a child document and the parent is already loaded
1223 /// use the parent's list instead [ale990412]
1224 Buffer const * tmp = getMasterBuffer();
1227 tmp->fillWithBibKeys(keys);
1231 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1232 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1233 InsetBibtex const & inset =
1234 dynamic_cast<InsetBibtex const &>(*it);
1235 inset.fillWithBibKeys(*this, keys);
1236 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1237 InsetInclude const & inset =
1238 dynamic_cast<InsetInclude const &>(*it);
1239 inset.fillWithBibKeys(*this, keys);
1240 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1241 InsetBibitem const & inset =
1242 dynamic_cast<InsetBibitem const &>(*it);
1243 string const key = inset.getContents();
1244 string const opt = inset.getOptions();
1245 string const ref; // = pit->asString(this, false);
1246 string const info = opt + "TheBibliographyRef" + ref;
1247 keys.push_back(pair<string, string>(key, info));
1253 void Buffer::updateBibfilesCache()
1255 // if this is a child document and the parent is already loaded
1256 // update the parent's cache instead
1257 Buffer * tmp = getMasterBuffer();
1260 tmp->updateBibfilesCache();
1264 bibfilesCache_.clear();
1265 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1266 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1267 InsetBibtex const & inset =
1268 dynamic_cast<InsetBibtex const &>(*it);
1269 vector<string> const bibfiles = inset.getFiles(*this);
1270 bibfilesCache_.insert(bibfilesCache_.end(),
1273 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1274 InsetInclude & inset =
1275 dynamic_cast<InsetInclude &>(*it);
1276 inset.updateBibfilesCache(*this);
1277 vector<string> const & bibfiles =
1278 inset.getBibfilesCache(*this);
1279 bibfilesCache_.insert(bibfilesCache_.end(),
1287 vector<string> const & Buffer::getBibfilesCache() const
1289 // if this is a child document and the parent is already loaded
1290 // use the parent's cache instead
1291 Buffer const * tmp = getMasterBuffer();
1294 return tmp->getBibfilesCache();
1296 return bibfilesCache_;
1300 bool Buffer::isDepClean(string const & name) const
1302 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1303 if (it == pimpl_->dep_clean.end())
1309 void Buffer::markDepClean(string const & name)
1311 pimpl_->dep_clean[name] = true;
1315 bool Buffer::dispatch(string const & command, bool * result)
1317 return dispatch(lyxaction.lookupFunc(command), result);
1321 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1323 bool dispatched = true;
1325 switch (func.action) {
1326 case LFUN_BUFFER_EXPORT: {
1327 bool const tmp = Exporter::Export(this, func.argument, false);
1340 void Buffer::changeLanguage(Language const * from, Language const * to)
1345 lyxerr << "Changing Language!" << endl;
1347 // Take care of l10n/i18n
1350 for_each(par_iterator_begin(),
1352 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1354 text().current_font.setLanguage(to);
1355 text().real_current_font.setLanguage(to);
1359 void Buffer::updateDocLang(Language const * nlang)
1361 BOOST_ASSERT(nlang);
1363 pimpl_->messages.reset(new Messages(nlang->code()));
1367 bool Buffer::isMultiLingual() const
1369 ParConstIterator end = par_iterator_end();
1370 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1371 if (it->isMultiLingual(params()))
1378 ParIterator Buffer::getParFromID(int const id) const
1380 ParConstIterator it = par_iterator_begin();
1381 ParConstIterator const end = par_iterator_end();
1384 // John says this is called with id == -1 from undo
1385 lyxerr << "getParFromID(), id: " << id << endl;
1389 for (; it != end; ++it)
1397 bool Buffer::hasParWithID(int const id) const
1399 ParConstIterator const it = getParFromID(id);
1400 return it != par_iterator_end();
1404 ParIterator Buffer::par_iterator_begin()
1406 return ::par_iterator_begin(inset());
1410 ParIterator Buffer::par_iterator_end()
1412 return ::par_iterator_end(inset());
1416 ParConstIterator Buffer::par_iterator_begin() const
1418 return ::par_const_iterator_begin(inset());
1422 ParConstIterator Buffer::par_iterator_end() const
1424 return ::par_const_iterator_end(inset());
1428 Language const * Buffer::getLanguage() const
1430 return params().language;
1434 string const Buffer::B_(string const & l10n) const
1436 if (pimpl_->messages.get()) {
1437 return pimpl_->messages->get(l10n);
1444 bool Buffer::isClean() const
1446 return pimpl_->lyx_clean;
1450 bool Buffer::isBakClean() const
1452 return pimpl_->bak_clean;
1456 void Buffer::markClean() const
1458 if (!pimpl_->lyx_clean) {
1459 pimpl_->lyx_clean = true;
1462 // if the .lyx file has been saved, we don't need an
1464 pimpl_->bak_clean = true;
1468 void Buffer::markBakClean()
1470 pimpl_->bak_clean = true;
1474 void Buffer::setUnnamed(bool flag)
1476 pimpl_->unnamed = flag;
1480 bool Buffer::isUnnamed() const
1482 return pimpl_->unnamed;
1486 #ifdef WITH_WARNINGS
1487 #warning this function should be moved to buffer_pimpl.C
1489 void Buffer::markDirty()
1491 if (pimpl_->lyx_clean) {
1492 pimpl_->lyx_clean = false;
1495 pimpl_->bak_clean = false;
1497 DepClean::iterator it = pimpl_->dep_clean.begin();
1498 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1500 for (; it != end; ++it) {
1506 string const & Buffer::fileName() const
1508 return pimpl_->filename;
1512 string const & Buffer::filePath() const
1514 return params().filepath;
1518 bool Buffer::isReadonly() const
1520 return pimpl_->read_only;
1524 void Buffer::setParentName(string const & name)
1526 params().parentname = name;
1530 Buffer const * Buffer::getMasterBuffer() const
1532 if (!params().parentname.empty()
1533 && bufferlist.exists(params().parentname)) {
1534 Buffer const * buf = bufferlist.getBuffer(params().parentname);
1536 return buf->getMasterBuffer();
1543 Buffer * Buffer::getMasterBuffer()
1545 if (!params().parentname.empty()
1546 && bufferlist.exists(params().parentname)) {
1547 Buffer * buf = bufferlist.getBuffer(params().parentname);
1549 return buf->getMasterBuffer();
1556 MacroData const & Buffer::getMacro(std::string const & name) const
1558 return pimpl_->macros.get(name);
1562 bool Buffer::hasMacro(string const & name) const
1564 return pimpl_->macros.has(name);
1568 void Buffer::insertMacro(string const & name, MacroData const & data)
1570 MacroTable::globalMacros().insert(name, data);
1571 pimpl_->macros.insert(name, data);
1575 void Buffer::buildMacros()
1577 // Start with global table.
1578 pimpl_->macros = MacroTable::globalMacros();
1581 ParagraphList const & pars = text().paragraphs();
1582 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1583 //lyxerr << "searching main par " << i
1584 // << " for macro definitions" << std::endl;
1585 InsetList const & insets = pars[i].insetlist;
1586 InsetList::const_iterator it = insets.begin();
1587 InsetList::const_iterator end = insets.end();
1588 for ( ; it != end; ++it) {
1589 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1590 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1591 MathMacroTemplate const & mac
1592 = static_cast<MathMacroTemplate const &>(*it->inset);
1593 insertMacro(mac.name(), mac.asMacroData());
1600 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1607 void Buffer::changeRefsIfUnique(string const & from, string const & to)
1609 // Check if the label 'from' appears more than once
1610 vector<string> labels;
1611 getLabelList(labels);
1613 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1616 InsetBase::Code code = InsetBase::REF_CODE;
1618 ParIterator it = par_iterator_begin();
1619 ParIterator end = par_iterator_end();
1620 for ( ; it != end; ++it) {
1621 bool changed_inset = false;
1622 for (InsetList::iterator it2 = it->insetlist.begin();
1623 it2 != it->insetlist.end(); ++it2) {
1624 if (it2->inset->lyxCode() == code) {
1625 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
1626 if (inset->getContents() == from) {
1627 inset->setContents(to);
1628 //inset->setButtonLabel();
1629 changed_inset = true;
1637 void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end)
1639 OutputParams runparams;
1640 runparams.nice = true;
1641 runparams.flavor = OutputParams::LATEX;
1642 runparams.linelen = lyxrc.ascii_linelen;
1643 runparams.par_begin = par_begin;
1644 runparams.par_end = par_end;
1645 // No side effect of file copying and image conversion
1646 runparams.dryrun = true;
1648 if (par_begin + 1 == par_end)
1649 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1651 os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
1652 // output paragraphs
1655 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1656 } else if (isLinuxDoc())
1657 linuxdocParagraphs(*this, paragraphs(), os, runparams);
1659 docbookParagraphs(paragraphs(), *this, os, runparams);