]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCitation.cpp
Cocoa based Qt-4.6 needs to paint every character separately to match metrics computa...
[lyx.git] / src / insets / InsetCitation.cpp
index c236ae4a4641c5706021221f6f6ce944905389b2..6f9035c5b9f4606d07f8323428d7beb0587cbef7 100644 (file)
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Angus Leeming
- * \author Herbert Voß
+ * \author Herbert Voß
  *
  * Full author contact details are available in file CREDITS.
  */
 
 #include "InsetCitation.h"
 
-#include "buffer.h"
-#include "bufferparams.h"
-#include "debug.h"
-#include "dispatchresult.h"
-#include "funcrequest.h"
+#include "BiblioInfo.h"
+#include "Buffer.h"
+#include "buffer_funcs.h"
+#include "BufferParams.h"
+#include "BufferView.h"
+#include "DispatchResult.h"
+#include "FuncCode.h"
+#include "FuncRequest.h"
 #include "LaTeXFeatures.h"
-
-#include "frontends/controllers/frontend_helpers.h"
-
-#include "support/fs_extras.h"
+#include "output_xhtml.h"
+#include "ParIterator.h"
+#include "TocBackend.h"
+
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/FileNameList.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 
 #include <algorithm>
 
-#include <boost/filesystem/operations.hpp>
-#include <boost/filesystem/exception.hpp>
-
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::ascii_lowercase;
-using support::contains;
-using support::FileName;
-using support::getStringFromVector;
-using support::getVectorFromString;
-using support::ltrim;
-using support::rtrim;
-using support::split;
-using support::tokenPos;
+ParamInfo InsetCitation::param_info_;
 
-using std::endl;
-using std::replace;
-using std::string;
-using std::ostream;
-using std::vector;
-using std::map;
 
