]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/InsetMathHull.cpp
Allow automatic text direction in Painter::text()
[lyx.git] / src / mathed / InsetMathHull.cpp
index ab1b5860f0bc8d1ffe4553009fa71be153148b9f..a782751b1048bc9c99e4203cb41c4f857e2a6578 100644 (file)
 
 #include "InsetMathChar.h"
 #include "InsetMathColor.h"
+#include "InsetMathFrac.h"
+#include "InsetMathGrid.h"
+#include "InsetMathNest.h"
+#include "InsetMathScript.h"
 #include "MathExtern.h"
 #include "MathFactory.h"
 #include "MathStream.h"
@@ -32,6 +36,8 @@
 #include "LaTeXFeatures.h"
 #include "LyXRC.h"
 #include "MacroTable.h"
+#include "MathMacro.h"
+#include "MathMacroTemplate.h"
 #include "output_xhtml.h"
 #include "Paragraph.h"
 #include "ParIterator.h"
@@ -152,7 +158,7 @@ static InsetLabel * dummy_pointer = 0;
 InsetMathHull::InsetMathHull(Buffer * buf)
        : InsetMathGrid(buf, 1, 1), type_(hullNone), numbered_(1, NUMBER),
          numbers_(1, empty_docstring()), label_(1, dummy_pointer),
