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/InsetLine.h"
  33 #include "insets/InsetListings.h"
  34 #include "insets/InsetNote.h"
  35 #include "insets/InsetPhantom.h"
  36 #include "insets/InsetSpace.h"
  37 #include "insets/InsetTabular.h"
  38 #include "insets/InsetVSpace.h"
  39 #include "insets/InsetWrap.h"
  40
  41 #include "support/debug.h"
  42 #include "support/gettext.h"
  43
  44 #include "frontends/Application.h"
  45
  46 #include <sstream>
  47
  48 using namespace std;
  49
  50
  51 namespace lyx {
  52
  53 // FIXME Would it now be possible to use the InsetCode in
  54 // place of the mailer name and recover that information?
  55 InsetCommand::InsetCommand(Buffer * buf, InsetCommandParams const & p,
  56                            string const & mailer_name)
  57         : Inset(buf), p_(p), mailer_name_(mailer_name)
  58 {}
  59
  60
  61 // The sole purpose of this copy constructor is to make sure
  62 // that the mouse_hover_ map is not copied and remains empty.
  63 InsetCommand::InsetCommand(InsetCommand const & rhs)
  64         : Inset(rhs), p_(rhs.p_), mailer_name_(rhs.mailer_name_)
  65 {}
  66
  67
  68 InsetCommand::~InsetCommand()
  69 {
  70         if (!mailer_name_.empty())
  71                 hideDialogs(mailer_name_, this);
  72
  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         // This happens when inset-insert is called without argument except for the
 232         // inset type; ex:
 233         // "inset-insert toc"
 234         if (in == name)
 235                 return true;
 236         istringstream data(in);
 237         Lexer lex;
 238         lex.setStream(data);
 239         lex.setContext("InsetCommand::string2params");
 240         lex >> name.c_str(); // check for name
 241         lex >> "CommandInset";
 242         params.read(lex);
 243         return true;
 244 }
 245
 246
 247 // FIXME This could take an InsetCode instead of a string
 248 string InsetCommand::params2string(string const & name,
 249                                   InsetCommandParams const & params)
 250 {
 251         ostringstream data;
 252         data << name << ' ';
 253         params.write(data);
 254         data << "\\end_inset\n";
 255         return data.str();
 256 }
 257
 258
 259 bool decodeInsetParam(string const & name, string & data,
 260         Buffer const & buffer)
 261 {
 262         InsetCode const code = insetCode(name);
 263         switch (code) {
 264         case BIBITEM_CODE:
 265         case BIBTEX_CODE:
 266         case INDEX_CODE:
 267         case LABEL_CODE:
 268         case LINE_CODE:
 269         case NOMENCL_CODE:
 270         case NOMENCL_PRINT_CODE:
 271         case REF_CODE:
 272         case TOC_CODE:
 273         case HYPERLINK_CODE: {
 274                 InsetCommandParams p(code);
 275                 data = InsetCommand::params2string(name, p);
 276                 break;
 277         }
 278         case INCLUDE_CODE: {
 279                 // data is the include type: one of "include",
 280                 // "input", "verbatiminput" or "verbatiminput*"
 281                 if (data.empty())
 282                         // default type is requested
 283                         data = "include";
 284                 InsetCommandParams p(INCLUDE_CODE, data);
 285                 data = InsetCommand::params2string("include", p);
 286                 break;
 287         }
 288         case BOX_CODE: {
 289                 // \c data == "Boxed" || "Frameless" etc
 290                 InsetBoxParams p(data);
 291                 data = InsetBox::params2string(p);
 292                 break;
 293         }
 294         case BRANCH_CODE: {
 295                 InsetBranchParams p;
 296                 data = InsetBranch::params2string(p);
 297                 break;
 298         }
 299         case CITE_CODE: {
 300                 InsetCommandParams p(CITE_CODE);
 301                 data = InsetCommand::params2string(name, p);
 302                 break;
 303         }
 304         case ERT_CODE: {
 305                 data = InsetERT::params2string(InsetCollapsable::Open);
 306                 break;
 307         }
 308         case EXTERNAL_CODE: {
 309                 InsetExternalParams p;
 310                 data = InsetExternal::params2string(p, buffer);
 311                 break;
 312         }
 313         case FLOAT_CODE:  {
 314                 InsetFloatParams p;
 315                 data = InsetFloat::params2string(p);
 316                 break;
 317         }
 318         case LISTINGS_CODE: {
 319                 InsetListingsParams p;
 320                 data = InsetListings::params2string(p);
 321                 break;
 322         }
 323         case GRAPHICS_CODE: {
 324                 InsetGraphicsParams p;
 325                 data = InsetGraphics::params2string(p, buffer);
 326                 break;
 327         }
 328         case NOTE_CODE: {
 329                 InsetNoteParams p;
 330                 data = InsetNote::params2string(p);
 331                 break;
 332         }
 333         case PHANTOM_CODE: {
 334                 InsetPhantomParams p;
 335                 data = InsetPhantom::params2string(p);
 336                 break;
 337         }
 338         case SPACE_CODE: {
 339                 InsetSpaceParams p;
 340                 data = InsetSpace::params2string(p);
 341                 break;
 342         }
 343         case VSPACE_CODE: {
 344                 VSpace space;
 345                 data = InsetVSpace::params2string(space);
 346                 break;
 347         }
 348         case WRAP_CODE: {
 349                 InsetWrapParams p;
 350                 data = InsetWrap::params2string(p);
 351                 break;
 352         }
 353         default:
 354                 return false;
 355         } // end switch(code)
 356         return true;
 357 }
 358
 359 } // namespace lyx