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);
120 cur.recordUndoInset(ATOMIC_UNDO, this);
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 Buffer * buf = const_cast<Buffer *>(buffer().masterBuffer());
130 // is the branch in our master buffer?
131 bool branch_in_master = (buf != &buffer());
133 Branch * our_branch = buf->params().branchlist().find(params_.branch);
134 if (branch_in_master && !our_branch) {
136 our_branch = buffer().params().branchlist().find(params_.branch);
139 branch_in_master = false;
141 bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE);
142 if (our_branch->isSelected() != activate) {
143 // FIXME If the branch is in the master document, we cannot
144 // call recordUndo..., becuase the master may be hidden, and
145 // the code presently assumes that hidden documents can never
146 // be dirty. See GuiView::closeBufferAll(), for example.
147 if (!branch_in_master)
148 buffer().undo().recordUndoFullDocument(cur);
149 our_branch->setSelected(activate);
150 cur.forceBufferUpdate();
154 case LFUN_INSET_TOGGLE:
155 if (cmd.argument() == "assign")
156 setStatus(cur, isBranchSelected() ? Open : Collapsed);
158 InsetCollapsable::doDispatch(cur, cmd);
162 InsetCollapsable::doDispatch(cur, cmd);
168 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
169 FuncStatus & flag) const
171 switch (cmd.action()) {
172 case LFUN_INSET_MODIFY:
173 flag.setEnabled(true);
176 case LFUN_BRANCH_ACTIVATE:
177 flag.setEnabled(!isBranchSelected());
180 case LFUN_BRANCH_DEACTIVATE:
181 flag.setEnabled(isBranchSelected());
184 case LFUN_INSET_TOGGLE:
185 if (cmd.argument() == "assign")
186 flag.setEnabled(true);
188 return InsetCollapsable::getStatus(cur, cmd, flag);
192 return InsetCollapsable::getStatus(cur, cmd, flag);
198 bool InsetBranch::isBranchSelected() const
200 Buffer const & realbuffer = *buffer().masterBuffer();
201 BranchList const & branchlist = realbuffer.params().branchlist();
202 Branch const * ourBranch = branchlist.find(params_.branch);
205 // this branch is defined in child only
206 ourBranch = buffer().params().branchlist().find(params_.branch);
210 return ourBranch->isSelected();
214 void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
216 if (isBranchSelected())
217 InsetText::latex(os, runparams);
221 int InsetBranch::plaintext(odocstream & os,
222 OutputParams const & runparams) const
224 if (!isBranchSelected())
227 int len = InsetText::plaintext(os, runparams);
232 int InsetBranch::docbook(odocstream & os,
233 OutputParams const & runparams) const
235 return isBranchSelected() ? InsetText::docbook(os, runparams) : 0;
239 docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
241 if (isBranchSelected()) {
242 OutputParams newrp = rp;
244 newrp.par_end = text().paragraphs().size();
245 xhtmlParagraphs(text(), buffer(), xs, newrp);
251 void InsetBranch::toString(odocstream & os) const
253 if (isBranchSelected())
254 InsetCollapsable::toString(os);
258 void InsetBranch::forToc(docstring & os, size_t maxlen) const
260 if (isBranchSelected())
261 InsetCollapsable::forToc(os, maxlen);
265 void InsetBranch::validate(LaTeXFeatures & features) const
267 if (isBranchSelected())
268 InsetCollapsable::validate(features);
272 string InsetBranch::contextMenuName() const
274 return "context-branch";
278 bool InsetBranch::isMacroScope() const
280 // Its own scope if not selected by buffer
281 return !isBranchSelected();
285 string InsetBranch::params2string(InsetBranchParams const & params)
293 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
295 params = InsetBranchParams();
299 istringstream data(in);
302 lex.setContext("InsetBranch::string2params");
307 void InsetBranch::addToToc(DocIterator const & cpit) const
309 DocIterator pit = cpit;
310 pit.push_back(CursorSlice(const_cast<InsetBranch &>(*this)));
312 Toc & toc = buffer().tocBackend().toc("branch");
313 docstring str = params_.branch + ": ";
314 text().forToc(str, TOC_ENTRY_LENGTH);
315 toc.push_back(TocItem(pit, 0, str, toolTipText(docstring(), 3, 60)));
316 // Proceed with the rest of the inset.
317 InsetCollapsable::addToToc(cpit);
321 void InsetBranchParams::write(ostream & os) const
323 os << to_utf8(branch);
327 void InsetBranchParams::read(Lexer & lex)
330 branch = lex.getDocString();