]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetbibtex.C
The speed patch: redraw only rows that have changed
[lyx.git] / src / insets / insetbibtex.C
index f0f536f23c0a0fb3a8562e05226ed3c78022c6c3..3bc29d0566a09e2c1d67a04325523ad072ea6a6e 100644 (file)
  *
  * \author Alejandro Aguilar Sierra
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
 #include "insetbibtex.h"
+
 #include "buffer.h"
-#include "BufferView.h"
+#include "bufferparams.h"
+#include "dispatchresult.h"
 #include "debug.h"
 #include "funcrequest.h"
 #include "gettext.h"
-#include "latexrunparams.h"
+#include "LaTeXFeatures.h"
+#include "metricsinfo.h"
+#include "outputparams.h"
+
+#include "frontends/Alert.h"
 
+#include "support/filename.h"
 #include "support/filetools.h"
-#include "support/path.h"
-#include "support/os.h"
 #include "support/lstrings.h"
-#include "support/LAssert.h"
+#include "support/lyxlib.h"
+#include "support/os.h"
+#include "support/path.h"
+
+#include <boost/tokenizer.hpp>
 
 #include <fstream>
-#include <cstdlib>
+#include <sstream>
+
+using lyx::support::AbsolutePath;
+using lyx::support::ascii_lowercase;
+using lyx::support::ChangeExtension;
+using lyx::support::contains;
+using lyx::support::copy;
+using lyx::support::FileName;
+using lyx::support::findtexfile;
+using lyx::support::IsFileReadable;
+using lyx::support::latex_path;
+using lyx::support::ltrim;
+using lyx::support::MakeAbsPath;
+using lyx::support::MakeRelPath;
+using lyx::support::Path;
+using lyx::support::prefixIs;
+using lyx::support::rtrim;
+using lyx::support::split;
+using lyx::support::subst;
+using lyx::support::tokenPos;
+using lyx::support::trim;
+
+namespace os = lyx::support::os;
 
-using std::ostream;
-using std::ifstream;
-using std::getline;
 using std::endl;
-using std::vector;
+using std::getline;
+using std::string;
+using std::ifstream;
+using std::ostream;
 using std::pair;
+using std::vector;
 
 
 InsetBibtex::InsetBibtex(InsetCommandParams const & p)
-       : InsetCommand(p)
+       : InsetCommand(p, "bibtex")
 {}
 
 
-InsetBibtex::~InsetBibtex()
+std::auto_ptr<InsetBase> InsetBibtex::doClone() const
 {
-       InsetCommandMailer("bibtex", *this).hideDialog();
+       return std::auto_ptr<InsetBase>(new InsetBibtex(*this));
 }
 
 
-dispatch_result InsetBibtex::localDispatch(FuncRequest const & cmd)
+void InsetBibtex::doDispatch(LCursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
 
-       case LFUN_INSET_EDIT:
-               InsetCommandMailer("bibtex", *this).showDialog(cmd.view());
-               return DISPATCHED;
-
        case LFUN_INSET_MODIFY: {
                InsetCommandParams p;
-               InsetCommandMailer::string2params(cmd.argument, p);
-               if (p.getCmdName().empty())
-                       return DISPATCHED;
-
-               if (view() && p.getContents() != params().getContents()) {
-                       view()->ChangeCitationsIfUnique(params().getContents(),
-                                                       p.getContents());
-               }
-
-               setParams(p);
-               cmd.view()->updateInset(this);
-               return  DISPATCHED;
+               InsetCommandMailer::string2params("bibtex", cmd.argument, p);
+               if (!p.getCmdName().empty())
+                       setParams(p);
+               else
+                       cur.noUpdate();
+               break;
        }
 
        default:
-               return InsetCommand::localDispatch(cmd);
+               InsetCommand::doDispatch(cur, cmd);
+               break;
        }
+}
+
 
+string const InsetBibtex::getScreenLabel(Buffer const &) const
+{
+       return _("BibTeX Generated Bibliography");
 }
 