-namespace fs = boost::filesystem;
+InsetCitation::InsetCitation(Buffer * buf, InsetCommandParams const & p)
+       : InsetCommand(buf, p)
+{}
+
+
+ParamInfo const & InsetCitation::findInfo(string const & /* cmdName */)
+{
+       // standard cite does only take one argument if jurabib is
+       // not used, but jurabib extends this to two arguments, so
+       // we have to allow both here. InsetCitation takes care that
+       // LaTeX output is nevertheless correct.
+       if (param_info_.empty()) {
+               param_info_.add("after", ParamInfo::LATEX_OPTIONAL);
+               param_info_.add("before", ParamInfo::LATEX_OPTIONAL);
+               param_info_.add("key", ParamInfo::LATEX_REQUIRED);
+       }
+       return param_info_;
+}
 
 
 namespace {
 
-docstring const getNatbibLabel(Buffer const & buffer,
-                           string const & citeType, string const & keyList,
-                           docstring const & before, docstring const & after,
-                           biblio::CiteEngine engine)
+vector<string> const init_possible_cite_commands()
 {
-       // Only start the process off after the buffer is loaded from file.
-       if (!buffer.fully_loaded())
+       char const * const possible[] = {
+               "cite", "nocite", "citet", "citep", "citealt", "citealp",
+               "citeauthor", "citeyear", "citeyearpar",
+               "citet*", "citep*", "citealt*", "citealp*", "citeauthor*",
+               "Citet",  "Citep",  "Citealt",  "Citealp",  "Citeauthor",
+               "Citet*", "Citep*", "Citealt*", "Citealp*", "Citeauthor*",
+               "fullcite",
+               "footcite", "footcitet", "footcitep", "footcitealt",
+               "footcitealp", "footciteauthor", "footciteyear", "footciteyearpar",
+               "citefield", "citetitle", "cite*"
+       };
+       size_t const size_possible = sizeof(possible) / sizeof(possible[0]);
+
+       return vector<string>(possible, possible + size_possible);
+}
+
+
+vector<string> const & possibleCiteCommands()
+{
+       static vector<string> const possible = init_possible_cite_commands();
+       return possible;
+}
+
+
+} // anon namespace
+
+
+bool InsetCitation::isCompatibleCommand(string const & cmd)
+{
+       vector<string> const & possibles = possibleCiteCommands();
+       vector<string>::const_iterator const end = possibles.end();
+       return find(possibles.begin(), end, cmd) != end;
+}
+
+
+void InsetCitation::doDispatch(Cursor & cur, FuncRequest & cmd)
+{
+       if (cmd.action() == LFUN_INSET_MODIFY)
+               cache.recalculate = true;
+       InsetCommand::doDispatch(cur, cmd);
+}
+
+
+docstring InsetCitation::toolTip(BufferView const & bv, int, int) const
+{
+       Buffer const & buf = bv.buffer();
+       // Only after the buffer is loaded from file...
+       if (!buf.isFullyLoaded())
                return docstring();
 
-       // Cache the labels
-       typedef std::map<Buffer const *, biblio::InfoMap> CachedMap;
-       static CachedMap cached_keys;
-
-       // and cache the timestamp of the bibliography files.
-       static std::map<FileName, time_t> bibfileStatus;
-
-       biblio::InfoMap infomap;
-
-       vector<FileName> const & bibfilesCache = buffer.getBibfilesCache();
-       // compare the cached timestamps with the actual ones.
-       bool changed = false;
-       for (vector<FileName>::const_iterator it = bibfilesCache.begin();
-                       it != bibfilesCache.end(); ++ it) {
-               FileName const f = *it;
-               try {
-                       std::time_t lastw = fs::last_write_time(f.toFilesystemEncoding());
-                       if (lastw != bibfileStatus[f]) {
-                               changed = true;
-                               bibfileStatus[f] = lastw;
-                       }
-               }
-               catch (fs::filesystem_error & fserr) {
-                       changed = true;
-                       lyxerr << "Couldn't find or read bibtex file "
-                              << f << endl;
-                       LYXERR(Debug::DEBUG) << "Fs error: "
-                                            << fserr.what() << endl;
+       BiblioInfo const & bi = buf.masterBibInfo();
+       if (bi.empty())
+               return _("No bibliography defined!");
+
+       docstring const & key = getParam("key");
+       if (key.empty())
+               return _("No citations selected!");
+
+       vector<docstring> keys = getVectorFromString(key);
+       vector<docstring>::const_iterator it = keys.begin();
+       vector<docstring>::const_iterator en = keys.end();
+       docstring tip;
+       for (; it != en; ++it) {
+               docstring const key_info = bi.getInfo(*it, buffer());
+               if (key_info.empty())
+                       continue;
+               if (!tip.empty())
+                       tip += "\n";
+               tip += wrap(key_info, -4);
+       }
+       return tip;
+}
+
+
+namespace {
+       
+// FIXME See the header for the issue.
+string defaultCiteCommand(CiteEngine engine)
+{
+       string str;
+       switch (engine) {
+               case ENGINE_BASIC:
+                       str = "cite";
+                       break;
+               case ENGINE_NATBIB_AUTHORYEAR:
+                       str = "citet";
+                       break;
+               case ENGINE_NATBIB_NUMERICAL:
+                       str = "citep";
+                       break;
+               case ENGINE_JURABIB:
+                       str = "cite";
+                       break;
+       }
+       return str;
+}
+
+       
+string asValidLatexCommand(string const & input, CiteEngine const engine)
+{
+       string const default_str = defaultCiteCommand(engine);
+       if (!InsetCitation::isCompatibleCommand(input))
+               return default_str;
+
+       string output;
+       switch (engine) {
+               case ENGINE_BASIC:
+                       if (input == "nocite")
+                               output = input;
+                       else
+                               output = default_str;
+                       break;
+
+               case ENGINE_NATBIB_AUTHORYEAR:
+               case ENGINE_NATBIB_NUMERICAL:
+                       if (input == "cite" || input == "citefield"
+                           || input == "citetitle" || input == "cite*")
+                               output = default_str;
+                       else if (prefixIs(input, "foot"))
+                               output = input.substr(4);
+                       else
+                               output = input;
+                       break;
+
+               case ENGINE_JURABIB: {
+                       // Jurabib does not support the 'uppercase' natbib style.
+                       if (input[0] == 'C')
+                               output = string(1, 'c') + input.substr(1);
+                       else
+                               output = input;
+
+                       // Jurabib does not support the 'full' natbib style.
+                       string::size_type const n = output.size() - 1;
+                       if (output != "cite*" && output[n] == '*')
+                               output = output.substr(0, n);
+
+                       break;
                }
        }
 
-       // build the keylist only if the bibfiles have been changed
-       if (cached_keys[&buffer].empty() || bibfileStatus.empty() || changed) {
-               typedef vector<std::pair<string, docstring> > InfoType;
-               InfoType bibkeys;
-               buffer.fillWithBibKeys(bibkeys);
+       return output;
+}
+
+
+inline docstring wrapCitation(docstring const & key, 
+               docstring const & content, bool for_xhtml)
+{
+       if (!for_xhtml)
+               return content;
+       // we have to do the escaping here, because we will ultimately
+       // write this as a raw string, so as not to escape the tags.
+       return "<a href='#" + key + "'>" +
+                       html::htmlize(content, XHTMLStream::ESCAPE_ALL) + "</a>";
+}
+
+} // anonymous namespace
+
+docstring InsetCitation::generateLabel(bool for_xhtml) const
+{
+       docstring label;
+       label = complexLabel(for_xhtml);
+
+       // Fallback to fail-safe
+       if (label.empty())
+               label = basicLabel(for_xhtml);
 
-               InfoType::const_iterator bit  = bibkeys.begin();
-               InfoType::const_iterator bend = bibkeys.end();
+       return label;
+}
 
-               for (; bit != bend; ++bit)
-                       infomap[bit->first] = bit->second;
 
-               cached_keys[&buffer] = infomap;
-       } else
-               // use the cached keys
-               infomap = cached_keys[&buffer];
+docstring InsetCitation::complexLabel(bool for_xhtml) const
+{
+       Buffer const & buf = buffer();
+       // Only start the process off after the buffer is loaded from file.
+       if (!buf.isFullyLoaded())
+               return docstring();
 
-       if (infomap.empty())
+       BiblioInfo const & biblist = buf.masterBibInfo();
+       if (biblist.empty())
                return docstring();
 
        // the natbib citation-styles
@@ -126,13 +258,17 @@ docstring const getNatbibLabel(Buffer const & buffer,
        // jurabib supports these plus
        // CITE:        author/<before field>
 
+       CiteEngine const engine = buffer().params().citeEngine();
        // We don't currently use the full or forceUCase fields.
-       string cite_type = biblio::asValidLatexCommand(citeType, engine);
+       string cite_type = asValidLatexCommand(getCmdName(), engine);
        if (cite_type[0] == 'C')
+               // If we were going to use them, this would mean ForceUCase
                cite_type = string(1, 'c') + cite_type.substr(1);
        if (cite_type[cite_type.size() - 1] == '*')
+               // and this would mean FULL
                cite_type = cite_type.substr(0, cite_type.size() - 1);
 
+       docstring const & before = getParam("before");
        docstring before_str;
        if (!before.empty()) {
                // In CITET and CITEALT mode, the "before" string is
@@ -153,103 +289,123 @@ docstring const getNatbibLabel(Buffer const & buffer,
                        before_str = '/' + before;
        }
 
+       docstring const & after = getParam("after");
        docstring after_str;
-       if (!after.empty()) {
-               // The "after" key is appended only to the end of the whole.
+       // The "after" key is appended only to the end of the whole.
+       if (cite_type == "nocite")
+               after_str =  " (" + _("not cited") + ')';
+       else if (!after.empty()) {
                after_str = ", " + after;
        }
 
        // One day, these might be tunable (as they are in BibTeX).
-       char const op  = '('; // opening parenthesis.
-       char const cp  = ')'; // closing parenthesis.
-       // puctuation mark separating citation entries.
-       char const * const sep = ";";
+       char op, cp;    // opening and closing parenthesis.
+       const char * sep;       // punctuation mark separating citation entries.
+       if (engine == ENGINE_BASIC) {
+               op  = '[';
+               cp  = ']';
+               sep = ",";
+       } else {
+               op  = '(';
+               cp  = ')';
+               sep = ";";
+       }
 
-       docstring const op_str(' ' + docstring(1, op));
-       docstring const cp_str(docstring(1, cp) + ' ');
-       docstring const sep_str(from_ascii(sep) + ' ');
+       docstring const op_str = ' ' + docstring(1, op);
+       docstring const cp_str = docstring(1, cp) + ' ';
+       docstring const sep_str = from_ascii(sep) + ' ';
 
        docstring label;
-       vector<string> keys = getVectorFromString(keyList);
-       vector<string>::const_iterator it  = keys.begin();
-       vector<string>::const_iterator end = keys.end();
+       vector<docstring> keys = getVectorFromString(getParam("key"));
+       vector<docstring>::const_iterator it  = keys.begin();
+       vector<docstring>::const_iterator end = keys.end();
        for (; it != end; ++it) {
                // get the bibdata corresponding to the key
-               docstring const author(biblio::getAbbreviatedAuthor(infomap, *it));
-               docstring const year(biblio::getYear(infomap, *it));
+               docstring const author = biblist.getAbbreviatedAuthor(*it);
+               docstring const year = biblist.getYear(*it, for_xhtml);
+               docstring const citenum = for_xhtml ? biblist.getCiteNumber(*it) : *it;
 
-               // Something isn't right. Fail safely.
                if (author.empty() || year.empty())
+                       // We can't construct a "complex" label without that info.
+                       // So fail safely.
                        return docstring();
 
                // authors1/<before>;  ... ;
                //  authors_last, <after>
-               if (cite_type == "cite" && engine == biblio::ENGINE_JURABIB) {
-                       if (it == keys.begin())
-                               label += author + before_str + sep_str;
-                       else
-                               label += author + sep_str;
-
+               if (cite_type == "cite") {
+                       if (engine == ENGINE_BASIC) {
+                               label += wrapCitation(*it, citenum, for_xhtml) + sep_str;
+                       } else if (engine == ENGINE_JURABIB) {
+                               if (it == keys.begin())
+                                       label += wrapCitation(*it, author, for_xhtml) + before_str + sep_str;
+                               else
+                                       label += wrapCitation(*it, author, for_xhtml) + sep_str;
+                       }
+               } 
+               // nocite
+               else if (cite_type == "nocite") {
+                       label += *it + sep_str;
+               } 
                // (authors1 (<before> year);  ... ;
                //  authors_last (<before> year, <after>)
-               else if (cite_type == "citet") {
+               else if (cite_type == "citet") {
                        switch (engine) {
-                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                       case ENGINE_NATBIB_AUTHORYEAR:
                                label += author + op_str + before_str +
-                                       year + cp + sep_str;
+                                       wrapCitation(*it, year, for_xhtml) + cp + sep_str;
                                break;
-                       case biblio::ENGINE_NATBIB_NUMERICAL:
-                               // FIXME UNICODE
-                               label += author + op_str + before_str +
-                                       '#' + from_utf8(*it) + cp + sep_str;
+                       case ENGINE_NATBIB_NUMERICAL:
+                               label += author + op_str + before_str + 
+                                       wrapCitation(*it, citenum, for_xhtml) + cp + sep_str;
                                break;
-                       case biblio::ENGINE_JURABIB:
+                       case ENGINE_JURABIB:
                                label += before_str + author + op_str +
-                                       year + cp + sep_str;
+                                       wrapCitation(*it, year, for_xhtml) + cp + sep_str;
                                break;
-                       case biblio::ENGINE_BASIC:
+                       case ENGINE_BASIC:
                                break;
                        }
-
-               // author, year; author, year; ...
-               else if (cite_type == "citep" ||
+               } 
+               // author, year; author, year; ...      
+               else if (cite_type == "citep" ||
                           cite_type == "citealp") {
-                       if (engine == biblio::ENGINE_NATBIB_NUMERICAL) {
-                               // FIXME UNICODE
-                               label += from_utf8(*it) + sep_str;
+                       if (engine == ENGINE_NATBIB_NUMERICAL) {
+                               label += wrapCitation(*it, citenum, for_xhtml) + sep_str;
                        } else {
-                               label += author + ", " + year + sep_str;
+                               label += wrapCitation(*it, author + ", " + year, for_xhtml) + sep_str;
                        }
 
+               } 
                // (authors1 <before> year;
                //  authors_last <before> year, <after>)
-               else if (cite_type == "citealt") {
+               else if (cite_type == "citealt") {
                        switch (engine) {
-                       case biblio::ENGINE_NATBIB_AUTHORYEAR:
+                       case ENGINE_NATBIB_AUTHORYEAR:
                                label += author + ' ' + before_str +
-                                       year + sep_str;
+                                       wrapCitation(*it, year, for_xhtml) + sep_str;
                                break;
-                       case biblio::ENGINE_NATBIB_NUMERICAL:
-                               // FIXME UNICODE
-                               label += author + ' ' + before_str +
-                                       '#' + from_utf8(*it) + sep_str;
+                       case ENGINE_NATBIB_NUMERICAL:
+                               label += author + ' ' + before_str + '#' + 
+                                       wrapCitation(*it, citenum, for_xhtml) + sep_str;
                                break;
-                       case biblio::ENGINE_JURABIB:
-                               label += before_str + author + ' ' +
-                                       year + sep_str;
+                       case ENGINE_JURABIB:
+                               label += before_str + 
+                                       wrapCitation(*it, author + ' ' + year, for_xhtml) + sep_str;
                                break;
-                       case biblio::ENGINE_BASIC:
+                       case ENGINE_BASIC:
                                break;
                        }
 
+               
+               } 
                // author; author; ...
-               else if (cite_type == "citeauthor") {
-                       label += author + sep_str;
-
+               else if (cite_type == "citeauthor") {
+                       label += wrapCitation(*it, author, for_xhtml) + sep_str;
+               }
                // year; year; ...
-               else if (cite_type == "citeyear" ||
+               else if (cite_type == "citeyear" ||
                           cite_type == "citeyearpar") {
-                       label += year + sep_str;
+                       label += wrapCitation(*it, year, for_xhtml) + sep_str;
                }
        }
        label = rtrim(rtrim(label), sep);
@@ -260,7 +416,7 @@ docstring const getNatbibLabel(Buffer const & buffer,
                        label.insert(label.size() - 1, after_str);
                } else {
                        bool const add =
-                               !(engine == biblio::ENGINE_NATBIB_NUMERICAL &&
+                               !(engine == ENGINE_NATBIB_NUMERICAL &&
                                  (cite_type == "citeauthor" ||
                                   cite_type == "citeyear"));
                        if (add)
@@ -274,110 +430,85 @@ docstring const getNatbibLabel(Buffer const & buffer,
                label = before_str + label;
        }
 
-       if (cite_type == "citep" || cite_type == "citeyearpar")
+       if (cite_type == "citep" || cite_type == "citeyearpar" || 
+           (cite_type == "cite" && engine == ENGINE_BASIC) )
                label = op + label + cp;
 
        return label;
 }
 
 
-docstring const getBasicLabel(docstring const & keyList, docstring const & after)
+docstring InsetCitation::basicLabel(bool for_xhtml) const
 {
-       docstring keys(keyList);
+       docstring keys = getParam("key");
        docstring label;
 
-       if (contains(keys, ',')) {
-               // Final comma allows while loop to cover all keys
-               keys = ltrim(split(keys, label, ',')) + ',';
-               while (contains(keys, ',')) {
-                       docstring key;
-                       keys = ltrim(split(keys, key, ','));
-                       label += ", " + key;
-               }
-       } else
-               label = keys;
-
+       docstring key;
+       do {
+               // if there is no comma, then everything goes into key
+               // and keys will be empty.
+               keys = trim(split(keys, key, ','));
+               key = trim(key);
+               if (!label.empty())
+                       label += ", ";
+               label += wrapCitation(key, key, for_xhtml);
+       } while (!keys.empty());
+
+       docstring const & after = getParam("after");
        if (!after.empty())
                label += ", " + after;
 
        return '[' + label + ']';
 }
 
-} // anon namespace
-
-
-InsetCitation::InsetCitation(InsetCommandParams const & p)
-       : InsetCommand(p, "citation")
-{}
-
-
-docstring const InsetCitation::generateLabel(Buffer const & buffer) const
+docstring InsetCitation::screenLabel() const
 {
-       docstring const before = getParam("before");
-       docstring const after  = getParam("after");
-
-       docstring label;
-       biblio::CiteEngine const engine = buffer.params().getEngine();
-       if (engine != biblio::ENGINE_BASIC) {
-               // FIXME UNICODE
-               label = getNatbibLabel(buffer, getCmdName(), to_utf8(getParam("key")),
-                                      before, after, engine);
-       }
-
-       // Fallback to fail-safe
-       if (label.empty()) {
-               label = getBasicLabel(getParam("key"), after);
-       }
-
-       return label;
+       return cache.screen_label;
 }
 
 
-docstring const InsetCitation::getScreenLabel(Buffer const & buffer) const
+void InsetCitation::updateBuffer(ParIterator const &, UpdateType)
 {
-       biblio::CiteEngine const engine = buffer.params().getEngine();
-       if (cache.params == params() && cache.engine == engine)
-               return cache.screen_label;
+       if (!cache.recalculate && buffer().citeLabelsValid())
+               return;
 
-       // The label has changed, so we have to re-create it.
-       docstring const glabel = generateLabel(buffer);
+       // The label may have changed, so we have to re-create it.
+       docstring const glabel = generateLabel();
 
        unsigned int const maxLabelChars = 45;
 
        docstring label = glabel;
        if (label.size() > maxLabelChars) {
-               label.erase(maxLabelChars-3);
+               label.erase(maxLabelChars - 3);
                label += "...";
        }
 
-       cache.engine  = engine;
-       cache.params = params();
+       cache.recalculate = false;
        cache.generated_label = glabel;
        cache.screen_label = label;
-
-       return label;
 }
 
 
-int InsetCitation::plaintext(Buffer const & buffer, odocstream & os,
-                             OutputParams const &) const
+void InsetCitation::addToToc(DocIterator const & cpit) const
 {
-       docstring str;
+       // NOTE
+       // XHTML output uses the TOC to collect the citations
+       // from the document. So if this gets changed, then we
+       // will need to change how the citations are collected.
+       docstring const tocitem = getParam("key");
+       Toc & toc = buffer().tocBackend().toc("citation");
+       toc.push_back(TocItem(cpit, 0, tocitem));
+}
 
-       if (cache.params == params() &&
-           cache.engine == buffer.params().getEngine())
-               str = cache.generated_label;
-       else
-               str = generateLabel(buffer);
 
-       os << str;
-       return str.size();
+int InsetCitation::plaintext(odocstream & os, OutputParams const &) const
+{
+       os << cache.generated_label;
+       return cache.generated_label.size();
 }
 
 
-namespace {
-
-docstring const cleanupWhitespace(docstring const & citelist)
+static docstring const cleanupWhitespace(docstring const & citelist)
 {
        docstring::const_iterator it  = citelist.begin();
        docstring::const_iterator end = citelist.end();
@@ -394,23 +525,38 @@ docstring const cleanupWhitespace(docstring const & citelist)
        return result;
 }
 
-// end anon namyspace
-}
 
-int InsetCitation::docbook(Buffer const &, odocstream & os,
-                           OutputParams const &) const
+int InsetCitation::docbook(odocstream & os, OutputParams const &) const
 {
-       os << "<citation>"
-           << cleanupWhitespace(getParam("key"))
-           << "</citation>";
+       os << from_ascii("<citation>")
+          << cleanupWhitespace(getParam("key"))
+          << from_ascii("</citation>");
        return 0;
 }
 
 
-int InsetCitation::textString(Buffer const & buf, odocstream & os,
-                      OutputParams const & op) const
+docstring InsetCitation::xhtml(XHTMLStream & xs, OutputParams const &) const
+{
+       string const & cmd = getCmdName();
+       if (cmd == "nocite")
+               return docstring();
+
+       // have to output this raw, because generateLabel() will include tags
+       xs << XHTMLStream::ESCAPE_NONE << generateLabel(true);
+
+       return docstring();
+}
+
+
+void InsetCitation::toString(odocstream & os) const
+{
+       plaintext(os, OutputParams(0));
+}
+
+
+void InsetCitation::forToc(docstring & os, size_t) const
 {
-       return plaintext(buf, os, op);
+       os += screenLabel();
 }
 
 
@@ -418,52 +564,56 @@ int InsetCitation::textString(Buffer const & buf, odocstream & os,
 // the \cite command is valid. Eg, the user has natbib enabled, inputs some
 // citations and then changes his mind, turning natbib support off. The output
 // should revert to \cite[]{}
-int InsetCitation::latex(Buffer const & buffer, odocstream & os,
-                         OutputParams const &) const
+void InsetCitation::latex(otexstream & os, OutputParams const & runparams) const
 {
-       biblio::CiteEngine cite_engine = buffer.params().getEngine();
+       CiteEngine cite_engine = buffer().params().citeEngine();
+       BiblioInfo const & bi = buffer().masterBibInfo();
        // FIXME UNICODE
        docstring const cite_str = from_utf8(
-               biblio::asValidLatexCommand(getCmdName(), cite_engine));
+               asValidLatexCommand(getCmdName(), cite_engine));
+
+       if (runparams.inulemcmd)
+               os << "\\mbox{";
 
        os << "\\" << cite_str;
 
        docstring const & before = getParam("before");
        docstring const & after  = getParam("after");
-       if (!before.empty() && cite_engine != biblio::ENGINE_BASIC)
+       if (!before.empty() && cite_engine != ENGINE_BASIC)
                os << '[' << before << "][" << after << ']';
        else if (!after.empty())
                os << '[' << after << ']';
 
-       os << '{' << cleanupWhitespace(getParam("key")) << '}';
+       if (!bi.isBibtex(getParam("key")))
+               // escape chars with bibitems
+               os << '{' << escape(cleanupWhitespace(getParam("key"))) << '}';
+       else
+               os << '{' << cleanupWhitespace(getParam("key")) << '}';
 
-       return 0;
+       if (runparams.inulemcmd)
+               os << "}";
 }
 
 
 void InsetCitation::validate(LaTeXFeatures & features) const
 {
-       switch (features.bufferParams().getEngine()) {
-       case biblio::ENGINE_BASIC:
+       switch (features.bufferParams().citeEngine()) {
+       case ENGINE_BASIC:
                break;
-       case biblio::ENGINE_NATBIB_AUTHORYEAR:
-       case biblio::ENGINE_NATBIB_NUMERICAL:
+       case ENGINE_NATBIB_AUTHORYEAR:
+       case ENGINE_NATBIB_NUMERICAL:
                features.require("natbib");
                break;
-       case biblio::ENGINE_JURABIB:
+       case ENGINE_JURABIB:
                features.require("jurabib");
                break;
        }
 }
 
 
-void InsetCitation::replaceContents(string const & from, string const & to)
+docstring InsetCitation::contextMenuName() const
 {
-       if (tokenPos(getContents(), ',', from) != -1) {
-               vector<string> items = getVectorFromString(getContents());
-               replace(items.begin(), items.end(), from, to);
-               setContents(getStringFromVector(items));
-       }
+       return from_ascii("context-citation");
 }