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 "BranchList.h"
21 #include "DispatchResult.h"
22 #include "FuncRequest.h"
23 #include "FuncStatus.h"
24 #include "support/gettext.h"
26 #include "OutputParams.h"
27 #include "TextClass.h"
36 InsetBranch::InsetBranch(BufferParams const & bp,
37 InsetBranchParams const & params)
38 : InsetCollapsable(bp), params_(params)
42 InsetBranch::InsetBranch(InsetBranch const & in)
43 : InsetCollapsable(in), params_(in.params_)
47 InsetBranch::~InsetBranch()
49 InsetBranchMailer(*this).hideDialog();
53 Inset * InsetBranch::clone() const
55 return new InsetBranch(*this);
59 docstring InsetBranch::editMessage() const
61 return _("Opened Branch Inset");
65 void InsetBranch::write(ostream & os) const
68 InsetCollapsable::write(os);
72 void InsetBranch::read(Lexer & lex)
75 InsetCollapsable::read(lex);
79 docstring InsetBranch::toolTip(BufferView const &, int, int) const
81 return _("Branch: ") + params_.branch;
85 void InsetBranch::setButtonLabel()
87 docstring s = _("Branch: ") + params_.branch;
88 if (!params_.branch.empty()) {
90 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
91 if (c == Color_none) {
95 if (decoration() == InsetLayout::Classic)
96 setLabel(isOpen() ? s : getNewLabel(s) );
98 setLabel(params_.branch + ": " + getNewLabel(s));
102 ColorCode InsetBranch::backgroundColor() const
104 if (!params_.branch.empty()) {
106 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
107 if (c == Color_none) {
112 return Inset::backgroundColor();
116 bool InsetBranch::showInsetDialog(BufferView * bv) const
118 InsetBranchMailer(const_cast<InsetBranch &>(*this)).showDialog(bv);
123 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
125 switch (cmd.action) {
126 case LFUN_INSET_MODIFY: {
127 InsetBranchParams params;
128 InsetBranchMailer::string2params(to_utf8(cmd.argument()), params);
129 params_.branch = params.branch;
130 setLayout(cur.buffer().params());
134 case LFUN_MOUSE_PRESS:
135 if (cmd.button() != mouse_button::button3)
136 InsetCollapsable::doDispatch(cur, cmd);
141 case LFUN_INSET_DIALOG_UPDATE:
142 InsetBranchMailer(*this).updateDialog(&cur.bv());
145 case LFUN_MOUSE_RELEASE:
146 if (cmd.button() == mouse_button::button3 && hitButton(cmd))
147 InsetBranchMailer(*this).showDialog(&cur.bv());
149 InsetCollapsable::doDispatch(cur, cmd);
153 case LFUN_INSET_TOGGLE:
154 if (cmd.argument() == "assign") {
155 // The branch inset uses "assign".
156 if (isBranchSelected()) {
157 if (status() != Open)
158 setStatus(cur, Open);
162 if (status() != Collapsed)
163 setStatus(cur, Collapsed);
169 InsetCollapsable::doDispatch(cur, cmd);
173 InsetCollapsable::doDispatch(cur, cmd);
179 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
180 FuncStatus & flag) const
182 switch (cmd.action) {
183 case LFUN_INSET_MODIFY:
184 case LFUN_INSET_DIALOG_UPDATE:
188 case LFUN_INSET_TOGGLE:
189 if (cmd.argument() == "open" || cmd.argument() == "close" ||
190 cmd.argument() == "toggle")
192 else if (cmd.argument() == "assign" || cmd.argument().empty()) {
193 if (isBranchSelected())
194 flag.enabled(status() != Open);
196 flag.enabled(status() != Collapsed);
202 return InsetCollapsable::getStatus(cur, cmd, flag);
208 bool InsetBranch::isBranchSelected() const
210 Buffer const & realbuffer = *buffer().masterBuffer();
211 BranchList const & branchlist = realbuffer.params().branchlist();
212 BranchList::const_iterator const end = branchlist.end();
213 BranchList::const_iterator it =
214 find_if(branchlist.begin(), end,
215 BranchNamesEqual(params_.branch));
218 return it->getSelected();
222 void InsetBranch::updateLabels(ParIterator const & it)
224 if (isBranchSelected())
225 InsetCollapsable::updateLabels(it);
227 DocumentClass const & tclass = buffer().params().documentClass();
228 Counters savecnt = tclass.counters();
229 InsetCollapsable::updateLabels(it);
230 tclass.counters() = savecnt;
235 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
237 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
241 int InsetBranch::plaintext(odocstream & os,
242 OutputParams const & runparams) const
244 if (!isBranchSelected())
247 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
248 InsetText::plaintext(os, runparams);
251 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
255 int InsetBranch::docbook(odocstream & os,
256 OutputParams const & runparams) const
258 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
262 void InsetBranch::textString(odocstream & os) const
264 if (isBranchSelected())
265 os << paragraphs().begin()->asString(true);
269 void InsetBranch::validate(LaTeXFeatures & features) const
271 InsetText::validate(features);
275 bool InsetBranch::isMacroScope() const
277 // Its own scope if not selected by buffer
278 return !isBranchSelected();
282 string const InsetBranchMailer::name_("branch");
284 InsetBranchMailer::InsetBranchMailer(InsetBranch & inset)
289 string const InsetBranchMailer::inset2string(Buffer const &) const
291 return params2string(inset_.params());
295 string const InsetBranchMailer::params2string(InsetBranchParams const & params)
298 data << name_ << ' ';
304 void InsetBranchMailer::string2params(string const & in,
305 InsetBranchParams & params)
307 params = InsetBranchParams();
311 istringstream data(in);
318 return print_mailer_error("InsetBranchMailer", in, 1, name_);
320 // This is part of the inset proper that is usually swallowed
321 // by Text::readInset
324 if (!lex || id != "Branch")
325 return print_mailer_error("InsetBranchMailer", in, 2, "Branch");
331 void InsetBranchParams::write(ostream & os) const
333 os << "Branch " << to_utf8(branch) << '\n';
337 void InsetBranchParams::read(Lexer & lex)