3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "InsetLabel.h"
17 #include "buffer_funcs.h"
19 #include "BufferView.h"
20 #include "DispatchResult.h"
21 #include "FuncRequest.h"
22 #include "InsetIterator.h"
23 #include "ParIterator.h"
26 #include "TocBackend.h"
28 #include "frontends/alert.h"
30 #include "support/convert.h"
31 #include "support/lyxalgo.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
36 using namespace lyx::support;
41 InsetLabel::InsetLabel(InsetCommandParams const & p)
42 : InsetCommand(p, "label")
46 void InsetLabel::validate()
48 update(getParam("name"));
52 void InsetLabel::update(docstring const & new_label)
54 docstring const old_label = getParam("name");
55 docstring label = new_label;
57 while (buffer().insetLabel(label)) {
58 label = new_label + '-' + convert<docstring>(i);
61 setParam("name", label);
63 Buffer::References const & refs = buffer().references(old_label);
64 Buffer::References::const_iterator it = refs.begin();
65 Buffer::References::const_iterator end = refs.end();
66 for (; it != end; ++it)
67 it->first->setParam("reference", label);
69 if (label != new_label) {
70 // Warn the user that the label has been changed to something else.
71 frontend::Alert::warning(_("Label names must be unique!"),
72 bformat(_("The label %1$s already exists,\n"
73 "it will been changed to %2$s."), new_label, label));
75 // We need an update of the Buffer reference cache. This is achieved by
77 lyx::updateLabels(buffer());
81 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
83 static ParamInfo param_info_;
84 if (param_info_.empty()) {
85 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
91 void InsetLabel::getLabelList(vector<docstring> & list) const
93 list.push_back(getParam("name"));
97 docstring InsetLabel::screenLabel() const
99 return getParam("name");
103 void InsetLabel::updateLabels(ParIterator const & it)
105 docstring const & label = getParam("name");
106 if (buffer().insetLabel(label))
107 // Problem: We already have an InsetLabel with the same name!
109 buffer().setInsetLabel(label, this);
113 void InsetLabel::addToToc(ParConstIterator const & cpit) const
115 docstring const & label = getParam("name");
116 Toc & toc = buffer().tocBackend().toc("label");
117 if (buffer().insetLabel(label) != this) {
118 toc.push_back(TocItem(cpit, 0, _("DUPLICATE: ") + label));
121 toc.push_back(TocItem(cpit, 0, label));
122 Buffer::References const & refs = buffer().references(label);
123 Buffer::References::const_iterator it = refs.begin();
124 Buffer::References::const_iterator end = refs.end();
125 for (; it != end; ++it) {
126 ParConstIterator const ref_pit(it->second);
127 toc.push_back(TocItem(ref_pit, 1, it->first->screenLabel()));
132 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
134 switch (cmd.action) {
136 case LFUN_INSET_MODIFY: {
137 InsetCommandParams p(LABEL_CODE);
139 InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p);
140 if (p.getCmdName().empty()) {
149 InsetCommand::doDispatch(cur, cmd);
155 int InsetLabel::latex(odocstream & os, OutputParams const &) const
157 os << escape(getCommand());
162 int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
164 docstring const str = getParam("name");
165 os << '<' << str << '>';
166 return 2 + str.size();
170 int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
172 os << "<!-- anchor id=\""
173 << sgml::cleanID(buffer(), runparams, getParam("name"))