* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
- * \author Herbert Voss
+ * \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "insetcite.h"
-#include "funcrequest.h"
+
#include "buffer.h"
+#include "bufferparams.h"
#include "BufferView.h"
+#include "dispatchresult.h"
+#include "funcrequest.h"
#include "LaTeXFeatures.h"
#include "frontends/controllers/biblio.h"
#include "support/lstrings.h"
-#include <map>
-
-using namespace lyx::support;
+using lyx::support::ascii_lowercase;
+using lyx::support::contains;
+using lyx::support::getVectorFromString;
+using lyx::support::ltrim;
+using lyx::support::rtrim;
+using lyx::support::split;
+using std::string;
using std::ostream;
using std::vector;
using std::map;
-namespace {
+namespace biblio = lyx::biblio;
-// An optimisation. We assume that until the first InsetCitation::edit is
-// called, we're loading the buffer and that, therefore, we don't need to
-// reload the bibkey list
-std::map<Buffer const *, bool> loading_buffer;
-string const getNatbibLabel(Buffer const * buffer,
+namespace {
+
+string const getNatbibLabel(Buffer const & buffer,
string const & citeType, string const & keyList,
string const & before, string const & after,
- bool numerical)
+ biblio::CiteEngine engine)
{
+ // Only start the process off after the buffer is loaded from file.
+ if (!buffer.fully_loaded())
+ return string();
+
typedef std::map<Buffer const *, biblio::InfoMap> CachedMap;
static CachedMap cached_keys;
- // Only load the bibkeys once if we're loading up the buffer,
- // else load them afresh each time.
- map<Buffer const *, bool>::iterator lit = loading_buffer.find(buffer);
- if (lit == loading_buffer.end())
- loading_buffer[buffer] = true;
-
- bool loadkeys = !loading_buffer[buffer];
- if (!loadkeys) {
- CachedMap::iterator kit = cached_keys.find(buffer);
- loadkeys = kit == cached_keys.end();
- }
-
- if (loadkeys) {
- // build the keylist
- typedef vector<std::pair<string, string> > InfoType;
- InfoType bibkeys;
- buffer->fillWithBibKeys(bibkeys);
-
- InfoType::const_iterator bit = bibkeys.begin();
- InfoType::const_iterator bend = bibkeys.end();
+ // build the keylist
+ typedef vector<std::pair<string, string> > InfoType;
+ InfoType bibkeys;
+ buffer.fillWithBibKeys(bibkeys);
- biblio::InfoMap infomap;
- for (; bit != bend; ++bit) {
- infomap[bit->first] = bit->second;
- }
- if (infomap.empty())
- return string();
+ InfoType::const_iterator bit = bibkeys.begin();
+ InfoType::const_iterator bend = bibkeys.end();
- cached_keys[buffer] = infomap;
+ biblio::InfoMap infomap;
+ for (; bit != bend; ++bit) {
+ infomap[bit->first] = bit->second;
}
+ if (infomap.empty())
+ return string();
- biblio::InfoMap infomap = cached_keys[buffer];
+ cached_keys[&buffer] = infomap;
// the natbib citation-styles
// CITET: author (year)
// CITEAUTHOR: author
// CITEYEAR: year
// CITEYEARPAR: (year)
+ // jurabib supports these plus
+ // CITE: author/<before field>
// We don't currently use the full or forceUCase fields.
- // bool const forceUCase = citeType[0] == 'C';
- bool const full = citeType[citeType.size() - 1] == '*';
-
- string const cite_type = full ?
- ascii_lowercase(citeType.substr(0, citeType.size() - 1)) :
- ascii_lowercase(citeType);
+ string cite_type = biblio::asValidLatexCommand(citeType, engine);
+ if (cite_type[0] == 'C')
+ cite_type = string(1, 'c') + cite_type.substr(1);
+ if (cite_type[cite_type.size() - 1] == '*')
+ cite_type = cite_type.substr(0, cite_type.size() - 1);
string before_str;
if (!before.empty()) {
cite_type == "citealp" ||
cite_type == "citeyearpar")
before_str = before + ' ';
+ // In CITE (jurabib), the "before" string is used to attach
+ // the annotator (of legal texts) to the author(s) of the
+ // first reference.
+ else if (cite_type == "cite")
+ before_str = '/' + before;
}
string after_str;
if (author.empty() || year.empty())
return string();
+ // 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;
+
// (authors1 (<before> year); ... ;
// authors_last (<before> year, <after>)
- if (cite_type == "citet") {
- string const tmp = numerical ? '#' + *it : year;
- label += author + op_str + before_str + tmp +
- cp + sep_str;
+ } else if (cite_type == "citet") {
+ switch (engine) {
+ case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ label += author + op_str + before_str +
+ year + cp + sep_str;
+ break;
+ case biblio::ENGINE_NATBIB_NUMERICAL:
+ label += author + op_str + before_str +
+ '#' + *it + cp + sep_str;
+ break;
+ case biblio::ENGINE_JURABIB:
+ label += before_str + author + op_str +
+ year + cp + sep_str;
+ break;
+ case biblio::ENGINE_BASIC:
+ break;
+ }
// author, year; author, year; ...
} else if (cite_type == "citep" ||
cite_type == "citealp") {
- if (numerical) {
+ if (engine == biblio::ENGINE_NATBIB_NUMERICAL) {
label += *it + sep_str;
} else {
label += author + ", " + year + sep_str;
// (authors1 <before> year;
// authors_last <before> year, <after>)
} else if (cite_type == "citealt") {
- string const tmp = numerical ? '#' + *it : year;
- label += author + ' ' + before_str + tmp + sep_str;
+ switch (engine) {
+ case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ label += author + ' ' + before_str +
+ year + sep_str;
+ break;
+ case biblio::ENGINE_NATBIB_NUMERICAL:
+ label += author + ' ' + before_str +
+ '#' + *it + sep_str;
+ break;
+ case biblio::ENGINE_JURABIB:
+ label += before_str + author + ' ' +
+ year + sep_str;
+ break;
+ case biblio::ENGINE_BASIC:
+ break;
+ }
// author; author; ...
} else if (cite_type == "citeauthor") {
// insert "after" before last ')'
label.insert(label.size() - 1, after_str);
} else {
- bool const add = !(numerical &&
- (cite_type == "citeauthor" ||
- cite_type == "citeyear"));
+ bool const add =
+ !(engine == biblio::ENGINE_NATBIB_NUMERICAL &&
+ (cite_type == "citeauthor" ||
+ cite_type == "citeyear"));
if (add)
label += after_str;
}
string keys(keyList);
string label;
- if (contains(keys, ",")) {
+ if (contains(keys, ',')) {
// Final comma allows while loop to cover all keys
keys = ltrim(split(keys, label, ',')) + ',';
- while (contains(keys, ",")) {
+ while (contains(keys, ',')) {
string key;
keys = ltrim(split(keys, key, ','));
label += ", " + key;
InsetCitation::InsetCitation(InsetCommandParams const & p)
- : InsetCommand(p)
+ : InsetCommand(p, "citation")
{}
-// InsetCitation::InsetCitation(InsetCommandParams const & p, bool)
-// : InsetCommand(p, false)
-// {}
-
-
-InsetCitation::~InsetCitation()
+string const InsetCitation::generateLabel(Buffer const & buffer) const
{
- InsetCommandMailer mailer("citation", *this);
- mailer.hideDialog();
-}
-
-
-string const InsetCitation::generateLabel(Buffer const * buffer) const
-{
- string const before = string();
+ string const before = getSecOptions();
string const after = getOptions();
string label;
- if (buffer->params.use_natbib) {
- string cmd = getCmdName();
- if (cmd == "cite") {
- // We may be "upgrading" from an older LyX version.
- // If, however, we use "cite" because the necessary
- // author/year info is not present in the biblio
- // database, then getNatbibLabel will exit gracefully
- // and we'll call getBasicLabel.
- if (buffer->params.use_numerical_citations)
- cmd = "citep";
- else
- cmd = "citet";
- }
- label = getNatbibLabel(buffer, cmd, getContents(),
- before, after,
- buffer->params.use_numerical_citations);
+ biblio::CiteEngine const engine = buffer.params().cite_engine;
+ if (engine != biblio::ENGINE_BASIC) {
+ label = getNatbibLabel(buffer, getCmdName(), getContents(),
+ before, after, engine);
}
// Fallback to fail-safe
}
-InsetCitation::Cache::Style InsetCitation::getStyle(Buffer const * buffer) const
-{
- Cache::Style style = Cache::BASIC;
-
- if (buffer->params.use_natbib) {
- if (buffer->params.use_numerical_citations) {
- style = Cache::NATBIB_NUM;
- } else {
- style = Cache::NATBIB_AY;
- }
- }
-
- return style;
-}
-
-
-string const InsetCitation::getScreenLabel(Buffer const * buffer) const
+string const InsetCitation::getScreenLabel(Buffer const & buffer) const
{
- Cache::Style const style = getStyle(buffer);
- if (cache.params == params() && cache.style == style)
+ biblio::CiteEngine const engine = biblio::getEngine(buffer);
+ if (cache.params == params() && cache.engine == engine)
return cache.screen_label;
// The label has changed, so we have to re-create it.
- string const before = string();
+ string const before = getSecOptions();
string const after = getOptions();
string const glabel = generateLabel(buffer);
label += "...";
}
- cache.style = style;
+ cache.engine = engine;
cache.params = params();
cache.generated_label = glabel;
cache.screen_label = label;
}
-void InsetCitation::setLoadingBuffer(Buffer const * buffer, bool state) const
+int InsetCitation::plaintext(Buffer const & buffer, ostream & os, OutputParams const &) const
{
- // Doesn't matter if there is no bv->buffer() entry in the map.
- loading_buffer[buffer] = state;
+ if (cache.params == params() &&
+ cache.engine == biblio::getEngine(buffer))
+ os << cache.generated_label;
+ else
+ os << generateLabel(buffer);
+ return 0;
}
-dispatch_result InsetCitation::localDispatch(FuncRequest const & cmd)
+namespace {
+
+string const cleanupWhitespace(string const & citelist)
{
- switch (cmd.action) {
- case LFUN_INSET_EDIT:
- // A call to edit indicates that we're no longer loading the
- // buffer but doing some real work.
- setLoadingBuffer(cmd.view()->buffer(), false);
- InsetCommandMailer("citation", *this).showDialog(cmd.view());
- return DISPATCHED;
-
- default:
- return InsetCommand::localDispatch(cmd);
+ string::const_iterator it = citelist.begin();
+ string::const_iterator end = citelist.end();
+ // Paranoia check: make sure that there is no whitespace in here
+ // -- at least not behind commas or at the beginning
+ string result;
+ char last = ',';
+ for (; it != end; ++it) {
+ if (*it != ' ')
+ last = *it;
+ if (*it != ' ' || last != ',')
+ result += *it;
}
+ return result;
}
+// end anon namyspace
+}
-int InsetCitation::ascii(Buffer const * buffer, ostream & os, int) const
+int InsetCitation::docbook(Buffer const &, ostream & os, OutputParams const &) const
{
- if (cache.params == params() && cache.style == getStyle(buffer))
- os << cache.generated_label;
- else
- os << generateLabel(buffer);
+ os << "<citation>" << cleanupWhitespace(getContents()) << "</citation>";
return 0;
}
+int InsetCitation::textString(Buffer const & buf, ostream & os,
+ OutputParams const & op) const
+{
+ return plaintext(buf, os, op);
+}
+
+
// Have to overwrite the default InsetCommand method in order to check that
// 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, ostream & os,
- LatexRunParams const &) const
+int InsetCitation::latex(Buffer const & buffer, ostream & os,
+ OutputParams const &) const
{
- os << "\\";
- if (buffer->params.use_natbib)
- os << getCmdName();
- else
- os << "cite";
+ biblio::CiteEngine const cite_engine = buffer.params().cite_engine;
+ string const cite_str =
+ biblio::asValidLatexCommand(getCmdName(), cite_engine);
-#warning What is this code supposed to do? (Lgb)
-// my guess is that this is just waiting for when we support before,
-// so it's a oneliner. But this is very silly ! - jbl
+ os << "\\" << cite_str;
-#if 1
- // The current strange code
-
- string const before = string();
+ string const before = getSecOptions();
string const after = getOptions();
- if (!before.empty() && buffer->params.use_natbib)
+ if (!before.empty() && cite_engine != biblio::ENGINE_BASIC)
os << '[' << before << "][" << after << ']';
else if (!after.empty())
os << '[' << after << ']';
-#else
- // and the cleaned up equvalent, should it just be changed? (Lgb)
- string const after = getOptions();
- if (!after.empty())
- os << '[' << after << ']';
-#endif
- string::const_iterator it = getContents().begin();
- string::const_iterator end = getContents().end();
- // Paranoia check: make sure that there is no whitespace in here
- string content;
- char last = ',';
- for (; it != end; ++it) {
- if (*it != ' ')
- last = *it;
- if (*it != ' ' || last != ',')
- content += *it;
- }
- os << '{' << content << '}';
+ os << '{' << cleanupWhitespace(getContents()) << '}';
return 0;
}
void InsetCitation::validate(LaTeXFeatures & features) const
{
- if (features.bufferParams().use_natbib)
+ switch (features.bufferParams().cite_engine) {
+ case biblio::ENGINE_BASIC:
+ break;
+ case biblio::ENGINE_NATBIB_AUTHORYEAR:
+ case biblio::ENGINE_NATBIB_NUMERICAL:
features.require("natbib");
+ break;
+ case biblio::ENGINE_JURABIB:
+ features.require("jurabib");
+ break;
+ }
}
projects / lyx.git / blobdiff