-string const InsetBibtex::getScreenLabel(Buffer const *) const
+
+namespace {
+
+string normalize_name(Buffer const & buffer, OutputParams const & runparams,
+                     string const & name, string const & ext)
 {
-       return _("BibTeX Generated References");
+       string const fname = MakeAbsPath(name, buffer.filePath());
+       if (AbsolutePath(name) || !IsFileReadable(fname + ext))
+               return name;
+       else if (!runparams.nice)
+               return fname;
+       else
+               return MakeRelPath(fname, buffer.getMasterBuffer()->filePath());
+}
+
 }
 
 
-int InsetBibtex::latex(Buffer const * buffer, ostream & os,
-                      LatexRunParams const & runparams) const
+int InsetBibtex::latex(Buffer const & buffer, ostream & os,
+                      OutputParams const & runparams) const
 {
-       // changing the sequence of the commands
+       // the sequence of the commands:
        // 1. \bibliographystyle{style}
        // 2. \addcontentsline{...} - if option bibtotoc set
        // 3. \bibliography{database}
-       string adb;
-       string db_in = getContents();
-       db_in = split(db_in, adb, ',');
+       // and with bibtopic:
+       // 1. \bibliographystyle{style}
+       // 2. \begin{btSect}{database}
+       // 3. \btPrint{Cited|NotCited|All}
+       // 4. \end{btSect}
+
+       // Database(s)
+       // If we are processing the LaTeX file in a temp directory then
+       // copy the .bib databases to this temp directory, mangling their
+       // names in the process. Store this mangled name in the list of
+       // all databases.
+       // (We need to do all this because BibTeX *really*, *really*
+       // can't handle "files with spaces" and Windows users tend to
+       // use such filenames.)
+       // Otherwise, store the (maybe absolute) path to the original,
+       // unmangled database name.
+       typedef boost::char_separator<char> Separator;
+       typedef boost::tokenizer<Separator> Tokenizer;
+
+       Separator const separator(",");
+       Tokenizer const tokens(getContents(), separator);
+       Tokenizer::const_iterator const begin = tokens.begin();
+       Tokenizer::const_iterator const end = tokens.end();
+
+       std::ostringstream dbs;
+       for (Tokenizer::const_iterator it = begin; it != end; ++it) {
+               string const input = trim(*it);
+               string database =
+                       normalize_name(buffer, runparams, input, ".bib");
+               string const in_file = database + ".bib";
+
+               if (!runparams.nice && IsFileReadable(in_file)) {
+
+                       database = FileName(database).mangledFilename();
+                       string const out_file = MakeAbsPath(database + ".bib",
+                                       buffer.getMasterBuffer()->temppath());
+
+                       bool const success = copy(in_file, out_file);
+                       if (!success) {
+                               lyxerr << "Failed to copy '" << in_file
+                                      << "' to '" << out_file << "'"
+                                      << endl;
+                       }
+               }
+
+               if (it != begin)
+                       dbs << ',';
+               dbs << latex_path(database);
+       }
+       string const db_out = dbs.str();
+
+       // Post this warning only once.
+       static bool warned_about_spaces = false;
+       if (!warned_about_spaces &&
+           runparams.nice && db_out.find(' ') != string::npos) {
+               warned_about_spaces = true;
+
+               Alert::warning(_("Export Warning!"),
+                              _("There are spaces in the paths to your BibTeX databases.\n"
+                                "BibTeX will be unable to find them."));
+
+       }
 
        // Style-Options
        string style = getOptions(); // maybe empty! and with bibtotoc
@@ -103,24 +202,36 @@ int InsetBibtex::latex(Buffer const * buffer, ostream & os,
                }
        }
 
