X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetLabel.cpp;h=35d5f543b8f86e4a0d32fa3799b3192c0ecd48e2;hb=e15d3d35cba7266d8a1a22c7e4cd92d12599e103;hp=95fb3e6bb5af59525152f8c3a44a5e8995a2ff24;hpb=897436efbb9bd641b61467d185a2dfae9839e575;p=lyx.git diff --git a/src/insets/InsetLabel.cpp b/src/insets/InsetLabel.cpp index 95fb3e6bb5..35d5f543b8 100644 --- a/src/insets/InsetLabel.cpp +++ b/src/insets/InsetLabel.cpp @@ -3,7 +3,7 @@ * 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. */ @@ -12,89 +12,265 @@ #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 "InsetList.h" -#include "Text.h" -#include "Paragraph.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" -#include "support/std_ostream.h" +using namespace std; +using namespace lyx::support; namespace lyx { -using support::escape; -using std::string; -using std::ostream; -using std::vector; +InsetLabel::InsetLabel(Buffer * buf, InsetCommandParams const & p) + : InsetCommand(buf, p) +{} -InsetLabel::InsetLabel(InsetCommandParams const & p) - : InsetCommand(p, "label") -{} +void InsetLabel::initView() +{ + // This seems to be used only for inset creation. + // Therefore we do not update refs here, since this would + // erroneously change refs from existing duplicate labels + // (#8141). + updateLabel(getParam("name")); +} + + +void InsetLabel::uniqueLabel(docstring & label) const +{ + docstring const new_label = label; + int i = 1; + while (buffer().insetLabel(label)) { + label = new_label + '-' + convert(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)); + } +} + + +void InsetLabel::updateLabel(docstring const & new_label) +{ + docstring label = new_label; + uniqueLabel(label); + setParam("name", label); +} -std::auto_ptr InsetLabel::doClone() const +void InsetLabel::updateLabelAndRefs(docstring const & new_label, + Cursor * cursor) { - return std::auto_ptr(new InsetLabel(params())); + docstring const old_label = getParam("name"); + docstring label = new_label; + uniqueLabel(label); + if (label == old_label) + return; + + buffer().undo().beginUndoGroup(); + if (cursor) + cursor->recordUndo(); + setParam("name", label); + updateReferences(old_label, label); + buffer().undo().endUndoGroup(); +} + + +void InsetLabel::updateReferences(docstring const & old_label, + docstring const & new_label) +{ + Buffer::References const & refs = buffer().references(old_label); + Buffer::References::const_iterator it = refs.begin(); + Buffer::References::const_iterator end = refs.end(); + for (; it != end; ++it) { + buffer().undo().recordUndo(CursorData(it->second)); + if (it->first->lyxCode() == MATH_REF_CODE) { + InsetMathRef * mi = it->first->asInsetMath()->asRefInset(); + mi->changeTarget(new_label); + } else { + InsetCommand * ref = it->first->asInsetCommand(); + ref->setParam("reference", new_label); + } + } } -void InsetLabel::getLabelList(Buffer const &, std::vector & list) const +ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */) { - list.push_back(getParam("name")); + static ParamInfo param_info_; + if (param_info_.empty()) + param_info_.add("name", ParamInfo::LATEX_REQUIRED, + ParamInfo::HANDLING_ESCAPE); + return param_info_; } -docstring const InsetLabel::getScreenLabel(Buffer const &) const +docstring InsetLabel::screenLabel() const { - return getParam("name"); + return screen_label_; +} + + +void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype) +{ + 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 == OutputUpdate) { + // 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, bool output_active) const +{ + docstring const & label = getParam("name"); + Toc & toc = buffer().tocBackend().toc("label"); + if (buffer().insetLabel(label) != this) { + toc.push_back(TocItem(cpit, 0, screen_label_, output_active)); + return; + } + toc.push_back(TocItem(cpit, 0, screen_label_, output_active)); + 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, + it->first->asInsetMath()->asRefInset()->screenLabel(), + output_active)); + else + toc.push_back(TocItem(ref_pit, 1, + static_cast(it->first)->getTOCString(), + output_active)); + } +} + + +bool InsetLabel::getStatus(Cursor & cur, FuncRequest const & cmd, + FuncStatus & status) const +{ + bool enabled; + switch (cmd.action()) { + case LFUN_LABEL_INSERT_AS_REFERENCE: + case LFUN_LABEL_COPY_AS_REFERENCE: + enabled = true; + break; + case LFUN_INSET_MODIFY: + if (cmd.getArg(0) == "changetype") { + // this is handled by InsetCommand, + // but not by InsetLabel. + enabled = false; + break; + } + default: + return InsetCommand::getStatus(cur, cmd, status); + } + + status.setEnabled(enabled); + return true; } void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd) { - switch (cmd.action) { + switch (cmd.action()) { case LFUN_INSET_MODIFY: { - InsetCommandParams p("label"); + // the only other option here is "changetype", and we + // do not have different types. + if (cmd.getArg(0) != "label") { + cur.undispatched(); + return; + } + InsetCommandParams p(LABEL_CODE); // FIXME UNICODE - InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p); + InsetCommand::string2params(to_utf8(cmd.argument()), p); if (p.getCmdName().empty()) { - cur.noUpdate(); + cur.noScreenUpdate(); break; } - if (p["name"] != params()["name"]) - cur.bv().buffer()->changeRefsIfUnique(params()["name"], - p["name"], Inset::REF_CODE); - setParams(p); + if (p["name"] != params()["name"]) { + // undo is handled in updateLabelAndRefs + updateLabelAndRefs(p["name"], &cur); + } + cur.forceBufferUpdate(); break; } - default: - InsetCommand::doDispatch(cur, cmd); + case LFUN_LABEL_COPY_AS_REFERENCE: { + 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_REFERENCE: { + InsetCommandParams p(REF_CODE, "ref"); + p["reference"] = getParam("name"); + string const data = InsetCommand::params2string(p); + lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data)); + break; + } -int InsetLabel::latex(Buffer const &, odocstream & os, - OutputParams const &) const -{ - os << escape(getCommand()); - return 0; + default: + InsetCommand::doDispatch(cur, cmd); + break; + } } -int InsetLabel::plaintext(Buffer const &, odocstream & os, - OutputParams const &) const +int InsetLabel::plaintext(odocstringstream & os, + OutputParams const &, size_t) const { docstring const str = getParam("name"); os << '<' << str << '>'; @@ -102,14 +278,26 @@ int InsetLabel::plaintext(Buffer const &, odocstream & os, } -int InsetLabel::docbook(Buffer const & buf, odocstream & os, - OutputParams const & runparams) const +int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const { os << ""; 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