]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBibtex.cpp
Remove all BufferParam arguments in InsetXXX methods (since insets know about their...
[lyx.git] / src / insets / InsetBibtex.cpp
index 4394992e9687749b9c62a61923190e014fef9558..8a41b9fc5d279046e477b10c309ef899ee9a8049 100644 (file)
 #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 "output_xhtml.h"
 #include "OutputParams.h"
 #include "TextClass.h"
+#include "TocBackend.h"
 
 #include "frontends/alert.h"
 
+#include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/ExceptionMessage.h"
@@ -46,9 +51,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 +82,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,6 +115,49 @@ 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");
@@ -105,7 +167,7 @@ docstring InsetBibtex::screenLabel() const
 docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
 {
        docstring item = from_ascii("* ");
-       docstring tip = _("Databases:\n");
+       docstring tip = _("Databases:") + "\n";
        vector<docstring> bibfilelist = getVectorFromString(getParam("bibfiles"));
 
        if (bibfilelist.empty()) {
@@ -130,14 +192,14 @@ docstring InsetBibtex::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/)
                        style = split(style, bibtotoc, char_type(','));
        }
 
-       tip += _("Style File:\n");
+       tip += _("Style File:") +"\n";
        tip += item;
        if (!style.empty())
                tip += style;
        else
                tip += _("none");
 
-       tip += _("\nLists: ");
+       tip += "\n" + _("Lists:") + " ";
        docstring btprint = getParam("btprint");
                if (btprint == "btPrintAll")
                        tip += _("all references");
@@ -159,7 +221,7 @@ static string normalizeName(Buffer const & buffer,
        OutputParams const & runparams, string const & name, string const & ext)
 {
        string const fname = makeAbsPath(name, buffer.filePath()).absFilename();
-       if (FileName(name).isAbsolute() || !FileName(fname + ext).isReadableFile())
+       if (FileName::isAbsolute(name) || !FileName(fname + ext).isReadableFile())
                return name;
        if (!runparams.nice)
                return fname;
@@ -208,7 +270,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
 
                if (!runparams.inComment && !runparams.dryrun && !runparams.nice &&
                    not_from_texmf) {
-
                        // mangledFilename() needs the extension
                        DocFileName const in_file = DocFileName(try_in_file);
                        database = removeExtension(in_file.mangledFilename());
@@ -243,7 +304,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
        if (!warned_about_spaces &&
            runparams.nice && db_out.find(' ') != docstring::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."));
@@ -257,7 +317,6 @@ int InsetBibtex::latex(odocstream & os, OutputParams const & runparams) const
                        style = split(style, bibtotoc, ',');
        }
 
-
        // line count
        int nlines = 0;
 
@@ -351,12 +410,12 @@ support::FileNameList InsetBibtex::getBibFiles() const
        vector<docstring>::const_iterator it = bibfilelist.begin();
        vector<docstring>::const_iterator en = bibfilelist.end();
        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
+               FileName const file = getBibTeXPath(*it, buffer());
+
                if (!file.empty())
                        vec.push_back(file);
+               else
+                       LYXERR0("Couldn't find " + to_utf8(*it) + " in InsetBibtex::getBibFiles()!");
        }
        
        return vec;
@@ -373,7 +432,7 @@ namespace {
        /// and further whitespace characters from the stream.
        /// @return true if a comma was found, false otherwise
        ///
-       bool removeWSAndComma(idocfstream & ifs) {
+       bool removeWSAndComma(ifdocstream & ifs) {
                char_type ch;
 
                if (!ifs)
@@ -416,7 +475,7 @@ namespace {
        ///
        /// @return true if a string of length > 0 could be read.
        ///
-       bool readTypeOrKey(docstring & val, idocfstream & ifs,
+       bool readTypeOrKey(docstring & val, ifdocstream & ifs,
                docstring const & delimChars, docstring const &illegalChars, 
                charCase chCase) {
 
@@ -471,7 +530,7 @@ namespace {
        /// the variable strings.
        /// @return true if reading was successfull (all single parts were delimited
        /// correctly)
-       bool readValue(docstring & val, idocfstream & ifs, const VarMap & strings) {
+       bool readValue(docstring & val, ifdocstream & ifs, const VarMap & strings) {
 
                char_type ch;
 
@@ -505,7 +564,7 @@ namespace {
                                // set end delimiter
                                char_type delim = ch == '"' ? '"': '}';
 
-                               //Skip whitespace
+                               // Skip whitespace
                                do {
                                        ifs.get(ch);
                                } while (ifs && isSpace(ch));
@@ -513,8 +572,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.
@@ -528,9 +587,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 += ' ';
@@ -627,7 +686,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
        support::FileNameList::const_iterator it = files.begin();
        support::FileNameList::const_iterator en = files.end();
        for (; it != en; ++ it) {
-               idocfstream ifs(it->toFilesystemEncoding().c_str(),
+               ifdocstream ifs(it->toFilesystemEncoding().c_str(),
                        ios_base::in, buffer().params().encoding().iconvName());
 
                char_type ch;
@@ -644,22 +703,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 (!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;
                        }
@@ -672,17 +738,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;
 
@@ -692,17 +770,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 
@@ -730,16 +817,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;
@@ -751,7 +845,7 @@ void InsetBibtex::fillWithBibKeys(BiblioInfo & keylist,
                                keylist.addEntryType(entryType);
                                keyvalmap.setAllData(data);
                                keylist[key] = keyvalmap;
-                       }
+                       } //< else (citation entry)
                } //< searching '@'
        } //< for loop over files
 }
@@ -808,4 +902,86 @@ void InsetBibtex::validate(LaTeXFeatures & features) const
 }
 
 
+namespace {
+       // used in xhtml to sort a list of BibTeXInfo objects
+       bool lSorter(BibTeXInfo const * lhs, BibTeXInfo const * rhs)
+       {
+               return lhs->getAbbreviatedAuthor() < rhs->getAbbreviatedAuthor();
+       }
+}
+
+
+docstring InsetBibtex::xhtml(odocstream & os, OutputParams const &) const
+{
+       // We are going to collect all the citation keys used in the document,
+       // getting them from the TOC.
+       Toc const & toc = buffer().tocBackend().toc("citation");
+       Toc::const_iterator it = toc.begin();
+       Toc::const_iterator en = toc.end();
+       vector<docstring> citekeys;
+       for (; it != en; ++it) {
+               if (it->str().empty())
+                       continue;
+               vector<docstring> keys = getVectorFromString(it->str());
+               vector<docstring>::const_iterator dit = keys.begin();
+               vector<docstring>::const_iterator den = keys.end();
+               for (; dit != den; ++dit)
+                       citekeys.push_back(*dit);
+       }
+       if (citekeys.empty())
+               return docstring();
+       sort(citekeys.begin(), citekeys.end());
+       unique(citekeys.begin(), citekeys.end());
+       // We now have a sorted, unique list of the keys used in this document.
+       // We will now convert it to a list of the BibTeXInfo objects used in 
+       // this document...
+       // FIXME We need to do something here about cross-references, if we
+       // want to be able to display them AS cross-references. Probably the
+       // easiest thing to do is to loop over the list again and add whatever
+       // cross-references we find, then sort and unique it, planning just to
+       // add the cross-references to the bibliography.
+       vector<BibTeXInfo const *> binfo;
+       vector<docstring>::const_iterator cit = citekeys.begin();
+       vector<docstring>::const_iterator cen = citekeys.end();
+       BiblioInfo const & bi = buffer().masterBibInfo();
+       for (; cit != cen; ++cit) {
+               BiblioInfo::const_iterator bt = bi.find(*cit);
+               if (bt == bi.end())
+                       continue;
+               binfo.push_back(&(bt->second));
+       }
+       // ...and sort it.
+       sort(binfo.begin(), binfo.end(), lSorter);
+       // Finally, then, we are ready for output.
+       os << "<h2 class='bibliography'>" << _("References") << "</h2>\n";
+       os << "<div class='bibliography'>\n";
+       vector<BibTeXInfo const *>::const_iterator vit = binfo.begin();
+       vector<BibTeXInfo const *>::const_iterator ven = binfo.end();
+       // Now we loop over the entries
+       for (; vit != ven; ++vit) {
+               BibTeXInfo const * bip = *vit;
+               os << "<p class='bibliography'>";
+               os << "<a name='" << html::htmlize(bip->key()) << "'></a>";
+               docstring label = bip->label();
+               if (label.empty())
+                       label = bip->key();
+               os << "<span class='biblabel'>[" << label << "]</span> ";
+               // FIXME Right now, we are calling BibInfo::getInfo on the key,
+               // which will give us all the cross-referenced info. But for every
+               // entry.
+               os << "<span class='bibinfo'>" << bi.getInfo(bip->key()) << "</span>";
+               os << "</p>\n";
+       }
+               
+       os << "</div>\n";
+       return docstring();
+}
+
+
+docstring InsetBibtex::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-bibtex");
+}
+
+
 } // namespace lyx