2 * \file InsetBibitem.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
8 * Full author contact details are available in file CREDITS.
13 #include "InsetBibitem.h"
15 #include "BiblioInfo.h"
17 #include "buffer_funcs.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
21 #include "DispatchResult.h"
22 #include "FuncRequest.h"
23 #include "InsetIterator.h"
24 #include "InsetList.h"
26 #include "Paragraph.h"
27 #include "ParagraphList.h"
28 #include "TextClass.h"
30 #include "frontends/alert.h"
32 #include "support/lstrings.h"
33 #include "support/docstream.h"
34 #include "support/gettext.h"
35 #include "support/convert.h"
40 using namespace lyx::support;
45 int InsetBibitem::key_counter = 0;
46 docstring const key_prefix = from_ascii("key-");
49 InsetBibitem::InsetBibitem(InsetCommandParams const & p)
50 : InsetCommand(p, "bibitem")
52 if (getParam("key").empty())
53 setParam("key", key_prefix + convert<docstring>(++key_counter));
57 void InsetBibitem::initView()
59 updateCommand(getParam("key"));
63 void InsetBibitem::updateCommand(docstring const & new_key, bool)
65 docstring const old_key = getParam("key");
66 docstring key = new_key;
69 keys.fillWithBibKeys(&buffer());
70 vector<docstring> bibkeys = keys.getKeys();
74 if (find(bibkeys.begin(), bibkeys.end(), key) != bibkeys.end()) {
75 // generate unique label
76 key = new_key + '-' + convert<docstring>(i);
77 while (find(bibkeys.begin(), bibkeys.end(), key) != bibkeys.end()) {
79 key = new_key + '-' + convert<docstring>(i);
81 frontend::Alert::warning(_("Keys must be unique!"),
82 bformat(_("The key %1$s already exists,\n"
83 "it will be changed to %2$s."), new_key, key));
87 lyx::updateLabels(buffer());
91 ParamInfo const & InsetBibitem::findInfo(string const & /* cmdName */)
93 static ParamInfo param_info_;
94 if (param_info_.empty()) {
95 param_info_.add("label", ParamInfo::LATEX_OPTIONAL);
96 param_info_.add("key", ParamInfo::LATEX_REQUIRED);
102 void InsetBibitem::doDispatch(Cursor & cur, FuncRequest & cmd)
104 switch (cmd.action) {
106 case LFUN_INSET_MODIFY: {
107 InsetCommandParams p(BIBITEM_CODE);
108 InsetCommandMailer::string2params("bibitem", to_utf8(cmd.argument()), p);
109 if (p.getCmdName().empty()) {
113 docstring old_key = params()["key"];
114 setParam("label", p["label"]);
115 updateCommand(p["key"]);
116 if (params()["key"] != old_key)
117 cur.bv().buffer().changeRefsIfUnique(old_key,
118 params()["key"], CITE_CODE);
122 InsetCommand::doDispatch(cur, cmd);
128 void InsetBibitem::read(Lexer & lex)
130 InsetCommand::read(lex);
132 if (prefixIs(getParam("key"), key_prefix)) {
133 int const key = convert<int>(getParam("key").substr(key_prefix.length()));
134 key_counter = max(key_counter, key);
139 docstring InsetBibitem::bibLabel() const
141 docstring const & label = getParam("label");
142 return label.empty() ? autolabel_ : label;
146 docstring InsetBibitem::screenLabel() const
148 return getParam("key") + " [" + bibLabel() + ']';
152 int InsetBibitem::plaintext(odocstream & os, OutputParams const &) const
154 odocstringstream oss;
155 oss << '[' << bibLabel() << "] ";
157 docstring const str = oss.str();
165 docstring const bibitemWidest(Buffer const & buffer)
169 InsetBibitem const * bitem = 0;
171 // FIXME: this font is used unitialized for now but should be set to
172 // a proportional font. Here is what Georg Baum has to say about it:
174 bibitemWidest() is supposed to find the bibitem with the widest label in the
175 output, because that is needed as an argument of the bibliography
176 environment to dtermine the correct indentation. To be 100% correct we
177 would need the metrics of the font that is used in the output, but usually
178 we don't have access to these.
179 In practice, any proportional font is probably good enough, since we don't
180 need to know the final with, we only need to know the which label is the
182 Unless there is an easy way to get the metrics of the output font I suggest
183 to use a hardcoded font like "Times" or so.
185 It is very important that the result of this function is the same both with
186 and without GUI. After thinking about this it is clear that no Font
187 metrics should be used here, since these come from the gui. If we can't
188 easily get the LaTeX font metrics we should make our own poor mans font
189 metrics replacement, e.g. by hardcoding the metrics of the standard TeX
193 ParagraphList::const_iterator it = buffer.paragraphs().begin();
194 ParagraphList::const_iterator end = buffer.paragraphs().end();
196 for (; it != end; ++it) {
197 if (it->insetList().empty())
199 Inset * inset = it->insetList().begin()->inset;
200 if (inset->lyxCode() != BIBITEM_CODE)
203 bitem = static_cast<InsetBibitem const *>(inset);
204 docstring const label = bitem->bibLabel();
206 // FIXME: we can't be sure using the following that the GUI
207 // version and the command-line version will give the same
210 //int const wx = use_gui?
211 // theFontMetrics(font).width(label): label.size();
213 // So for now we just use the label size in order to be sure
214 // that GUI and no-GUI gives the same bibitem (even if that is
215 // potentially the wrong one.
216 int const wx = label.size();
222 if (bitem && !bitem->bibLabel().empty())
223 return bitem->bibLabel();
225 return from_ascii("99");
229 void InsetBibitem::fillWithBibKeys(BiblioInfo & keys, InsetIterator const & it) const
231 docstring const key = getParam("key");
232 BibTeXInfo keyvalmap(false);
233 keyvalmap[from_ascii("label")] = getParam("label");
234 DocIterator doc_it(it);
236 keyvalmap[from_ascii("ref")] = doc_it.paragraph().asString(false);
237 keys[key] = keyvalmap;
241 /// Update the counters of this inset and of its contents
242 void InsetBibitem::updateLabels(ParIterator const &)
244 Counters & counters = buffer().params().documentClass().counters();
245 docstring const bibitem = from_ascii("bibitem");
246 if (counters.hasCounter(bibitem) && getParam("label").empty()) {
247 counters.step(bibitem);
248 autolabel_ = counters.theCounter(bibitem);
250 autolabel_ = from_ascii("??");