]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.C
minimal effort implementation of:
[lyx.git] / src / buffer.C
index 0dc0229063dd209618ff1d7e398c56cad322e746..466da5bc83be1b51b9604aa3db2215b72c2e2a15 100644 (file)
@@ -41,7 +41,6 @@
 #include "output.h"
 #include "output_docbook.h"
 #include "output_latex.h"
-#include "output_linuxdoc.h"
 #include "paragraph.h"
 #include "paragraph_funcs.h"
 #include "ParagraphParameters.h"
 
 #include "graphics/Previews.h"
 
+#include "support/types.h"
 #include "support/lyxalgo.h"
 #include "support/filetools.h"
 #include "support/fs_extras.h"
-#ifdef USE_COMPRESSION
-# include "support/gzstream.h"
-#endif
+# include <boost/iostreams/filtering_stream.hpp>
+# include <boost/iostreams/filter/gzip.hpp>
+# include <boost/iostreams/device/file.hpp>
+namespace io = boost::iostreams;
 #include "support/lyxlib.h"
 #include "support/os.h"
 #include "support/path.h"
 using lyx::pos_type;
 using lyx::pit_type;
 
-using lyx::support::AddName;
+using lyx::support::addName;
 using lyx::support::bformat;
-using lyx::support::ChangeExtension;
+using lyx::support::changeExtension;
 using lyx::support::cmd_ret;
 using lyx::support::createBufferTmpDir;
 using lyx::support::destroyDir;
 using lyx::support::getFormatFromContents;
-using lyx::support::IsDirWriteable;
-using lyx::support::LibFileSearch;
+using lyx::support::isDirWriteable;
+using lyx::support::libFileSearch;
 using lyx::support::latex_path;
 using lyx::support::ltrim;
-using lyx::support::MakeAbsPath;
-using lyx::support::MakeDisplayPath;
-using lyx::support::MakeLatexName;
-using lyx::support::OnlyFilename;
-using lyx::support::OnlyPath;
+using lyx::support::makeAbsPath;
+using lyx::support::makeDisplayPath;
+using lyx::support::makeLatexName;
+using lyx::support::onlyFilename;
+using lyx::support::onlyPath;
 using lyx::support::Path;
-using lyx::support::QuoteName;
+using lyx::support::quoteName;
 using lyx::support::removeAutosaveFile;
 using lyx::support::rename;
-using lyx::support::RunCommand;
+using lyx::support::runCommand;
 using lyx::support::split;
 using lyx::support::subst;
 using lyx::support::tempName;
@@ -144,7 +145,7 @@ extern BufferList bufferlist;
 
 namespace {
 
-int const LYX_FORMAT = 245;
+int const LYX_FORMAT = 249;
 
 } // namespace anon
 
@@ -181,9 +182,6 @@ public:
        /// name of the file the buffer is associated with.
        string filename;
 
