#include "Buffer.h"
#include "BufferParams.h"
+#include "BufferView.h"
#include "BranchList.h"
+#include "ColorSet.h"
#include "Cursor.h"
#include "DispatchResult.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
-#include "gettext.h"
-#include "LColor.h"
#include "Lexer.h"
-#include "Paragraph.h"
+#include "LyX.h"
#include "OutputParams.h"
+#include "output_xhtml.h"
+#include "TextClass.h"
+#include "TocBackend.h"
-#include <sstream>
-
-
-namespace lyx {
-
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
+#include "support/debug.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+#include "frontends/alert.h"
+#include "frontends/Application.h"
-void InsetBranch::init()
-{
- setInsetName(from_utf8("Branch"));
- setButtonLabel();
-}
-
-
-InsetBranch::InsetBranch(BufferParams const & bp,
- InsetBranchParams const & params)
- : InsetCollapsable(bp), params_(params)
-{
- init();
-}
+#include <sstream>
+using namespace std;
-InsetBranch::InsetBranch(InsetBranch const & in)
- : InsetCollapsable(in), params_(in.params_)
-{
- init();
-}
+namespace lyx {
-InsetBranch::~InsetBranch()
-{
- InsetBranchMailer(*this).hideDialog();
-}
+InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
+ : InsetCollapsible(buf, InsetText::DefaultLayout), params_(params)
+{}
-auto_ptr<InsetBase> InsetBranch::doClone() const
+void InsetBranch::write(ostream & os) const
{
- return auto_ptr<InsetBase>(new InsetBranch(*this));
+ os << "Branch ";
+ params_.write(os);
+ os << '\n';
+ InsetCollapsible::write(os);
}
-docstring const InsetBranch::editMessage() const
+void InsetBranch::read(Lexer & lex)
{
- return _("Opened Branch Inset");
+ params_.read(lex);
+ InsetCollapsible::read(lex);
}
-void InsetBranch::write(Buffer const & buf, ostream & os) const
+docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
{
- params_.write(os);
- InsetCollapsable::write(buf, os);
+ docstring const masterstatus = isBranchSelected() ?
+ _("active") : _("non-active");
+ docstring const childstatus = isBranchSelected(true) ?
+ _("active") : _("non-active");
+ docstring const status = (masterstatus == childstatus) ?
+ masterstatus :
+ support::bformat(_("master %1$s, child %2$s"),
+ masterstatus, childstatus);
+
+ docstring const masteron = producesOutput() ?
+ _("on") : _("off");
+ docstring const childon =
+ (isBranchSelected(true) != params_.inverted) ?
+ _("on") : _("off");
+ docstring const onoff = (masteron == childon) ?
+ masteron :
+ support::bformat(_("master %1$s, child %2$s"),
+ masteron, childon);
+
+ docstring const heading =
+ support::bformat(_("Branch Name: %1$s\nBranch Status: %2$s\nInset Status: %3$s"),
+ params_.branch, status, onoff);
+
+ if (isOpen(bv))
+ return heading;
+ return toolTipText(heading + from_ascii("\n"));
}
-void InsetBranch::read(Buffer const & buf, Lexer & lex)
+docstring const InsetBranch::buttonLabel(BufferView const &) const
{
- params_.read(lex);
- InsetCollapsable::read(buf, lex);
- setButtonLabel();
-}
+ static char_type const tick = 0x2714; // ✔ U+2714 HEAVY CHECK MARK
+ static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
-
-void InsetBranch::setButtonLabel()
-{
- LyXFont font(LyXFont::ALL_SANE);
- font.decSize();
- font.decSize();
-
- docstring s = _("Branch: ") + params_.branch;
- font.setColor(LColor::foreground);
- if (!params_.branch.empty()) {
- // FIXME UNICODE
- LColor_color c = lcolor.getFromLyXName(to_utf8(params_.branch));
- if (c == LColor::none) {
- c = LColor::error;
- s = _("Undef: ") + s;
- }
- setBackgroundColor(c);
- } else
- setBackgroundColor(LColor::background);
- setLabel(isOpen() ? s : getNewLabel(s) );
- setLabelFont(font);
+ Buffer const & realbuffer = *buffer().masterBuffer();
+ BranchList const & branchlist = realbuffer.params().branchlist();
+ bool const inmaster = branchlist.find(params_.branch);
+ bool const inchild = buffer().params().branchlist().find(params_.branch);
+
+ bool const master_selected = producesOutput();
+ bool const child_selected = isBranchSelected(true) != params_.inverted;
+
+ docstring symb = docstring(1, master_selected ? tick : cross);
+ if (inchild && master_selected != child_selected)
+ symb += (child_selected ? tick : cross);
+
+ if (decoration() == InsetLayout::MINIMALISTIC)
+ return symb + params_.branch;
+
+ docstring s;
+ if (inmaster && inchild)
+ s = _("Branch: ");
+ else if (inchild) // && !inmaster
+ s = _("Branch (child): ");
+ else if (inmaster) // && !inchild
+ s = _("Branch (master): ");
+ else // !inmaster && !inchild
+ s = _("Branch (undefined): ");
+ s += params_.branch;
+
+ return symb + s;
}
-bool InsetBranch::showInsetDialog(BufferView * bv) const
+ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
{
- InsetBranchMailer(const_cast<InsetBranch &>(*this)).showDialog(bv);
- return true;
+ if (params_.branch.empty())
+ return Inset::backgroundColor(pi);
+ // FIXME UNICODE
+ ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
+ if (c == Color_none)
+ c = Color_error;
+ return c;
}
void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY: {
InsetBranchParams params;
- InsetBranchMailer::string2params(to_utf8(cmd.argument()), params);
+ InsetBranch::string2params(to_utf8(cmd.argument()), params);
+
+ cur.recordUndoInset(this);
params_.branch = params.branch;
- setButtonLabel();
+ params_.inverted = params.inverted;
+ // what we really want here is a TOC update, but that means
+ // a full buffer update
+ cur.forceBufferUpdate();
break;
}
+ case LFUN_BRANCH_ACTIVATE:
+ case LFUN_BRANCH_DEACTIVATE:
+ case LFUN_BRANCH_MASTER_ACTIVATE:
+ case LFUN_BRANCH_MASTER_DEACTIVATE: {
+ bool const master = (cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE
+ || cmd.action() == LFUN_BRANCH_MASTER_DEACTIVATE);
+ Buffer * buf = master ? const_cast<Buffer *>(buffer().masterBuffer())
+ : &buffer();
+
+ Branch * our_branch = buf->params().branchlist().find(params_.branch);
+ if (!our_branch)
+ break;
+
+ bool const activate = (cmd.action() == LFUN_BRANCH_ACTIVATE
+ || cmd.action() == LFUN_BRANCH_MASTER_ACTIVATE);
+ if (our_branch->isSelected() != activate) {
+ // FIXME If the branch is in the master document, we cannot
+ // call recordUndo..., because the master may be hidden, and
+ // the code presently assumes that hidden documents can never
+ // be dirty. See GuiView::closeBufferAll(), for example.
+ // An option would be to check if the master is hidden.
+ // If it is, unhide.
+ if (!master)
+ buffer().undo().recordUndoBufferParams(cur);
+ else
+ // at least issue a warning for now (ugly, but better than dataloss).
+ frontend::Alert::warning(_("Branch state changes in master document"),
+ lyx::support::bformat(_("The state of the branch '%1$s' "
+ "was changed in the master file. "
+ "Please make sure to save the master."), params_.branch), true);
+ our_branch->setSelected(activate);
+ // cur.forceBufferUpdate() is not enough
+ buf->updateBuffer();
+ }
- case LFUN_MOUSE_PRESS:
- if (cmd.button() != mouse_button::button3)
- InsetCollapsable::doDispatch(cur, cmd);
- else
- cur.undispatched();
+ // if branch exists in a descendant, update previews.
+ // TODO: only needed if "Show preview" is enabled in the included inset.
+ bool exists_in_desc = false;
+ for (auto const & it : buf->getDescendants()) {
+ if (it->params().branchlist().find(params_.branch))
+ exists_in_desc = true;
+ }
+ if (exists_in_desc) {
+ // TODO: ideally we would only update the previews of the
+ // specific children that have this branch directly or
+ // in one of their descendants
+ buf->removePreviews();
+ buf->updatePreviews();
+ }
break;
-
- case LFUN_INSET_DIALOG_UPDATE:
- InsetBranchMailer(*this).updateDialog(&cur.bv());
+ }
+ case LFUN_BRANCH_INVERT:
+ cur.recordUndoInset(this);
+ params_.inverted = !params_.inverted;
+ // what we really want here is a TOC update, but that means
+ // a full buffer update
+ cur.forceBufferUpdate();
break;
-
- case LFUN_MOUSE_RELEASE:
- if (cmd.button() == mouse_button::button3 && hitButton(cmd))
- InsetBranchMailer(*this).showDialog(&cur.bv());
- else
- InsetCollapsable::doDispatch(cur, cmd);
+ case LFUN_BRANCH_ADD:
+ lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, params_.branch));
break;
-
-
case LFUN_INSET_TOGGLE:
- if (cmd.argument() == "assign" || cmd.argument().empty()) {
- // The branch inset uses "assign".
- if (isBranchSelected(cur.buffer())) {
- if (status() != Open)
- setStatus(cur, Open);
- else
- cur.undispatched();
- } else {
- if (status() != Collapsed)
- setStatus(cur, Collapsed);
- else
- cur.undispatched();
- }
- }
+ if (cmd.argument() == "assign")
+ setStatus(cur, isBranchSelected() ? Open : Collapsed);
else
- InsetCollapsable::doDispatch(cur, cmd);
+ InsetCollapsible::doDispatch(cur, cmd);
break;
default:
- InsetCollapsable::doDispatch(cur, cmd);
+ InsetCollapsible::doDispatch(cur, cmd);
break;
}
}
bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
- switch (cmd.action) {
+ bool const known_branch =
+ buffer().params().branchlist().find(params_.branch);
+
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY:
- case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ flag.setEnabled(true);
+ break;
+
+ case LFUN_BRANCH_ACTIVATE:
+ flag.setEnabled(known_branch && !isBranchSelected(true));
+ break;
+
+ case LFUN_BRANCH_INVERT:
+ flag.setEnabled(true);
+ flag.setOnOff(params_.inverted);
+ break;
+
+ case LFUN_BRANCH_ADD:
+ flag.setEnabled(!known_branch);
+ break;
+
+ case LFUN_BRANCH_DEACTIVATE:
+ flag.setEnabled(isBranchSelected(true));
+ break;
+
+ case LFUN_BRANCH_MASTER_ACTIVATE:
+ flag.setEnabled(buffer().parent()
+ && buffer().masterBuffer()->params().branchlist().find(params_.branch)
+ && !isBranchSelected());
+ break;
+
+ case LFUN_BRANCH_MASTER_DEACTIVATE:
+ flag.setEnabled(buffer().parent() && isBranchSelected());
break;
case LFUN_INSET_TOGGLE:
- if (cmd.argument() == "open" || cmd.argument() == "close" ||
- cmd.argument() == "toggle")
- flag.enabled(true);
- else if (cmd.argument() == "assign"
- || cmd.argument().empty()) {
- if (isBranchSelected(cur.buffer()))
- flag.enabled(status() != Open);
- else
- flag.enabled(status() != Collapsed);
- } else
- flag.enabled(true);
+ if (cmd.argument() == "assign")
+ flag.setEnabled(true);
+ else
+ return InsetCollapsible::getStatus(cur, cmd, flag);
break;
default:
- return InsetCollapsable::getStatus(cur, cmd, flag);
+ return InsetCollapsible::getStatus(cur, cmd, flag);
}
return true;
}
-bool InsetBranch::isBranchSelected(Buffer const & buffer) const
+bool InsetBranch::isBranchSelected(bool const child) const
{
- Buffer const & realbuffer = *buffer.getMasterBuffer();
+ Buffer const & realbuffer = child ? buffer() : *buffer().masterBuffer();
BranchList const & branchlist = realbuffer.params().branchlist();
- BranchList::const_iterator const end = branchlist.end();
- BranchList::const_iterator it =
- std::find_if(branchlist.begin(), end,
- BranchNamesEqual(params_.branch));
- if (it == end)
- return false;
- return it->getSelected();
+ Branch const * ourBranch = branchlist.find(params_.branch);
+
+ if (!ourBranch) {
+ // this branch is defined in child only
+ ourBranch = buffer().params().branchlist().find(params_.branch);
+ if (!ourBranch)
+ return false;
+ }
+ return ourBranch->isSelected();
}
-int InsetBranch::latex(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+bool InsetBranch::producesOutput() const
{
- return isBranchSelected(buf) ?
- InsetText::latex(buf, os, runparams) : 0;
+ return isBranchSelected() != params_.inverted;
}
-int InsetBranch::plaintext(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
{
- if (!isBranchSelected(buf))
+ if (producesOutput()) {
+ OutputParams rp = runparams;
+ rp.inbranch = true;
+ InsetText::latex(os, rp);
+ }
+}
+
+
+int InsetBranch::plaintext(odocstringstream & os,
+ OutputParams const & runparams, size_t max_length) const
+{
+ if (!producesOutput())
return 0;
- os << '[' << _("branch") << ' ' << params_.branch << ":\n";
- InsetText::plaintext(buf, os, runparams);
- os << "\n]";
+ int len = InsetText::plaintext(os, runparams, max_length);
+ return len;
+}
+
- return PLAINTEXT_NEWLINE + 1; // one char on a separate line
+int InsetBranch::docbook(odocstream & os,
+ OutputParams const & runparams) const
+{
+ return producesOutput() ? InsetText::docbook(os, runparams) : 0;
}
-int InsetBranch::docbook(Buffer const & buf, odocstream & os,
- OutputParams const & runparams) const
+docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
{
- return isBranchSelected(buf) ?
- InsetText::docbook(buf, os, runparams) : 0;
+ if (producesOutput()) {
+ OutputParams newrp = rp;
+ newrp.par_begin = 0;
+ newrp.par_end = text().paragraphs().size();
+ xhtmlParagraphs(text(), buffer(), xs, newrp);
+ }
+ return docstring();
}
-void InsetBranch::textString(Buffer const & buf, odocstream & os) const
+void InsetBranch::toString(odocstream & os) const
{
- if (isBranchSelected(buf))
- os << paragraphs().begin()->asString(buf, true);
+ if (producesOutput())
+ InsetCollapsible::toString(os);
}
-void InsetBranch::validate(LaTeXFeatures & features) const
+void InsetBranch::forOutliner(docstring & os, size_t const maxlen,
+ bool const shorten) const
{
- InsetText::validate(features);
+ if (producesOutput())
+ InsetCollapsible::forOutliner(os, maxlen, shorten);
}
+void InsetBranch::validate(LaTeXFeatures & features) const
+{
+ if (producesOutput())
+ InsetCollapsible::validate(features);
+}
-string const InsetBranchMailer::name_("branch");
-InsetBranchMailer::InsetBranchMailer(InsetBranch & inset)
- : inset_(inset)
-{}
+string InsetBranch::contextMenuName() const
+{
+ return "context-branch";
+}
-string const InsetBranchMailer::inset2string(Buffer const &) const
+bool InsetBranch::isMacroScope() const
{
- return params2string(inset_.params());
+ // Its own scope if not selected by buffer
+ return !producesOutput();
}
-string const InsetBranchMailer::params2string(InsetBranchParams const & params)
+string InsetBranch::params2string(InsetBranchParams const & params)
{
ostringstream data;
- data << name_ << ' ';
params.write(data);
return data.str();
}
-void InsetBranchMailer::string2params(string const & in,
- InsetBranchParams & params)
+void InsetBranch::string2params(string const & in, InsetBranchParams & params)
{
params = InsetBranchParams();
if (in.empty())
return;
istringstream data(in);
- Lexer lex(0,0);
+ Lexer lex;
lex.setStream(data);
+ lex.setContext("InsetBranch::string2params");
+ params.read(lex);
+}
- string name;
- lex >> name;
- if (name != name_)
- return print_mailer_error("InsetBranchMailer", in, 1, name_);
-
- // This is part of the inset proper that is usually swallowed
- // by LyXText::readInset
- string id;
- lex >> id;
- if (!lex || id != "Branch")
- return print_mailer_error("InsetBranchMailer", in, 2, "Branch");
- params.read(lex);
+void InsetBranch::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
+{
+ setLabel(params_.branch + (params_.inverted ? " (-)" : ""));
+ InsetCollapsible::updateBuffer(it, utype, deleted);
}
void InsetBranchParams::write(ostream & os) const
{
- os << "Branch " << to_utf8(branch) << '\n';
+ os << to_utf8(branch)
+ << '\n'
+ << "inverted "
+ << inverted;
}
void InsetBranchParams::read(Lexer & lex)
{
- lex >> branch;
+ // There may be a space in branch name
+ // if we wanted to use lex>>, the branch name should be properly in quotes
+ lex.eatLine();
+ branch = lex.getDocString();
+ lex >> "inverted" >> inverted;
}
} // namespace lyx