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"
50 #include "TocBackend.h"
54 #include "insets/insetbibitem.h"
55 #include "insets/insetbibtex.h"
56 #include "insets/insetinclude.h"
57 #include "insets/insettext.h"
59 #include "mathed/MathMacroTemplate.h"
60 #include "mathed/MathMacroTable.h"
61 #include "mathed/MathSupport.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 "support/lyxlib.h"
72 #include "support/os.h"
73 #include "support/path.h"
74 #include "support/textutils.h"
75 #include "support/convert.h"
77 #include <boost/iostreams/filtering_stream.hpp>
78 #include <boost/iostreams/filter/gzip.hpp>
79 #include <boost/iostreams/device/file.hpp>
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>
98 using support::addName;
99 using support::bformat;
100 using support::changeExtension;
101 using support::cmd_ret;
102 using support::createBufferTmpDir;
103 using support::destroyDir;
104 using support::FileName;
105 using support::getFormatFromContents;
106 using support::isDirWriteable;
107 using support::libFileSearch;
108 using support::latex_path;
109 using support::ltrim;
110 using support::makeAbsPath;
111 using support::makeDisplayPath;
112 using support::makeLatexName;
113 using support::onlyFilename;
114 using support::onlyPath;
115 using support::quoteName;
116 using support::removeAutosaveFile;
117 using support::rename;
118 using support::runCommand;
119 using support::split;
120 using support::subst;
121 using support::tempName;
124 namespace Alert = frontend::Alert;
125 namespace os = support::os;
126 namespace fs = boost::filesystem;
127 namespace io = boost::iostreams;
131 using std::make_pair;
137 using std::ostringstream;
147 int const LYX_FORMAT = 255;
152 typedef std::map<string, bool> DepClean;
157 Impl(Buffer & parent, string const & file, bool readonly);
159 limited_stack<Undo> undostack;
160 limited_stack<Undo> redostack;
166 /// need to regenerate .tex?
170 mutable bool lyx_clean;
172 /// is autosave needed?
173 mutable bool bak_clean;
175 /// is this a unnamed file (New...)?
181 /// name of the file the buffer is associated with.
184 boost::scoped_ptr<Messages> messages;
186 /** Set to true only when the file is fully loaded.
187 * Used to prevent the premature generation of previews
188 * and by the citation inset.
190 bool file_fully_loaded;
192 /// our LyXText that should be wrapped in an InsetText
199 TocBackend toc_backend;
203 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
204 : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
205 filename(file), file_fully_loaded(false), inset(params),
208 inset.setAutoBreakRows(true);
209 lyxvc.buffer(&parent);
210 temppath = createBufferTmpDir();
211 params.filepath = onlyPath(file);
212 // FIXME: And now do something if temppath == string(), because we
213 // assume from now on that temppath points to a valid temp dir.
214 // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
218 Buffer::Buffer(string const & file, bool readonly)
219 : pimpl_(new Impl(*this, file, readonly))
221 lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
227 lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
228 // here the buffer should take care that it is
229 // saved properly, before it goes into the void.
233 if (!temppath().empty() && !destroyDir(temppath())) {
234 Alert::warning(_("Could not remove temporary directory"),
235 bformat(_("Could not remove the temporary directory %1$s"),
236 from_utf8(temppath())));
239 // Remove any previewed LaTeX snippets associated with this buffer.
240 graphics::Previews::get().removeLoader(*this);
244 LyXText & Buffer::text() const
246 return const_cast<LyXText &>(pimpl_->inset.text_);
250 InsetBase & Buffer::inset() const
252 return const_cast<InsetText &>(pimpl_->inset);
256 limited_stack<Undo> & Buffer::undostack()
258 return pimpl_->undostack;
262 limited_stack<Undo> const & Buffer::undostack() const
264 return pimpl_->undostack;
268 limited_stack<Undo> & Buffer::redostack()
270 return pimpl_->redostack;
274 limited_stack<Undo> const & Buffer::redostack() const
276 return pimpl_->redostack;
280 BufferParams & Buffer::params()
282 return pimpl_->params;
286 BufferParams const & Buffer::params() const
288 return pimpl_->params;
292 ParagraphList & Buffer::paragraphs()
294 return text().paragraphs();
298 ParagraphList const & Buffer::paragraphs() const
300 return text().paragraphs();
304 LyXVC & Buffer::lyxvc()
306 return pimpl_->lyxvc;
310 LyXVC const & Buffer::lyxvc() const
312 return pimpl_->lyxvc;
316 string const & Buffer::temppath() const
318 return pimpl_->temppath;
322 TexRow & Buffer::texrow()
324 return pimpl_->texrow;
328 TexRow const & Buffer::texrow() const
330 return pimpl_->texrow;
334 TocBackend & Buffer::tocBackend()
336 return pimpl_->toc_backend;
340 TocBackend const & Buffer::tocBackend() const
342 return pimpl_->toc_backend;
346 string const Buffer::getLatexName(bool const no_path) const
348 string const name = changeExtension(makeLatexName(fileName()), ".tex");
349 return no_path ? onlyFilename(name) : name;
353 pair<Buffer::LogType, string> const Buffer::getLogName() const
355 string const filename = getLatexName(false);
357 if (filename.empty())
358 return make_pair(Buffer::latexlog, string());
360 string const path = temppath();
362 string const fname = addName(path,
363 onlyFilename(changeExtension(filename,
366 addName(path, onlyFilename(
367 changeExtension(filename,
368 formats.extension("literate") + ".out")));
370 // If no Latex log or Build log is newer, show Build log
372 if (fs::exists(bname) &&
373 (!fs::exists(fname) || fs::last_write_time(fname) < fs::last_write_time(bname))) {
374 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
375 return make_pair(Buffer::buildlog, bname);
377 lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
378 return make_pair(Buffer::latexlog, fname);
382 void Buffer::setReadonly(bool const flag)
384 if (pimpl_->read_only != flag) {
385 pimpl_->read_only = flag;
391 void Buffer::setFileName(string const & newfile)
393 pimpl_->filename = makeAbsPath(newfile);
394 params().filepath = onlyPath(pimpl_->filename);
395 setReadonly(fs::is_readonly(pimpl_->filename));
400 // We'll remove this later. (Lgb)
403 void unknownClass(string const & unknown)
405 Alert::warning(_("Unknown document class"),
406 bformat(_("Using the default document class, because the "
407 "class %1$s is unknown."), from_utf8(unknown)));
413 int Buffer::readHeader(LyXLex & lex)
415 int unknown_tokens = 0;
417 int begin_header_line = -1;
419 // Initialize parameters that may be/go lacking in header:
420 params().branchlist().clear();
421 params().preamble.erase();
422 params().options.erase();
423 params().float_placement.erase();
424 params().paperwidth.erase();
425 params().paperheight.erase();
426 params().leftmargin.erase();
427 params().rightmargin.erase();
428 params().topmargin.erase();
429 params().bottommargin.erase();
430 params().headheight.erase();
431 params().headsep.erase();
432 params().footskip.erase();
434 ErrorList & errorList = errorLists_["Parse"];
438 string const token = lex.getString();
443 if (token == "\\end_header")
447 if (token == "\\begin_header") {
448 begin_header_line = line;
452 lyxerr[Debug::PARSER] << "Handling document header token: `"
453 << token << '\'' << endl;
455 string unknown = params().readToken(lex, token);
456 if (!unknown.empty()) {
457 if (unknown[0] != '\\' && token == "\\textclass") {
458 unknownClass(unknown);
461 docstring const s = bformat(_("Unknown token: "
465 errorList.push_back(ErrorItem(_("Document header error"),
470 if (begin_header_line) {
471 docstring const s = _("\\begin_header is missing");
472 errorList.push_back(ErrorItem(_("Document header error"),
476 return unknown_tokens;
481 // changed to be public and have one parameter
482 // Returns false if "\end_document" is not read (Asger)
483 bool Buffer::readDocument(LyXLex & lex)
485 ErrorList & errorList = errorLists_["Parse"];
489 string const token = lex.getString();
490 if (token != "\\begin_document") {
491 docstring const s = _("\\begin_document is missing");
492 errorList.push_back(ErrorItem(_("Document header error"),
496 // we are reading in a brand new document
497 BOOST_ASSERT(paragraphs().empty());
500 if (!params().getLyXTextClass().load(filePath())) {
501 string theclass = params().getLyXTextClass().name();
502 Alert::error(_("Can't load document class"), bformat(
503 _("Using the default document class, because the "
504 " class %1$s could not be loaded."), from_utf8(theclass)));
505 params().textclass = 0;
508 bool const res = text().read(*this, lex, errorList);
509 for_each(text().paragraphs().begin(),
510 text().paragraphs().end(),
511 bind(&Paragraph::setInsetOwner, _1, &inset()));
512 updateBibfilesCache();
518 // needed to insert the selection
519 void Buffer::insertStringAsLines(ParagraphList & pars,
520 pit_type & pit, pos_type & pos,
521 LyXFont const & fn, docstring const & str, bool autobreakrows)
525 // insert the string, don't insert doublespace
526 bool space_inserted = true;
527 for (docstring::const_iterator cit = str.begin();
528 cit != str.end(); ++cit) {
529 Paragraph & par = pars[pit];
531 if (autobreakrows && (!par.empty() || par.allowEmpty())) {
532 breakParagraph(params(), pars, pit, pos,
533 par.layout()->isEnvironment());
536 space_inserted = true;
540 // do not insert consecutive spaces if !free_spacing
541 } else if ((*cit == ' ' || *cit == '\t') &&
542 space_inserted && !par.isFreeSpacing()) {
544 } else if (*cit == '\t') {
545 if (!par.isFreeSpacing()) {
546 // tabs are like spaces here
547 par.insertChar(pos, ' ', font, params().trackChanges);
549 space_inserted = true;
551 const pos_type n = 8 - pos % 8;
552 for (pos_type i = 0; i < n; ++i) {
553 par.insertChar(pos, ' ', font, params().trackChanges);
556 space_inserted = true;
558 } else if (!isPrintable(*cit)) {
559 // Ignore unprintables
562 // just insert the character
563 par.insertChar(pos, *cit, font, params().trackChanges);
565 space_inserted = (*cit == ' ');
572 bool Buffer::readFile(string const & filename)
574 // Check if the file is compressed.
575 FileName const name(makeAbsPath(filename));
576 string const format = getFormatFromContents(name);
577 if (format == "gzip" || format == "zip" || format == "compress") {
578 params().compressed = true;
581 // remove dummy empty par
582 paragraphs().clear();
585 if (!readFile(lex, filename))
588 // After we have read a file, we must ensure that the buffer
589 // language is set and used in the gui.
590 // If you know of a better place to put this, please tell me. (Lgb)
591 updateDocLang(params().language);
597 bool Buffer::fully_loaded() const
599 return pimpl_->file_fully_loaded;
603 void Buffer::fully_loaded(bool const value)
605 pimpl_->file_fully_loaded = value;
609 bool Buffer::readFile(LyXLex & lex, string const & filename)
611 BOOST_ASSERT(!filename.empty());
614 Alert::error(_("Document could not be read"),
615 bformat(_("%1$s could not be read."), from_utf8(filename)));
620 string const token(lex.getString());
623 Alert::error(_("Document could not be read"),
624 bformat(_("%1$s could not be read."), from_utf8(filename)));
628 // the first token _must_ be...
629 if (token != "\\lyxformat") {
630 lyxerr << "Token: " << token << endl;
632 Alert::error(_("Document format failure"),
633 bformat(_("%1$s is not a LyX document."),
634 from_utf8(filename)));
639 string tmp_format = lex.getString();
640 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
641 // if present remove ".," from string.
642 string::size_type dot = tmp_format.find_first_of(".,");
643 //lyxerr << " dot found at " << dot << endl;
644 if (dot != string::npos)
645 tmp_format.erase(dot, 1);
646 int const file_format = convert<int>(tmp_format);
647 //lyxerr << "format: " << file_format << endl;
649 if (file_format != LYX_FORMAT) {
650 string const tmpfile = tempName();
651 if (tmpfile.empty()) {
652 Alert::error(_("Conversion failed"),
653 bformat(_("%1$s is from an earlier"
654 " version of LyX, but a temporary"
655 " file for converting it could"
657 from_utf8(filename)));
660 FileName const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
661 if (lyx2lyx.empty()) {
662 Alert::error(_("Conversion script not found"),
663 bformat(_("%1$s is from an earlier"
664 " version of LyX, but the"
665 " conversion script lyx2lyx"
666 " could not be found."),
667 from_utf8(filename)));
670 ostringstream command;
671 command << os::python() << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
672 << " -t " << convert<string>(LYX_FORMAT)
673 << " -o " << quoteName(tmpfile) << ' '
674 << quoteName(filename);
675 string const command_str = command.str();
677 lyxerr[Debug::INFO] << "Running '"
678 << command_str << '\''
681 cmd_ret const ret = runCommand(command_str);
682 if (ret.first != 0) {
683 Alert::error(_("Conversion script failed"),
684 bformat(_("%1$s is from an earlier version"
685 " of LyX, but the lyx2lyx script"
686 " failed to convert it."),
687 from_utf8(filename)));
690 bool const ret = readFile(tmpfile);
691 // Do stuff with tmpfile name and buffer name here.
697 if (readDocument(lex)) {
698 Alert::error(_("Document format failure"),
699 bformat(_("%1$s ended unexpectedly, which means"
700 " that it is probably corrupted."),
701 from_utf8(filename)));
704 //lyxerr << "removing " << MacroTable::localMacros().size()
705 // << " temporary macro entries" << endl;
706 //MacroTable::localMacros().clear();
708 pimpl_->file_fully_loaded = true;
713 // Should probably be moved to somewhere else: BufferView? LyXView?
714 bool Buffer::save() const
716 // We don't need autosaves in the immediate future. (Asger)
717 resetAutosaveTimers();
721 if (lyxrc.make_backup) {
722 s = fileName() + '~';
723 if (!lyxrc.backupdir_path.empty())
724 s = addName(lyxrc.backupdir_path,
725 subst(os::internal_path(s),'/','!'));
727 // It might very well be that this variant is just
728 // good enough. (Lgb)
729 // But to use this we need fs::copy_file to actually do a copy,
730 // even when the target file exists. (Lgb)
732 fs::copy_file(fileName(), s, false);
734 catch (fs::filesystem_error const & fe) {
735 Alert::error(_("Backup failure"),
736 bformat(_("LyX was not able to make a backup copy in %1$s.\n"
737 "Please check if the directory exists and is writeable."),
738 from_utf8(fs::path(s).branch_path().native_directory_string())));
739 lyxerr[Debug::DEBUG] << "Fs error: "
740 << fe.what() << endl;
744 if (writeFile(fileName())) {
746 removeAutosaveFile(fileName());
748 // Saving failed, so backup is not backup
749 if (lyxrc.make_backup)
750 rename(FileName(s), FileName(fileName()));
757 bool Buffer::writeFile(string const & fname) const
759 if (pimpl_->read_only && fname == fileName())
764 if (params().compressed) {
765 io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
769 retval = do_writeFile(ofs);
771 ofstream ofs(fname.c_str(), ios::out|ios::trunc);
775 retval = do_writeFile(ofs);
782 bool Buffer::do_writeFile(ostream & ofs) const
785 // Use the standard "C" locale for file output.
786 ofs.imbue(std::locale::classic());
789 // The top of the file should not be written by params().
791 // write out a comment in the top of the file
792 ofs << "#LyX " << lyx_version
793 << " created this file. For more info see http://www.lyx.org/\n"
794 << "\\lyxformat " << LYX_FORMAT << "\n"
795 << "\\begin_document\n";
797 // now write out the buffer parameters.
798 ofs << "\\begin_header\n";
799 params().writeFile(ofs);
800 ofs << "\\end_header\n";
803 ofs << "\n\\begin_body\n";
804 text().write(*this, ofs);
805 ofs << "\n\\end_body\n";
807 // Write marker that shows file is complete
808 ofs << "\\end_document" << endl;
810 // Shouldn't really be needed....
813 // how to check if close went ok?
814 // Following is an attempt... (BE 20001011)
816 // good() returns false if any error occured, including some
818 // bad() returns true if something bad happened in the buffer,
819 // which should include file system full errors.
824 lyxerr << "File was not closed properly." << endl;
831 bool Buffer::makeLaTeXFile(string const & fname,
832 string const & original_path,
833 OutputParams const & runparams,
834 bool output_preamble, bool output_body)
837 if (params().inputenc == "auto")
838 encoding = params().language->encoding()->iconvName();
840 Encoding const * enc = encodings.getFromLaTeXName(params().inputenc);
842 encoding = enc->iconvName();
844 lyxerr << "Unknown inputenc value `"
846 << "'. Using `auto' instead." << endl;
847 encoding = params().language->encoding()->iconvName();
850 lyxerr[Debug::LATEX] << "makeLaTeXFile encoding: "
851 << encoding << "..." << endl;
853 odocfstream ofs(encoding);
854 if (!openFileWrite(ofs, fname))
858 writeLaTeXSource(ofs, original_path,
859 runparams, output_preamble, output_body);
861 catch (iconv_codecvt_facet_exception &) {
862 Alert::error(_("Encoding error"),
863 _("Some characters of your document are not "
864 "representable in the chosen encoding.\n"
865 "Changing the document encoding to utf8 could help."));
871 lyxerr << "File '" << fname << "' was not closed properly." << endl;
872 Alert::error(_("Error closing file"),
873 _("The output file could not be closed properly.\n"
874 " Probably some characters of your document are not "
875 "representable in the chosen encoding.\n"
876 "Changing the document encoding to utf8 could help."));
883 void Buffer::writeLaTeXSource(odocstream & os,
884 string const & original_path,
885 OutputParams const & runparams_in,
886 bool const output_preamble, bool const output_body)
888 OutputParams runparams = runparams_in;
890 // validate the buffer.
891 lyxerr[Debug::LATEX] << " Validating buffer..." << endl;
892 LaTeXFeatures features(*this, params(), runparams);
894 lyxerr[Debug::LATEX] << " Buffer validation done." << endl;
898 // The starting paragraph of the coming rows is the
899 // first paragraph of the document. (Asger)
900 texrow().start(paragraphs().begin()->id(), 0);
902 if (output_preamble && runparams.nice) {
903 os << "%% LyX " << lyx_version << " created this file. "
904 "For more info, see http://www.lyx.org/.\n"
905 "%% Do not edit unless you really know what "
910 lyxerr[Debug::INFO] << "lyx document header finished" << endl;
911 // There are a few differences between nice LaTeX and usual files:
912 // usual is \batchmode and has a
913 // special input@path to allow the including of figures
914 // with either \input or \includegraphics (what figinsets do).
915 // input@path is set when the actual parameter
916 // original_path is set. This is done for usual tex-file, but not
917 // for nice-latex-file. (Matthias 250696)
918 // Note that input@path is only needed for something the user does
919 // in the preamble, included .tex files or ERT, files included by
920 // LyX work without it.
921 if (output_preamble) {
922 if (!runparams.nice) {
923 // code for usual, NOT nice-latex-file
924 os << "\\batchmode\n"; // changed
928 if (!original_path.empty()) {
930 // We don't know the encoding of inputpath
931 docstring const inputpath = from_utf8(latex_path(original_path));
932 os << "\\makeatletter\n"
933 << "\\def\\input@path{{"
934 << inputpath << "/}}\n"
935 << "\\makeatother\n";
941 // Write the preamble
942 runparams.use_babel = params().writeLaTeX(os, features, texrow());
948 os << "\\begin{document}\n";
951 lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
953 if (!lyxrc.language_auto_begin) {
955 os << from_utf8(subst(lyxrc.language_command_begin,
957 params().language->babel()))
962 // if we are doing a real file with body, even if this is the
963 // child of some other buffer, let's cut the link here.
964 // This happens for example if only a child document is printed.
965 string save_parentname;
966 if (output_preamble) {
967 save_parentname = params().parentname;
968 params().parentname.erase();
972 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
974 // Restore the parenthood if needed
976 params().parentname = save_parentname;
978 // add this just in case after all the paragraphs
982 if (!lyxrc.language_auto_end) {
983 os << from_utf8(subst(lyxrc.language_command_end,
985 params().language->babel()))
990 if (output_preamble) {
991 os << "\\end{document}\n";
994 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
996 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
1000 // Just to be sure. (Asger)
1003 lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
1004 lyxerr[Debug::INFO] << "Row count was " << texrow().rows() - 1
1009 bool Buffer::isLatex() const
1011 return params().getLyXTextClass().outputType() == LATEX;
1015 bool Buffer::isLiterate() const
1017 return params().getLyXTextClass().outputType() == LITERATE;
1021 bool Buffer::isDocBook() const
1023 return params().getLyXTextClass().outputType() == DOCBOOK;
1027 void Buffer::makeDocBookFile(string const & fname,
1028 OutputParams const & runparams,
1029 bool const body_only)
1031 lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
1035 if (!openFileWrite(ofs, fname))
1038 writeDocBookSource(ofs, fname, runparams, body_only);
1042 lyxerr << "File '" << fname << "' was not closed properly." << endl;
1046 void Buffer::writeDocBookSource(odocstream & os, string const & fname,
1047 OutputParams const & runparams,
1048 bool const only_body)
1050 LaTeXFeatures features(*this, params(), runparams);
1055 LyXTextClass const & tclass = params().getLyXTextClass();
1056 string const top_element = tclass.latexname();
1059 if (runparams.flavor == OutputParams::XML)
1060 os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1063 os << "<!DOCTYPE " << from_ascii(top_element) << ' ';
1066 if (! tclass.class_header().empty())
1067 os << from_ascii(tclass.class_header());
1068 else if (runparams.flavor == OutputParams::XML)
1069 os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1070 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1072 os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1074 docstring preamble = from_utf8(params().preamble);
1075 if (runparams.flavor != OutputParams::XML ) {
1076 preamble += "<!ENTITY % output.print.png \"IGNORE\">\n";
1077 preamble += "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1078 preamble += "<!ENTITY % output.print.eps \"IGNORE\">\n";
1079 preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1082 string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
1084 preamble += features.getIncludedFiles(name);
1085 preamble += features.getLyXSGMLEntities();
1087 if (!preamble.empty()) {
1088 os << "\n [ " << preamble << " ]";
1093 string top = top_element;
1095 if (runparams.flavor == OutputParams::XML)
1096 top += params().language->code();
1098 top += params().language->code().substr(0,2);
1101 if (!params().options.empty()) {
1103 top += params().options;
1106 os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
1107 << " file was created by LyX " << lyx_version
1108 << "\n See http://www.lyx.org/ for more information -->\n";
1110 params().getLyXTextClass().counters().reset();
1112 sgml::openTag(os, top);
1114 docbookParagraphs(paragraphs(), *this, os, runparams);
1115 sgml::closeTag(os, top_element);
1119 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1120 // Other flags: -wall -v0 -x
1121 int Buffer::runChktex()
1125 // get LaTeX-Filename
1126 string const name = getLatexName();
1127 string const path = temppath();
1128 string const org_path = filePath();
1130 support::Path p(path); // path to LaTeX file
1131 message(_("Running chktex..."));
1133 // Generate the LaTeX file if neccessary
1134 OutputParams runparams;
1135 runparams.flavor = OutputParams::LATEX;
1136 runparams.nice = false;
1137 makeLaTeXFile(name, org_path, runparams);
1140 Chktex chktex(lyxrc.chktex_command, name, filePath());
1141 int const res = chktex.run(terr); // run chktex
1144 Alert::error(_("chktex failure"),
1145 _("Could not run chktex successfully."));
1146 } else if (res > 0) {
1147 // Fill-in the error list with the TeX errors
1148 bufferErrors(*this, terr, errorLists_["ChkTex"]);
1159 void Buffer::validate(LaTeXFeatures & features) const
1161 LyXTextClass const & tclass = params().getLyXTextClass();
1163 if (features.isAvailable("dvipost") && params().outputChanges)
1164 features.require("dvipost");
1166 // AMS Style is at document level
1167 if (params().use_amsmath == BufferParams::package_on
1168 || tclass.provides(LyXTextClass::amsmath))
1169 features.require("amsmath");
1170 if (params().use_esint == BufferParams::package_on)
1171 features.require("esint");
1173 for_each(paragraphs().begin(), paragraphs().end(),
1174 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
1176 // the bullet shapes are buffer level not paragraph level
1177 // so they are tested here
1178 for (int i = 0; i < 4; ++i) {
1179 if (params().user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1180 int const font = params().user_defined_bullet(i).getFont();
1182 int const c = params()
1183 .user_defined_bullet(i)
1190 features.require("latexsym");
1192 } else if (font == 1) {
1193 features.require("amssymb");
1194 } else if ((font >= 2 && font <= 5)) {
1195 features.require("pifont");
1200 if (lyxerr.debugging(Debug::LATEX)) {
1201 features.showStruct();
1206 void Buffer::getLabelList(vector<docstring> & list) const
1208 /// if this is a child document and the parent is already loaded
1209 /// Use the parent's list instead [ale990407]
1210 Buffer const * tmp = getMasterBuffer();
1212 lyxerr << "getMasterBuffer() failed!" << endl;
1216 tmp->getLabelList(list);
1220 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
1221 it.nextInset()->getLabelList(*this, list);
1225 // This is also a buffer property (ale)
1226 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
1229 /// if this is a child document and the parent is already loaded
1230 /// use the parent's list instead [ale990412]
1231 Buffer const * tmp = getMasterBuffer();
1234 tmp->fillWithBibKeys(keys);
1238 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1239 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1240 InsetBibtex const & inset =
1241 dynamic_cast<InsetBibtex const &>(*it);
1242 inset.fillWithBibKeys(*this, keys);
1243 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1244 InsetInclude const & inset =
1245 dynamic_cast<InsetInclude const &>(*it);
1246 inset.fillWithBibKeys(*this, keys);
1247 } else if (it->lyxCode() == InsetBase::BIBITEM_CODE) {
1248 InsetBibitem const & inset =
1249 dynamic_cast<InsetBibitem const &>(*it);
1250 string const key = inset.getContents();
1251 string const opt = inset.getOptions();
1252 string const ref; // = pit->asString(this, false);
1253 string const info = opt + "TheBibliographyRef" + ref;
1254 keys.push_back(pair<string, string>(key, info));
1260 void Buffer::updateBibfilesCache()
1262 // if this is a child document and the parent is already loaded
1263 // update the parent's cache instead
1264 Buffer * tmp = getMasterBuffer();
1267 tmp->updateBibfilesCache();
1271 bibfilesCache_.clear();
1272 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1273 if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
1274 InsetBibtex const & inset =
1275 dynamic_cast<InsetBibtex const &>(*it);
1276 vector<string> const bibfiles = inset.getFiles(*this);
1277 bibfilesCache_.insert(bibfilesCache_.end(),
1280 } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
1281 InsetInclude & inset =
1282 dynamic_cast<InsetInclude &>(*it);
1283 inset.updateBibfilesCache(*this);
1284 vector<string> const & bibfiles =
1285 inset.getBibfilesCache(*this);
1286 bibfilesCache_.insert(bibfilesCache_.end(),
1294 vector<string> const & Buffer::getBibfilesCache() const
1296 // if this is a child document and the parent is already loaded
1297 // use the parent's cache instead
1298 Buffer const * tmp = getMasterBuffer();
1301 return tmp->getBibfilesCache();
1303 return bibfilesCache_;
1307 bool Buffer::isDepClean(string const & name) const
1309 DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
1310 if (it == pimpl_->dep_clean.end())
1316 void Buffer::markDepClean(string const & name)
1318 pimpl_->dep_clean[name] = true;
1322 bool Buffer::dispatch(string const & command, bool * result)
1324 return dispatch(lyxaction.lookupFunc(command), result);
1328 bool Buffer::dispatch(FuncRequest const & func, bool * result)
1330 bool dispatched = true;
1332 switch (func.action) {
1333 case LFUN_BUFFER_EXPORT: {
1334 bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
1347 void Buffer::changeLanguage(Language const * from, Language const * to)
1352 // Take care of l10n/i18n
1355 for_each(par_iterator_begin(),
1357 bind(&Paragraph::changeLanguage, _1, params(), from, to));
1359 text().current_font.setLanguage(to);
1360 text().real_current_font.setLanguage(to);
1364 void Buffer::updateDocLang(Language const * nlang)
1366 BOOST_ASSERT(nlang);
1368 pimpl_->messages.reset(new Messages(nlang->code()));
1370 updateLabels(*this);
1374 bool Buffer::isMultiLingual() const
1376 ParConstIterator end = par_iterator_end();
1377 for (ParConstIterator it = par_iterator_begin(); it != end; ++it)
1378 if (it->isMultiLingual(params()))
1385 ParIterator Buffer::getParFromID(int const id) const
1387 ParConstIterator it = par_iterator_begin();
1388 ParConstIterator const end = par_iterator_end();
1391 // John says this is called with id == -1 from undo
1392 lyxerr << "getParFromID(), id: " << id << endl;
1396 for (; it != end; ++it)
1404 bool Buffer::hasParWithID(int const id) const
1406 ParConstIterator const it = getParFromID(id);
1407 return it != par_iterator_end();
1411 ParIterator Buffer::par_iterator_begin()
1413 return lyx::par_iterator_begin(inset());
1417 ParIterator Buffer::par_iterator_end()
1419 return lyx::par_iterator_end(inset());
1423 ParConstIterator Buffer::par_iterator_begin() const
1425 return lyx::par_const_iterator_begin(inset());
1429 ParConstIterator Buffer::par_iterator_end() const
1431 return lyx::par_const_iterator_end(inset());
1435 Language const * Buffer::getLanguage() const
1437 return params().language;
1441 docstring const Buffer::B_(string const & l10n) const
1443 if (pimpl_->messages.get())
1444 return pimpl_->messages->get(l10n);
1450 docstring const Buffer::translateLabel(docstring const & label) const
1452 if (support::isAscii(label))
1453 // Probably standard layout, try to translate
1454 return B_(to_ascii(label));
1456 // This must be a user defined layout. We cannot translate
1457 // this, since gettext accepts only ascii keys.
1462 bool Buffer::isClean() const
1464 return pimpl_->lyx_clean;
1468 bool Buffer::isBakClean() const
1470 return pimpl_->bak_clean;
1474 void Buffer::markClean() const
1476 if (!pimpl_->lyx_clean) {
1477 pimpl_->lyx_clean = true;
1480 // if the .lyx file has been saved, we don't need an
1482 pimpl_->bak_clean = true;
1486 void Buffer::markBakClean()
1488 pimpl_->bak_clean = true;
1492 void Buffer::setUnnamed(bool flag)
1494 pimpl_->unnamed = flag;
1498 bool Buffer::isUnnamed() const
1500 return pimpl_->unnamed;
1504 #ifdef WITH_WARNINGS
1505 #warning this function should be moved to buffer_pimpl.C
1507 void Buffer::markDirty()
1509 if (pimpl_->lyx_clean) {
1510 pimpl_->lyx_clean = false;
1513 pimpl_->bak_clean = false;
1515 DepClean::iterator it = pimpl_->dep_clean.begin();
1516 DepClean::const_iterator const end = pimpl_->dep_clean.end();
1518 for (; it != end; ++it)
1523 string const & Buffer::fileName() const
1525 return pimpl_->filename;
1529 string const & Buffer::filePath() const
1531 return params().filepath;
1535 bool Buffer::isReadonly() const
1537 return pimpl_->read_only;
1541 void Buffer::setParentName(string const & name)
1543 params().parentname = name;
1547 Buffer const * Buffer::getMasterBuffer() const
1549 if (!params().parentname.empty()
1550 && theBufferList().exists(params().parentname)) {
1551 Buffer const * buf = theBufferList().getBuffer(params().parentname);
1553 return buf->getMasterBuffer();
1560 Buffer * Buffer::getMasterBuffer()
1562 if (!params().parentname.empty()
1563 && theBufferList().exists(params().parentname)) {
1564 Buffer * buf = theBufferList().getBuffer(params().parentname);
1566 return buf->getMasterBuffer();
1573 MacroData const & Buffer::getMacro(docstring const & name) const
1575 return pimpl_->macros.get(name);
1579 bool Buffer::hasMacro(docstring const & name) const
1581 return pimpl_->macros.has(name);
1585 void Buffer::insertMacro(docstring const & name, MacroData const & data)
1587 MacroTable::globalMacros().insert(name, data);
1588 pimpl_->macros.insert(name, data);
1592 void Buffer::buildMacros()
1594 // Start with global table.
1595 pimpl_->macros = MacroTable::globalMacros();
1598 ParagraphList const & pars = text().paragraphs();
1599 for (size_t i = 0, n = pars.size(); i != n; ++i) {
1600 //lyxerr << "searching main par " << i
1601 // << " for macro definitions" << std::endl;
1602 InsetList const & insets = pars[i].insetlist;
1603 InsetList::const_iterator it = insets.begin();
1604 InsetList::const_iterator end = insets.end();
1605 for ( ; it != end; ++it) {
1606 //lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
1607 if (it->inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
1608 MathMacroTemplate const & mac
1609 = static_cast<MathMacroTemplate const &>(*it->inset);
1610 insertMacro(mac.name(), mac.asMacroData());
1617 void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
1624 void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
1625 InsetBase::Code code)
1627 //FIXME: This does not work for child documents yet.
1628 BOOST_ASSERT(code == InsetBase::CITE_CODE || code == InsetBase::REF_CODE);
1629 // Check if the label 'from' appears more than once
1630 vector<docstring> labels;
1632 if (code == InsetBase::CITE_CODE) {
1633 vector<pair<string, string> > keys;
1634 fillWithBibKeys(keys);
1635 vector<pair<string, string> >::const_iterator bit = keys.begin();
1636 vector<pair<string, string> >::const_iterator bend = keys.end();
1638 for (; bit != bend; ++bit)
1640 labels.push_back(from_utf8(bit->first));
1642 getLabelList(labels);
1644 if (lyx::count(labels.begin(), labels.end(), from) > 1)
1647 for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
1648 if (it->lyxCode() == code) {
1649 InsetCommand & inset = dynamic_cast<InsetCommand &>(*it);
1650 inset.replaceContents(to_utf8(from), to_utf8(to));
1656 void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
1657 pit_type par_end, bool full_source)
1659 OutputParams runparams;
1660 runparams.nice = true;
1661 runparams.flavor = OutputParams::LATEX;
1662 runparams.linelen = lyxrc.ascii_linelen;
1663 // No side effect of file copying and image conversion
1664 runparams.dryrun = true;
1666 /* Support for docbook temprarily commented out. */
1668 os << "% Preview source code\n\n";
1670 writeLaTeXSource(os, filePath(), runparams, true, true);
1672 writeDocBookSource(os, fileName(), runparams, false);
1675 runparams.par_begin = par_begin;
1676 runparams.par_end = par_end;
1677 if (par_begin + 1 == par_end)
1678 os << "% Preview source code for paragraph " << par_begin << "\n\n";
1680 os << "% Preview source code from paragraph " << par_begin
1681 << " to " << par_end - 1 << "\n\n";
1682 // output paragraphs
1685 latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
1688 docbookParagraphs(paragraphs(), *this, os, runparams);
1694 ErrorList const & Buffer::errorList(string const & type) const
1696 static ErrorList const emptyErrorList;
1697 std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
1698 if (I == errorLists_.end())
1699 return emptyErrorList;
1705 ErrorList & Buffer::errorList(string const & type)
1707 return errorLists_[type];