-       if (!runparams.nice
-           && IsFileReadable(MakeAbsPath(style, buffer->filePath()) + ".bst")) {
-               style = MakeAbsPath(style, buffer->filePath());
+       // line count
+       int nlines = 0;
+
+       if (!style.empty()) {
+               os << "\\bibliographystyle{"
+                  << latex_path(normalize_name(buffer, runparams, style, ".bst"))
+                  << "}\n";
+               nlines += 1;
        }
 
-       if (!style.empty()) { // we want no \biblio...{}
-               os << "\\bibliographystyle{" << style << "}\n";
+       if (!db_out.empty() && buffer.params().use_bibtopic){
+               os << "\\begin{btSect}{" << db_out << "}\n";
+               string btprint = getSecOptions();
+               if (btprint.empty())
+                       // default
+                       btprint = "btPrintCited";
+               os << "\\" << btprint << "\n"
+                  << "\\end{btSect}\n";
+               nlines += 3;
        }
 
        // bibtotoc-Option
-       if (!bibtotoc.empty()) {
+       if (!bibtotoc.empty() && !buffer.params().use_bibtopic) {
                // maybe a problem when a textclass has no "art" as
                // part of its name, because it's than book.
                // For the "official" lyx-layouts it's no problem to support
                // all well
-               if (!contains(buffer->params.getLyXTextClass().name(),
+               if (!contains(buffer.params().getLyXTextClass().name(),
                              "art")) {
-                       if (buffer->params.sides == LyXTextClass::OneSide) {
+                       if (buffer.params().sides == LyXTextClass::OneSide) {
                                // oneside
                                os << "\\clearpage";
                        } else {
@@ -137,28 +248,17 @@ int InsetBibtex::latex(Buffer const * buffer, ostream & os,
                }
        }
 
-       // database
-       // If we generate in a temp dir, we might need to give an
-       // absolute path there. This is a bit complicated since we can
-       // have a comma-separated list of bibliographies
-       string db_out;
-       while (!adb.empty()) {
-               if (!runparams.nice &&
-                   IsFileReadable(MakeAbsPath(adb, buffer->filePath())+".bib"))
-                        adb = os::external_path(MakeAbsPath(adb, buffer->filePath()));
-               db_out += adb;
-               db_out += ',';
-               db_in = split(db_in, adb,',');
+       if (!db_out.empty() && !buffer.params().use_bibtopic){
+               os << "\\bibliography{" << db_out << "}\n";
+               nlines += 1;
        }
-       db_out = rtrim(db_out, ",");
-       os   << "\\bibliography{" << db_out << "}\n";
-       return 2;
+
+       return nlines;
 }
 
 
 vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
 {
-       // Doesn't appear to be used (Angus, 31 July 2001)
        Path p(buffer.filePath());
 
        vector<string> vec;
@@ -183,11 +283,10 @@ vector<string> const InsetBibtex::getFiles(Buffer const & buffer) const
 
 
 // This method returns a comma separated list of Bibtex entries
-void InsetBibtex::fillWithBibKeys
-       (Buffer const * buffer, vector<pair<string, string> > & keys) const
+void InsetBibtex::fillWithBibKeys(Buffer const & buffer,
+                                 std::vector<std::pair<string, string> > & keys) const
 {
-       lyx::Assert(buffer);
-       vector<string> const files = getFiles(*buffer);
+       vector<string> const files = getFiles(buffer);
        for (vector<string>::const_iterator it = files.begin();
             it != files.end(); ++ it) {
                // This is a _very_ simple parser for Bibtex database
@@ -223,7 +322,7 @@ void InsetBibtex::fillWithBibKeys
 bool InsetBibtex::addDatabase(string const & db)
 {
        string contents(getContents());
-       if (!contains(contents, db)) {
+       if (tokenPos(contents, ',', db) == -1) {
                if (!contents.empty())
                        contents += ',';
                setContents(contents + db);
@@ -235,18 +334,26 @@ bool InsetBibtex::addDatabase(string const & db)
 
 bool InsetBibtex::delDatabase(string const & db)
 {
-       if (contains(getContents(), db)) {
+       string contents(getContents());
+       if (contains(contents, db)) {
+               int const n = tokenPos(contents, ',', db);
                string bd = db;
-               int const n = tokenPos(getContents(), ',', bd);
                if (n > 0) {
-                       // Weird code, would someone care to explain this?(Lgb)
-                       string tmp(", ");
-                       tmp += bd;
-                       setContents(subst(getContents(), tmp, ", "));
+                       // this is not the first database
+                       string tmp = ',' + bd;
+                       setContents(subst(contents, tmp, ""));
                } else if (n == 0)
-                       setContents(split(getContents(), bd, ','));
+                       // this is the first (or only) database
+                       setContents(split(contents, bd, ','));
                else
                        return false;
        }
        return true;
 }
+
+
+void InsetBibtex::validate(LaTeXFeatures & features) const
+{
+       if (features.bufferParams().use_bibtopic)
+               features.require("bibtopic");
+}