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"
16 #include "BufferView.h"
17 #include "dispatchresult.h"
18 #include "funcrequest.h"
21 #include "paragraph.h"
22 #include "ParagraphList.h"
24 #include "support/lstrings.h"
25 #include "support/std_ostream.h"
26 #include "support/convert.h"
29 using lyx::support::prefixIs;
36 int InsetBibitem::key_counter = 0;
37 string const key_prefix = "key-";
39 InsetBibitem::InsetBibitem(InsetCommandParams const & p)
40 : InsetCommand(p, "bibitem"), counter(1)
42 if (getContents().empty())
43 setContents(key_prefix + convert<string>(++key_counter));
47 auto_ptr<InsetBase> InsetBibitem::doClone() const
49 auto_ptr<InsetBibitem> b(new InsetBibitem(params()));
50 b->setCounter(counter);
51 return auto_ptr<InsetBase>(b);
55 void InsetBibitem::doDispatch(LCursor & cur, FuncRequest & cmd)
59 case LFUN_INSET_MODIFY: {
61 InsetCommandMailer::string2params("bibitem", lyx::to_utf8(cmd.argument()), p);
62 if (p.getCmdName().empty()) {
66 if (p.getContents() != params().getContents())
67 cur.bv().buffer()->changeRefsIfUnique(params().getContents(),
68 p.getContents(), InsetBase::CITE_CODE);
73 InsetCommand::doDispatch(cur, cmd);
79 void InsetBibitem::setCounter(int c)
85 // I'm sorry but this is still necessary because \bibitem is used also
86 // as a LyX 2.x command, and lyxlex is not enough smart to understand
87 // real LaTeX commands. Yes, that could be fixed, but would be a waste
88 // of time cause LyX3 won't use lyxlex anyway. (ale)
89 void InsetBibitem::write(Buffer const &, std::ostream & os) const
92 if (!getOptions().empty())
93 os << '[' << getOptions() << ']';
94 os << '{' << getContents() << "}\n";
98 // This is necessary here because this is written without begin_inset
99 // This should be changed!!! (Jug)
100 void InsetBibitem::read(Buffer const &, LyXLex & lex)
103 scanCommand(lex.getString());
105 lex.printError("InsetCommand: Parse error: `$$Token'");
107 if (prefixIs(getContents(), key_prefix)) {
108 int const key = convert<int>(getContents().substr(key_prefix.length()));
109 key_counter = max(key_counter, key);
114 docstring const InsetBibitem::getBibLabel() const
117 return getOptions().empty() ?
118 convert<docstring>(counter) :
119 lyx::from_utf8(getOptions());
123 docstring const InsetBibitem::getScreenLabel(Buffer const &) const
126 return lyx::from_utf8(getContents()) + " [" + getBibLabel() + ']';
130 int InsetBibitem::plaintext(Buffer const &, lyx::odocstream & os,
131 OutputParams const &) const
133 os << '[' << getCounter() << "] ";
139 docstring const bibitemWidest(Buffer const & buffer)
143 InsetBibitem const * bitem = 0;
145 // FIXME: this font is used unitialized for now but should be set to
146 // a proportional font. Here is what Georg Baum has to say about it:
148 bibitemWidest() is supposed to find the bibitem with the widest label in the
149 output, because that is needed as an argument of the bibliography
150 environment to dtermine the correct indentation. To be 100% correct we
151 would need the metrics of the font that is used in the output, but usually
152 we don't have access to these.
153 In practice, any proportional font is probably good enough, since we don't
154 need to know the final with, we only need to know the which label is the
156 Unless there is an easy way to get the metrics of the output font I suggest
157 to use a hardcoded font like "Times" or so.
159 It is very important that the result of this function is the same both with
160 and without GUI. After thinking about this it is clear that no LyXFont
161 metrics should be used here, since these come from the gui. If we can't
162 easily get the LaTeX font metrics we should make our own poor mans front
163 metrics replacement, e.g. by hardcoding the metrics of the standard TeX
168 ParagraphList::const_iterator it = buffer.paragraphs().begin();
169 ParagraphList::const_iterator end = buffer.paragraphs().end();
171 for (; it != end; ++it) {
173 docstring const label = it->bibitem()->getBibLabel();
175 // FIXME: we can't be sure using the following that the GUI
176 // version and the command-line version will give the same
179 //int const wx = lyx::use_gui?
180 // theFontMetrics(font).width(label): label.size();
182 // So for now we just use the label size in order to be sure
183 // that GUI and no-GUI gives the same bibitem (even if that is
184 // potentially the wrong one.
185 int const wx = label.size();
189 bitem = it->bibitem();
194 if (bitem && !bitem->getBibLabel().empty())
195 return bitem->getBibLabel();
197 return lyx::from_ascii("99");