]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBranch.cpp
Ask for saving changes when branch state in child was altered
[lyx.git] / src / insets / InsetBranch.cpp
index 6a2519fee55d27e2bd73e0e703c3d786e01969d9..db047c2f3d3085e5bbbd08fa7dea03dc6f44013d 100644 (file)
@@ -23,7 +23,9 @@
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "Lexer.h"
+#include "LyX.h"
 #include "OutputParams.h"
+#include "output_xhtml.h"
 #include "TextClass.h"
 #include "TocBackend.h"
 
@@ -31,6 +33,7 @@
 #include "support/gettext.h"
 #include "support/lstrings.h"
 
+#include "frontends/alert.h"
 #include "frontends/Application.h"
 
 #include <sstream>
@@ -40,26 +43,16 @@ using namespace std;
 
 namespace lyx {
 
-InsetBranch::InsetBranch(Buffer const & buf, InsetBranchParams const & params)
+InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
        : InsetCollapsable(buf, InsetText::DefaultLayout), params_(params)
 {}
 
 
-InsetBranch::~InsetBranch()
-{
-       hideDialogs("branch", this);
-}
-
-
-docstring InsetBranch::editMessage() const
-{
-       return _("Opened Branch Inset");
-}
-
-
 void InsetBranch::write(ostream & os) const
 {
+       os << "Branch ";
        params_.write(os);
+       os << '\n';
        InsetCollapsable::write(os);
 }
 
@@ -71,17 +64,21 @@ void InsetBranch::read(Lexer & lex)
 }
 
 
-docstring InsetBranch::toolTip(BufferView const & bv, int x, int y) const
+docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
 {
-       docstring const status = isBranchSelected() ? 
+       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 heading = 
                support::bformat(_("Branch (%1$s): %2$s"), status, params_.branch);
-       docstring const contents = InsetCollapsable::toolTip(bv, x, y);
-       if (isOpen(bv) || contents.empty())
+       if (isOpen(bv))
                return heading;
-       else
-               return heading + from_ascii("\n") + contents;
+       return toolTipText(heading + from_ascii("\n"));
 }
 
 
@@ -90,10 +87,13 @@ docstring const InsetBranch::buttonLabel(BufferView const & bv) const
        docstring s = _("Branch: ") + params_.branch;
        Buffer const & realbuffer = *buffer().masterBuffer();
        BranchList const & branchlist = realbuffer.params().branchlist();
-       if (!branchlist.find(params_.branch)
-           && buffer().params().branchlist().find(params_.branch))
+       bool const inmaster = branchlist.find(params_.branch);
+       bool const inchild = buffer().params().branchlist().find(params_.branch);
+       if (!inmaster && inchild)
                s = _("Branch (child only): ") + params_.branch;
-       else if (!branchlist.find(params_.branch))
+       else if (inmaster && !inchild)
+               s = _("Branch (master only): ") + params_.branch;
+       else if (!inmaster)
                s = _("Branch (undefined): ") + params_.branch;
        if (!params_.branch.empty()) {
                // FIXME UNICODE
@@ -101,7 +101,12 @@ docstring const InsetBranch::buttonLabel(BufferView const & bv) const
                if (c == Color_none)
                        s = _("Undef: ") + s;
        }
-       s = char_type(isBranchSelected() ? 0x2714 : 0x2716) + s;
+       bool const master_selected = isBranchSelected();
+       bool const child_selected = isBranchSelected(true);
+       docstring symb = docstring(1, char_type(master_selected ? 0x2714 : 0x2716));
+       if (inchild && master_selected != child_selected)
+               symb += char_type(child_selected ? 0x2714 : 0x2716);
+       s = symb + s;
        if (decoration() == InsetLayout::CLASSIC)
                return isOpen(bv) ? s : getNewLabel(s);
        else
@@ -109,10 +114,10 @@ docstring const InsetBranch::buttonLabel(BufferView const & bv) const
 }
 
 
-ColorCode InsetBranch::backgroundColor() const
+ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
 {
        if (params_.branch.empty())
-               return Inset::backgroundColor();
+               return Inset::backgroundColor(pi);
        // FIXME UNICODE
        ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
        if (c == Color_none)
@@ -121,45 +126,59 @@ ColorCode InsetBranch::backgroundColor() const
 }
 
 
-bool InsetBranch::showInsetDialog(BufferView * bv) const
-{
-       bv->showDialog("branch", params2string(params()),
-                       const_cast<InsetBranch *>(this));
-       return true;
-}
-
-
 void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
        case LFUN_INSET_MODIFY: {
                InsetBranchParams params;
                InsetBranch::string2params(to_utf8(cmd.argument()), params);
+
+               cur.recordUndoInset(ATOMIC_UNDO, this);
                params_.branch = params.branch;
-               setLayout(cur.buffer()->params());
+               // what we really want here is a TOC update, but that means
+               // a full buffer update
+               cur.forceBufferUpdate();
                break;
        }
-
-       case LFUN_INSET_DIALOG_UPDATE:
-               cur.bv().updateDialog("branch", params2string(params()));
-               break;
-
        case LFUN_BRANCH_ACTIVATE:
