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 : InsetCollapsible(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()), is_toc_caption_(false)
50 void InsetArgument::write(ostream & os) const
52 os << "Argument " << name_ << "\n";
53 InsetCollapsible::write(os);
57 void InsetArgument::read(Lexer & lex)
60 InsetCollapsible::read(lex);
64 void InsetArgument::updateBuffer(ParIterator const & it, UpdateType utype)
66 bool const insetlayout = !it.paragraph().layout().hasArgs();
67 Layout::LaTeXArgMap const args = insetlayout ?
68 it.inset().getLayout().args() : it.paragraph().layout().args();
69 pass_thru_context_ = insetlayout ?
70 it.inset().getLayout().isPassThru() : it.paragraph().layout().pass_thru;
71 // Record PassThru status in order to act on changes.
72 bool const former_pass_thru = pass_thru_;
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 is_toc_caption_ = true;
124 // empty if AddToToc is not set
125 caption_of_toc_ = insetlayout
126 ? it.inset().getLayout().tocType()
127 : it.paragraph().layout().tocType();
130 switch ((*lait).second.passthru) {
132 pass_thru_ = pass_thru_context_;
136 pass_thru_local_ = true;
143 labelstring_ = _("Unknown Argument");
144 tooltip_ = _("Argument not known in this Layout. Will be suppressed in the output.");
147 if (former_pass_thru != pass_thru_) {
148 // PassThru status changed. We might need to update
149 // the language of the contents
150 Language const * l = insetlayout
151 ? it.inset().buffer().language()
152 : it.buffer()->language();
153 fixParagraphLanguage(l);
157 InsetCollapsible::updateBuffer(it, utype);
161 void InsetArgument::setButtonLabel()
163 setLabel(labelstring_);
167 docstring InsetArgument::toolTip(BufferView const & bv, int, int) const
171 return toolTipText(tooltip_ + from_ascii(":\n"));
175 void InsetArgument::doDispatch(Cursor & cur, FuncRequest & cmd)
177 switch (cmd.action()) {
179 case LFUN_INSET_MODIFY: {
180 string const first_arg = cmd.getArg(0);
181 bool const change_type = first_arg == "changetype";
184 // this will not be handled higher up
188 cur.recordUndoInset(this);
189 name_ = cmd.getArg(1);
190 cur.forceBufferUpdate();
195 case LFUN_CLIPBOARD_PASTE:
196 case LFUN_SELECTION_PASTE:
197 case LFUN_PRIMARY_SELECTION_PASTE:
198 case LFUN_SELF_INSERT:
199 // With (only) inherited pass_thru, call Text::dispatch()
200 // directly to avoid call for fixParagraphsFont() and/or
201 // forcing to latex_language in InsetText::dispatch(),
202 // since this does not play nicely with inherited pass_thru
204 if (pass_thru_ && !pass_thru_local_) {
205 text().dispatch(cur, cmd);
206 // For the paste operations, check if we have
207 // non-latex_language, and if so, fix.
208 if (cmd.action() != LFUN_SELF_INSERT)
209 fixParagraphLanguage(buffer().params().language);
212 InsetCollapsible::doDispatch(cur, cmd);
216 InsetCollapsible::doDispatch(cur, cmd);
222 bool InsetArgument::getStatus(Cursor & cur, FuncRequest const & cmd,
223 FuncStatus & flag) const
225 switch (cmd.action()) {
227 case LFUN_INSET_MODIFY: {
228 string const first_arg = cmd.getArg(0);
229 if (first_arg == "changetype") {
230 string const type = cmd.getArg(1);
231 flag.setOnOff(type == name_);
233 flag.setEnabled(true);
236 Layout::LaTeXArgMap args;
237 bool const insetlayout = cur.paragraph().layout().latexargs().empty();
239 args = cur.inset().getLayout().latexargs();
241 args = cur.paragraph().layout().latexargs();
242 Layout::LaTeXArgMap::const_iterator const lait = args.find(type);
243 if (lait != args.end()) {
244 flag.setEnabled(true);
245 for (auto const & table : cur.paragraph().insetList())
246 if (InsetArgument const * ins = table.inset->asInsetArgument())
247 if (ins->name() == type) {
248 // we have this already
249 flag.setEnabled(false);
253 flag.setEnabled(false);
256 return InsetCollapsible::getStatus(cur, cmd, flag);
260 return InsetCollapsible::getStatus(cur, cmd, flag);
265 string InsetArgument::contextMenuName() const
267 if (decoration() == InsetLayout::CONGLOMERATE)
268 return "context-argument-conglomerate";
270 return "context-argument";
274 FontInfo InsetArgument::getFont() const
276 if (font_ != inherit_font)
278 return InsetCollapsible::getFont();
282 FontInfo InsetArgument::getLabelfont() const
284 if (labelfont_ != inherit_font)
286 return InsetCollapsible::getLabelfont();
290 ColorCode InsetArgument::labelColor() const {
291 if (labelfont_.color() != Color_inherit)
292 return labelfont_.color();
293 return InsetCollapsible::labelColor();
297 InsetLayout::InsetDecoration InsetArgument::decoration() const
299 InsetLayout::InsetDecoration dec = getLayout().decoration();
300 if (!decoration_.empty())
301 dec = translateDecoration(decoration_);
302 return dec == InsetLayout::DEFAULT ? InsetLayout::CLASSIC : dec;
306 void InsetArgument::latexArgument(otexstream & os,
307 OutputParams const & runparams_in, docstring const & ldelim,
308 docstring const & rdelim, docstring const & presetarg) const
310 otexstringstream ots;
311 OutputParams runparams = runparams_in;
312 if (!pass_thru_chars_.empty())
313 runparams.pass_thru_chars += pass_thru_chars_;
314 runparams.pass_thru = isPassThru();
315 InsetText::latex(ots, runparams);
316 TexString ts = ots.release();
317 bool const add_braces = !ldelim.empty() && ldelim != "{"
318 && support::contains(ts.str, rdelim);
323 if (!presetarg.empty() && !ts.str.empty())
332 void InsetArgument::addToToc(DocIterator const & dit, bool output_active,
333 UpdateType utype, TocBackend & backend) const
335 if (!caption_of_toc_.empty()) {
337 text().forOutliner(str, TOC_ENTRY_LENGTH);
338 backend.builder(caption_of_toc_).argumentItem(str);
340 // Proceed with the rest of the inset.
341 InsetText::addToToc(dit, output_active, utype, backend);
345 void InsetArgument::fixParagraphLanguage(Language const * l)
347 Font font(inherit_font, l);
349 font.setLanguage(latex_language);
350 paragraphs().front().resetFonts(font);