2 * \file InsetArgument.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Martin Vermeer
8 * Full author contact details are available in file CREDITS.
13 #include "InsetArgument.h"
16 #include "FuncStatus.h"
17 #include "FuncRequest.h"
18 #include "InsetList.h"
21 #include "ParIterator.h"
23 #include "support/convert.h"
24 #include "support/debug.h"
25 #include "support/docstream.h"
26 #include "support/gettext.h"
27 #include "support/lstrings.h"
34 InsetArgument::InsetArgument(Buffer * buf, string const & name)
35 : InsetCollapsable(buf), name_(name), labelstring_(docstring())
39 void InsetArgument::write(ostream & os) const
41 os << "Argument " << name_ << "\n";
42 InsetCollapsable::write(os);
45 void InsetArgument::read(Lexer & lex)
48 InsetCollapsable::read(lex);
51 void InsetArgument::updateBuffer(ParIterator const & it, UpdateType utype)
53 Layout::LaTeXArgMap args;
54 bool const insetlayout = &it.inset() && it.paragraph().layout().latexargs().empty();
56 args = it.inset().getLayout().latexargs();
58 args = it.paragraph().layout().latexargs();
60 // Handle pre 2.1 ArgInsets (lyx2lyx cannot classify them)
62 int req = insetlayout ? it.inset().getLayout().requiredArgs()
63 : it.paragraph().layout().requiredArgs();
64 int opts = insetlayout ? it.inset().getLayout().optArgs()
65 : it.paragraph().layout().optArgs();
68 InsetList::const_iterator parit = it.paragraph().insetList().begin();
69 InsetList::const_iterator parend = it.paragraph().insetList().end();
70 for (; parit != parend; ++parit) {
71 if (parit->inset->lyxCode() == ARG_CODE) {
73 if (parit->inset == this)
80 // We have optional arguments
82 if (ours <= realopts) {
83 name_ = convert<string>(ours);
88 // This is a mandatory argument. We have to consider
89 // non-given optional arguments for the numbering
90 int offset = opts - realopts;
92 name_ = convert<string>(ours);
95 Layout::LaTeXArgMap::const_iterator const lait =
96 args.find(convert<unsigned int>(name_));
97 if (lait != args.end()) {
98 labelstring_ = translateIfPossible((*lait).second.labelstring);
99 tooltip_ = translateIfPossible((*lait).second.tooltip);
101 labelstring_ = _("Unknown Argument");
102 tooltip_ = _("Argument not known in this Layout. Will be supressed in the output.");
105 InsetCollapsable::updateBuffer(it, utype);
108 void InsetArgument::setButtonLabel()
110 setLabel(labelstring_);
113 docstring InsetArgument::toolTip(BufferView const & bv, int, int) const
117 return toolTipText(tooltip_ + from_ascii(":\n"));
120 void InsetArgument::doDispatch(Cursor & cur, FuncRequest & cmd)
122 switch (cmd.action()) {
124 case LFUN_INSET_MODIFY: {
125 string const first_arg = cmd.getArg(0);
126 bool const change_type = first_arg == "changetype";
129 // this will not be handled higher up
133 cur.recordUndoInset(ATOMIC_UNDO, this);
134 name_ = cmd.getArg(1);
135 cur.forceBufferUpdate();
140 InsetCollapsable::doDispatch(cur, cmd);
146 bool InsetArgument::getStatus(Cursor & cur, FuncRequest const & cmd,
147 FuncStatus & flag) const
149 switch (cmd.action()) {
151 case LFUN_INSET_MODIFY: {
152 string const first_arg = cmd.getArg(0);
153 if (first_arg == "changetype") {
154 string const type = cmd.getArg(1);
155 flag.setOnOff(type == name_);
157 flag.setEnabled(true);
160 Layout::LaTeXArgMap args;
161 bool const insetlayout = &cur.inset() && cur.paragraph().layout().latexargs().empty();
163 args = cur.inset().getLayout().latexargs();
165 args = cur.paragraph().layout().latexargs();
166 Layout::LaTeXArgMap::const_iterator const lait =
167 args.find(convert<unsigned int>(type));
168 if (lait != args.end()) {
169 flag.setEnabled(true);
170 InsetList::const_iterator it = cur.paragraph().insetList().begin();
171 InsetList::const_iterator end = cur.paragraph().insetList().end();
172 for (; it != end; ++it) {
173 if (it->inset->lyxCode() == ARG_CODE) {
174 InsetArgument const * ins =
175 static_cast<InsetArgument const *>(it->inset);
176 if (ins->name() == type) {
177 // we have this already
178 flag.setEnabled(false);
184 flag.setEnabled(false);
187 return InsetCollapsable::getStatus(cur, cmd, flag);
191 return InsetCollapsable::getStatus(cur, cmd, flag);
195 string InsetArgument::contextMenuName() const
197 return "context-argument";
200 void InsetArgument::latexArgument(otexstream & os,
201 OutputParams const & runparams, docstring const & ldelim,
202 docstring const & rdelim) const
206 otexstream ots(ss, texrow);
207 InsetText::latex(ots, runparams);
208 docstring str = ss.str();
209 if (ldelim != "{" && support::contains(str, rdelim))
210 str = '{' + str + '}';
211 os << ldelim << str << rdelim;