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)
  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         Buffer::References const & refs = buffer().references(old_label);
  72         Buffer::References::const_iterator it = refs.begin();
  73         Buffer::References::const_iterator end = refs.end();
  74         for (; it != end; ++it)
  75                 it->first->setParam("reference", label);
  76
  77         // We need an update of the Buffer reference cache. This is achieved by
  78         // updateLabel().
  79         lyx::updateLabels(buffer());
  80 }
  81
  82
  83 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
  84 {
  85         static ParamInfo param_info_;
  86         if (param_info_.empty()) {
  87                 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
  88         }
  89         return param_info_;
  90 }
  91
  92
  93 void InsetLabel::getLabelList(vector<docstring> & list) const
  94 {
  95         list.push_back(getParam("name"));
  96 }
  97
  98
  99 docstring InsetLabel::screenLabel() const
 100 {
 101         return getParam("name");
 102 }
 103
 104
 105 void InsetLabel::updateLabels(ParIterator const & it)
 106 {
 107         docstring const & label = getParam("name");
 108         if (buffer().insetLabel(label))
 109                 // Problem: We already have an InsetLabel with the same name!
 110                 return;
 111         buffer().setInsetLabel(label, this);
 112 }
 113
 114
 115 void InsetLabel::addToToc(ParConstIterator const & cpit) const
 116 {
 117         docstring const & label = getParam("name");
 118         Toc & toc = buffer().tocBackend().toc("label");
 119         if (buffer().insetLabel(label) != this) {
 120                 toc.push_back(TocItem(cpit, 0, _("DUPLICATE: ") + label));
 121                 return;
 122         }
 123         toc.push_back(TocItem(cpit, 0, label));
 124         Buffer::References const & refs = buffer().references(label);
 125         Buffer::References::const_iterator it = refs.begin();
 126         Buffer::References::const_iterator end = refs.end();
 127         for (; it != end; ++it) {
 128                 ParConstIterator const ref_pit(it->second);
 129                 toc.push_back(TocItem(ref_pit, 1, it->first->screenLabel()));
 130         }
 131 }
 132
 133
 134 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
 135 {
 136         switch (cmd.action) {
 137
 138         case LFUN_INSET_MODIFY: {
 139                 InsetCommandParams p(LABEL_CODE);
 140                 // FIXME UNICODE
 141                 InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p);
 142                 if (p.getCmdName().empty()) {
 143                         cur.noUpdate();
 144                         break;
 145                 }
 146                 update(p["name"]);
 147                 break;
 148         }
 149
 150         default:
 151                 InsetCommand::doDispatch(cur, cmd);
 152                 break;
 153         }
 154 }
 155
 156
 157 int InsetLabel::latex(odocstream & os, OutputParams const &) const
 158 {
 159         os << escape(getCommand());
 160         return 0;
 161 }
 162
 163
 164 int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
 165 {
 166         docstring const str = getParam("name");
 167         os << '<' << str << '>';
 168         return 2 + str.size();
 169 }
 170
 171
 172 int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
 173 {
 174         os << "<!-- anchor id=\""
 175            << sgml::cleanID(buffer(), runparams, getParam("name"))
 176            << "\" -->";
 177         return 0;
 178 }
 179
 180
 181 } // namespace lyx