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
7 * \author Jürgen Spitzmüller
9 * Full author contact details are available in file CREDITS.
14 #include "InsetArgument.h"
17 #include "BufferParams.h"
19 #include "FuncStatus.h"
20 #include "FuncRequest.h"
21 #include "InsetList.h"
25 #include "OutputParams.h"
26 #include "ParIterator.h"
28 #include "texstream.h"
29 #include "TocBackend.h"
31 #include "support/convert.h"
32 #include "support/debug.h"
33 #include "support/docstream.h"
34 #include "support/gettext.h"
35 #include "support/lstrings.h"
42 InsetArgument::InsetArgument(Buffer * buf, string const & name)
43 : InsetCollapsable(buf), name_(name), labelstring_(docstring()),
44 font_(inherit_font), labelfont_(inherit_font), decoration_(string()),
45 pass_thru_context_(false), pass_thru_local_(false), pass_thru_(false),
46 pass_thru_chars_(docstring())
50 void InsetArgument::write(ostream & os) const
52 os << "Argument " << name_ << "\n";
53 InsetCollapsable::write(os);
57 void InsetArgument::read(Lexer & lex)
60 InsetCollapsable::read(lex);
64 void InsetArgument::updateBuffer(ParIterator const & it, UpdateType utype)
66 Layout::LaTeXArgMap args = it.paragraph().layout().args();
67 pass_thru_context_ = it.paragraph().layout().pass_thru;
68 bool const insetlayout = args.empty();
70 args = it.inset().getLayout().args();
71 pass_thru_context_ = it.inset().getLayout().isPassThru();
74 // Handle pre 2.1 ArgInsets (lyx2lyx cannot classify them)
76 unsigned int const req = insetlayout ? it.inset().getLayout().requiredArgs()
77 : it.paragraph().layout().requiredArgs();
78 unsigned int const opts = insetlayout ? it.inset().getLayout().optArgs()
79 : it.paragraph().layout().optArgs();
81 unsigned int ours = 0;
82 InsetList::const_iterator parit = it.paragraph().insetList().begin();
83 InsetList::const_iterator parend = it.paragraph().insetList().end();
84 for (; parit != parend; ++parit) {
85 if (parit->inset->lyxCode() == ARG_CODE) {
87 if (parit->inset == this)
92 unsigned int realopts = 0;
94 // We have optional arguments
96 if (ours <= realopts) {
97 name_ = convert<string>(ours);
102 // This is a mandatory argument. We have to consider
103 // non-given optional arguments for the numbering
104 int offset = opts - realopts;
106 name_ = convert<string>(ours);
109 Layout::LaTeXArgMap::const_iterator const lait = args.find(name_);
110 caption_of_toc_ = string();
111 if (lait != args.end()) {
112 docstring label = translateIfPossible((*lait).second.labelstring);
113 docstring striplabel;
114 support::rsplit(label, striplabel, '|');
115 labelstring_ = striplabel.empty() ? label: striplabel;
116 tooltip_ = translateIfPossible((*lait).second.tooltip);
117 font_ = (*lait).second.font;
118 labelfont_ = (*lait).second.labelfont;
119 decoration_ = (*lait).second.decoration;
120 pass_thru_chars_ = (*lait).second.pass_thru_chars;
121 pass_thru_local_ = false;
122 if (lait->second.is_toc_caption)
123 // empty if AddToToc is not set
124 caption_of_toc_ = insetlayout
125 ? it.inset().getLayout().tocType()
126 : it.paragraph().layout().tocType();
128 switch ((*lait).second.passthru) {
130 pass_thru_ = pass_thru_context_;
134 pass_thru_local_ = true;
141 labelstring_ = _("Unknown Argument");
142 tooltip_ = _("Argument not known in this Layout. Will be supressed in the output.");
145 InsetCollapsable::updateBuffer(it, utype);
149 void InsetArgument::setButtonLabel()
151 setLabel(labelstring_);
155 docstring InsetArgument::toolTip(BufferView const & bv, int, int) const
159 return toolTipText(tooltip_ + from_ascii(":\n"));
163 void InsetArgument::doDispatch(Cursor & cur, FuncRequest & cmd)
165 switch (cmd.action()) {
167 case LFUN_INSET_MODIFY: {
168 string const first_arg = cmd.getArg(0);
169 bool const change_type = first_arg == "changetype";
172 // this will not be handled higher up
176 cur.recordUndoInset(this);
177 name_ = cmd.getArg(1);
178 cur.forceBufferUpdate();
183 case LFUN_CLIPBOARD_PASTE:
184 case LFUN_SELECTION_PASTE:
185 case LFUN_PRIMARY_SELECTION_PASTE:
186 case LFUN_SELF_INSERT:
187 // With (only) inherited pass_thru, call Text::dispatch()
188 // directly to avoid call for fixParagraphsFont() and/or
189 // forcing to latex_language in InsetText::dispatch(),
190 // since this does not play nicely with inherited pass_thru
192 if (pass_thru_ && !pass_thru_local_)
193 text().dispatch(cur, cmd);
195 InsetCollapsable::doDispatch(cur, cmd);
199 InsetCollapsable::doDispatch(cur, cmd);
205 bool InsetArgument::getStatus(Cursor & cur, FuncRequest const & cmd,
206 FuncStatus & flag) const
208 switch (cmd.action()) {
210 case LFUN_INSET_MODIFY: {
211 string const first_arg = cmd.getArg(0);
212 if (first_arg == "changetype") {
213 string const type = cmd.getArg(1);
214 flag.setOnOff(type == name_);
216 flag.setEnabled(true);
219 Layout::LaTeXArgMap args;
220 bool const insetlayout = cur.paragraph().layout().latexargs().empty();
222 args = cur.inset().getLayout().latexargs();
224 args = cur.paragraph().layout().latexargs();
225 Layout::LaTeXArgMap::const_iterator const lait = args.find(type);
226 if (lait != args.end()) {
227 flag.setEnabled(true);
228 for (auto const & table : cur.paragraph().insetList())
229 if (InsetArgument const * ins = table.inset->asInsetArgument())
230 if (ins->name() == type) {
231 // we have this already
232 flag.setEnabled(false);
236 flag.setEnabled(false);
239 return InsetCollapsable::getStatus(cur, cmd, flag);
243 return InsetCollapsable::getStatus(cur, cmd, flag);
248 string InsetArgument::contextMenuName() const
250 if (decoration() == InsetLayout::CONGLOMERATE)
251 return "context-argument-conglomerate";
253 return "context-argument";
257 FontInfo InsetArgument::getFont() const
259 if (font_ != inherit_font)
261 return InsetCollapsable::getFont();
265 FontInfo InsetArgument::getLabelfont() const
267 if (labelfont_ != inherit_font)
269 return InsetCollapsable::getLabelfont();
273 ColorCode InsetArgument::labelColor() const {
274 if (labelfont_.color() != Color_inherit)
275 return labelfont_.color();
276 return InsetCollapsable::labelColor();
280 InsetLayout::InsetDecoration InsetArgument::decoration() const
282 InsetLayout::InsetDecoration dec = getLayout().decoration();
283 if (!decoration_.empty())
284 dec = translateDecoration(decoration_);
285 return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
289 void InsetArgument::latexArgument(otexstream & os,
290 OutputParams const & runparams_in, docstring const & ldelim,
291 docstring const & rdelim, docstring const & presetarg) const
293 otexstringstream ots;
294 OutputParams runparams = runparams_in;
295 if (!pass_thru_chars_.empty())
296 runparams.pass_thru_chars += pass_thru_chars_;
297 runparams.pass_thru = isPassThru();
298 InsetText::latex(ots, runparams);
299 TexString ts = ots.release();
300 bool const add_braces = ldelim != "{" && support::contains(ts.str, rdelim);
305 if (!presetarg.empty() && !ts.str.empty())
314 void InsetArgument::addToToc(DocIterator const & dit, bool output_active,
315 UpdateType utype, TocBackend & backend) const
317 if (!caption_of_toc_.empty()) {
319 text().forOutliner(str, TOC_ENTRY_LENGTH);
320 backend.builder(caption_of_toc_).argumentItem(str);
322 // Proceed with the rest of the inset.
323 InsetText::addToToc(dit, output_active, utype, backend);