* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#include "InsetLabel.h"
+#include "InsetRef.h"
+
+#include "buffer_funcs.h"
#include "Buffer.h"
+#include "BufferParams.h"
#include "BufferView.h"
+#include "CutAndPaste.h"
#include "DispatchResult.h"
#include "FuncRequest.h"
-#include "Text.h"
+#include "FuncStatus.h"
+#include "InsetIterator.h"
+#include "Language.h"
+#include "LyX.h"
+#include "output_xhtml.h"
+#include "ParIterator.h"
#include "sgml.h"
+#include "Text.h"
+#include "TextClass.h"
+#include "TocBackend.h"
+
+#include "mathed/InsetMathHull.h"
+#include "mathed/InsetMathRef.h"
+#include "frontends/alert.h"
+
+#include "support/convert.h"
+#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/lyxalgo.h"
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-InsetLabel::InsetLabel(InsetCommandParams const & p)
- : InsetCommand(p, "label")
+InsetLabel::InsetLabel(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "label")
{}
-Inset * InsetLabel::clone() const
+void InsetLabel::initView()
+{
+ updateCommand(getParam("name"));
+}
+
+
+void InsetLabel::updateCommand(docstring const & new_label, bool updaterefs)
+{
+ docstring const old_label = getParam("name");
+ docstring label = new_label;
+ int i = 1;
+ while (buffer().insetLabel(label)) {
+ label = new_label + '-' + convert<docstring>(i);
+ ++i;
+ }
+
+ if (label != new_label) {
+ // Warn the user that the label has been changed to something else.
+ frontend::Alert::warning(_("Label names must be unique!"),
+ bformat(_("The label %1$s already exists,\n"
+ "it will be changed to %2$s."), new_label, label));
+ }
+
+ buffer().undo().beginUndoGroup();
+ setParam("name", label);
+
+ if (updaterefs) {
+ Buffer::References & refs = buffer().references(old_label);
+ Buffer::References::iterator it = refs.begin();
+ Buffer::References::iterator end = refs.end();
+ for (; it != end; ++it) {
+ buffer().undo().recordUndo(it->second);
+ if (it->first->lyxCode() == MATH_REF_CODE) {
+ InsetMathHull * mi =
+ static_cast<InsetMathHull *>(it->first);
+ mi->asRefInset()->changeTarget(label);
+ } else {
+ InsetCommand * ref =
+ static_cast<InsetCommand *>(it->first);
+ ref->setParam("reference", label);
+ }
+ }
+ }
+ buffer().undo().endUndoGroup();
+
+ // We need an update of the Buffer reference cache. This is achieved by
+ // updateBuffer().
+ buffer().updateBuffer();
+}
+
+
+ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
{
- return new InsetLabel(params());
+ static ParamInfo param_info_;
+ if (param_info_.empty())
+ param_info_.add("name", ParamInfo::LATEX_REQUIRED,
+ ParamInfo::HANDLING_ESCAPE);
+ return param_info_;
}
-void InsetLabel::getLabelList(Buffer const &, std::vector<docstring> & list) const
+docstring InsetLabel::screenLabel() const
{
- list.push_back(getParam("name"));
+ return screen_label_;
}
-docstring const InsetLabel::getScreenLabel(Buffer const &) const
+void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype)
{
- return getParam("name");
+ docstring const & label = getParam("name");
+ if (buffer().insetLabel(label)) {
+ // Problem: We already have an InsetLabel with the same name!
+ screen_label_ = _("DUPLICATE: ") + label;
+ return;
+ }
+ buffer().setInsetLabel(label, this);
+ screen_label_ = label;
+
+ if (utype) {
+ // save info on the active counter
+ Counters const & cnts =
+ buffer().masterBuffer()->params().documentClass().counters();
+ active_counter_ = cnts.currentCounter();
+ Language const * lang = par->getParLanguage(buffer().params());
+ if (lang && !active_counter_.empty()) {
+ counter_value_ = cnts.theCounter(active_counter_, lang->code());
+ pretty_counter_ = cnts.prettyCounter(active_counter_, lang->code());
+ } else {
+ counter_value_ = from_ascii("??");
+ pretty_counter_ = from_ascii("??");
+ }
+ }
+}
+
+
+void InsetLabel::addToToc(DocIterator const & cpit)
+{
+ docstring const & label = getParam("name");
+ Toc & toc = buffer().tocBackend().toc("label");
+ if (buffer().insetLabel(label) != this) {
+ toc.push_back(TocItem(cpit, 0, screen_label_));
+ return;
+ }
+ toc.push_back(TocItem(cpit, 0, screen_label_));
+ Buffer::References const & refs = buffer().references(label);
+ Buffer::References::const_iterator it = refs.begin();
+ Buffer::References::const_iterator end = refs.end();
+ for (; it != end; ++it) {
+ DocIterator const ref_pit(it->second);
+ if (it->first->lyxCode() == MATH_REF_CODE)
+ toc.push_back(TocItem(ref_pit, 1,
+ static_cast<InsetMathHull *>(it->first)->asRefInset()
+ ->screenLabel()));
+ else
+ toc.push_back(TocItem(ref_pit, 1,
+ static_cast<InsetRef *>(it->first)->screenLabel()));
+ }
+}
+
+
+bool InsetLabel::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & status) const
+{
+ bool enabled;
+ switch (cmd.action) {
+ case LFUN_LABEL_INSERT_AS_REF:
+ case LFUN_LABEL_COPY_AS_REF:
+ enabled = true;
+ break;
+ default:
+ return InsetCommand::getStatus(cur, cmd, status);
+ }
+
+ status.setEnabled(enabled);
+ return true;
}
switch (cmd.action) {
case LFUN_INSET_MODIFY: {
- InsetCommandParams p("label");
+ InsetCommandParams p(LABEL_CODE);
// FIXME UNICODE
- InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p);
+ InsetCommand::string2params("label", to_utf8(cmd.argument()), p);
if (p.getCmdName().empty()) {
cur.noUpdate();
break;
}
if (p["name"] != params()["name"])
- cur.bv().buffer().changeRefsIfUnique(params()["name"],
- p["name"], Inset::REF_CODE);
- setParams(p);
+ updateCommand(p["name"]);
break;
}
- default:
- InsetCommand::doDispatch(cur, cmd);
+ case LFUN_LABEL_COPY_AS_REF: {
+ InsetCommandParams p(REF_CODE, "ref");
+ p["reference"] = getParam("name");
+ cap::clearSelection();
+ cap::copyInset(cur, new InsetRef(buffer_, p), getParam("name"));
break;
}
-}
+ case LFUN_LABEL_INSERT_AS_REF: {
+ InsetCommandParams p(REF_CODE, "ref");
+ p["reference"] = getParam("name");
+ string const data = InsetCommand::params2string("ref", p);
+ lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data));
+ break;
+ }
-int InsetLabel::latex(Buffer const &, odocstream & os,
- OutputParams const &) const
-{
- os << support::escape(getCommand());
- return 0;
+ default:
+ InsetCommand::doDispatch(cur, cmd);
+ break;
+ }
}
-int InsetLabel::plaintext(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
{
docstring const str = getParam("name");
os << '<' << str << '>';
}
-int InsetLabel::docbook(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
{
os << "<!-- anchor id=\""
- << sgml::cleanID(buf, runparams, getParam("name"))
+ << sgml::cleanID(buffer(), runparams, getParam("name"))
<< "\" -->";
return 0;
}
+docstring InsetLabel::xhtml(XHTMLStream & xs, OutputParams const &) const
+{
+ // FIXME XHTML
+ // Unfortunately, the name attribute has been deprecated, so we have to use
+ // id here to get the document to validate as XHTML 1.1. This will cause a
+ // problem with some browsers, though, I'm sure. (Guess which!) So we will
+ // have to figure out what to do about this later.
+ string const attr = "id=\"" + html::cleanAttr(to_utf8(getParam("name"))) + "\"";
+ xs << html::CompTag("a", attr);
+ return docstring();
+}
+
+
} // namespace lyx