]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetBranch.cpp
DocBook, InsetFloat: avoid a potential nullptr dereference when detecting the type...
[features.git] / src / insets / InsetBranch.cpp
index 8f4b77b0033fd06a5fd42a2ac031adf074ec34da..be8e5517472da67010b95ee6b54d66b45d918137 100644 (file)
 #include "BufferView.h"
 #include "BranchList.h"
 #include "ColorSet.h"
-#include "Counters.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "Lexer.h"
 #include "LyX.h"
-#include "OutputParams.h"
+#include "output_docbook.h"
 #include "output_xhtml.h"
 #include "TextClass.h"
 #include "TocBackend.h"
 
+#include "support/convert.h"
 #include "support/debug.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
@@ -44,7 +44,7 @@ using namespace std;
 namespace lyx {
 
 InsetBranch::InsetBranch(Buffer * buf, InsetBranchParams const & params)
-       : InsetCollapsable(buf, InsetText::DefaultLayout), params_(params)
+       : InsetCollapsible(buf, InsetText::DefaultLayout), params_(params)
 {}
 
 
@@ -53,18 +53,18 @@ void InsetBranch::write(ostream & os) const
        os << "Branch ";
        params_.write(os);
        os << '\n';
-       InsetCollapsable::write(os);
+       InsetCollapsible::write(os);
 }
 
 
 void InsetBranch::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(lex);
+       InsetCollapsible::read(lex);
 }
 
 
-docstring InsetBranch::toolTip(BufferView const &, int, int) const
+docstring InsetBranch::toolTip(BufferView const & bv, int, int) const
 {
        docstring const masterstatus = isBranchSelected() ?
                _("active") : _("non-active");
@@ -77,17 +77,21 @@ docstring InsetBranch::toolTip(BufferView const &, int, int) const
 
        docstring const masteron = producesOutput() ?
                _("on") : _("off");
-       docstring const childon = producesOutput(true) ?
-               _("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 = 
+       docstring const heading =
                support::bformat(_("Branch Name: %1$s\nBranch Status: %2$s\nInset Status: %3$s"),
                                                 params_.branch, status, onoff);
-       return toolTipText(heading);
+
+       if (isOpen(bv))
+               return heading;
+       return toolTipText(heading + from_ascii("\n"));
 }
 
 
@@ -102,14 +106,16 @@ docstring const InsetBranch::buttonLabel(BufferView const &) const
        bool const inchild = buffer().params().branchlist().find(params_.branch);
 
        bool const master_selected = producesOutput();
-       bool const child_selected = producesOutput(true);
+       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 inv_symb = from_ascii(params_.inverted ? "~" : "");
+
+       if (decoration() == InsetDecoration::MINIMALISTIC)
+               return symb + inv_symb + params_.branch;
 
        docstring s;
        if (inmaster && inchild)
@@ -120,7 +126,7 @@ docstring const InsetBranch::buttonLabel(BufferView const &) const
                s = _("Branch (master): ");
        else // !inmaster && !inchild
                s = _("Branch (undefined): ");
-       s += params_.branch;
+       s += inv_symb + params_.branch;
 
        return symb + s;
 }
@@ -130,8 +136,12 @@ ColorCode InsetBranch::backgroundColor(PainterInfo const & pi) const
 {
        if (params_.branch.empty())
                return Inset::backgroundColor(pi);
+       string const branch_id = (buffer().masterParams().branchlist().find(params_.branch))
+                       ? convert<string>(buffer().masterParams().branchlist().id())
+                       : convert<string>(buffer().params().branchlist().id());
        // FIXME UNICODE
-       ColorCode c = lcolor.getFromLyXName(to_utf8(params_.branch));
+       string const branchcol = "branch" + branch_id + to_utf8(params_.branch);
+       ColorCode c = lcolor.getFromLyXName(branchcol);
        if (c == Color_none)
                c = Color_error;
        return c;
@@ -187,6 +197,21 @@ void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
                        // cur.forceBufferUpdate() is not enough
                        buf->updateBuffer();
                }
+
+               // 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_BRANCH_INVERT:
@@ -203,11 +228,11 @@ void InsetBranch::doDispatch(Cursor & cur, FuncRequest & cmd)
                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;
        }
 }