-       /// The path to the document file.
-       string filepath;
-
        boost::scoped_ptr<Messages> messages;
 
        /** Set to true only when the file is fully loaded.
@@ -202,12 +200,13 @@ public:
 
 Buffer::Impl::Impl(Buffer & parent, string const & file, bool readonly_)
        : lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
-         filename(file), filepath(OnlyPath(file)), file_fully_loaded(false),
+         filename(file), file_fully_loaded(false),
                inset(params)
 {
        inset.setAutoBreakRows(true);
        lyxvc.buffer(&parent);
        temppath = createBufferTmpDir();
+       params.filepath = onlyPath(file);
        // FIXME: And now do something if temppath == string(), because we
        // assume from now on that temppath points to a valid temp dir.
        // See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
@@ -331,8 +330,8 @@ TexRow const & Buffer::texrow() const
 
 string const Buffer::getLatexName(bool const no_path) const
 {
-       string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
-       return no_path ? OnlyFilename(name) : name;
+       string const name = changeExtension(makeLatexName(fileName()), ".tex");
+       return no_path ? onlyFilename(name) : name;
 }
 
 
@@ -345,12 +344,12 @@ pair<Buffer::LogType, string> const Buffer::getLogName() const
 
        string const path = temppath();
 
-       string const fname = AddName(path,
-                                    OnlyFilename(ChangeExtension(filename,
+       string const fname = addName(path,
+                                    onlyFilename(changeExtension(filename,
                                                                  ".log")));
        string const bname =
-               AddName(path, OnlyFilename(
-                       ChangeExtension(filename,
+               addName(path, onlyFilename(
+                       changeExtension(filename,
                                        formats.extension("literate") + ".out")));
 
        // If no Latex log or Build log is newer, show Build log
@@ -376,8 +375,8 @@ void Buffer::setReadonly(bool const flag)
 
 void Buffer::setFileName(string const & newfile)
 {
-       pimpl_->filename = MakeAbsPath(newfile);
-       pimpl_->filepath = OnlyPath(pimpl_->filename);
+       pimpl_->filename = makeAbsPath(newfile);
+       params().filepath = onlyPath(pimpl_->filename);
        setReadonly(fs::is_readonly(pimpl_->filename));
        updateTitles();
 }
@@ -417,6 +416,8 @@ int Buffer::readHeader(LyXLex & lex)
        params().headsep.erase();
        params().footskip.erase();
 
+       ErrorList & errorList = errorLists_["Parse"];
+
        while (lex.isOK()) {
                lex.next();
                string const token = lex.getString();
@@ -446,15 +447,17 @@ int Buffer::readHeader(LyXLex & lex)
                                                           "%1$s %2$s\n"),
                                                         token,
                                                         lex.getString());
-                               error(ErrorItem(_("Document header error"), s,
-                                               -1, 0, 0));
+                               errorList.push_back(ErrorItem(_("Document header error"),
+                                       s, -1, 0, 0));
                        }
                }
        }
        if (begin_header_line) {
                string const s = _("\\begin_header is missing");
-               error(ErrorItem(_("Document header error"), s, -1, 0, 0));
+               errorList.push_back(ErrorItem(_("Document header error"),
+                       s, -1, 0, 0));
        }
+
        return unknown_tokens;
 }
 
@@ -464,18 +467,22 @@ int Buffer::readHeader(LyXLex & lex)
 // Returns false if "\end_document" is not read (Asger)
 bool Buffer::readDocument(LyXLex & lex)
 {
+       ErrorList & errorList = errorLists_["Parse"];
+       errorList.clear();
+
        lex.next();
        string const token = lex.getString();
        if (token != "\\begin_document") {
                string const s = _("\\begin_document is missing");
-               error(ErrorItem(_("Document header error"), s, -1, 0, 0));
+               errorList.push_back(ErrorItem(_("Document header error"),
+                       s, -1, 0, 0));
        }
 
        // we are reading in a brand new document
        BOOST_ASSERT(paragraphs().empty());
 
        readHeader(lex);
-       if (!params().getLyXTextClass().load()) {
+       if (!params().getLyXTextClass().load(filePath())) {
                string theclass = params().getLyXTextClass().name();
                Alert::error(_("Can't load document class"), bformat(
                                     "Using the default document class, because the "
@@ -483,10 +490,12 @@ bool Buffer::readDocument(LyXLex & lex)
                params().textclass = 0;
        }
 
-       bool const res = text().read(*this, lex);
+       bool const res = text().read(*this, lex, errorList);
        for_each(text().paragraphs().begin(),
                 text().paragraphs().end(),
                 bind(&Paragraph::setInsetOwner, _1, &inset()));
+       updateBibfilesCache();
+
        return res;
 }
 
@@ -531,7 +540,7 @@ void Buffer::insertStringAsLines(ParagraphList & pars,
                                }
                                space_inserted = true;
                        }
-               } else if (!IsPrintable(*cit)) {
+               } else if (!isPrintable(*cit)) {
                        // Ignore unprintables
                        continue;
                } else {
@@ -557,14 +566,15 @@ bool Buffer::readFile(string const & filename)
        paragraphs().clear();
        LyXLex lex(0, 0);
        lex.setFile(filename);
-       bool ret = readFile(lex, filename);
+       if (!readFile(lex, filename))
+               return false;
 
        // After we have read a file, we must ensure that the buffer
        // language is set and used in the gui.
        // If you know of a better place to put this, please tell me. (Lgb)
        updateDocLang(params().language);
 
-       return ret;
+       return true;
 }
 
 
@@ -631,7 +641,7 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
                                              filename));
                        return false;
                }
-               string const lyx2lyx = LibFileSearch("lyx2lyx", "lyx2lyx");
+               string const lyx2lyx = libFileSearch("lyx2lyx", "lyx2lyx");
                if (lyx2lyx.empty()) {
                        Alert::error(_("Conversion script not found"),
                                     bformat(_("%1$s is from an earlier"
@@ -642,17 +652,17 @@ bool Buffer::readFile(LyXLex & lex, string const & filename)
                        return false;
                }
                ostringstream command;
-               command << "python " << QuoteName(lyx2lyx)
+               command << os::python() << ' ' << quoteName(lyx2lyx)
                        << " -t " << convert<string>(LYX_FORMAT)
-                       << " -o " << QuoteName(tmpfile) << ' '
-                       << QuoteName(filename);
+                       << " -o " << quoteName(tmpfile) << ' '
+                       << quoteName(filename);
                string const command_str = command.str();
 
                lyxerr[Debug::INFO] << "Running '"
                                    << command_str << '\''
                                    << endl;
 
-               cmd_ret const ret = RunCommand(command_str);
+               cmd_ret const ret = runCommand(command_str);
                if (ret.first != 0) {
                        Alert::error(_("Conversion script failed"),
                                     bformat(_("%1$s is from an earlier version"
@@ -695,7 +705,7 @@ bool Buffer::save() const
        if (lyxrc.make_backup) {
                s = fileName() + '~';
                if (!lyxrc.backupdir_path.empty())
-                       s = AddName(lyxrc.backupdir_path,
+                       s = addName(lyxrc.backupdir_path,
                                    subst(os::internal_path(s),'/','!'));
 
                // It might very well be that this variant is just
@@ -734,15 +744,11 @@ bool Buffer::writeFile(string const & fname) const
        bool retval = false;
 
        if (params().compressed) {
-#ifdef USE_COMPRESSION
-               gz::ogzstream ofs(fname.c_str(), ios::out|ios::trunc);
+               io::filtering_ostream ofs(io::gzip_compressor() | io::file_sink(fname));
                if (!ofs)
                        return false;
 
                retval = do_writeFile(ofs);
-#else
-               return false;
-#endif
        } else {
                ofstream ofs(fname.c_str(), ios::out|ios::trunc);
                if (!ofs)
@@ -815,7 +821,7 @@ void Buffer::makeLaTeXFile(string const & fname,
        if (!openFileWrite(ofs, fname))
                return;
 
-       makeLaTeXFile(ofs, original_path,
+       writeLaTeXSource(ofs, original_path,
                      runparams, output_preamble, output_body);
 
        ofs.close();
@@ -824,7 +830,7 @@ void Buffer::makeLaTeXFile(string const & fname,
 }
 
 
-void Buffer::makeLaTeXFile(ostream & os,
+void Buffer::writeLaTeXSource(ostream & os,
                           string const & original_path,
                           OutputParams const & runparams_in,
                           bool const output_preamble, bool const output_body)
@@ -951,12 +957,6 @@ bool Buffer::isLatex() const
 }
 
 
-bool Buffer::isLinuxDoc() const
-{
-       return params().getLyXTextClass().outputType() == LINUXDOC;
-}
-
-
 bool Buffer::isLiterate() const
 {
        return params().getLyXTextClass().outputType() == LITERATE;
@@ -969,66 +969,17 @@ bool Buffer::isDocBook() const
 }
 
 
-bool Buffer::isSGML() const
-{
-       LyXTextClass const & tclass = params().getLyXTextClass();
-
-       return tclass.outputType() == LINUXDOC ||
-              tclass.outputType() == DOCBOOK;
-}
-
-
-void Buffer::makeLinuxDocFile(string const & fname,
+void Buffer::makeDocBookFile(string const & fname,
                              OutputParams const & runparams,
                              bool const body_only)
 {
+       lyxerr[Debug::LATEX] << "makeDocBookFile..." << endl;
+
        ofstream ofs;
        if (!openFileWrite(ofs, fname))
                return;
 
-       LaTeXFeatures features(*this, params(), runparams);
-       validate(features);
-
-       texrow().reset();
-
-       LyXTextClass const & tclass = params().getLyXTextClass();
-
-       string const & top_element = tclass.latexname();
-
-       if (!body_only) {
-               ofs << tclass.class_header();
-
-               string preamble = params().preamble;
-               string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
-                        : fname;
-               preamble += features.getIncludedFiles(name);
-               preamble += features.getLyXSGMLEntities();
-
-               if (!preamble.empty()) {
-                       ofs << " [ " << preamble << " ]";
-               }
-               ofs << ">\n\n";
-
-               if (params().options.empty())
-                       sgml::openTag(ofs, top_element);
-               else {
-                       string top = top_element;
-                       top += ' ';
-                       top += params().options;
-                       sgml::openTag(ofs, top);
-               }
-       }
-
-       ofs << "<!-- LyX "  << lyx_version
-           << " created this file. For more info see http://www.lyx.org/"
-           << " -->\n";
-
-       linuxdocParagraphs(*this, paragraphs(), ofs, runparams);
-
-       if (!body_only) {
-               ofs << "\n\n";
-               sgml::closeTag(ofs, top_element);
-       }
+       writeDocBookSource(ofs, fname, runparams, body_only);
 
        ofs.close();
        if (ofs.fail())
@@ -1036,14 +987,10 @@ void Buffer::makeLinuxDocFile(string const & fname,
 }
 
 
-void Buffer::makeDocBookFile(string const & fname,
+void Buffer::writeDocBookSource(ostream & os, string const & fname,
                             OutputParams const & runparams,
                             bool const only_body)
 {
-       ofstream ofs;
-       if (!openFileWrite(ofs, fname))
-               return;
-
        LaTeXFeatures features(*this, params(), runparams);
        validate(features);
 
@@ -1054,17 +1001,17 @@ void Buffer::makeDocBookFile(string const & fname,
 
        if (!only_body) {
                if (runparams.flavor == OutputParams::XML)
-                       ofs << "<?xml version=\"1.0\" encoding=\""
-                           << params().language->encoding()->Name() << "\"?>\n";
+                       os << "<?xml version=\"1.0\" encoding=\""
+                           << params().language->encoding()->name() << "\"?>\n";
 
-               ofs << "<!DOCTYPE " << top_element << " ";
+               os << "<!DOCTYPE " << top_element << " ";
 
-               if (! tclass.class_header().empty()) ofs << tclass.class_header();
+               if (! tclass.class_header().empty()) os << tclass.class_header();
                else if (runparams.flavor == OutputParams::XML)
-                       ofs << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
+                       os << "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
                            << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
                else
-                       ofs << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
+                       os << " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
 
                string preamble = params().preamble;
                if (runparams.flavor != OutputParams::XML ) {
@@ -1074,15 +1021,15 @@ void Buffer::makeDocBookFile(string const & fname,
                        preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
                }
 
-               string const name = runparams.nice ? ChangeExtension(pimpl_->filename, ".sgml")
+               string const name = runparams.nice ? changeExtension(pimpl_->filename, ".sgml")
                         : fname;
                preamble += features.getIncludedFiles(name);
                preamble += features.getLyXSGMLEntities();
 
                if (!preamble.empty()) {
-                       ofs << "\n [ " << preamble << " ]";
+                       os << "\n [ " << preamble << " ]";
                }
-               ofs << ">\n\n";
+               os << ">\n\n";
        }
 
        string top = top_element;
@@ -1098,20 +1045,16 @@ void Buffer::makeDocBookFile(string const & fname,
                top += params().options;
        }
 
-       ofs << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
+       os << "<!-- " << ((runparams.flavor == OutputParams::XML)? "XML" : "SGML")
            << " file was created by LyX " << lyx_version
            << "\n  See http://www.lyx.org/ for more information -->\n";
 
        params().getLyXTextClass().counters().reset();
 
-       sgml::openTag(ofs, top);
-       ofs << '\n';
-       docbookParagraphs(paragraphs(), *this, ofs, runparams);
-       sgml::closeTag(ofs, top_element);
-
-       ofs.close();
-       if (ofs.fail())
-               lyxerr << "File '" << fname << "' was not closed properly." << endl;
+       sgml::openTag(os, top);
+       os << '\n';
+       docbookParagraphs(paragraphs(), *this, os, runparams);
+       sgml::closeTag(os, top_element);
 }
 
 
@@ -1143,12 +1086,14 @@ int Buffer::runChktex()
                Alert::error(_("chktex failure"),
                             _("Could not run chktex successfully."));
        } else if (res > 0) {
-               // Insert all errors as errors boxes
-               bufferErrors(*this, terr);
+               // Fill-in the error list with the TeX errors
+               bufferErrors(*this, terr, errorLists_["ChkTex"]);
        }
 
        busy(false);
 
+       errors("ChkTeX");
+
        return res;
 }
 
@@ -1253,6 +1198,53 @@ void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys)
 }
 
 
+void Buffer::updateBibfilesCache()
+{
+       // if this is a child document and the parent is already loaded
+       // update the parent's cache instead
+       Buffer * tmp = getMasterBuffer();
+       BOOST_ASSERT(tmp);
+       if (tmp != this) {
+               tmp->updateBibfilesCache();
+               return;
+       }
+
+       bibfilesCache_.clear();
+       for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
+               if (it->lyxCode() == InsetBase::BIBTEX_CODE) {
+                       InsetBibtex const & inset =
+                               dynamic_cast<InsetBibtex const &>(*it);
+                       vector<string> const bibfiles = inset.getFiles(*this);
+                       bibfilesCache_.insert(bibfilesCache_.end(),
+                               bibfiles.begin(),
+                               bibfiles.end());
+               } else if (it->lyxCode() == InsetBase::INCLUDE_CODE) {
+                       InsetInclude & inset =
+                               dynamic_cast<InsetInclude &>(*it);
+                       inset.updateBibfilesCache(*this);
+                       vector<string> const & bibfiles =
+                                       inset.getBibfilesCache(*this);
+                       bibfilesCache_.insert(bibfilesCache_.end(),
+                               bibfiles.begin(),
+                               bibfiles.end());
+               }
+       }
+}
+
+
+vector<string> const & Buffer::getBibfilesCache() const
+{
+       // if this is a child document and the parent is already loaded
+       // use the parent's cache instead
+       Buffer const * tmp = getMasterBuffer();
+       BOOST_ASSERT(tmp);
+       if (tmp != this)
+               return tmp->getBibfilesCache();
+
+       return bibfilesCache_;
+}
+
+
 bool Buffer::isDepClean(string const & name) const
 {
        DepClean::const_iterator const it = pimpl_->dep_clean.find(name);
@@ -1279,7 +1271,7 @@ bool Buffer::dispatch(FuncRequest const & func, bool * result)
        bool dispatched = true;
 
        switch (func.action) {
-               case LFUN_EXPORT: {
+               case LFUN_BUFFER_EXPORT: {
                        bool const tmp = Exporter::Export(this, func.argument, false);
                        if (result)
                                *result = tmp;
@@ -1298,8 +1290,6 @@ void Buffer::changeLanguage(Language const * from, Language const * to)
        BOOST_ASSERT(from);
        BOOST_ASSERT(to);
 
-       lyxerr << "Changing Language!" << endl;
-
        // Take care of l10n/i18n
        updateDocLang(to);
 
@@ -1317,6 +1307,8 @@ void Buffer::updateDocLang(Language const * nlang)
        BOOST_ASSERT(nlang);
 
        pimpl_->messages.reset(new Messages(nlang->code()));
+
+       updateLabels(*this);
 }
 
 
@@ -1467,7 +1459,7 @@ string const & Buffer::fileName() const
 
 string const & Buffer::filePath() const
 {
-       return pimpl_->filepath;
+       return params().filepath;
 }
 
 
@@ -1496,6 +1488,19 @@ Buffer const * Buffer::getMasterBuffer() const
 }
 
 
+Buffer * Buffer::getMasterBuffer()
+{
+       if (!params().parentname.empty()
+           && bufferlist.exists(params().parentname)) {
+               Buffer * buf = bufferlist.getBuffer(params().parentname);
+               if (buf)
+                       return buf->getMasterBuffer();
+       }
+
+       return this;
+}
+
+
 MacroData const & Buffer::getMacro(std::string const & name) const
 {
        return pimpl_->macros.get(name);
@@ -1575,3 +1580,52 @@ void Buffer::changeRefsIfUnique(string const & from, string const & to)
                }
        }
 }
+
+
+void Buffer::getSourceCode(ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source)
+{
+       OutputParams runparams;
+       runparams.nice = true;
+       runparams.flavor = OutputParams::LATEX;
+       runparams.linelen = lyxrc.ascii_linelen;
+       // No side effect of file copying and image conversion
+       runparams.dryrun = true;
+
+       if (full_source) {
+               os << "% Preview source code\n\n";
+               if (isLatex()) 
+                       writeLaTeXSource(os, filePath(), runparams, true, true);
+               else 
+                       writeDocBookSource(os, fileName(), runparams, false);
+       } else {
+               runparams.par_begin = par_begin;
+               runparams.par_end = par_end;
+               if (par_begin + 1 == par_end)
+                       os << "% Preview source code for paragraph " << par_begin << "\n\n";
+               else
+                       os << "% Preview source code from paragraph " << par_begin << " to " << par_end - 1 << "\n\n";
+               // output paragraphs
+               if (isLatex()) {
+                       texrow().reset();
+                       latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
+               } else // DocBook
+                       docbookParagraphs(paragraphs(), *this, os, runparams);
+       }
+}
+
+
+ErrorList const & Buffer::errorList(string const & type) const
+{
+       static ErrorList const emptyErrorList;
+       std::map<std::string, ErrorList>::const_iterator I = errorLists_.find(type);
+       if (I == errorLists_.end())
+               return emptyErrorList;
+
+       return I->second;
+}
+
+
+ErrorList & Buffer::errorList(string const & type)
+{
+       return errorLists_[type];
+}