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 x, int y) 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);
71 docstring const contents = InsetCollapsable::toolTip(bv, x, y);
72 if (isOpen(bv) || contents.empty())
75 return heading + from_ascii("\n") + contents;
79 docstring const InsetBranch::buttonLabel(BufferView const & bv) const
81 docstring s = _("Branch: ") + params_.branch;
82 Buffer const & realbuffer = *buffer().masterBuffer();
83 BranchList const & branchlist = realbuffer.params().branchlist();
84 if (!branchlist.find(params_.branch)
85 && buffer().params().branchlist().find(params_.branch))
86 s = _("Branch (child only): ") + params_.branch;
87 else if (!branchlist.find(params_.branch))
88 s = _("Branch (undefined): ") + params_.branch;
89 if (!params_.branch.empty()) {
91 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
95 s = char_type(isBranchSelected() ? 0x2714 : 0x2716) + s;
96 if (decoration() == InsetLayout::CLASSIC)
97 return isOpen(bv) ? s : getNewLabel(s);
99 return params_.branch + ": " + getNewLabel(s);
103 ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
105 if (params_.branch.empty())
106 return Inset::backgroundColor(pi);
108 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
115 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
117 switch (cmd.action()) {
118 case LFUN_INSET_MODIFY: {
119 InsetBranchParams params;
120 InsetBranch::string2params(to_utf8(cmd.argument()), params);
121 params_.branch = params.branch;
122 // what we really want here is a TOC update, but that means
123 // a full buffer update
124 cur.forceBufferUpdate();
127 case LFUN_BRANCH_ACTIVATE:
128 case LFUN_BRANCH_DEACTIVATE: {
129 // FIXME: I do not like this cast, but have no other idea...
130 Buffer const * buf = buffer().masterBuffer();
131 BranchList const & branchlist = buf->params().branchlist();
132 Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
135 our_branch = buffer().params().branchlist().find(params_.branch);
139 our_branch->setSelected(cmd.action() == LFUN_BRANCH_ACTIVATE);
142 case LFUN_INSET_TOGGLE:
143 if (cmd.argument() == "assign")
144 setStatus(cur, isBranchSelected() ? Open : Collapsed);
146 InsetCollapsable::doDispatch(cur, cmd);
150 InsetCollapsable::doDispatch(cur, cmd);
156 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
157 FuncStatus & flag) const
159 switch (cmd.action()) {
160 case LFUN_INSET_MODIFY:
161 flag.setEnabled(true);
164 case LFUN_BRANCH_ACTIVATE:
165 flag.setEnabled(!isBranchSelected());
168 case LFUN_BRANCH_DEACTIVATE:
169 flag.setEnabled(isBranchSelected());
172 case LFUN_INSET_TOGGLE:
173 if (cmd.argument() == "assign")
174 flag.setEnabled(true);
176 return InsetCollapsable::getStatus(cur, cmd, flag);
179 return InsetCollapsable::getStatus(cur, cmd, flag);
185 bool InsetBranch::isBranchSelected() const
187 Buffer const & realbuffer = *buffer().masterBuffer();
188 BranchList const & branchlist = realbuffer.params().branchlist();
189 Branch const * ourBranch = branchlist.find(params_.branch);
192 // this branch is defined in child only
193 ourBranch = buffer().params().branchlist().find(params_.branch);
197 return ourBranch->isSelected();
201 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
203 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
207 int InsetBranch::plaintext(odocstream & os,
208 OutputParams const & runparams) const
210 if (!isBranchSelected())
213 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
214 InsetText::plaintext(os, runparams);
217 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
221 int InsetBranch::docbook(odocstream & os,
222 OutputParams const & runparams) const
224 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
228 docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
230 if (isBranchSelected())
231 return InsetText::xhtml(xs, rp);
236 void InsetBranch::tocString(odocstream & os) const
238 if (isBranchSelected())
239 InsetCollapsable::tocString(os);
243 void InsetBranch::validate(LaTeXFeatures & features) const
245 if (isBranchSelected())
246 InsetCollapsable::validate(features);
250 docstring InsetBranch::contextMenu(BufferView const &, int, int) const
252 return from_ascii("context-branch");
256 bool InsetBranch::isMacroScope() const
258 // Its own scope if not selected by buffer
259 return !isBranchSelected();
263 string InsetBranch::params2string(InsetBranchParams const & params)
271 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
273 params = InsetBranchParams();
277 istringstream data(in);
280 lex.setContext("InsetBranch::string2params");
285 void InsetBranch::addToToc(DocIterator const & cpit)
287 DocIterator pit = cpit;
288 pit.push_back(CursorSlice(*this));
290 Toc & toc = buffer().tocBackend().toc("branch");
291 docstring const str = params_.branch + ": " + text().getPar(0).asString();
292 toc.push_back(TocItem(pit, 0, str, toolTipText()));
293 // Proceed with the rest of the inset.
294 InsetCollapsable::addToToc(cpit);
298 void InsetBranchParams::write(ostream & os) const
300 os << to_utf8(branch);
304 void InsetBranchParams::read(Lexer & lex)