2 * \file InsetBranch.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 "InsetBranch.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "BranchList.h"
22 #include "DispatchResult.h"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
26 #include "OutputParams.h"
27 #include "output_xhtml.h"
28 #include "TextClass.h"
29 #include "TocBackend.h"
31 #include "support/debug.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
35 #include "frontends/Application.h"
44 InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
45 : InsetCollapsable(buf, InsetText::DefaultLayout), params_(params)
49 void InsetBranch::write(ostream & os) const
54 InsetCollapsable::write(os);
58 void InsetBranch::read(Lexer & lex)
61 InsetCollapsable::read(lex);
65 docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
67 docstring const status = isBranchSelected() ?
68 _("active") : _("non-active");
69 docstring const heading =
70 support::bformat(_("Branch (%1$s): %2$s"), status, params_.branch);
73 return toolTipText(heading + from_ascii("\n"));
77 docstring const InsetBranch::buttonLabel(BufferView const & bv) const
79 docstring s = _("Branch: ") + params_.branch;
80 Buffer const & realbuffer = *buffer().masterBuffer();
81 BranchList const & branchlist = realbuffer.params().branchlist();
82 if (!branchlist.find(params_.branch)
83 && buffer().params().branchlist().find(params_.branch))
84 s = _("Branch (child only): ") + params_.branch;
85 else if (!branchlist.find(params_.branch))
86 s = _("Branch (undefined): ") + params_.branch;
87 if (!params_.branch.empty()) {
89 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
93 s = char_type(isBranchSelected() ? 0x2714 : 0x2716) + s;
94 if (decoration() == InsetLayout::CLASSIC)
95 return isOpen(bv) ? s : getNewLabel(s);
97 return params_.branch + ": " + getNewLabel(s);
101 ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
103 if (params_.branch.empty())
104 return Inset::backgroundColor(pi);
106 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
113 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
115 switch (cmd.action()) {
116 case LFUN_INSET_MODIFY: {
117 InsetBranchParams params;
118 InsetBranch::string2params(to_utf8(cmd.argument()), params);
119 params_.branch = params.branch;
120 // what we really want here is a TOC update, but that means
121 // a full buffer update
122 cur.forceBufferUpdate();
125 case LFUN_BRANCH_ACTIVATE:
126 case LFUN_BRANCH_DEACTIVATE: {
127 // FIXME: I do not like this cast, but have no other idea...
128 Buffer const * buf = buffer().masterBuffer();
129 BranchList const & branchlist = buf->params().branchlist();
130 Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
133 our_branch = buffer().params().branchlist().find(params_.branch);
137 bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE);
138 if (our_branch->isSelected() != activate) {
139 our_branch->setSelected(activate);
140 cur.forceBufferUpdate();
144 case LFUN_INSET_TOGGLE:
145 if (cmd.argument() == "assign")
146 setStatus(cur, isBranchSelected() ? Open : Collapsed);
148 InsetCollapsable::doDispatch(cur, cmd);
152 InsetCollapsable::doDispatch(cur, cmd);
158 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
159 FuncStatus & flag) const
161 switch (cmd.action()) {
162 case LFUN_INSET_MODIFY:
163 flag.setEnabled(true);
166 case LFUN_BRANCH_ACTIVATE:
167 flag.setEnabled(!isBranchSelected());
170 case LFUN_BRANCH_DEACTIVATE:
171 flag.setEnabled(isBranchSelected());
174 case LFUN_INSET_TOGGLE:
175 if (cmd.argument() == "assign")
176 flag.setEnabled(true);
178 return InsetCollapsable::getStatus(cur, cmd, flag);
181 return InsetCollapsable::getStatus(cur, cmd, flag);
187 bool InsetBranch::isBranchSelected() const
189 Buffer const & realbuffer = *buffer().masterBuffer();
190 BranchList const & branchlist = realbuffer.params().branchlist();
191 Branch const * ourBranch = branchlist.find(params_.branch);
194 // this branch is defined in child only
195 ourBranch = buffer().params().branchlist().find(params_.branch);
199 return ourBranch->isSelected();
203 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
205 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
209 int InsetBranch::plaintext(odocstream & os,
210 OutputParams const & runparams) const
212 if (!isBranchSelected())
215 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
216 InsetText::plaintext(os, runparams);
219 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
223 int InsetBranch::docbook(odocstream & os,
224 OutputParams const & runparams) const
226 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
230 docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
232 if (isBranchSelected())
233 return InsetText::xhtml(xs, rp);
238 void InsetBranch::tocString(odocstream & os) const
240 if (isBranchSelected())
241 InsetCollapsable::tocString(os);
245 void InsetBranch::validate(LaTeXFeatures & features) const
247 if (isBranchSelected())
248 InsetCollapsable::validate(features);
252 docstring InsetBranch::contextMenu(BufferView const &, int, int) const
254 return from_ascii("context-branch");
258 bool InsetBranch::isMacroScope() const
260 // Its own scope if not selected by buffer
261 return !isBranchSelected();
265 string InsetBranch::params2string(InsetBranchParams const & params)
273 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
275 params = InsetBranchParams();
279 istringstream data(in);
282 lex.setContext("InsetBranch::string2params");
287 void InsetBranch::addToToc(DocIterator const & cpit)
289 DocIterator pit = cpit;
290 pit.push_back(CursorSlice(*this));
292 Toc & toc = buffer().tocBackend().toc("branch");
293 docstring const str = params_.branch + ": " + text().getPar(0).asString();
294 toc.push_back(TocItem(pit, 0, str, toolTipText()));
295 // Proceed with the rest of the inset.
296 InsetCollapsable::addToToc(cpit);
300 void InsetBranchParams::write(ostream & os) const
302 os << to_utf8(branch);
306 void InsetBranchParams::read(Lexer & lex)