]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.cpp
This should be the last of the commits refactoring the InsetLayout code.
[lyx.git] / src / insets / InsetCollapsable.cpp
index 6b025ccabb74fb89eab171a1b153b3815fe555f8..6135a63545e69494301a66ba7928e58729a98007 100644 (file)
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "Cursor.h"
-#include "debug.h"
+#include "Dimension.h"
 #include "DispatchResult.h"
 #include "FloatList.h"
 #include "FuncStatus.h"
-#include "gettext.h"
+#include "InsetLayout.h"
 #include "Language.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "FuncRequest.h"
 #include "MetricsInfo.h"
 #include "ParagraphParameters.h"
+#include "TextClass.h"
 
 #include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
 
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
 
-namespace lyx {
+using namespace std;
 
-using std::endl;
-using std::max;
-using std::ostream;
-using std::string;
+namespace lyx {
 
 
 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
@@ -51,7 +52,7 @@ InsetCollapsable::CollapseStatus InsetCollapsable::status() const
 InsetCollapsable::Geometry InsetCollapsable::geometry() const
 {
        switch (decoration()) {
-       case Classic:
+       case Deco_Classic:
                if (status() == Open) {
                        if (openinlined_)
                                return LeftButton;
@@ -60,11 +61,14 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
                } else
                        return ButtonOnly;
 
-       case Minimalistic:
+       case Deco_Minimalistic:
                return status() == Open ? NoButton : ButtonOnly ;
 
-       case Conglomerate:
+       case Deco_Conglomerate:
                return status() == Open ? SubLabel : Corners ;
+
+       case Deco_Default:
+               break; // this shouldn't happen
        }
 
        // dummy return value to shut down a warning,
@@ -73,26 +77,25 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
 }
 
 
-InsetCollapsable::InsetCollapsable
-               (BufferParams const & bp, CollapseStatus status)
+InsetCollapsable::InsetCollapsable(BufferParams const & bp,
+               CollapseStatus status, TextClassPtr tc)
        : InsetText(bp), status_(status),
          openinlined_(false), autoOpen_(false), mouse_hover_(false)
 {
+       setLayout(tc);
        setAutoBreakRows(true);
        setDrawFrame(true);
        setFrameColor(Color_collapsableframe);
-       setButtonLabel();
-       // Fallback for lacking inset layout item
-       layout_.bgcolor = Color_background;
+       paragraphs().back().layout(bp.getTextClass().emptyLayout());
 }
 
 
 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
        : InsetText(rhs),
-               button_dim(rhs.button_dim),
-               topx(rhs.topx),
-               topbaseline(rhs.topbaseline),
+               textClass_(rhs.textClass_),
                layout_(rhs.layout_),
+               labelstring_(rhs.labelstring_),
+               button_dim(rhs.button_dim),
                status_(rhs.status_),
                openinlined_(rhs.openinlined_),
                autoOpen_(rhs.autoOpen_),
@@ -102,9 +105,42 @@ InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
 }
 
 
-void  InsetCollapsable::setLayout(BufferParams const & bp)
+docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
+{
+       Dimension dim = dimensionCollapsed();
+       if (geometry() == NoButton)
+               return layout_->labelstring();
+       else if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des)
+               return docstring();
+
+       switch (status_) {
+       case Open:
+               return _("Left-click to collapse the inset");
+       case Collapsed:
+               return _("Left-click to open the inset");
+       }
+       return docstring();
+}
+
+
+void InsetCollapsable::setLayout(BufferParams const & bp)
+{
+       setLayout(bp.getTextClassPtr());
+}
+
+
+void InsetCollapsable::setLayout(TextClassPtr tc)
 {
-       layout_ = getLayout(bp);
+       textClass_ = tc;
+       if ( tc.get() != 0 ) {
+               layout_ = &tc->insetlayout(name());
+               labelstring_ = layout_->labelstring();
+       } else {
+               layout_ = &TextClass::emptyInsetLayout();
+               labelstring_ = _("UNDEFINED");
+       }
+
+       setButtonLabel();
 }
 
 
