src/insets/InsetLabel.cpp

   1 /**
   2  * \file InsetLabel.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetLabel.h"
  14
  15 #include "InsetRef.h"
  16
  17 #include "buffer_funcs.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "BufferView.h"
  21 #include "CutAndPaste.h"
  22 #include "DispatchResult.h"
  23 #include "FuncRequest.h"
  24 #include "FuncStatus.h"
  25 #include "InsetIterator.h"
  26 #include "Language.h"
  27 #include "LyX.h"
  28 #include "output_xhtml.h"
  29 #include "ParIterator.h"
  30 #include "sgml.h"
  31 #include "Text.h"
  32 #include "TextClass.h"
  33 #include "TocBackend.h"
  34
  35 #include "mathed/InsetMathHull.h"
  36 #include "mathed/InsetMathRef.h"
  37
  38 #include "frontends/alert.h"
  39
  40 #include "support/convert.h"
  41 #include "support/gettext.h"
  42 #include "support/lstrings.h"
  43 #include "support/lyxalgo.h"
  44
  45 using namespace std;
  46 using namespace lyx::support;
  47
  48 namespace lyx {
  49
  50
  51 InsetLabel::InsetLabel(Buffer * buf, InsetCommandParams const & p)
  52         : InsetCommand(buf, p)
  53 {}
  54
  55
  56 void InsetLabel::initView()
  57 {
  58         // This seems to be used only for inset creation.
  59         // Therefore we do not update refs here, since this would
  60         // erroneously change refs from existing duplicate labels
  61         // (#8141).
  62         updateLabel(getParam("name"));
  63 }
  64
  65
  66 void InsetLabel::uniqueLabel(docstring & label) const
  67 {
  68         docstring const new_label = label;
  69         int i = 1;
  70         bool ambiguous = false;
  71         while (buffer().activeLabel(label)) {
  72                 label = new_label + '-' + convert<docstring>(i);
  73                 ++i;
  74                 ambiguous = true;
  75         }
  76         if (ambiguous) {
  77                 // Warn the user that the label has been changed to something else.
  78                 frontend::Alert::warning(_("Label names must be unique!"),
  79                         bformat(_("The label %1$s already exists,\n"
  80                         "it will be changed to %2$s."), new_label, label));
  81         }
  82 }
  83
  84
  85 void InsetLabel::updateLabel(docstring const & new_label)
  86 {
  87         docstring label = new_label;
  88         uniqueLabel(label);
  89         setParam("name", label);
  90 }
  91
  92
  93 void InsetLabel::updateLabelAndRefs(docstring const & new_label,
  94                 Cursor * cursor)
  95 {
  96         docstring const old_label = getParam("name");
  97         docstring label = new_label;
  98         uniqueLabel(label);
  99         if (label == old_label)
 100                 return;
 101
 102         // This handles undo groups automagically
 103         UndoGroupHelper ugh(&buffer());
 104         if (cursor)
 105                 cursor->recordUndo();
 106         setParam("name", label);
 107         updateReferences(old_label, label);
 108 }
 109
 110
 111 void InsetLabel::updateReferences(docstring const & old_label,
 112                 docstring const & new_label)
 113 {
 114         UndoGroupHelper ugh;
 115         for (auto const & p: buffer().references(old_label)) {
 116                 ugh.resetBuffer(p.second.buffer());
 117                 CursorData(p.second).recordUndo();
 118                 if (p.first->lyxCode() == MATH_REF_CODE) {
 119                         InsetMathRef * mi = p.first->asInsetMath()->asRefInset();
 120                         mi->changeTarget(new_label);
 121                 } else {
 122                         InsetCommand * ref = p.first->asInsetCommand();
 123                         ref->setParam("reference", new_label);
 124                 }
 125         }
 126 }
 127
 128
 129 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
 130 {
 131         static ParamInfo param_info_;
 132         if (param_info_.empty())
 133                 param_info_.add("name", ParamInfo::LATEX_REQUIRED,
 134                                 ParamInfo::HANDLING_ESCAPE);
 135         return param_info_;
 136 }
 137
 138
 139 docstring InsetLabel::screenLabel() const
 140 {
 141         return screen_label_;
 142 }
 143
 144
 145 void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype)
 146 {
 147         docstring const & label = getParam("name");
 148
 149         // Check if this one is deleted (ct)
 150         Paragraph const & para = par.paragraph();
 151         bool const active = !para.isDeleted(par.pos());
 152
 153         if (buffer().activeLabel(label) && active) {
 154                 // Problem: We already have an active InsetLabel with the same name!
 155                 screen_label_ = _("DUPLICATE: ") + label;
 156                 return;
 157         }
 158         buffer().setInsetLabel(label, this, active);
 159         screen_label_ = label;
 160
 161         if (utype == OutputUpdate) {
 162                 // save info on the active counter
 163                 Counters const & cnts =
 164                         buffer().masterBuffer()->params().documentClass().counters();
 165                 active_counter_ = cnts.currentCounter();
 166                 Language const * lang = par->getParLanguage(buffer().params());
 167                 if (lang && !active_counter_.empty()) {
 168                         counter_value_ = cnts.theCounter(active_counter_, lang->code());
 169                         pretty_counter_ = cnts.prettyCounter(active_counter_, lang->code());
 170                 } else {
 171                         counter_value_ = from_ascii("#");
 172                         pretty_counter_ = from_ascii("#");
 173                 }
 174         }
 175 }
 176
 177
 178 void InsetLabel::addToToc(DocIterator const & cpit, bool output_active,
 179                                                   UpdateType, TocBackend & backend) const
 180 {
 181         docstring const & label = getParam("name");
 182         if (!buffer().activeLabel(label))
 183                 return;
 184
 185         shared_ptr<Toc> toc = backend.toc("label");
 186         if (buffer().insetLabel(label, true) != this) {
 187                 toc->push_back(TocItem(cpit, 0, screen_label_, output_active));
 188         } else {
 189                 toc->push_back(TocItem(cpit, 0, screen_label_, output_active));
 190                 for (auto const & p : buffer().references(label)) {
 191                         DocIterator const ref_pit(p.second);
 192                         if (p.first->lyxCode() == MATH_REF_CODE)
 193                                 toc->push_back(TocItem(ref_pit, 1,
 194                                                 p.first->asInsetMath()->asRefInset()->screenLabel(),
 195                                                 output_active));
 196                         else
 197                                 toc->push_back(TocItem(ref_pit, 1,
 198                                                 static_cast<InsetRef *>(p.first)->getTOCString(),
 199                                                 output_active));
 200                 }
 201         }
 202 }
 203
 204
 205 bool InsetLabel::getStatus(Cursor & cur, FuncRequest const & cmd,
 206                            FuncStatus & status) const
 207 {
 208         bool enabled;
 209         switch (cmd.action()) {
 210         case LFUN_LABEL_INSERT_AS_REFERENCE:
 211         case LFUN_LABEL_COPY_AS_REFERENCE:
 212                 enabled = true;
 213                 break;
 214         case LFUN_INSET_MODIFY:
 215                 if (cmd.getArg(0) == "changetype") {
 216                         // this is handled by InsetCommand,
 217                         // but not by InsetLabel.
 218                         enabled = false;
 219                         break;
 220                 }
 221                 // no "changetype":
 222                 // fall through
 223         default:
 224                 return InsetCommand::getStatus(cur, cmd, status);
 225         }
 226
 227         status.setEnabled(enabled);
 228         return true;
 229 }
 230
 231
 232 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
 233 {
 234         switch (cmd.action()) {
 235
 236         case LFUN_INSET_MODIFY: {
 237                 // the only other option here is "changetype", and we
 238                 // do not have different types.
 239                 if (cmd.getArg(0) != "label") {
 240                         cur.undispatched();
 241                         return;
 242                 }
 243                 InsetCommandParams p(LABEL_CODE);
 244                 // FIXME UNICODE
 245                 InsetCommand::string2params(to_utf8(cmd.argument()), p);
 246                 if (p.getCmdName().empty()) {
 247                         cur.noScreenUpdate();
 248                         break;
 249                 }
 250                 if (p["name"] != params()["name"]) {
 251                         // undo is handled in updateLabelAndRefs
 252                         updateLabelAndRefs(p["name"], &cur);
 253                 }
 254                 cur.forceBufferUpdate();
 255                 break;
 256         }
 257
 258         case LFUN_LABEL_COPY_AS_REFERENCE: {
 259                 InsetCommandParams p(REF_CODE, "ref");
 260                 p["reference"] = getParam("name");
 261                 cap::clearSelection();
 262                 cap::copyInset(cur, new InsetRef(buffer_, p), getParam("name"));
 263                 break;
 264         }
 265
 266         case LFUN_LABEL_INSERT_AS_REFERENCE: {
 267                 InsetCommandParams p(REF_CODE, "ref");
 268                 p["reference"] = getParam("name");
 269                 string const data = InsetCommand::params2string(p);
 270                 lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data));
 271                 break;
 272         }
 273
 274         default:
 275                 InsetCommand::doDispatch(cur, cmd);
 276                 break;
 277         }
 278 }
 279
 280
 281 int InsetLabel::plaintext(odocstringstream & os,
 282         OutputParams const &, size_t) const
 283 {
 284         docstring const str = getParam("name");
 285         os << '<' << str << '>';
 286         return 2 + str.size();
 287 }
 288
 289
 290 int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
 291 {
 292         os << "<!-- anchor id=\""
 293            << sgml::cleanID(buffer(), runparams, getParam("name"))
 294            << "\" -->";
 295         return 0;
 296 }
 297
 298
 299 docstring InsetLabel::xhtml(XHTMLStream & xs, OutputParams const &) const
 300 {
 301         // FIXME XHTML
 302         // Unfortunately, the name attribute has been deprecated, so we have to use
 303         // id here to get the document to validate as XHTML 1.1. This will cause a
 304         // problem with some browsers, though, I'm sure. (Guess which!) So we will
 305         // have to figure out what to do about this later.
 306         docstring const attr = "id=\"" + html::cleanAttr(getParam("name")) + '"';
 307         xs << html::CompTag("a", to_utf8(attr));
 308         return docstring();
 309 }
 310
 311
 312 } // namespace lyx