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 "TextClass.h"
28 #include "TocBackend.h"
30 #include "support/debug.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
34 #include "frontends/Application.h"
43 InsetBranch::InsetBranch(Buffer const & buf, InsetBranchParams const & params)
44 : InsetCollapsable(buf, InsetText::DefaultLayout), params_(params)
48 InsetBranch::~InsetBranch()
50 hideDialogs("branch", this);
54 docstring InsetBranch::editMessage() const
56 return _("Opened Branch Inset");
60 void InsetBranch::write(ostream & os) const
63 InsetCollapsable::write(os);
67 void InsetBranch::read(Lexer & lex)
70 InsetCollapsable::read(lex);
74 docstring InsetBranch::toolTip(BufferView const & bv, int x, int y) const
76 docstring const status = isBranchSelected() ?
77 _("active") : _("non-active");
78 docstring const heading =
79 support::bformat(_("Branch (%1$s): %2$s"), status, params_.branch);
80 docstring const contents = InsetCollapsable::toolTip(bv, x, y);
81 if (isOpen(bv) || contents.empty())
84 return heading + from_ascii("\n") + contents;
88 docstring const InsetBranch::buttonLabel(BufferView const & bv) const
90 docstring s = _("Branch: ") + params_.branch;
91 Buffer const & realbuffer = *buffer().masterBuffer();
92 BranchList const & branchlist = realbuffer.params().branchlist();
93 if (!branchlist.find(params_.branch)
94 && buffer().params().branchlist().find(params_.branch))
95 s = _("Branch (child only): ") + params_.branch;
96 else if (!branchlist.find(params_.branch))
97 s = _("Branch (undefined): ") + params_.branch;
98 if (!params_.branch.empty()) {
100 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
102 s = _("Undef: ") + s;
104 s = char_type(isBranchSelected() ? 0x2714 : 0x2716) + s;
105 if (decoration() == InsetLayout::CLASSIC)
106 return isOpen(bv) ? s : getNewLabel(s);
108 return params_.branch + ": " + getNewLabel(s);
112 ColorCode InsetBranch::backgroundColor() const
114 if (params_.branch.empty())
115 return Inset::backgroundColor();
117 ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
124 bool InsetBranch::showInsetDialog(BufferView * bv) const
126 bv->showDialog("branch", params2string(params()),
127 const_cast<InsetBranch *>(this));
132 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
134 switch (cmd.action) {
135 case LFUN_INSET_MODIFY: {
136 InsetBranchParams params;
137 InsetBranch::string2params(to_utf8(cmd.argument()), params);
138 params_.branch = params.branch;
139 setLayout(cur.buffer()->params());
143 case LFUN_INSET_DIALOG_UPDATE:
144 cur.bv().updateDialog("branch", params2string(params()));
147 case LFUN_BRANCH_ACTIVATE:
148 case LFUN_BRANCH_DEACTIVATE: {
149 // FIXME: I do not like this cast, but have no other idea...
150 Buffer const * buf = buffer().masterBuffer();
151 BranchList const & branchlist = buf->params().branchlist();
152 Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
155 our_branch->setSelected(cmd.action == LFUN_BRANCH_ACTIVATE);
159 case LFUN_INSET_TOGGLE:
160 if (cmd.argument() == "assign")
161 setStatus(cur, isBranchSelected() ? Open : Collapsed);
163 InsetCollapsable::doDispatch(cur, cmd);
167 InsetCollapsable::doDispatch(cur, cmd);
173 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
174 FuncStatus & flag) const
176 switch (cmd.action) {
177 case LFUN_INSET_MODIFY:
178 case LFUN_INSET_DIALOG_UPDATE:
179 flag.setEnabled(true);
182 case LFUN_BRANCH_ACTIVATE:
183 flag.setEnabled(!isBranchSelected());
186 case LFUN_BRANCH_DEACTIVATE:
187 flag.setEnabled(isBranchSelected());
190 case LFUN_INSET_TOGGLE:
191 if (cmd.argument() == "assign")
192 flag.setEnabled(true);
194 return InsetCollapsable::getStatus(cur, cmd, flag);
197 return InsetCollapsable::getStatus(cur, cmd, flag);
203 bool InsetBranch::isBranchSelected() const
205 Buffer const & realbuffer = *buffer().masterBuffer();
206 BranchList const & branchlist = realbuffer.params().branchlist();
207 Branch const * ourBranch = branchlist.find(params_.branch);
210 return ourBranch->isSelected();
214 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
216 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
220 int InsetBranch::plaintext(odocstream & os,
221 OutputParams const & runparams) const
223 if (!isBranchSelected())
226 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
227 InsetText::plaintext(os, runparams);
230 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
234 int InsetBranch::docbook(odocstream & os,
235 OutputParams const & runparams) const
237 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
241 docstring InsetBranch::xhtml(odocstream & os, OutputParams const & rp) const
243 if (isBranchSelected())
244 return InsetText::xhtml(os, rp);
249 void InsetBranch::tocString(odocstream & os) const
251 if (isBranchSelected())
252 InsetCollapsable::tocString(os);
256 void InsetBranch::validate(LaTeXFeatures & features) const
258 if (isBranchSelected())
259 InsetCollapsable::validate(features);
263 docstring InsetBranch::contextMenu(BufferView const &, int, int) const
265 return from_ascii("context-branch");
269 bool InsetBranch::isMacroScope() const
271 // Its own scope if not selected by buffer
272 return !isBranchSelected();
276 string InsetBranch::params2string(InsetBranchParams const & params)
279 data << "branch" << ' ';
285 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
287 params = InsetBranchParams();
291 istringstream data(in);
294 lex.setContext("InsetBranch::string2params");
295 lex >> "branch" >> "Branch";
300 void InsetBranch::addToToc(DocIterator const & cpit)
302 DocIterator pit = cpit;
303 pit.push_back(CursorSlice(*this));
305 Toc & toc = buffer().tocBackend().toc("branch");
306 docstring const str = params_.branch + ": " + text().getPar(0).asString();
307 toc.push_back(TocItem(pit, 0, str));
308 // Proceed with the rest of the inset.
309 InsetCollapsable::addToToc(cpit);
313 void InsetBranchParams::write(ostream & os) const
315 os << "Branch " << to_utf8(branch) << '\n';
319 void InsetBranchParams::read(Lexer & lex)
322 branch = lex.getDocString();