@@ -147,19 +183,19 @@ void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
                                lex.pushToken(token);
                        }
                } else {
-                       lyxerr << "InsetCollapsable::read: Missing 'status'-tag!"
-                                  << endl;
+                       LYXERR0("InsetCollapsable::read: Missing 'status'-tag!");
                        // take countermeasures
                        lex.pushToken(token);
                }
        }
+       //this must be set before we enter InsetText::read()
+       setLayout(buf.params());
+
        InsetText::read(buf, lex);
 
        if (!token_found)
                status_ = isOpen() ? Open : Collapsed;
 
-       setButtonLabel();
-
        // Force default font, if so requested
        // This avoids paragraphs in buffer language that would have a
        // foreign language after a document language change, and it ensures
@@ -173,19 +209,22 @@ void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
 
 Dimension InsetCollapsable::dimensionCollapsed() const
 {
+       BOOST_ASSERT(layout_);
        Dimension dim;
-       theFontMetrics(layout_.labelfont).buttonText(
-               layout_.labelstring, dim.wid, dim.asc, dim.des);
+       theFontMetrics(layout_->labelfont()).buttonText(
+               labelstring_, dim.wid, dim.asc, dim.des);
        return dim;
 }
 
 
 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       BOOST_ASSERT(layout_);
+
        autoOpen_ = mi.base.bv->cursor().isInside(this);
 
        FontInfo tmpfont = mi.base.font;
-       getDrawFont(mi.base.font);
+       mi.base.font = layout_->font();
        mi.base.font.realize(tmpfont);
 
        switch (geometry()) {
@@ -200,15 +239,14 @@ void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
        case SubLabel: {
                InsetText::metrics(mi, dim);
                // consider width of the inset label
-               FontInfo font(layout_.labelfont);
+               FontInfo font(layout_->labelfont());
                font.realize(sane_font);
                font.decSize();
                font.decSize();
                int w = 0;
                int a = 0;
                int d = 0;
-               docstring s = layout_.labelstring;
-               theFontMetrics(font).rectText(s, w, a, d);
+               theFontMetrics(font).rectText(labelstring_, w, a, d);
                dim.des += a + d;
                break;
                }
@@ -227,7 +265,7 @@ void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
                                dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
                                dim.asc = textdim.asc;
                        } else {
-                               dim.des += textdim.height() + TEXT_TO_BOTTOM_OFFSET;
+                               dim.des += textdim.height() + TEXT_TO_INSET_OFFSET;
                                dim.wid = max(dim.wid, textdim.wid);
                        }
                }
@@ -247,12 +285,14 @@ bool InsetCollapsable::setMouseHover(bool mouse_hover)
 
 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 {
+       BOOST_ASSERT(layout_);
+
        autoOpen_ = pi.base.bv->cursor().isInside(this);
        ColorCode const old_color = pi.background_color;
        pi.background_color = backgroundColor();
 
        FontInfo tmpfont = pi.base.font;
-       getDrawFont(pi.base.font);
+       pi.base.font = layout_->font();
        pi.base.font.realize(tmpfont);
 
        // Draw button first -- top, left or only
@@ -266,7 +306,8 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                button_dim.y1 = y - dimc.asc;
                button_dim.y2 = y + dimc.des;
 
-               pi.pain.buttonText(x, y, layout_.labelstring, layout_.labelfont, mouse_hover_);
+               pi.pain.buttonText(x, y, labelstring_, layout_->labelfont(),
+                       mouse_hover_);
        } else {
                button_dim.x1 = 0;
                button_dim.y1 = 0;
@@ -311,37 +352,36 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                const int xx2 = x + textdim.wid - TEXT_TO_INSET_OFFSET + 1;
                pi.pain.line(xx1, y + desc - 4, 
                             xx1, y + desc, 
-                       layout_.labelfont.color());
-               if (internalStatus() == Open)
+                       layout_->labelfont().color());
+               if (status_ == Open)
                        pi.pain.line(xx1, y + desc, 
                                xx2, y + desc,
-                               layout_.labelfont.color());
+                               layout_->labelfont().color());
                else {
                        // Make status_ value visible:
                        pi.pain.line(xx1, y + desc,
                                xx1 + 4, y + desc,
-                               layout_.labelfont.color());
+                               layout_->labelfont().color());
                        pi.pain.line(xx2 - 4, y + desc,
                                xx2, y + desc,
-                               layout_.labelfont.color());
+                               layout_->labelfont().color());
                }
                pi.pain.line(x + textdim.wid - 3, y + desc, x + textdim.wid - 3, y + desc - 4,
-                       layout_.labelfont.color());
+                       layout_->labelfont().color());
 
                // the label below the text. Can be toggled.
                if (geometry() == SubLabel) {
-                       FontInfo font(layout_.labelfont);
+                       FontInfo font(layout_->labelfont());
                        font.realize(sane_font);
                        font.decSize();
                        font.decSize();
                        int w = 0;
                        int a = 0;
                        int d = 0;
-                       docstring s = layout_.labelstring;
-                       theFontMetrics(font).rectText(s, w, a, d);
+                       theFontMetrics(font).rectText(labelstring_, w, a, d);
                        int const ww = max(textdim.wid, w);
                        pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
-                               s, font, Color_none, Color_none);
+                               labelstring_, font, Color_none, Color_none);
                        desc += d;
                }
 
