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"
21 #include "DispatchResult.h"
22 #include "FuncRequest.h"
23 #include "FuncStatus.h"
26 #include "output_docbook.h"
27 #include "output_xhtml.h"
28 #include "TextClass.h"
29 #include "TocBackend.h"
31 #include "support/convert.h"
32 #include "support/debug.h"
33 #include "support/gettext.h"
34 #include "support/lstrings.h"
36 #include "frontends/alert.h"
37 #include "frontends/Application.h"
46 InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
47 : InsetCollapsible(buf, InsetText::DefaultLayout), params_(params)
51 void InsetBranch::write(ostream & os) const
56 InsetCollapsible::write(os);
60 void InsetBranch::read(Lexer & lex)
63 InsetCollapsible::read(lex);
67 docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
69 docstring const masterstatus = isBranchSelected() ?
70 _("active") : _("non-active");
71 docstring const childstatus = isBranchSelected(true) ?
72 _("active") : _("non-active");
73 docstring const status = (masterstatus == childstatus) ?
75 support::bformat(_("master %1$s, child %2$s"),
76 masterstatus, childstatus);
78 docstring const masteron = producesOutput() ?
80 docstring const childon =
81 (isBranchSelected(true) != params_.inverted) ?
83 docstring const onoff = (masteron == childon) ?
85 support::bformat(_("master %1$s, child %2$s"),
88 docstring const heading =
89 support::bformat(_("Branch Name: %1$s\nBranch Status: %2$s\nInset Status: %3$s"),
90 params_.branch, status, onoff);
94 return toolTipText(heading + from_ascii("\n"));
98 docstring const InsetBranch::buttonLabel(BufferView const &) const
100 static char_type const tick = 0x2714; // ✔ U+2714 HEAVY CHECK MARK
101 static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
103 Buffer const & realbuffer = *buffer().masterBuffer();
104 BranchList const & branchlist = realbuffer.params().branchlist();
105 bool const inmaster = branchlist.find(params_.branch);
106 bool const inchild = buffer().params().branchlist().find(params_.branch);
108 bool const master_selected = producesOutput();
109 bool const child_selected = isBranchSelected(true) != params_.inverted;
111 docstring symb = docstring(1, master_selected ? tick : cross);
112 if (inchild && master_selected != child_selected)
113 symb += (child_selected ? tick : cross);
115 docstring inv_symb = from_ascii(params_.inverted ? "~" : "");
117 if (decoration() == InsetDecoration::MINIMALISTIC)
118 return symb + inv_symb + params_.branch;
121 if (inmaster && inchild)
123 else if (inchild) // && !inmaster
124 s = _("Branch (child): ");
125 else if (inmaster) // && !inchild
126 s = _("Branch (master): ");
127 else // !inmaster && !inchild
128 s = _("Branch (undefined): ");
129 s += inv_symb + params_.branch;
135 ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
137 if (params_.branch.empty())
138 return Inset::backgroundColor(pi);
139 string const branch_id = (buffer().masterParams().branchlist().find(params_.branch))
140 ? convert<string>(buffer().masterParams().branchlist().id())
141 : convert<string>(buffer().params().branchlist().id());
143 string const branchcol = "branch" + branch_id + to_utf8(params_.branch);
144 ColorCode c = lcolor.getFromLyXName(branchcol);
151 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
153 switch (cmd.action()) {
154 case LFUN_INSET_MODIFY: {
155 InsetBranchParams params;
156 InsetBranch::string2params(to_utf8(cmd.argument()), params);
158 cur.recordUndoInset(this);
159 params_.branch = params.branch;
160 params_.inverted = params.inverted;
161 // what we really want here is a TOC update, but that means
162 // a full buffer update
163 cur.forceBufferUpdate();
166 case LFUN_BRANCH_ACTIVATE:
167 case LFUN_BRANCH_DEACTIVATE:
168 case LFUN_BRANCH_MASTER_ACTIVATE:
169 case LFUN_BRANCH_MASTER_DEACTIVATE: {
170 bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
171 || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
172 Buffer * buf = master ? const_cast<Buffer *>(buffer().masterBuffer())
175 Branch * our_branch = buf->params().branchlist().find(params_.branch);
179 bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE
180 || cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE);
181 if (our_branch->isSelected() != activate) {
182 // FIXME If the branch is in the master document, we cannot
183 // call recordUndo..., because the master may be hidden, and
184 // the code presently assumes that hidden documents can never
185 // be dirty. See GuiView::closeBufferAll(), for example.
186 // An option would be to check if the master is hidden.
189 buffer().undo().recordUndoBufferParams(cur);
191 // at least issue a warning for now (ugly, but better than dataloss).
192 frontend::Alert::warning(_("Branch state changes in master document"),
193 lyx::support::bformat(_("The state of the branch '%1$s' "
194 "was changed in the master file. "
195 "Please make sure to save the master."), params_.branch), true);
196 our_branch->setSelected(activate);
197 // cur.forceBufferUpdate() is not enough
201 // if branch exists in a descendant, update previews.
202 // TODO: only needed if "Show preview" is enabled in the included inset.
203 bool exists_in_desc = false;
204 for (auto const & it : buf->getDescendants()) {
205 if (it->params().branchlist().find(params_.branch))
206 exists_in_desc = true;
208 if (exists_in_desc) {
209 // TODO: ideally we would only update the previews of the
210 // specific children that have this branch directly or
211 // in one of their descendants
212 buf->removePreviews();
213 buf->updatePreviews();
217 case LFUN_BRANCH_INVERT:
218 cur.recordUndoInset(this);
219 params_.inverted = !params_.inverted;
220 // what we really want here is a TOC update, but that means
221 // a full buffer update
222 cur.forceBufferUpdate();
224 case LFUN_BRANCH_ADD:
225 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, params_.branch));
227 case LFUN_BRANCH_SYNC_ALL:
228 lyx::dispatch(FuncRequest(LFUN_INSET_FORALL, "Branch:" + params_.branch + " inset-toggle assign"));
230 case LFUN_INSET_TOGGLE:
231 if (cmd.argument() == "assign")
232 setStatus(cur, (isBranchSelected(true) != params_.inverted) ? Open : Collapsed);
234 InsetCollapsible::doDispatch(cur, cmd);
238 InsetCollapsible::doDispatch(cur, cmd);
244 bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
245 FuncStatus & flag) const
247 bool const known_branch =
248 buffer().params().branchlist().find(params_.branch);
250 switch (cmd.action()) {
251 case LFUN_INSET_MODIFY:
252 flag.setEnabled(true);
255 case LFUN_BRANCH_ACTIVATE:
256 flag.setEnabled(known_branch && !isBranchSelected(true));
259 case LFUN_BRANCH_INVERT:
260 flag.setEnabled(true);
261 flag.setOnOff(params_.inverted);
264 case LFUN_BRANCH_ADD:
265 flag.setEnabled(!known_branch);
268 case LFUN_BRANCH_DEACTIVATE:
269 flag.setEnabled(isBranchSelected(true));
272 case LFUN_BRANCH_MASTER_ACTIVATE:
273 flag.setEnabled(buffer().parent()
274 && buffer().masterBuffer()->params().branchlist().find(params_.branch)
275 && !isBranchSelected());
278 case LFUN_BRANCH_MASTER_DEACTIVATE:
279 flag.setEnabled(buffer().parent() && isBranchSelected());
282 case LFUN_BRANCH_SYNC_ALL:
283 flag.setEnabled(known_branch);
286 case LFUN_INSET_TOGGLE:
287 if (cmd.argument() == "assign")
288 flag.setEnabled(true);
290 return InsetCollapsible::getStatus(cur, cmd, flag);
294 return InsetCollapsible::getStatus(cur, cmd, flag);
300 bool InsetBranch::isBranchSelected(bool const child) const
302 Buffer const & realbuffer = child ? buffer() : *buffer().masterBuffer();
303 BranchList const & branchlist = realbuffer.params().branchlist();
304 Branch const * ourBranch = branchlist.find(params_.branch);
307 // this branch is defined in child only
308 ourBranch = buffer().params().branchlist().find(params_.branch);
312 return ourBranch->isSelected();
316 bool InsetBranch::producesOutput() const
318 return isBranchSelected() != params_.inverted;
322 void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
324 if (producesOutput() || ((runparams.for_search & OutputParams::SearchNonOutput) != 0)) {
325 OutputParams rp = runparams;
327 InsetText::latex(os, rp);
328 // These need to be passed upstream
329 runparams.need_maketitle = rp.need_maketitle;
330 runparams.have_maketitle = rp.have_maketitle;
335 int InsetBranch::plaintext(odocstringstream & os,
336 OutputParams const & runparams, size_t max_length) const
338 if (!producesOutput() && ((runparams.for_search & OutputParams::SearchNonOutput) == 0))
341 int len = InsetText::plaintext(os, runparams, max_length);
346 void InsetBranch::docbook(XMLStream & xs, OutputParams const & runparams) const
348 if (producesOutput()) {
349 OutputParams rp = runparams;
351 rp.par_end = text().paragraphs().size();
352 docbookParagraphs(text(), buffer(), xs, rp);
357 docstring InsetBranch::xhtml(XMLStream & xs, OutputParams const & rp) const
359 if (producesOutput()) {
360 OutputParams newrp = rp;
362 newrp.par_end = text().paragraphs().size();
363 xhtmlParagraphs(text(), buffer(), xs, newrp);
369 void InsetBranch::toString(odocstream & os) const
371 if (producesOutput())
372 InsetCollapsible::toString(os);
376 void InsetBranch::forOutliner(docstring & os, size_t const maxlen,
377 bool const shorten) const
379 if (producesOutput())
380 InsetCollapsible::forOutliner(os, maxlen, shorten);
384 void InsetBranch::validate(LaTeXFeatures & features) const
386 if (producesOutput())
387 InsetCollapsible::validate(features);
391 string InsetBranch::contextMenuName() const
393 return "context-branch";
397 bool InsetBranch::isMacroScope() const
399 // Its own scope if not selected by buffer
400 return !producesOutput();
404 string InsetBranch::params2string(InsetBranchParams const & params)
412 void InsetBranch::string2params(string const & in, InsetBranchParams & params)
414 params = InsetBranchParams();
418 istringstream data(in);
421 lex.setContext("InsetBranch::string2params");
426 void InsetBranch::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
428 setLabel(params_.branch + (params_.inverted ? " (-)" : ""));
429 InsetCollapsible::updateBuffer(it, utype, deleted);
433 void InsetBranchParams::write(ostream & os) const
435 os << to_utf8(branch)
442 void InsetBranchParams::read(Lexer & lex)
444 // There may be a space in branch name
445 // if we wanted to use lex>>, the branch name should be properly in quotes
447 branch = lex.getDocString();
448 lex >> "inverted" >> inverted;