src/insets/InsetCommand.cpp

   1 /**
   2  * \file InsetCommand.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetCommand.h"
  15
  16 #include "Buffer.h"
  17 #include "BufferView.h"
  18 #include "DispatchResult.h"
  19 #include "FuncRequest.h"
  20 #include "FuncStatus.h"
  21 #include "Lexer.h"
  22 #include "MetricsInfo.h"
  23
  24 #include "insets/InsetBox.h"
  25 #include "insets/InsetBranch.h"
  26 #include "insets/InsetCommand.h"
  27 #include "insets/InsetERT.h"
  28 #include "insets/InsetExternal.h"
  29 #include "insets/InsetFloat.h"
  30 #include "insets/InsetGraphics.h"
  31 #include "insets/InsetInclude.h"
  32 #include "insets/InsetListings.h"
  33 #include "insets/InsetNote.h"
  34 #include "insets/InsetPhantom.h"
  35 #include "insets/InsetSpace.h"
  36 #include "insets/InsetTabular.h"
  37 #include "insets/InsetVSpace.h"
  38 #include "insets/InsetWrap.h"
  39
  40 #include "support/debug.h"
  41 #include "support/gettext.h"
  42
  43 #include "frontends/Application.h"
  44
  45 #include <sstream>
  46
  47 using namespace std;
  48
  49
  50 namespace lyx {
  51
  52 // FIXME Would it now be possible to use the InsetCode in
  53 // place of the mailer name and recover that information?
  54 InsetCommand::InsetCommand(Buffer * buf, InsetCommandParams const & p,
  55                            string const & mailer_name)
  56         : Inset(buf), p_(p),
  57           mailer_name_(mailer_name),
  58           mouse_hover_()
  59 {}
  60
  61
  62 // The sole purpose of this copy constructor is to make sure
  63 // that the mouse_hover_ map is not copied and remains empty.
  64 InsetCommand::InsetCommand(InsetCommand const & rhs)
  65         : Inset(rhs), p_(rhs.p_), mailer_name_(rhs.mailer_name_)
  66 {}
  67
  68
  69 InsetCommand::~InsetCommand()
  70 {
  71         if (!mailer_name_.empty())
  72                 hideDialogs(mailer_name_, this);
  73         map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
  74         map<BufferView const *, bool>::iterator end = mouse_hover_.end();
  75         for (; it != end; ++it)
  76                 if (it->second)
  77                         it->first->clearLastInset(this);
  78 }
  79
  80
  81 void InsetCommand::metrics(MetricsInfo & mi, Dimension & dim) const
  82 {
  83         button_.update(screenLabel(), editable() || hasSettings());
  84         button_.metrics(mi, dim);
  85 }
  86
  87
  88 bool InsetCommand::setMouseHover(BufferView const * bv, bool mouse_hover)
  89 {
  90         mouse_hover_[bv] = mouse_hover;
  91         return true;
  92 }
  93
  94
  95 void InsetCommand::draw(PainterInfo & pi, int x, int y) const
  96 {
  97         button_.setRenderState(mouse_hover_[pi.base.bv]);
  98         button_.draw(pi, x, y);
  99 }
 100
 101
 102 void InsetCommand::setParam(std::string const & name, docstring const & value)
 103 {
 104         p_[name] = value;
 105 }
 106
 107
 108 docstring const & InsetCommand::getParam(std::string const & name) const
 109 {
 110         return p_[name];
 111 }
 112
 113
 114 void InsetCommand::setParams(InsetCommandParams const & p)
 115 {
 116         p_ = p;
 117         initView();
 118 }
 119
 120
 121 int InsetCommand::latex(odocstream & os, OutputParams const & runparams_in) const
 122 {
 123         OutputParams runparams = runparams_in;
 124         os << getCommand(runparams);
 125         return 0;
 126 }
 127
 128
 129 int InsetCommand::plaintext(odocstream & os, OutputParams const &) const
 130 {
 131         docstring const str = "[" + buffer().B_("LaTeX Command: ")
 132                 + from_utf8(getCmdName()) + "]";
 133         os << str;
 134         return str.size();
 135 }
 136
 137
 138 int InsetCommand::docbook(odocstream &, OutputParams const &) const
 139 {
 140         return 0;
 141 }
 142
 143
 144 void InsetCommand::doDispatch(Cursor & cur, FuncRequest & cmd)
 145 {
 146         switch (cmd.action()) {
 147         case LFUN_INSET_MODIFY: {
 148                 if (cmd.getArg(0) == "changetype") {
 149                         p_.setCmdName(cmd.getArg(1));
 150                         initView();
 151                         break;
 152                 }
 153                 InsetCommandParams p(p_.code());
 154                 InsetCommand::string2params(mailer_name_, to_utf8(cmd.argument()), p);
 155                 if (p.getCmdName().empty())
 156                         cur.noScreenUpdate();
 157                 else
 158                         setParams(p);
 159                 // FIXME We might also want to check here if this one is in the TOC.
 160                 // But I think most of those are labeled.
 161                 if (isLabeled())
 162                         cur.forceBufferUpdate();
 163                 break;
 164         }
 165
 166         case LFUN_INSET_DIALOG_UPDATE: {
 167                 string const name = to_utf8(cmd.argument());
 168                 cur.bv().updateDialog(name, params2string(name, params()));
 169                 break;
 170         }
 171
 172         default:
 173                 Inset::doDispatch(cur, cmd);
 174                 break;
 175         }
 176
 177 }
 178
 179
 180 bool InsetCommand::getStatus(Cursor & cur, FuncRequest const & cmd,
 181         FuncStatus & status) const
 182 {
 183         switch (cmd.action()) {
 184         // suppress these
 185         case LFUN_ERT_INSERT:
 186                 status.setEnabled(false);
 187                 return true;
 188
 189         // we handle these
 190         case LFUN_INSET_MODIFY:
 191                 if (cmd.getArg(0) == "changetype") {
 192                         string const newtype = cmd.getArg(1);
 193                         status.setEnabled(p_.isCompatibleCommand(p_.code(), newtype));
 194                         status.setOnOff(newtype == p_.getCmdName());
 195                 }
 196                 status.setEnabled(true);
 197                 return true;
 198
 199         case LFUN_INSET_DIALOG_UPDATE:
 200                 status.setEnabled(true);
 201                 return true;
 202
 203         default:
 204                 return Inset::getStatus(cur, cmd, status);
 205         }
 206 }
 207
 208
 209 docstring InsetCommand::contextMenu(BufferView const &, int, int) const
 210 {
 211         return from_ascii("context-") + from_ascii(mailer_name_);
 212 }
 213
 214
 215 bool InsetCommand::showInsetDialog(BufferView * bv) const
 216 {
 217         if (!mailer_name_.empty())
 218                 bv->showDialog(mailer_name_, params2string(mailer_name_, p_),
 219                         const_cast<InsetCommand *>(this));
 220         return true;
 221 }
 222
 223
 224 // FIXME This could take an InsetCode instead of a string
 225 bool InsetCommand::string2params(string const & name, string const & in,
 226         InsetCommandParams & params)
 227 {
 228         params.clear();
 229         if (in.empty())
 230                 return false;
 231         istringstream data(in);
 232         Lexer lex;
 233         lex.setStream(data);
 234         lex.setContext("InsetCommand::string2params");
 235         lex >> name.c_str(); // check for name
 236         lex >> "CommandInset";
 237         params.read(lex);
 238         return true;
 239 }
 240
 241
 242 // FIXME This could take an InsetCode instead of a string
 243 string InsetCommand::params2string(string const & name,
 244                                   InsetCommandParams const & params)
 245 {
 246         ostringstream data;
 247         data << name << ' ';
 248         params.write(data);
 249         data << "\\end_inset\n";
 250         return data.str();
 251 }
 252
 253
 254 bool decodeInsetParam(string const & name, string & data,
 255         Buffer const & buffer)
 256 {
 257         InsetCode const code = insetCode(name);
 258         switch (code) {
 259         case BIBITEM_CODE:
 260         case BIBTEX_CODE:
 261         case INDEX_CODE:
 262         case LABEL_CODE:
 263         case NOMENCL_CODE:
 264         case NOMENCL_PRINT_CODE:
 265         case REF_CODE:
 266         case TOC_CODE:
 267         case HYPERLINK_CODE: {
 268                 InsetCommandParams p(code);
 269                 data = InsetCommand::params2string(name, p);
 270                 break;
 271         }
 272         case INCLUDE_CODE: {
 273                 // data is the include type: one of "include",
 274                 // "input", "verbatiminput" or "verbatiminput*"
 275                 if (data.empty())
 276                         // default type is requested
 277                         data = "include";
 278                 InsetCommandParams p(INCLUDE_CODE, data);
 279                 data = InsetCommand::params2string("include", p);
 280                 break;
 281         }
 282         case BOX_CODE: {
 283                 // \c data == "Boxed" || "Frameless" etc
 284                 InsetBoxParams p(data);
 285                 data = InsetBox::params2string(p);
 286                 break;
 287         }
 288         case BRANCH_CODE: {
 289                 InsetBranchParams p;
 290                 data = InsetBranch::params2string(p);
 291                 break;
 292         }
 293         case CITE_CODE: {
 294                 InsetCommandParams p(CITE_CODE);
 295                 data = InsetCommand::params2string(name, p);
 296                 break;
 297         }
 298         case ERT_CODE: {
 299                 data = InsetERT::params2string(InsetCollapsable::Open);
 300                 break;
 301         }
 302         case EXTERNAL_CODE: {
 303                 InsetExternalParams p;
 304                 data = InsetExternal::params2string(p, buffer);
 305                 break;
 306         }
 307         case FLOAT_CODE:  {
 308                 InsetFloatParams p;
 309                 data = InsetFloat::params2string(p);
 310                 break;
 311         }
 312         case LISTINGS_CODE: {
 313                 InsetListingsParams p;
 314                 data = InsetListings::params2string(p);
 315                 break;
 316         }
 317         case GRAPHICS_CODE: {
 318                 InsetGraphicsParams p;
 319                 data = InsetGraphics::params2string(p, buffer);
 320                 break;
 321         }
 322         case NOTE_CODE: {
 323                 InsetNoteParams p;
 324                 data = InsetNote::params2string(p);
 325                 break;
 326         }
 327         case PHANTOM_CODE: {
 328                 InsetPhantomParams p;
 329                 data = InsetPhantom::params2string(p);
 330                 break;
 331         }
 332         case SPACE_CODE: {
 333                 InsetSpaceParams p;
 334                 data = InsetSpace::params2string(p);
 335                 break;
 336         }
 337         case VSPACE_CODE: {
 338                 VSpace space;
 339                 data = InsetVSpace::params2string(space);
 340                 break;
 341         }
 342         case WRAP_CODE: {
 343                 InsetWrapParams p;
 344                 data = InsetWrap::params2string(p);
 345                 break;
 346         }
 347         default:
 348                 return false;
 349         } // end switch(code)
 350         return true;
 351 }
 352
 353 } // namespace lyx