@@ -350,12 +390,12 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                if (cur.isInside(this)) {
                        y -= textdim.asc;
                        y += 3;
-                       pi.pain.line(xx1, y + 4, xx1, y, layout_.labelfont.color());
-                       pi.pain.line(xx1 + 4, y, xx1, y, layout_.labelfont.color());
+                       pi.pain.line(xx1, y + 4, xx1, y, layout_->labelfont().color());
+                       pi.pain.line(xx1 + 4, y, xx1, y, layout_->labelfont().color());
                        pi.pain.line(xx2, y + 4, xx2, y,
-                               layout_.labelfont.color());
+                               layout_->labelfont().color());
                        pi.pain.line(xx2 - 4, y, xx2, y,
-                               layout_.labelfont.color());
+                               layout_->labelfont().color());
                }
                break;
        }
@@ -418,7 +458,7 @@ docstring const InsetCollapsable::getNewLabel(docstring const & l) const
        docstring label;
        pos_type const max_length = 15;
        pos_type const p_siz = paragraphs().begin()->size();
-       pos_type const n = std::min(max_length, p_siz);
+       pos_type const n = min(max_length, p_siz);
        pos_type i = 0;
        pos_type j = 0;
        for (; i < n && j < p_siz; ++j) {
@@ -434,11 +474,11 @@ docstring const InsetCollapsable::getNewLabel(docstring const & l) const
 }
 
 
-void InsetCollapsable::edit(Cursor & cur, bool left)
+void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
 {
        //lyxerr << "InsetCollapsable: edit left/right" << endl;
        cur.push(*this);
-       InsetText::edit(cur, left);
+       InsetText::edit(cur, front, entry_from);
 }
 
 
