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 "BufferView.h"
  20 #include "DispatchResult.h"
  21 #include "FuncRequest.h"
  22 #include "InsetIterator.h"
  23 #include "ParIterator.h"
  24 #include "sgml.h"
  25 #include "Text.h"
  26 #include "TocBackend.h"
  27
  28 #include "frontends/alert.h"
  29
  30 #include "support/convert.h"
  31 #include "support/lyxalgo.h"
  32 #include "support/gettext.h"
  33 #include "support/lstrings.h"
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38 namespace lyx {
  39
  40
  41 InsetLabel::InsetLabel(InsetCommandParams const & p)
  42         : InsetCommand(p, "label")
  43 {}
  44
  45
  46 void InsetLabel::validate()
  47 {
  48         update(getParam("name"));
  49 }
  50
  51
  52 void InsetLabel::update(docstring const & new_label, bool updaterefs)
  53 {
  54         docstring const old_label = getParam("name");
  55         docstring label = new_label;
  56         int i = 1;
  57         while (buffer().insetLabel(label)) {
  58                 label = new_label + '-' + convert<docstring>(i);
  59                 ++i;
  60         }
  61
  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 been changed to %2$s."), new_label, label));
  67         }
  68
  69         setParam("name", label);
  70
  71         if (updaterefs) {
  72                 Buffer::References const & refs = buffer().references(old_label);
  73                 Buffer::References::const_iterator it = refs.begin();
  74                 Buffer::References::const_iterator end = refs.end();
  75                 for (; it != end; ++it)
  76                         it->first->setParam("reference", label);
  77         }
  78
  79         // We need an update of the Buffer reference cache. This is achieved by
  80         // updateLabel().
  81         lyx::updateLabels(buffer());
  82 }
  83
  84
  85 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
  86 {
  87         static ParamInfo param_info_;
  88         if (param_info_.empty()) {
  89                 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
  90         }
  91         return param_info_;
  92 }
  93
  94
  95 void InsetLabel::getLabelList(vector<docstring> & list) const
  96 {
  97         list.push_back(getParam("name"));
  98 }
  99
 100
 101 docstring InsetLabel::screenLabel() const
 102 {
 103         return getParam("name");
 104 }
 105
 106
 107 void InsetLabel::updateLabels(ParIterator const &)
 108 {
 109         docstring const & label = getParam("name");
 110         if (buffer().insetLabel(label))
 111                 // Problem: We already have an InsetLabel with the same name!
 112                 return;
 113         buffer().setInsetLabel(label, this);
 114 }
 115
 116
 117 void InsetLabel::addToToc(ParConstIterator const & cpit) const
 118 {
 119         docstring const & label = getParam("name");
 120         Toc & toc = buffer().tocBackend().toc("label");
 121         if (buffer().insetLabel(label) != this) {
 122                 toc.push_back(TocItem(cpit, 0, _("DUPLICATE: ") + label));
 123                 return;
 124         }
 125         toc.push_back(TocItem(cpit, 0, label));
 126         Buffer::References const & refs = buffer().references(label);
 127         Buffer::References::const_iterator it = refs.begin();
 128         Buffer::References::const_iterator end = refs.end();
 129         for (; it != end; ++it) {
 130                 ParConstIterator const ref_pit(it->second);
 131                 toc.push_back(TocItem(ref_pit, 1, it->first->screenLabel()));
 132         }
 133 }
 134
 135
 136 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
 137 {
 138         switch (cmd.action) {
 139
 140         case LFUN_INSET_MODIFY: {
 141                 InsetCommandParams p(LABEL_CODE);
 142                 // FIXME UNICODE
 143                 InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p);
 144                 if (p.getCmdName().empty()) {
 145                         cur.noUpdate();
 146                         break;
 147                 }
 148                 docstring old_name = params()["name"];
 149                 update(p["name"]);
 150                 if (params()["name"] != old_name)
 151                         cur.bv().buffer().changeRefsIfUnique(old_name,
 152                                 params()["name"], REF_CODE);
 153                 break;
 154         }
 155
 156         default:
 157                 InsetCommand::doDispatch(cur, cmd);
 158                 break;
 159         }
 160 }
 161
 162
 163 int InsetLabel::latex(odocstream & os, OutputParams const &) const
 164 {
 165         os << escape(getCommand());
 166         return 0;
 167 }
 168
 169
 170 int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
 171 {
 172         docstring const str = getParam("name");
 173         os << '<' << str << '>';
 174         return 2 + str.size();
 175 }
 176
 177
 178 int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
 179 {
 180         os << "<!-- anchor id=\""
 181            << sgml::cleanID(buffer(), runparams, getParam("name"))
 182            << "\" -->";
 183         return 0;
 184 }
 185
 186
 187 } // namespace lyx