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/gettext.h"
32 #include "support/lstrings.h"
33 #include "support/lyxalgo.h"
36 using namespace lyx::support;
41 InsetLabel::InsetLabel(InsetCommandParams const & p)
42 : InsetCommand(p, "label")
46 void InsetLabel::initView()
48 updateCommand(getParam("name"));
52 void InsetLabel::updateCommand(docstring const & new_label, bool updaterefs)
54 docstring const old_label = getParam("name");
55 docstring label = new_label;
57 while (buffer().insetLabel(label)) {
58 label = new_label + '-' + convert<docstring>(i);
62 if (label != new_label) {
63 // Warn the user that the label has been changed to something else.
64 frontend::Alert::warning(_("Label names must be unique!"),
65 bformat(_("The label %1$s already exists,\n"
66 "it will be changed to %2$s."), new_label, label));
69 buffer().undo().beginUndoGroup();
70 setParam("name", label);
73 Buffer::References & refs = buffer().references(old_label);
74 Buffer::References::iterator it = refs.begin();
75 Buffer::References::iterator end = refs.end();
76 for (; it != end; ++it) {
77 buffer().undo().recordUndo(it->second);
78 it->first->setParam("reference", label);
81 buffer().undo().endUndoGroup();
83 // We need an update of the Buffer reference cache. This is achieved by
85 lyx::updateLabels(buffer());
89 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
91 static ParamInfo param_info_;
92 if (param_info_.empty()) {
93 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
99 docstring InsetLabel::screenLabel() const
101 return screen_label_;
105 void InsetLabel::updateLabels(ParIterator const &)
107 docstring const & label = getParam("name");
108 if (buffer().insetLabel(label)) {
109 // Problem: We already have an InsetLabel with the same name!
110 screen_label_ = _("DUPLICATE: ") + label;
113 buffer().setInsetLabel(label, this);
114 screen_label_ = label;
118 void InsetLabel::addToToc(DocIterator const & cpit)
120 docstring const & label = getParam("name");
121 Toc & toc = buffer().tocBackend().toc("label");
122 if (buffer().insetLabel(label) != this) {
123 toc.push_back(TocItem(cpit, 0, screen_label_));
126 toc.push_back(TocItem(cpit, 0, screen_label_));
127 Buffer::References const & refs = buffer().references(label);
128 Buffer::References::const_iterator it = refs.begin();
129 Buffer::References::const_iterator end = refs.end();
130 for (; it != end; ++it) {
131 DocIterator const ref_pit(it->second);
132 toc.push_back(TocItem(ref_pit, 1, it->first->screenLabel()));
137 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
139 switch (cmd.action) {
141 case LFUN_INSET_MODIFY: {
142 InsetCommandParams p(LABEL_CODE);
144 InsetCommand::string2params("label", to_utf8(cmd.argument()), p);
145 if (p.getCmdName().empty()) {
149 updateCommand(p["name"]);
154 InsetCommand::doDispatch(cur, cmd);
160 int InsetLabel::latex(odocstream & os, OutputParams const &) const
162 os << escape(getCommand());
167 int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
169 docstring const str = getParam("name");
170 os << '<' << str << '>';
171 return 2 + str.size();
175 int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
177 os << "<!-- anchor id=\""
178 << sgml::cleanID(buffer(), runparams, getParam("name"))