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"
19 #include "DispatchResult.h"
20 #include "FuncRequest.h"
21 #include "FuncStatus.h"
23 #include "MetricsInfo.h"
25 #include "insets/InsetBox.h"
26 #include "insets/InsetBranch.h"
27 #include "insets/InsetCommand.h"
28 #include "insets/InsetERT.h"
29 #include "insets/InsetExternal.h"
30 #include "insets/InsetFloat.h"
31 #include "insets/InsetGraphics.h"
32 #include "insets/InsetIndex.h"
33 #include "insets/InsetLine.h"
34 #include "insets/InsetListings.h"
35 #include "insets/InsetNote.h"
36 #include "insets/InsetPhantom.h"
37 #include "insets/InsetSpace.h"
38 #include "insets/InsetTabular.h"
39 #include "insets/InsetVSpace.h"
40 #include "insets/InsetWrap.h"
42 #include "support/debug.h"
43 #include "support/gettext.h"
45 #include "frontends/Application.h"
54 // FIXME Would it now be possible to use the InsetCode in
55 // place of the mailer name and recover that information?
56 InsetCommand::InsetCommand(Buffer * buf, InsetCommandParams const & p)
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_)
68 InsetCommand::~InsetCommand()
70 if (p_.code() != NO_CODE)
71 hideDialogs(insetName(p_.code()), 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)
77 it->first->clearLastInset(this);
81 void InsetCommand::metrics(MetricsInfo & mi, Dimension & dim) const
83 button_.update(screenLabel(), editable() || hasSettings());
84 button_.metrics(mi, dim);
88 bool InsetCommand::setMouseHover(BufferView const * bv, bool mouse_hover)
91 mouse_hover_[bv] = mouse_hover;
96 void InsetCommand::draw(PainterInfo & pi, int x, int y) const
98 button_.setRenderState(mouse_hover_[pi.base.bv]);
99 button_.draw(pi, x, y);
103 void InsetCommand::setParam(string const & name, docstring const & value)
109 docstring const & InsetCommand::getParam(string const & name) const
115 void InsetCommand::setParams(InsetCommandParams const & p)
122 int InsetCommand::latex(otexstream & os, OutputParams const & runparams_in) const
124 OutputParams runparams = runparams_in;
125 os << getCommand(runparams);
130 int InsetCommand::plaintext(odocstream & os, OutputParams const &) const
132 docstring const str = "[" + buffer().B_("LaTeX Command: ")
133 + from_utf8(getCmdName()) + "]";
139 int InsetCommand::docbook(odocstream &, OutputParams const &) const
145 void InsetCommand::doDispatch(Cursor & cur, FuncRequest & cmd)
147 switch (cmd.action()) {
148 case LFUN_INSET_MODIFY: {
149 if (cmd.getArg(0) == "changetype") {
151 p_.setCmdName(cmd.getArg(1));
152 cur.forceBufferUpdate();
156 InsetCommandParams p(p_.code());
157 InsetCommand::string2params(to_utf8(cmd.argument()), p);
158 if (p.getCmdName().empty())
159 cur.noScreenUpdate();
164 // FIXME We might also want to check here if this one is in the TOC.
165 // But I think most of those are labeled.
167 cur.forceBufferUpdate();
171 case LFUN_INSET_DIALOG_UPDATE: {
172 string const name = to_utf8(cmd.argument());
173 cur.bv().updateDialog(name, params2string(params()));
178 Inset::doDispatch(cur, cmd);
185 bool InsetCommand::getStatus(Cursor & cur, FuncRequest const & cmd,
186 FuncStatus & status) const
188 switch (cmd.action()) {
190 case LFUN_ERT_INSERT:
191 status.setEnabled(false);
195 case LFUN_INSET_MODIFY:
196 if (cmd.getArg(0) == "changetype") {
197 string const newtype = cmd.getArg(1);
198 status.setEnabled(p_.isCompatibleCommand(p_.code(), newtype));
199 status.setOnOff(newtype == p_.getCmdName());
201 status.setEnabled(true);
204 case LFUN_INSET_DIALOG_UPDATE:
205 status.setEnabled(true);
209 return Inset::getStatus(cur, cmd, status);
214 docstring InsetCommand::contextMenuName() const
216 return from_ascii("context-") + from_ascii(insetName(p_.code()));
220 bool InsetCommand::showInsetDialog(BufferView * bv) const
222 if (p_.code() != NO_CODE)
223 bv->showDialog(insetName(p_.code()), params2string(p_),
224 const_cast<InsetCommand *>(this));
229 bool InsetCommand::string2params(string const & data,
230 InsetCommandParams & params)
235 // This happens when inset-insert is called without argument except for the
237 // "inset-insert toc"
238 string const name = insetName(params.code());
241 istringstream dstream(data);
243 lex.setStream(dstream);
244 lex.setContext("InsetCommand::string2params");
245 lex >> name.c_str(); // check for name
246 lex >> "CommandInset";
252 string InsetCommand::params2string(InsetCommandParams const & params)
255 data << insetName(params.code()) << ' ';
257 data << "\\end_inset\n";
262 bool decodeInsetParam(string const & name, string & data,
263 Buffer const & buffer)
265 InsetCode const code = insetCode(name);
269 case INDEX_PRINT_CODE:
273 case NOMENCL_PRINT_CODE:
276 case HYPERLINK_CODE: {
277 InsetCommandParams p(code);
278 data = InsetCommand::params2string(p);
282 // data is the include type: one of "include",
283 // "input", "verbatiminput" or "verbatiminput*"
285 // default type is requested
287 InsetCommandParams p(INCLUDE_CODE, data);
288 data = InsetCommand::params2string(p);
292 // \c data == "Boxed" || "Frameless" etc
293 InsetBoxParams p(data);
294 data = InsetBox::params2string(p);
299 data = InsetBranch::params2string(p);
303 InsetCommandParams p(CITE_CODE);
304 data = InsetCommand::params2string(p);
308 data = InsetERT::params2string(InsetCollapsable::Open);
311 case EXTERNAL_CODE: {
312 InsetExternalParams p;
313 data = InsetExternal::params2string(p, buffer);
318 data = InsetFloat::params2string(p);
323 data = InsetIndex::params2string(p);
326 case LISTINGS_CODE: {
327 InsetListingsParams p;
328 data = InsetListings::params2string(p);
331 case GRAPHICS_CODE: {
332 InsetGraphicsParams p;
333 data = InsetGraphics::params2string(p, buffer);
338 data = InsetNote::params2string(p);
342 InsetPhantomParams p;
343 data = InsetPhantom::params2string(p);
348 data = InsetSpace::params2string(p);
353 data = InsetVSpace::params2string(space);
358 data = InsetWrap::params2string(p);
363 } // end switch(code)