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;
142 case LFUN_INSET_DIALOG_UPDATE:
143 cur.bv().updateDialog("branch", params2string(params()));
146 case LFUN_BRANCH_ACTIVATE:
147 case LFUN_BRANCH_DEACTIVATE: {
148 // FIXME: I do not like this cast, but have no other idea...
149 Buffer const * buf = buffer().masterBuffer();
150 BranchList const & branchlist = buf->params().branchlist();
151 Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
154 our_branch = buffer().params().branchlist().find(params_.branch);
158 our_branch->setSelected(cmd.action == LFUN_BRANCH_ACTIVATE);
162 case LFUN_INSET_TOGGLE:
163 if (cmd.argument() == "assign")
164 setStatus(cur, isBranchSelected() ? Open : Collapsed);
166 InsetCollapsable::doDispatch(cur, cmd);
170 InsetCollapsable::doDispatch(cur, cmd);
176 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
177 FuncStatus & flag) const
179 switch (cmd.action) {
180 case LFUN_INSET_MODIFY:
181 case LFUN_INSET_DIALOG_UPDATE:
182 flag.setEnabled(true);
185 case LFUN_BRANCH_ACTIVATE:
186 flag.setEnabled(!isBranchSelected());
189 case LFUN_BRANCH_DEACTIVATE:
190 flag.setEnabled(isBranchSelected());
193 case LFUN_INSET_TOGGLE:
194 if (cmd.argument() == "assign")
195 flag.setEnabled(true);
197 return InsetCollapsable::getStatus(cur, cmd, flag);
200 return InsetCollapsable::getStatus(cur, cmd, flag);
206 bool InsetBranch::isBranchSelected() const
208 Buffer const & realbuffer = *buffer().masterBuffer();
209 BranchList const & branchlist = realbuffer.params().branchlist();
210 Branch const * ourBranch = branchlist.find(params_.branch);
213 // this branch is defined in child only
214 ourBranch = buffer().params().branchlist().find(params_.branch);
218 return ourBranch->isSelected();
222 int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
224 return isBranchSelected() ? InsetText::latex(os, runparams) : 0;
228 int InsetBranch::plaintext(odocstream & os,
229 OutputParams const & runparams) const
231 if (!isBranchSelected())
234 os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
235 InsetText::plaintext(os, runparams);
238 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
242 int InsetBranch::docbook(odocstream & os,
243 OutputParams const & runparams) const
245 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
249 docstring InsetBranch::xhtml(odocstream & os, OutputParams const & rp) const
251 if (isBranchSelected())
252 return InsetText::xhtml(os, rp);
257 void InsetBranch::tocString(odocstream & os) const
259 if (isBranchSelected())
260 InsetCollapsable::tocString(os);
264 void InsetBranch::validate(LaTeXFeatures & features) const
266 if (isBranchSelected())
267 InsetCollapsable::validate(features);
271 docstring InsetBranch::contextMenu(BufferView const &, int, int) const
273 return from_ascii("context-branch");
277 bool InsetBranch::isMacroScope() const
279 // Its own scope if not selected by buffer
280 return !isBranchSelected();
284 string InsetBranch::params2string(InsetBranchParams const & params)
287 data << "branch" << ' ';
293 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
295 params = InsetBranchParams();
299 istringstream data(in);
302 lex.setContext("InsetBranch::string2params");
303 lex >> "branch" >> "Branch";
308 void InsetBranch::addToToc(DocIterator const & cpit)
310 DocIterator pit = cpit;
311 pit.push_back(CursorSlice(*this));
313 Toc & toc = buffer().tocBackend().toc("branch");
314 docstring const str = params_.branch + ": " + text().getPar(0).asString();
315 toc.push_back(TocItem(pit, 0, str));
316 // Proceed with the rest of the inset.
317 InsetCollapsable::addToToc(cpit);
321 void InsetBranchParams::write(ostream & os) const
323 os << "Branch " << to_utf8(branch) << '\n';
327 void InsetBranchParams::read(Lexer & lex)
330 branch = lex.getDocString();