]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBibtex.cpp
Stupid bug fix.
[lyx.git] / src / insets / InsetBibtex.cpp
index 5149087620024a4302bcba3d854d9e0cc6ec541f..9b0e77e7b6936654fddce7609c491bd4e296e007 100644 (file)
@@ -17,7 +17,9 @@
 #include "BufferParams.h"
 #include "DispatchResult.h"
 #include "Encoding.h"
+#include "Format.h"
 #include "FuncRequest.h"
+#include "FuncStatus.h"
 #include "LaTeXFeatures.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
@@ -25,6 +27,7 @@
 
 #include "frontends/alert.h"
 
+#include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/ExceptionMessage.h"
@@ -46,9 +49,19 @@ namespace Alert = frontend::Alert;
 namespace os = support::os;
 
 
-InsetBibtex::InsetBibtex(InsetCommandParams const & p)
+InsetBibtex::InsetBibtex(Buffer const & buf, InsetCommandParams const & p)
        : InsetCommand(p, "bibtex")
-{}
+{
+       Inset::setBuffer(const_cast<Buffer &>(buf));
+       buffer_->invalidateBibinfoCache();
+}
+
+
+InsetBibtex::~InsetBibtex()
+{
+       if (isBufferValid())
+               buffer_->invalidateBibinfoCache();
+}
 
 
 ParamInfo const & InsetBibtex::findInfo(string const & /* cmdName */)
@@ -67,6 +80,10 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
 
+       case LFUN_INSET_EDIT:
+               editDatabases();
+               break;
+
        case LFUN_INSET_MODIFY: {
                InsetCommandParams p(BIBTEX_CODE);
                try {
@@ -96,12 +113,108 @@ void InsetBibtex::doDispatch(Cursor & cur, FuncRequest & cmd)
 }
 
 
+bool InsetBibtex::getStatus(Cursor & cur, FuncRequest const & cmd,
+               FuncStatus & flag) const
+{
+       switch (cmd.action) {
+       case LFUN_INSET_EDIT:
+               flag.setEnabled(true);
+               return true;
+
+       default:
+               return InsetCommand::getStatus(cur, cmd, flag);
+       }
+}
+
+
+void InsetBibtex::editDatabases() const
+{
+       vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
+
+       if (bibfilelist.empty())
+               return;
+
+       int nr_databases = bibfilelist.size();
+       if (nr_databases > 1) {
+                       docstring message = bformat(_("The BibTeX inset includes %1$s databases.\n"
+                                                      "If you proceed, all of them will be opened."),
+                                                       convert<docstring>(nr_databases));
+                       int const ret = Alert::prompt(_("Open Databases?"),
+                               message, 0, 1, _("&Cancel"), _("&Proceed"));
+
+                       if (ret == 0)
+                               return;
+       }
+
+       vector<docstring>::const_iterator it = bibfilelist.begin();
+       vector<docstring>::const_iterator en = bibfilelist.end();
+       for (; it != en; ++it) {
+               FileName bibfile = getBibTeXPath(*it, buffer());
+               formats.edit(buffer(), bibfile,
+                    formats.getFormatFromFile(bibfile));
+       }
+}
+
+
 docstring InsetBibtex::screenLabel() const
 {
        return _("BibTeX Generated Bibliography");
 }
 
 
+docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
+{
+       docstring item = from_ascii("* ");
+       docstring tip = _("Databases:") + "\n";
+       vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
+
+       if (bibfilelist.empty()) {
+               tip += item;
+               tip += _("none");
+       } else {
+               vector<docstring>::const_iterator it = bibfilelist.begin();
+               vector<docstring>::const_iterator en = bibfilelist.end();
+               for (; it != en; ++it) {
+                       tip += item;
+                       tip += *it + "\n";
+               }
+       }
+
+       // Style-Options
+       bool toc = false;
+       docstring style = getParam("options"); // maybe empty! and with bibtotoc
+       docstring bibtotoc = from_ascii("bibtotoc");
+       if (prefixIs(style, bibtotoc)) {
+               toc = true;
+               if (contains(style, char_type(',')))
+                       style = split(style, bibtotoc, char_type(','));
+       }
+
+       tip += _("Style File:") +"\n";
+       tip += item;
+       if (!style.empty())
+               tip += style;
+       else
+               tip += _("none");
+
+       tip += "\n" + _("Lists:") + " ";
+       docstring btprint = getParam("btprint");
+               if (btprint == "btPrintAll")
+                       tip += _("all references");
+               else if (btprint == "btPrintNotCited")
+                       tip += _("all uncited references");
+               else
+                       tip += _("all cited references");
+       
+       if (toc) {
+               tip += ", ";
+               tip += _("included in TOC");
+       }
+
+       return tip;
+}
+
+
 static string normalizeName(Buffer const & buffer,
        OutputParams const & runparams, string const & name, string const & ext)
 {
@@ -179,7 +292,7 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
                if (didone)
                        dbs << ',';
                else 
-                       didone =- true;
+                       didone = true;
                // FIXME UNICODE
                dbs << from_utf8(latex_path(database));
        }
@@ -195,7 +308,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
                               _("There are spaces in the paths to your BibTeX databases.\n"
                                              "BibTeX will be unable to find them."));
        }