@@ -255,11 +280,11 @@ bool InsetBranch::getStatus(Cursor & cur, FuncRequest const & cmd,
                if (cmd.argument() == "assign")
                        flag.setEnabled(true);
                else
-                       return InsetCollapsable::getStatus(cur, cmd, flag);     
+                       return InsetCollapsible::getStatus(cur, cmd, flag);
                break;
 
        default:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
        return true;
 }
@@ -281,16 +306,22 @@ bool InsetBranch::isBranchSelected(bool const child) const
 }
 
 
-bool InsetBranch::producesOutput(bool const child) const
+bool InsetBranch::producesOutput() const
 {
-       return isBranchSelected(child) != params_.inverted;
+       return isBranchSelected() != params_.inverted;
 }
 
 
 void InsetBranch::latex(otexstream & os, OutputParams const & runparams) const
 {
-       if (producesOutput())
-               InsetText::latex(os, runparams);
+       if (producesOutput()) {
+               OutputParams rp = runparams;
+               rp.inbranch = true;
+               InsetText::latex(os, rp);
+               // These need to be passed upstream
+               runparams.need_maketitle = rp.need_maketitle;
+               runparams.have_maketitle = rp.have_maketitle;
+       }
 }
 
 
@@ -305,14 +336,18 @@ int InsetBranch::plaintext(odocstringstream & os,
 }
 
 
-int InsetBranch::docbook(odocstream & os,
-                        OutputParams const & runparams) const
+void InsetBranch::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       return producesOutput() ?  InsetText::docbook(os, runparams) : 0;
+       if (producesOutput()) {
+               OutputParams rp = runparams;
+               rp.par_begin = 0;
+               rp.par_end = text().paragraphs().size();
+               docbookParagraphs(text(), buffer(), xs, rp);
+       }
 }
 
 
-docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+docstring InsetBranch::xhtml(XMLStream & xs, OutputParams const & rp) const
 {
        if (producesOutput()) {
                OutputParams newrp = rp;
@@ -327,7 +362,7 @@ docstring InsetBranch::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 void InsetBranch::toString(odocstream & os) const
 {
        if (producesOutput())
-               InsetCollapsable::toString(os);
+               InsetCollapsible::toString(os);
 }
 
 
@@ -335,14 +370,14 @@ void InsetBranch::forOutliner(docstring & os, size_t const maxlen,
                                                          bool const shorten) const
 {
        if (producesOutput())
-               InsetCollapsable::forOutliner(os, maxlen, shorten);
+               InsetCollapsible::forOutliner(os, maxlen, shorten);
 }
 
 
 void InsetBranch::validate(LaTeXFeatures & features) const
 {
        if (producesOutput())
-               InsetCollapsable::validate(features);
+               InsetCollapsible::validate(features);
 }
 
 
@@ -352,7 +387,7 @@ string InsetBranch::contextMenuName() const
 }
 
 
-bool InsetBranch::isMacroScope() const 
+bool InsetBranch::isMacroScope() const
 {
        // Its own scope if not selected by buffer
        return !producesOutput();
@@ -381,37 +416,28 @@ void InsetBranch::string2params(string const & in, InsetBranchParams & params)
 }
 
 
-void InsetBranch::addToToc(DocIterator const & cpit, bool output_active,
-                                                  UpdateType utype) const
+void InsetBranch::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
 {
-       DocIterator pit = cpit;
-       pit.push_back(CursorSlice(const_cast<InsetBranch &>(*this)));
-
-       docstring str;
-       text().forOutliner(str, TOC_ENTRY_LENGTH);
-       str = params_.branch + (params_.inverted ? " (-):" : ": ") + str;
-
-       shared_ptr<Toc> toc = buffer().tocBackend().toc("branch");
-       toc->push_back(TocItem(pit, 0, str, output_active));
-
-       // Proceed with the rest of the inset.
-       bool const doing_output = output_active && producesOutput();
-       InsetCollapsable::addToToc(cpit, doing_output, utype);
+       setLabel(params_.branch + (params_.inverted ? " (-)" : ""));
+       InsetCollapsible::updateBuffer(it, utype, deleted);
 }
 
 
 void InsetBranchParams::write(ostream & os) const
 {
-       os << to_utf8(branch) 
-          << '\n' 
-          << "inverted " 
+       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;
 }