-       case LFUN_BRANCH_DEACTIVATE: {
-               // FIXME: I do not like this cast, but have no other idea...
-               Buffer const * buf = buffer().masterBuffer();
-               BranchList const & branchlist = buf->params().branchlist();
-               Branch * our_branch = const_cast<Branch *>(branchlist.find(params_.branch));
-               if (!our_branch) {
-                       // child only?
-                       our_branch = buffer().params().branchlist().find(params_.branch);
-                       if (!our_branch)
-                               break;
+       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().recordUndoFullDocument(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();
                }
-               our_branch->setSelected(cmd.action == LFUN_BRANCH_ACTIVATE);
                break;
        }
-
+       case LFUN_BRANCH_ADD:
+               lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, params_.branch));
+               break;
        case LFUN_INSET_TOGGLE:
                if (cmd.argument() == "assign")
                        setStatus(cur, isBranchSelected() ? Open : Collapsed);
@@ -177,18 +196,34 @@ void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
 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.setEnabled(true);
                break;
 
        case LFUN_BRANCH_ACTIVATE:
-               flag.setEnabled(!isBranchSelected());
+               flag.setEnabled(known_branch && !isBranchSelected(true));
+               break;
+
+       case LFUN_BRANCH_ADD:
+               flag.setEnabled(!known_branch);
                break;
 
        case LFUN_BRANCH_DEACTIVATE:
-               flag.setEnabled(isBranchSelected());
+               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:
@@ -196,6 +231,7 @@ bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
                        flag.setEnabled(true);
                else
                        return InsetCollapsable::getStatus(cur, cmd, flag);     
+               break;
 
        default:
                return InsetCollapsable::getStatus(cur, cmd, flag);
@@ -204,9 +240,9 @@ bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-bool InsetBranch::isBranchSelected() const
+bool InsetBranch::isBranchSelected(bool const child) const
 {
-       Buffer const & realbuffer = *buffer().masterBuffer();
+       Buffer const & realbuffer = child ? buffer() : *buffer().masterBuffer();
        BranchList const & branchlist = realbuffer.params().branchlist();
        Branch const * ourBranch = branchlist.find(params_.branch);
 
@@ -220,9 +256,10 @@ bool InsetBranch::isBranchSelected() const
 }
 
 
-int InsetBranch::latex(odocstream & os, OutputParams const & runparams) const
+void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
 {
-       return isBranchSelected() ?  InsetText::latex(os, runparams) : 0;
+       if (isBranchSelected())
+               InsetText::latex(os, runparams);
 }
 
 
@@ -232,11 +269,8 @@ int InsetBranch::plaintext(odocstream & os,
        if (!isBranchSelected())
                return 0;
 
-       os << '[' << buffer().B_("branch") << ' ' << params_.branch << ":\n";
-       InsetText::plaintext(os, runparams);
-       os << "\n]";
-
-       return PLAINTEXT_NEWLINE + 1; // one char on a separate line
+       int len = InsetText::plaintext(os, runparams);
+       return len;
 }
 
 
@@ -247,18 +281,29 @@ int InsetBranch::docbook(odocstream & os,
 }
 
 
-docstring InsetBranch::xhtml(odocstream & os, OutputParams const & rp) const
+docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 {
-       if (isBranchSelected())
-                return InsetText::xhtml(os, rp);
+       if (isBranchSelected()) {
+               OutputParams newrp = rp;
+               newrp.par_begin = 0;
+               newrp.par_end = text().paragraphs().size();
+               xhtmlParagraphs(text(), buffer(), xs, newrp);
+       }
        return docstring();
 }
 
 
-void InsetBranch::tocString(odocstream & os) const
+void InsetBranch::toString(odocstream & os) const
+{
+       if (isBranchSelected())
+               InsetCollapsable::toString(os);
+}
+
+
+void InsetBranch::forToc(docstring & os, size_t maxlen) const
 {
        if (isBranchSelected())
-               InsetCollapsable::tocString(os);
+               InsetCollapsable::forToc(os, maxlen);
 }
 
 
@@ -269,9 +314,9 @@ void InsetBranch::validate(LaTeXFeatures & features) const
 }
 
 
-docstring InsetBranch::contextMenu(BufferView const &, int, int) const
+string InsetBranch::contextMenuName() const
 {
-       return from_ascii("context-branch");
+       return "context-branch";
 }
 
 
@@ -285,7 +330,6 @@ bool InsetBranch::isMacroScope() const
 string InsetBranch::params2string(InsetBranchParams const & params)
 {
        ostringstream data;
-       data << "branch" << ' ';
        params.write(data);
        return data.str();
 }
@@ -301,19 +345,19 @@ void InsetBranch::string2params(string const & in, InsetBranchParams & params)
        Lexer lex;
        lex.setStream(data);
        lex.setContext("InsetBranch::string2params");
-       lex >> "branch" >> "Branch";
        params.read(lex);
 }
 
 
-void InsetBranch::addToToc(DocIterator const & cpit)
+void InsetBranch::addToToc(DocIterator const & cpit) const
 {
        DocIterator pit = cpit;
-       pit.push_back(CursorSlice(*this));
+       pit.push_back(CursorSlice(const_cast<InsetBranch &>(*this)));
 
        Toc & toc = buffer().tocBackend().toc("branch");
-       docstring const str = params_.branch + ": " + text().getPar(0).asString();
-       toc.push_back(TocItem(pit, 0, str));
+       docstring str = params_.branch + ": ";
+       text().forToc(str, TOC_ENTRY_LENGTH);
+       toc.push_back(TocItem(pit, 0, str, toolTipText(docstring(), 3, 60)));
        // Proceed with the rest of the inset.
        InsetCollapsable::addToToc(cpit);
 }
@@ -321,7 +365,7 @@ void InsetBranch::addToToc(DocIterator const & cpit)
 
 void InsetBranchParams::write(ostream & os) const
 {
-       os << "Branch " << to_utf8(branch) << '\n';
+       os << to_utf8(branch);
 }