@@ -496,10 +536,12 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MOUSE_RELEASE:
                if (cmd.button() == mouse_button::button3) {
                        // There is no button to right click:
-                       if (geometry() == Corners ||
+                       if (decoration() == Deco_Minimalistic ||
+                           geometry() == Corners ||
                            geometry() == SubLabel ||
-                           geometry() == NoButton)  {
-                               if (internalStatus() == Open)
+                           geometry() == NoButton
+                          )  {
+                               if (status_ == Open)
                                        setStatus(cur, Collapsed);
                                else
                                        setStatus(cur, Open);
@@ -550,7 +592,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                else if (cmd.argument() == "close")
                        setStatus(cur, Collapsed);
                else if (cmd.argument() == "toggle" || cmd.argument().empty())
-                       if (internalStatus() == Open) {
+                       if (status_ == Open) {
                                setStatus(cur, Collapsed);
                                if (geometry() == ButtonOnly)
                                        cur.top().forwardPos();
@@ -574,7 +616,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        }
 
        default:
-               if (layout_.forceltr) {
+               if (layout_ && layout_->isForceLtr()) {
                        // Force any new text to latex_language
                        // FIXME: This should only be necessary in constructor, but
                        // new paragraphs that are created by pressing enter at the
@@ -592,17 +634,17 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 
 bool InsetCollapsable::allowMultiPar() const
 {
-       return layout_.multipar;
+       return layout_->isMultiPar();
 }
 
 
 void InsetCollapsable::resetParagraphsFont()
 {
        Font font;
-       font.fontInfo() = sane_font;
-       if (layout_.forceltr)
+       font.fontInfo() = inherit_font;
+       if (layout_->isForceLtr())
                font.setLanguage(latex_language);
-       if (layout_.passthru) {
+       if (layout_->isPassThru()) {
                ParagraphList::iterator par = paragraphs().begin();
                ParagraphList::iterator const end = paragraphs().end();
                while (par != end) {
@@ -614,12 +656,6 @@ void InsetCollapsable::resetParagraphsFont()
 }
 
 
-void InsetCollapsable::getDrawFont(FontInfo & font) const
-{
-       font = layout_.font;
-}
-
-
 bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
@@ -646,14 +682,12 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_BIBITEM_INSERT:
        case LFUN_BOX_INSERT:
        case LFUN_BRANCH_INSERT:
-       case LFUN_BREAK_LINE:
+       case LFUN_NEW_LINE:
        case LFUN_CAPTION_INSERT:
        case LFUN_CLEARPAGE_INSERT:
        case LFUN_CLEARDOUBLEPAGE_INSERT:
        case LFUN_DEPTH_DECREMENT:
        case LFUN_DEPTH_INCREMENT:
-       case LFUN_DOTS_INSERT:
-       case LFUN_END_OF_SENTENCE_PERIOD_INSERT:
        case LFUN_ENVIRONMENT_INSERT:
        case LFUN_ERT_INSERT:
        case LFUN_FILE_INSERT:
@@ -678,14 +712,13 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_FOOTNOTE_INSERT:
        case LFUN_HFILL_INSERT:
        case LFUN_HYPERLINK_INSERT:
-       case LFUN_HYPHENATION_POINT_INSERT:
        case LFUN_INDEX_INSERT:
        case LFUN_INDEX_PRINT:
        case LFUN_INSET_INSERT:
        case LFUN_LABEL_GOTO:
        case LFUN_LABEL_INSERT:
-       case LFUN_LIGATURE_BREAK_INSERT:
        case LFUN_LINE_INSERT:
+       case LFUN_NEWPAGE_INSERT:
        case LFUN_PAGEBREAK_INSERT:
        case LFUN_LAYOUT:
        case LFUN_LAYOUT_PARAGRAPH:
@@ -696,7 +729,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_MATH_MATRIX:
        case LFUN_MATH_MODE:
        case LFUN_MENU_OPEN:
-       case LFUN_MENU_SEPARATOR_INSERT:
        case LFUN_NOACTION:
        case LFUN_NOMENCL_INSERT:
        case LFUN_NOMENCL_PRINT:
@@ -712,10 +744,11 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_SERVER_NOTIFY:
        case LFUN_SERVER_SET_XY:
        case LFUN_SPACE_INSERT:
+       case LFUN_SPECIALCHAR_INSERT:
        case LFUN_TABULAR_INSERT:
        case LFUN_TOC_INSERT:
        case LFUN_WRAP_INSERT:
-       if (layout_.passthru) {
+       if (layout_->isPassThru()) {
                flag.enabled(false);
                return true;
        } else
@@ -730,12 +763,12 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
                return true;
 
        case LFUN_LANGUAGE:
-               flag.enabled(layout_.forceltr);
+               flag.enabled(!layout_->isForceLtr());
                return InsetText::getStatus(cur, cmd, flag);
 
        case LFUN_BREAK_PARAGRAPH:
        case LFUN_BREAK_PARAGRAPH_SKIP:
-               flag.enabled(layout_.multipar);
+               flag.enabled(layout_->isMultiPar());
                return true;
 
        default:
@@ -746,7 +779,7 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 void InsetCollapsable::setLabel(docstring const & l)
 {
-       layout_.labelstring = l;
+       labelstring_ = l;
 }
 
 
@@ -759,11 +792,6 @@ void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
 }
 
 
-void InsetCollapsable::setLabelFont(FontInfo const & font)
-{
-       layout_.labelfont = font;
-}
-
 docstring InsetCollapsable::floatName(string const & type, BufferParams const & bp) const
 {
        FloatList const & floats = bp.getTextClass().floats();
@@ -773,49 +801,81 @@ docstring InsetCollapsable::floatName(string const & type, BufferParams const &
 }
 
 
-InsetCollapsable::Decoration InsetCollapsable::decoration() const
+InsetDecoration InsetCollapsable::decoration() const
 {
-       if (layout_.decoration == "classic")
-               return Classic;
-       if (layout_.decoration == "minimalistic")
-               return Minimalistic;
-       if (layout_.decoration == "conglomerate")
-               return Conglomerate;
-       if (name() == from_ascii("Flex"))
-               return Conglomerate;
-       return Classic;
+       if (!layout_)
+               return Deco_Classic;
+       InsetDecoration const dec = layout_->decoration();
+       switch (dec) {
+       case Deco_Classic:
+       case Deco_Minimalistic:
+       case Deco_Conglomerate:
+               return dec;
+       case Deco_Default:
+               break;
+       }
+       if (lyxCode() == FLEX_CODE)
+               // FIXME: Is this really necessary?
+               return Deco_Conglomerate;
+       return Deco_Classic;
+}
+
+
+bool InsetCollapsable::isMacroScope(Buffer const &) const
+{
+       // layout_ == 0 leads to no latex output, so ignore 
+       // the macros outside
+       if (!layout_)
+               return true;
+
+       // see InsetCollapsable::latex(...) below. In these case
+       // an environment is opened there
+       if (!layout_->latexname().empty())
+               return true;
+
+       return false;
 }
 
 
 int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
                          OutputParams const & runparams) const
 {
+       // FIXME: What should we do layout_ is 0?
+       // 1) assert
+       // 2) through an error
+       if (!layout_)
+               return 0;
+
        // This implements the standard way of handling the LaTeX output of
        // a collapsable inset, either a command or an environment. Standard 
        // collapsable insets should not redefine this, non-standard ones may
        // call this.
-       if (!layout_.latexname.empty()) {
-               if (layout_.latextype == "command") {
+       if (!layout_->latexname().empty()) {
+               if (layout_->latextype() == "command") {
                        // FIXME UNICODE
-                       os << '\\' << from_utf8(layout_.latexname);
-                       if (!layout_.latexparam.empty())
-                               os << from_utf8(layout_.latexparam);
+                       if (runparams.moving_arg)
+                               os << "\\protect";
+                       os << '\\' << from_utf8(layout_->latexname());
+                       if (!layout_->latexparam().empty())
+                               os << from_utf8(layout_->latexparam());
                        os << '{';
-               } else if (layout_.latextype == "environment") {
-                       os << "%\n\\begin{" << from_utf8(layout_.latexname) << "}\n";
-                       if (!layout_.latexparam.empty())
-                               os << from_utf8(layout_.latexparam);
+               } else if (layout_->latextype() == "environment") {
+                       os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
+                       if (!layout_->latexparam().empty())
+                               os << from_utf8(layout_->latexparam());
                }
        }
        OutputParams rp = runparams;
-       if (layout_.passthru)
+       if (layout_->isPassThru())
                rp.verbatim = true;
+       if (layout_->isNeedProtect())
+               rp.moving_arg = true;
        int i = InsetText::latex(buf, os, rp);
-       if (!layout_.latexname.empty()) {
-               if (layout_.latextype == "command") {
+       if (!layout_->latexname().empty()) {
+               if (layout_->latextype() == "command") {
                        os << "}";
-               } else if (layout_.latextype == "environment") {
-                       os << "\n\\end{" << from_utf8(layout_.latexname) << "}\n";
+               } else if (layout_->latextype() == "environment") {
+                       os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
                        i += 4;
                }
        }
@@ -825,10 +885,20 @@ int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
 
 void InsetCollapsable::validate(LaTeXFeatures & features) const
 {
+       if (!layout_)
+               return;
+
        // Force inclusion of preamble snippet in layout file
-       features.require(layout_.name);
+       features.require(to_utf8(layout_->name()));
        InsetText::validate(features);
 }
 
 
+bool InsetCollapsable::undefined() const
+{
+       docstring const & n = getLayout().name();
+       return n.empty() || n == TextClass::emptyInsetLayout().name();
+}
+
+
 } // namespace lyx