-
        // Style-Options
        string style = to_utf8(getParam("options")); // maybe empty! and with bibtotoc
        string bibtotoc;
@@ -205,6 +317,7 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
                        style = split(style, bibtotoc, ',');
        }
 
+
        // line count
        int nlines = 0;
 
@@ -300,10 +413,11 @@ support::FileNameList InsetBibtex::getBibFiles() const
        for (; it != en; ++it) {
                FileName const file = 
                        findtexfile(changeExtension(to_utf8(*it), "bib"), "bib");
-               
-               // If we didn't find a matching file name just fail silently
+
                if (!file.empty())
                        vec.push_back(file);
+               else
+                       LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
        }
        
        return vec;
@@ -452,7 +566,7 @@ namespace {
                                // set end delimiter
                                char_type delim = ch == '"' ? '"': '}';
 
-                               //Skip whitespace
+                               // Skip whitespace
                                do {
                                        ifs.get(ch);
                                } while (ifs && isSpace(ch));
@@ -460,8 +574,8 @@ namespace {
                                if (!ifs)
                                        return false;
                                
-                               //We now have the first non-whitespace character
-                               //We'll collapse adjacent whitespace.
+                               // We now have the first non-whitespace character
+                               // We'll collapse adjacent whitespace.
                                bool lastWasWhiteSpace = false;
                                
                                // inside this delimited text braces must match.
@@ -475,9 +589,9 @@ namespace {
                                                ifs.get(ch);
                                                continue;
                                        }
-                                       //We output the space only after we stop getting 
-                                       //whitespace so as not to output any whitespace
-                                       //at the end of the value.
+                                       // We output the space only after we stop getting 
+                                       // whitespace so as not to output any whitespace
+                                       // at the end of the value.
                                        if (lastWasWhiteSpace) {
                                                lastWasWhiteSpace = false;
                                                val += ' ';
@@ -570,7 +684,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
        // We don't restrict keys to ASCII in LyX, since our own
        // InsetBibitem can generate non-ASCII keys, and nonstandard
        // 8bit clean bibtex forks exist.
-       support::FileNameList const files = getBibFiles();
+       support::FileNameList const files = getBibFiles();
        support::FileNameList::const_iterator it = files.begin();
        support::FileNameList::const_iterator en = files.end();
        for (; it != en; ++ it) {
@@ -591,22 +705,29 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
 
                        docstring entryType;
 
-                       if (!readTypeOrKey(entryType, ifs, from_ascii("{("), 
-                                          docstring(), makeLowerCase) || !ifs)
+                       if (!readTypeOrKey(entryType, ifs, from_ascii("{("), docstring(), makeLowerCase)) {
+                               lyxerr << "InsetBibtex::fillWithBibKeys: Error reading entry type." << std::endl;
                                continue;
+                       }
 
-                       if (entryType == from_ascii("comment")) {
+                       if (!ifs) {
+                               lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
+                               continue;
+                       }
 
+                       if (entryType == from_ascii("comment")) {
                                ifs.ignore(numeric_limits<int>::max(), '\n');
                                continue;
                        }
 
                        ifs.get(ch);
-                       if (!ifs)
+                       if (!ifs) {
+                               lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
                                break;
+                       }
 
                        if ((ch != '(') && (ch != '{')) {
-                               // invalid entry delimiter
+                               lyxerr << "InsetBibtex::fillWithBibKeys: Invalid entry delimiter." << std::endl;
                                ifs.putback(ch);
                                continue;
                        }
@@ -619,17 +740,29 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
                                docstring name;
                                docstring value;
 
-                               if (!readTypeOrKey(name, ifs, from_ascii("="), 
-                                                  from_ascii("#{}(),"), makeLowerCase) || !ifs)
+                               if (!readTypeOrKey(name, ifs, from_ascii("="), from_ascii("#{}(),"), makeLowerCase)) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Error reading string name." << std::endl;
+                                       continue;
+                               }
+
+                               if (!ifs) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
                                        continue;
+                               }
 
                                // next char must be an equal sign
                                ifs.get(ch);
-                               if (!ifs || ch != '=')
+                               if (!ifs || ch != '=') {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: No `=' after string name: " << 
+                                                       name << "." << std::endl;
                                        continue;
+                               }
 
-                               if (!readValue(value, ifs, strings))
+                               if (!readValue(value, ifs, strings)) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for string: " << 
+                                                       name << "." << std::endl;
                                        continue;
+                               }
 
                                strings[name] = value;
 
@@ -639,17 +772,26 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
                                // can they be of any use in lyx?
                                docstring value;
 
-                               if (!readValue(value, ifs, strings))
+                               if (!readValue(value, ifs, strings)) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read preamble value." << std::endl;
                                        continue;
+                               }
 
                        } else {
 
                                // Citation entry. Try to read the key.
                                docstring key;
 
-                               if (!readTypeOrKey(key, ifs, from_ascii(","), 
-                                                  from_ascii("}"), keepCase) || !ifs)
+                               if (!readTypeOrKey(key, ifs, from_ascii(","), from_ascii("}"), keepCase)) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read key for entry type:" << 
+                                                       entryType << "." << std::endl;
                                        continue;
+                               }
+
+                               if (!ifs) {
+                                       lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
+                                       continue;
+                               }
 
                                /////////////////////////////////////////////
                                // now we have a key, so we will add an entry 
@@ -677,16 +819,23 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
 
                                        // next char must be an equal sign
                                        ifs.get(ch);
-                                       if (!ifs)
+                                       if (!ifs) {
+                                               lyxerr << "InsetBibtex::fillWithBibKeys: Unexpected end of file." << std::endl;
                                                break;
+                                       }
                                        if (ch != '=') {
+                                               lyxerr << "InsetBibtex::fillWithBibKeys: Missing `=' after field name: " <<
+                                                               name << ", for key: " << key << "." << std::endl;
                                                ifs.putback(ch);
                                                break;
                                        }
 
                                        // read field value
-                                       if (!readValue(value, ifs, strings))
+                                       if (!readValue(value, ifs, strings)) {
+                                               lyxerr << "InsetBibtex::fillWithBibKeys: Unable to read value for field: " <<
+                                                               name << ", for key: " << key << "." << std::endl;
                                                break;
+                                       }
 
                                        keyvalmap[name] = value;
                                        data += "\n\n" + value;
@@ -698,7 +847,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
                                keylist.addEntryType(entryType);
                                keyvalmap.setAllData(data);
                                keylist[key] = keyvalmap;
-                       }
+                       } //< else (citation entry)
                } //< searching '@'
        } //< for loop over files
 }
@@ -719,13 +868,12 @@ FileName InsetBibtex::getBibTeXPath(docstring const & filename, Buffer const & b
 bool InsetBibtex::addDatabase(docstring const & db)
 {
        docstring bibfiles = getParam("bibfiles");
-       if (tokenPos(bibfiles, ',', db) == -1) {
-               if (!bibfiles.empty())
+       if (tokenPos(bibfiles, ',', db) != -1)
+               return false;
+       if (!bibfiles.empty())
                bibfiles += ',';
-               setParam("bibfiles", bibfiles + db);
-               return true;
-       }
-       return false;
+       setParam("bibfiles", bibfiles + db);
+       return true;
 }
 
 
@@ -756,4 +904,10 @@ void InsetBibtex::validate(LaTeXFeatures & features) const
 }
 
 
+docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-bibtex");
+}
+
+
 } // namespace lyx