X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetLabel.cpp;h=4a1cc453ff8eb120608144161c62b1ae56a3171a;hb=96dea61f22c04529e726cab36acf0240d41fa778;hp=b0cf6dfcf55e00d05c2c85f55666c8d897b606f5;hpb=7c392af6eab5e06a4836146859cbd9f2c3764420;p=lyx.git diff --git a/src/insets/InsetLabel.cpp b/src/insets/InsetLabel.cpp index b0cf6dfcf5..4a1cc453ff 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,13 +12,33 @@ #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" @@ -28,74 +48,253 @@ using namespace lyx::support; namespace lyx { -InsetLabel::InsetLabel(InsetCommandParams const & p) - : InsetCommand(p, "label") +InsetLabel::InsetLabel(Buffer * buf, InsetCommandParams const & p) + : InsetCommand(buf, p) {} -CommandInfo const * InsetLabel::findInfo(string const & /* cmdName */) +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; + bool ambiguous = false; + while (buffer().activeLabel(label)) { + label = new_label + '-' + convert(i); + ++i; + ambiguous = true; + } + if (ambiguous) { + // 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); +} + + +void InsetLabel::updateLabelAndRefs(docstring const & new_label, + Cursor * cursor) +{ + docstring const old_label = getParam("name"); + docstring label = new_label; + uniqueLabel(label); + if (label == old_label) + return; + + // This handles undo groups automagically + UndoGroupHelper ugh(&buffer()); + if (cursor) + cursor->recordUndo(); + setParam("name", label); + updateReferences(old_label, label); +} + + +void InsetLabel::updateReferences(docstring const & old_label, + docstring const & new_label) +{ + UndoGroupHelper ugh; + 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) { + ugh.resetBuffer(it->second.buffer()); + it->second.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); + } + } +} + + +ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */) +{ + static ParamInfo param_info_; + if (param_info_.empty()) + param_info_.add("name", ParamInfo::LATEX_REQUIRED, + ParamInfo::HANDLING_ESCAPE); + return param_info_; +} + + +docstring InsetLabel::screenLabel() const { - static const char * const paramnames[] = {"name", ""}; - static const bool isoptional[] = {false}; - static const CommandInfo info = {1, paramnames, isoptional}; - return &info; + return screen_label_; } -Inset * InsetLabel::clone() const +void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype) { - return new InsetLabel(params()); + docstring const & label = getParam("name"); + + // Check if this one is deleted (ct) + Paragraph const & para = par.paragraph(); + bool active = !para.isDeleted(par.pos()); + // If not, check whether we are in a deleted inset + if (active) { + for (size_type sl = 0 ; sl < par.depth() ; ++sl) { + Paragraph const & outer_par = par[sl].paragraph(); + if (outer_par.isDeleted(par[sl].pos())) { + active = false; + break; + } + } + } + + if (buffer().activeLabel(label) && active) { + // Problem: We already have an active InsetLabel with the same name! + screen_label_ = _("DUPLICATE: ") + label; + return; + } + buffer().setInsetLabel(label, this, active); + 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::getLabelList(Buffer const &, vector & list) const +void InsetLabel::addToToc(DocIterator const & cpit, bool output_active, + UpdateType, TocBackend & backend) const { - list.push_back(getParam("name")); + docstring const & label = getParam("name"); + // inactive labels get a cross mark + if (buffer().insetLabel(label, true) != this) + output_active = false; + + // We put both active and inactive labels to the outliner + shared_ptr toc = backend.toc("label"); + toc->push_back(TocItem(cpit, 0, screen_label_, output_active)); + // The refs get assigned only to the active label. If no active one exists, + // assign the (BROKEN) refs to the first inactive one. + if (buffer().insetLabel(label, true) == this || !buffer().activeLabel(label)) { + for (auto const & p : buffer().references(label)) { + DocIterator const ref_pit(p.second); + if (p.first->lyxCode() == MATH_REF_CODE) + toc->push_back(TocItem(ref_pit, 1, + p.first->asInsetMath()->asRefInset()->screenLabel(), + output_active)); + else + toc->push_back(TocItem(ref_pit, 1, + static_cast(p.first)->getTOCString(), + output_active)); + } + } } -docstring const InsetLabel::getScreenLabel(Buffer const &) const +bool InsetLabel::getStatus(Cursor & cur, FuncRequest const & cmd, + FuncStatus & status) const { - return getParam("name"); + 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; + } + // no "changetype": + // fall through + 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: { + // 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"], 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 << '>'; @@ -103,14 +302,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. + docstring const attr = "id=\"" + html::cleanAttr(getParam("name")) + '"'; + xs << html::CompTag("a", to_utf8(attr)); + return docstring(); +} + + } // namespace lyx