2 * \file InsetCommand.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
14 #include "InsetCommand.h"
17 #include "BufferView.h"
18 #include "DispatchResult.h"
19 #include "FuncRequest.h"
20 #include "FuncStatus.h"
22 #include "MetricsInfo.h"
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"
41 #include "support/debug.h"
42 #include "support/gettext.h"
44 #include "frontends/Application.h"
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)
60 // The sole purpose of this copy constructor is to make sure
61 // that the mouse_hover_ map is not copied and remains empty.
62 InsetCommand::InsetCommand(InsetCommand const & rhs)
63 : Inset(rhs), p_(rhs.p_)
67 InsetCommand::~InsetCommand()
69 if (p_.code() != NO_CODE)
70 hideDialogs(insetName(p_.code()), this);
72 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
73 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
74 for (; it != end; ++it)
76 it->first->clearLastInset(this);
80 void InsetCommand::metrics(MetricsInfo & mi, Dimension & dim) const
82 button_.update(screenLabel(), editable() || hasSettings());
83 button_.metrics(mi, dim);
87 bool InsetCommand::setMouseHover(BufferView const * bv, bool mouse_hover)
90 mouse_hover_[bv] = mouse_hover;
95 void InsetCommand::draw(PainterInfo & pi, int x, int y) const
97 button_.setRenderState(mouse_hover_[pi.base.bv]);
98 button_.draw(pi, x, y);
102 void InsetCommand::setParam(std::string const & name, docstring const & value)
108 docstring const & InsetCommand::getParam(std::string const & name) const
114 void InsetCommand::setParams(InsetCommandParams const & p)
121 int InsetCommand::latex(odocstream & os, OutputParams const & runparams_in) const
123 OutputParams runparams = runparams_in;
124 os << getCommand(runparams);
129 int InsetCommand::plaintext(odocstream & os, OutputParams const &) const
131 docstring const str = "[" + buffer().B_("LaTeX Command: ")
132 + from_utf8(getCmdName()) + "]";
138 int InsetCommand::docbook(odocstream &, OutputParams const &) const
144 void InsetCommand::doDispatch(Cursor & cur, FuncRequest & cmd)
146 switch (cmd.action()) {
147 case LFUN_INSET_MODIFY: {
148 if (cmd.getArg(0) == "changetype") {
149 p_.setCmdName(cmd.getArg(1));
153 InsetCommandParams p(p_.code());
154 InsetCommand::string2params(to_utf8(cmd.argument()), p);
155 if (p.getCmdName().empty())
156 cur.noScreenUpdate();
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.
162 cur.forceBufferUpdate();
166 case LFUN_INSET_DIALOG_UPDATE: {
167 string const name = to_utf8(cmd.argument());
168 cur.bv().updateDialog(name, params2string(params()));
173 Inset::doDispatch(cur, cmd);
180 bool InsetCommand::getStatus(Cursor & cur, FuncRequest const & cmd,
181 FuncStatus & status) const
183 switch (cmd.action()) {
185 case LFUN_ERT_INSERT:
186 status.setEnabled(false);
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());
196 status.setEnabled(true);
199 case LFUN_INSET_DIALOG_UPDATE:
200 status.setEnabled(true);
204 return Inset::getStatus(cur, cmd, status);
209 docstring InsetCommand::contextMenu(BufferView const &, int, int) const
211 return from_ascii("context-") + from_ascii(insetName(p_.code()));
215 bool InsetCommand::showInsetDialog(BufferView * bv) const
217 if (p_.code() != NO_CODE)
218 bv->showDialog(insetName(p_.code()), params2string(p_),
219 const_cast<InsetCommand *>(this));
224 bool InsetCommand::string2params(string const & data,
225 InsetCommandParams & params)
230 // This happens when inset-insert is called without argument except for the
232 // "inset-insert toc"
233 string const name = insetName(params.code());
236 istringstream dstream(data);
238 lex.setStream(dstream);
239 lex.setContext("InsetCommand::string2params");
240 lex >> name.c_str(); // check for name
241 lex >> "CommandInset";
247 string InsetCommand::params2string(InsetCommandParams const & params)
250 data << insetName(params.code()) << ' ';
252 data << "\\end_inset\n";
257 bool decodeInsetParam(string const & name, string & data,
258 Buffer const & buffer)
260 InsetCode const code = insetCode(name);
268 case NOMENCL_PRINT_CODE:
271 case HYPERLINK_CODE: {
272 InsetCommandParams p(code);
273 data = InsetCommand::params2string(p);
277 // data is the include type: one of "include",
278 // "input", "verbatiminput" or "verbatiminput*"
280 // default type is requested
282 InsetCommandParams p(INCLUDE_CODE, data);
283 data = InsetCommand::params2string(p);
287 // \c data == "Boxed" || "Frameless" etc
288 InsetBoxParams p(data);
289 data = InsetBox::params2string(p);
294 data = InsetBranch::params2string(p);
298 InsetCommandParams p(CITE_CODE);
299 data = InsetCommand::params2string(p);
303 data = InsetERT::params2string(InsetCollapsable::Open);
306 case EXTERNAL_CODE: {
307 InsetExternalParams p;
308 data = InsetExternal::params2string(p, buffer);
313 data = InsetFloat::params2string(p);
316 case LISTINGS_CODE: {
317 InsetListingsParams p;
318 data = InsetListings::params2string(p);
321 case GRAPHICS_CODE: {
322 InsetGraphicsParams p;
323 data = InsetGraphics::params2string(p, buffer);
328 data = InsetNote::params2string(p);
332 InsetPhantomParams p;
333 data = InsetPhantom::params2string(p);
338 data = InsetSpace::params2string(p);
343 data = InsetVSpace::params2string(space);
348 data = InsetWrap::params2string(p);
353 } // end switch(code)