-         preview_(new RenderPreview(this)), use_preview_(false)
+         preview_(new RenderPreview(this))
 {
        //lyxerr << "sizeof InsetMath: " << sizeof(InsetMath) << endl;
        //lyxerr << "sizeof MetricsInfo: " << sizeof(MetricsInfo) << endl;
@@ -167,7 +173,7 @@ InsetMathHull::InsetMathHull(Buffer * buf)
 InsetMathHull::InsetMathHull(Buffer * buf, HullType type)
        : InsetMathGrid(buf, getCols(type), 1), type_(type), numbered_(1, NUMBER),
          numbers_(1, empty_docstring()), label_(1, dummy_pointer),
-         preview_(new RenderPreview(this)), use_preview_(false)
+         preview_(new RenderPreview(this))
 {
        buffer_ = buf;
        initMath();
@@ -286,7 +292,8 @@ void InsetMathHull::updateBuffer(ParIterator const & it, UpdateType utype)
 }
 
 
-void InsetMathHull::addToToc(DocIterator const & pit, bool output_active) const
+void InsetMathHull::addToToc(DocIterator const & pit, bool output_active,
+                                                        UpdateType utype) const
 {
        if (!buffer_) {
                //FIXME: buffer_ should be set at creation for this inset! Problem is
@@ -295,21 +302,21 @@ void InsetMathHull::addToToc(DocIterator const & pit, bool output_active) const
                return;
        }
 
-       Toc & toc = buffer().tocBackend().toc("equation");
+       shared_ptr<Toc> toc = buffer().tocBackend().toc("equation");
 
        for (row_type row = 0; row != nrows(); ++row) {
                if (!numbered(row))
                        continue;
                if (label_[row])
-                       label_[row]->addToToc(pit, output_active);
-               toc.push_back(TocItem(pit, 0, nicelabel(row), output_active));
+                       label_[row]->addToToc(pit, output_active, utype);
+               toc->push_back(TocItem(pit, 0, nicelabel(row), output_active));
        }
 }
 
 
 Inset * InsetMathHull::editXY(Cursor & cur, int x, int y)
 {
-       if (use_preview_) {
+       if (previewState(&cur.bv())) {
                edit(cur, true);
                return this;
        }
@@ -519,7 +526,6 @@ void InsetMathHull::drawBackground(PainterInfo & pi, int x, int y) const
 void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
 {
        BufferView const * const bv = pi.base.bv;
-       use_preview_ = previewState(bv);
 
        if (type_ == hullRegexp) {
                Dimension const dim = dimension(*bv);
@@ -527,7 +533,7 @@ void InsetMathHull::draw(PainterInfo & pi, int x, int y) const
                        dim.width() - 2, dim.height() - 2, Color_regexpframe);
        }
 
-       if (use_preview_) {
+       if (previewState(bv)) {
                Dimension const dim = dimension(*bv);
                if (previewTooSmall(dim)) {
                        // we have an extra frame
@@ -568,7 +574,9 @@ void InsetMathHull::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
                InsetMathGrid::metricsT(mi, dim);
        } else {
                odocstringstream os;
-               WriteStream wi(os, false, true, WriteStream::wsDefault);
+               TexRow texrow(false);
+               otexrowstream ots(os,texrow);
+               WriteStream wi(ots, false, true, WriteStream::wsDefault);
                write(wi);
                dim.wid = os.str().size();
                dim.asc = 1;
@@ -583,7 +591,9 @@ void InsetMathHull::drawT(TextPainter & pain, int x, int y) const
                InsetMathGrid::drawT(pain, x, y);
        } else {
                odocstringstream os;
-               WriteStream wi(os, false, true, WriteStream::wsDefault);
+               TexRow texrow(false);
+               otexrowstream ots(os,texrow);
+               WriteStream wi(ots, false, true, WriteStream::wsDefault);
                write(wi);
                pain.draw(x, y, os.str().c_str());
        }
@@ -601,7 +611,9 @@ static docstring latexString(InsetMathHull const & inset)
        static Encoding const * encoding = 0;
        if (inset.isBufferValid())
                encoding = &(inset.buffer().params().encoding());
-       WriteStream wi(ls, false, true, WriteStream::wsPreview, encoding);
+       TexRow texrow(false);
+       otexrowstream ots(ls,texrow);
+       WriteStream wi(ots, false, true, WriteStream::wsPreview, encoding);
        inset.write(wi);
        return ls.str();
 }
@@ -623,6 +635,64 @@ void InsetMathHull::addPreview(DocIterator const & inset_pos,
 }
 
 
+void InsetMathHull::usedMacros(MathData const & md, DocIterator const & pos,
+                               MacroNameSet & macros, MacroNameSet & defs) const
+{
+       MacroNameSet::iterator const end = macros.end();
+
+       for (size_t i = 0; i < md.size(); ++i) {
+               MathMacro const * mi = md[i].nucleus()->asMacro();
+               MathMacroTemplate const * mt = md[i].nucleus()->asMacroTemplate();
+               InsetMathScript const * si = md[i].nucleus()->asScriptInset();
+               InsetMathFracBase const * fi = md[i].nucleus()->asFracBaseInset();
+               InsetMathGrid const * gi = md[i].nucleus()->asGridInset();
+               InsetMathNest const * ni = md[i].nucleus()->asNestInset();
+               if (mi) {
+                       // Look for macros in the arguments of this macro.
+                       for (idx_type idx = 0; idx < mi->nargs(); ++idx)
+                               usedMacros(mi->cell(idx), pos, macros, defs);
+                       // Make sure this is a macro defined in the document
+                       // (as we also spot the macros in the symbols file)
+                       // or that we have not already accounted for it.
+                       docstring const name = mi->name();
+                       if (macros.find(name) == end)
+                               continue;
+                       macros.erase(name);
+                       // Look for macros in the definition of this macro.
+                       MathData ar(pos.buffer());
+                       MacroData const * data =
+                               pos.buffer()->getMacro(name, pos, true);
+                       if (data) {
+                               odocstringstream macro_def;
+                               data->write(macro_def, true);
+                               macro_def << endl;
+                               defs.insert(macro_def.str());
+                               asArray(data->definition(), ar);
+                       }
+                       usedMacros(ar, pos, macros, defs);
+               } else if (mt) {
+                       MathData ar(pos.buffer());
+                       asArray(mt->definition(), ar);
+                       usedMacros(ar, pos, macros, defs);
+               } else if (si) {
+                       if (!si->nuc().empty())
+                               usedMacros(si->nuc(), pos, macros, defs);
+                       if (si->hasDown())
+                               usedMacros(si->down(), pos, macros, defs);
+                       if (si->hasUp())
+                               usedMacros(si->up(), pos, macros, defs);
+               } else if (fi || gi) {
+                       idx_type nidx = fi ? fi->nargs() : gi->nargs();
+                       for (idx_type idx = 0; idx < nidx; ++idx)
+                               usedMacros(fi ? fi->cell(idx) : gi->cell(idx),
+                                          pos, macros, defs);
+               } else if (ni) {
+                       usedMacros(ni->cell(0), pos, macros, defs);
+               }
+       }
+}
+
+
 void InsetMathHull::preparePreview(DocIterator const & pos,
                                    bool forexport) const
 {
@@ -636,26 +706,34 @@ void InsetMathHull::preparePreview(DocIterator const & pos,
        // collect macros at this position
        MacroNameSet macros;
        buffer->listMacroNames(macros);
-       MacroNameSet::iterator it = macros.begin();
-       MacroNameSet::iterator end = macros.end();
+
+       // collect definitions only for the macros used in this inset
+       MacroNameSet defs;
+       for (idx_type idx = 0; idx < nargs(); ++idx)
+               usedMacros(cell(idx), pos, macros, defs);
+
+       MacroNameSet::iterator it = defs.begin();
+       MacroNameSet::iterator end = defs.end();
        docstring macro_preamble;
-       for (; it != end; ++it) {
-               MacroData const * data = buffer->getMacro(*it, pos, true);
-               if (data) {
-                       odocstringstream mac_preamble;
-                       data->write(mac_preamble, true);
-                       docstring const mps = mac_preamble.str();
-                       bool const is_new_def = prefixIs(mps, from_ascii("\\newcomm"));
-                       // assure that \newcommand definitions of macros are only added once
-                       if (!is_new_def || !preview_->hasMacroDef(mps, *buffer)) {
-                               if (is_new_def)
-                                       preview_->addMacroDef(mps, *buffer);
-                               if (!macro_preamble.empty())
-                                       macro_preamble += '\n';
-                               macro_preamble += mps;
-                       }
-               }
-       }
+       for (; it != end; ++it)
+               macro_preamble.append(*it);
+
+       // set the font series and size for this snippet
+       DocIterator dit = pos;
+       while (dit.inMathed())
+               dit.pop_back();
+       Paragraph const & par = dit.paragraph();
+       Font font = par.getFontSettings(buffer->params(), dit.pos());
+       font.fontInfo().realize(par.layout().font);
+       string const lsize = font.latexSize();
+       docstring setfont;
+       docstring endfont;
+       if (font.fontInfo().series() == BOLD_SERIES) {
+               setfont += from_ascii("\\textbf{");
+               endfont += '}';
+       }
+       if (lsize != "normalsize" && !prefixIs(lsize, "error"))
+               setfont += from_ascii("\\" + lsize + '\n'); 
 
        docstring setcnt;
        if (forexport && haveNumbers()) {
@@ -678,7 +756,8 @@ void InsetMathHull::preparePreview(DocIterator const & pos,
                                          '{' + convert<docstring>(num) + '}';
                }
        }
-       docstring const snippet = macro_preamble + setcnt + latexString(*this);
+       docstring const snippet = macro_preamble + setfont + setcnt
+                                 + latexString(*this) + endfont;
        LYXERR(Debug::MACROS, "Preview snippet: " << snippet);
        preview_->addPreview(snippet, *buffer, forexport);
 }
@@ -854,15 +933,18 @@ void InsetMathHull::header_write(WriteStream & os) const
 
        case hullSimple:
                os << '$';
+               os.startOuterRow();
                if (cell(0).empty())
                        os << ' ';
                break;
 
        case hullEquation:
+               os << "\n";
+               os.startOuterRow();
                if (n)
-                       os << "\n\\begin{equation" << star(n) << "}\n";
+                       os << "\\begin{equation" << star(n) << "}\n";
                else
-                       os << "\n\\[\n";
+                       os << "\\[\n";
                break;
 
        case hullEqnArray:
@@ -870,17 +952,23 @@ void InsetMathHull::header_write(WriteStream & os) const
        case hullFlAlign:
        case hullGather:
        case hullMultline:
-               os << "\n\\begin{" << hullName(type_) << star(n) << "}\n";
+               os << "\n";
+               os.startOuterRow();
+               os << "\\begin{" << hullName(type_) << star(n) << "}\n";
                break;
 
        case hullAlignAt:
        case hullXAlignAt:
-               os << "\n\\begin{" << hullName(type_) << star(n) << '}'
+               os << "\n";
+               os.startOuterRow();
+               os << "\\begin{" << hullName(type_) << star(n) << '}'
                  << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
                break;
 
        case hullXXAlignAt:
-               os << "\n\\begin{" << hullName(type_) << '}'
+               os << "\n";
+               os.startOuterRow();
+               os << "\\begin{" << hullName(type_) << '}'
                  << '{' << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
                break;
 
@@ -889,7 +977,9 @@ void InsetMathHull::header_write(WriteStream & os) const
                break;
 
        default:
-               os << "\n\\begin{unknown" << star(n) << "}\n";
+               os << "\n";
+               os.startOuterRow();
+               os << "\\begin{unknown" << star(n) << "}\n";
                break;
        }
 }
@@ -909,10 +999,12 @@ void InsetMathHull::footer_write(WriteStream & os) const
                break;
 
        case hullEquation:
+               os << "\n";
+               os.startOuterRow();
                if (n)
-                       os << "\n\\end{equation" << star(n) << "}\n";
+                       os << "\\end{equation" << star(n) << "}\n";
                else
-                       os << "\n\\]\n";
+                       os << "\\]\n";
                break;
 
        case hullEqnArray:
@@ -922,11 +1014,15 @@ void InsetMathHull::footer_write(WriteStream & os) const
        case hullXAlignAt:
        case hullGather:
        case hullMultline:
-               os << "\n\\end{" << hullName(type_) << star(n) << "}\n";
+               os << "\n";
+               os.startOuterRow();
+               os << "\\end{" << hullName(type_) << star(n) << "}\n";
                break;
 
        case hullXXAlignAt:
-               os << "\n\\end{" << hullName(type_) << "}\n";
+               os << "\n";
+               os.startOuterRow();
+               os << "\\end{" << hullName(type_) << "}\n";
                break;
 
        case hullRegexp:
@@ -935,9 +1031,33 @@ void InsetMathHull::footer_write(WriteStream & os) const
                break;
 
        default:
-               os << "\n\\end{unknown" << star(n) << "}\n";
+               os << "\n";
+               os.startOuterRow();
+               os << "\\end{unknown" << star(n) << "}\n";
+               break;
+       }
+}
+
+
+bool InsetMathHull::isTable() const
+{
+       switch (type_) {
+       case hullEqnArray:
+       case hullAlign:
+       case hullAlignAt:
+       case hullXAlignAt:
+       case hullXXAlignAt:
+       case hullFlAlign:
+       case hullMultline:
+       case hullGather:
+               return true;
+       case hullNone:
+       case hullSimple:
+       case hullEquation:
+       case hullRegexp:
                break;
        }
+       return false;
 }
 
 
@@ -1293,7 +1413,6 @@ docstring InsetMathHull::eolString(row_type row, bool fragile, bool latex,
        return res + InsetMathGrid::eolString(row, fragile, latex, last_eoln);
 }
 
-
 void InsetMathHull::write(WriteStream & os) const
 {
        ModeSpecifier specifier(os, MATH_MODE);
@@ -1430,7 +1549,7 @@ void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
                if (type_ == hullSimple || type_ == hullEquation) {
                        cur.recordUndoInset();
                        bool const align =
-                               cur.bv().buffer().params().use_package("amsmath") == BufferParams::package_on;
+                               cur.bv().buffer().params().use_package("amsmath") != BufferParams::package_off;
                        mutate(align ? hullAlign : hullEqnArray);
                        // mutate() may change labels and such.
                        cur.forceBufferUpdate();
@@ -1592,12 +1711,25 @@ void InsetMathHull::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MATH_DISPLAY: {
                cur.recordUndoInset();
                mutate(type_ == hullSimple ? hullEquation : hullSimple);
-               cur.idx() = 0;
-               cur.pos() = cur.lastpos();
-               //cur.dispatched(FINISHED);
+               // if the cursor is in a cell that got merged, move it to
+               // start of the hull inset.
+               if (cur.idx() > 0) {
+                       cur.idx() = 0;
+                       cur.pos() = 0;
+               }
+               if (cur.pos() > cur.lastpos())
+                       cur.pos() = cur.lastpos();
+
                break;
        }
 
+       case LFUN_TABULAR_FEATURE:
+               if (!isTable())
+                       cur.undispatched();
+               else
+                       InsetMathGrid::doDispatch(cur, cmd);
+               break;
+
        default:
                InsetMathGrid::doDispatch(cur, cmd);
                break;
@@ -1712,13 +1844,10 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                }
                return InsetMathGrid::getStatus(cur, cmd, status);
 
-       case LFUN_INSET_MODIFY: {
-               istringstream is(to_utf8(cmd.argument()));
-               string s;
-               is >> s;
-               if (s != "tabular")
-                       return InsetMathGrid::getStatus(cur, cmd, status);
-               is >> s;
+       case LFUN_TABULAR_FEATURE: {
+               if (!isTable())
+                       return false;
+               string s = cmd.getArg(0);
                if (!rowChangeOK()
                    && (s == "append-row"
                        || s == "delete-row"
@@ -1739,16 +1868,6 @@ bool InsetMathHull::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.setEnabled(false);
                        return true;
                }
-               if ((type_ == hullSimple
-                 || type_ == hullEquation
-                 || type_ == hullNone) &&
-                   (s == "add-hline-above" || s == "add-hline-below")) {
-                       status.message(bformat(
-                               from_utf8(N_("Can't add horizontal grid lines in '%1$s'")),
-                               hullName(type_)));
-                       status.setEnabled(false);
-                       return true;
-               }
                if (s == "add-vline-left" || s == "add-vline-right") {
                        status.message(bformat(
                                from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
@@ -1924,7 +2043,9 @@ bool InsetMathHull::searchForward(BufferView * bv, string const & str,
 void InsetMathHull::write(ostream & os) const
 {
        odocstringstream oss;
-       WriteStream wi(oss, false, false, WriteStream::wsDefault);
+       TexRow texrow(false);
+       otexrowstream ots(oss,texrow);
+       WriteStream wi(ots, false, false, WriteStream::wsDefault);
        oss << "Formula ";
        write(wi);
        os << to_utf8(oss.str());
@@ -1966,8 +2087,10 @@ int InsetMathHull::plaintext(odocstringstream & os,
        }
 
        odocstringstream oss;
+       TexRow texrow(false);
+       otexrowstream ots(oss,texrow);
        Encoding const * const enc = encodings.fromLyXName("utf8");
-       WriteStream wi(oss, false, true, WriteStream::wsDefault, enc);
+       WriteStream wi(ots, false, true, WriteStream::wsDefault, enc);
 
        // Fix Bug #6139
        if (type_ == hullRegexp)
@@ -2007,12 +2130,14 @@ int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) cons
        ++ms.tab(); ms.cr(); ms.os() << '<' << bname << '>';
 
        odocstringstream ls;
+       TexRow texrow;
+       otexstream ols(ls, texrow);
        if (runparams.flavor == OutputParams::XML) {
                ms << MTag("alt role='tex' ");
                // Workaround for db2latex: db2latex always includes equations with
                // \ensuremath{} or \begin{display}\end{display}
                // so we strip LyX' math environment
-               WriteStream wi(ls, false, false, WriteStream::wsDefault, runparams.encoding);
+               WriteStream wi(ols, false, false, WriteStream::wsDefault, runparams.encoding);
                InsetMathGrid::write(wi);
                ms << from_utf8(subst(subst(to_utf8(ls.str()), "&", "&amp;"), "<", "&lt;"));
                ms << ETag("alt");
@@ -2022,9 +2147,6 @@ int InsetMathHull::docbook(odocstream & os, OutputParams const & runparams) cons
                InsetMathGrid::mathmlize(ms);
                ms << ETag("math");
        } else {
-               TexRow texrow;
-               texrow.reset();
-               otexstream ols(ls, texrow);
                ms << MTag("alt role='tex'");
                latex(ols, runparams);
                res = texrow.rows();
@@ -2274,7 +2396,9 @@ docstring InsetMathHull::xhtml(XHTMLStream & xs, OutputParams const & op) const
                // Unfortunately, we cannot use latexString() because we do not want
                // $...$ or whatever.
                odocstringstream ls;
-               WriteStream wi(ls, false, true, WriteStream::wsPreview);
+               TexRow texrow(false);
+               otexrowstream ots(ls,texrow);
+               WriteStream wi(ots, false, true, WriteStream::wsPreview);
                ModeSpecifier specifier(wi, MATH_MODE);
                mathAsLatex(wi);
                docstring const latex = ls.str();
@@ -2301,11 +2425,13 @@ void InsetMathHull::toString(odocstream & os) const
 }
 
 
-void InsetMathHull::forOutliner(docstring & os, size_t) const
+void InsetMathHull::forOutliner(docstring & os, size_t const, bool const) const
 {
        odocstringstream ods;
        OutputParams op(0);
        op.for_toc = true;
+       // FIXME: this results in spilling TeX into the LyXHTML output since the
+       // outliner is used to generate the LyXHTML list of figures/etc.
        plaintext(ods, op);
        os += ods.str();
 }