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 "Buffer.h"
  16 #include "BufferView.h"
  17 #include "DispatchResult.h"
  18 #include "FuncRequest.h"
  19 #include "ParIterator.h"
  20 #include "sgml.h"
  21 #include "Text.h"
  22 #include "TocBackend.h"
  23
  24 #include "support/lstrings.h"
  25 #include "support/lyxalgo.h"
  26
  27 using namespace std;
  28 using namespace lyx::support;
  29
  30 namespace lyx {
  31
  32
  33 InsetLabel::InsetLabel(InsetCommandParams const & p)
  34         : InsetCommand(p, "label")
  35 {}
  36
  37
  38 ParamInfo const & InsetLabel::findInfo(string const & /* cmdName */)
  39 {
  40         static ParamInfo param_info_;
  41         if (param_info_.empty()) {
  42                 param_info_.add("name", ParamInfo::LATEX_REQUIRED);
  43         }
  44         return param_info_;
  45 }
  46
  47
  48 Inset * InsetLabel::clone() const
  49 {
  50         return new InsetLabel(params());
  51 }
  52
  53
  54 void InsetLabel::getLabelList(Buffer const &, vector<docstring> & list) const
  55 {
  56         list.push_back(getParam("name"));
  57 }
  58
  59
  60 docstring const InsetLabel::getScreenLabel(Buffer const &) const
  61 {
  62         return getParam("name");
  63 }
  64
  65
  66 void InsetLabel::addToToc(Buffer const & buf,
  67         ParConstIterator const & cpit) const
  68 {
  69         Toc & toc = buf.tocBackend().toc("label");
  70         toc.push_back(TocItem(cpit, 0, getScreenLabel(buf)));
  71 }
  72
  73
  74 void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
  75 {
  76         switch (cmd.action) {
  77
  78         case LFUN_INSET_MODIFY: {
  79                 InsetCommandParams p(LABEL_CODE);
  80                 // FIXME UNICODE
  81                 InsetCommandMailer::string2params("label", to_utf8(cmd.argument()), p);
  82                 if (p.getCmdName().empty()) {
  83                         cur.noUpdate();
  84                         break;
  85                 }
  86                 if (p["name"] != params()["name"])
  87                         cur.bv().buffer().changeRefsIfUnique(params()["name"],
  88                                         p["name"], REF_CODE);
  89                 setParams(p);
  90                 break;
  91         }
  92
  93         default:
  94                 InsetCommand::doDispatch(cur, cmd);
  95                 break;
  96         }
  97 }
  98
  99
 100 int InsetLabel::latex(Buffer const &, odocstream & os,
 101                       OutputParams const &) const
 102 {
 103         os << escape(getCommand());
 104         return 0;
 105 }
 106
 107
 108 int InsetLabel::plaintext(Buffer const &, odocstream & os,
 109                           OutputParams const &) const
 110 {
 111         docstring const str = getParam("name");
 112         os << '<' << str << '>';
 113         return 2 + str.size();
 114 }
 115
 116
 117 int InsetLabel::docbook(Buffer const & buf, odocstream & os,
 118                         OutputParams const & runparams) const
 119 {
 120         os << "<!-- anchor id=\""
 121            << sgml::cleanID(buf, runparams, getParam("name"))
 122            << "\" -->";
 123         return 0;
 124 }
 125
 126
 127 } // namespace lyx