]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathMacro.cpp
* src/frontends/GuiDocument.{cpp,h}:
[lyx.git] / src / mathed / MathMacro.cpp
index e664cf0cab2379d4c03f3a5046d3c4707498267d..1ce711a7478026f1450b8a48b6ed4ecbbf800ed0 100644 (file)
@@ -19,8 +19,9 @@
 
 #include "Buffer.h"
 #include "BufferView.h"
+#include "CoordCache.h"
 #include "Cursor.h"
-#include "debug.h"
+#include "support/debug.h"
 #include "LaTeXFeatures.h"
 #include "FuncStatus.h"
 #include "FuncRequest.h"
 
 #include "frontends/Painter.h"
 
+#include <ostream>
 #include <vector>
 
-namespace lyx {
+using namespace std;
 
-using std::string;
-using std::max;
+namespace lyx {
 
 
 /// A proxy for the macro values
@@ -51,31 +52,46 @@ public:
        ///
        void metrics(MetricsInfo & mi, Dimension & dim) const {
                mathMacro_.macro()->unlock();
-               mathMacro_.cell(idx_).metrics(mi, dim);
-               if (!mathMacro_.editing() && !def_.empty())
+               if (!mathMacro_.editMetrics(mi.base.bv) 
+                   && mathMacro_.cell(idx_).empty())
                        def_.metrics(mi, dim);
+               else {
+                       CoordCache & coords = mi.base.bv->coordCache();
+                       dim = coords.arrays().dim(&mathMacro_.cell(idx_));
+               }
                mathMacro_.macro()->lock();
        }
        ///
        void draw(PainterInfo & pi, int x, int y) const {
-               if (mathMacro_.editing()) {
+               if (mathMacro_.editMetrics(pi.base.bv)) {
+                       // The only way a ArgumentProxy can appear is in a cell of the 
+                       // MathMacro. Moreover the cells are only drawn in the DISPLAY_FOLDED 
+                       // mode and then, if the macro is edited the monochrome 
+                       // mode is entered by the MathMacro before calling the cells' draw
+                       // method. Then eventually this code is reached and the proxy leaves
+                       // monochrome mode temporarely. Hence, if it is not in monochrome 
+                       // here (and the assert triggers in pain.leaveMonochromeMode()) 
+                       // it's a bug.
                        pi.pain.leaveMonochromeMode();
                        mathMacro_.cell(idx_).draw(pi, x, y);
-                       // FIXME: use real min/max colors here, not necessarely the ones of MathMacro are set
                        pi.pain.enterMonochromeMode(Color_mathbg, Color_mathmacroblend);
-               } else {
-                       if (def_.empty())
-                               mathMacro_.cell(idx_).draw(pi, x, y);
-                       else {
-                               mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
-                               def_.draw(pi, x, y);
-                       }
-               }
+               } else if (mathMacro_.cell(idx_).empty()) {
+                       mathMacro_.cell(idx_).setXY(*pi.base.bv, x, y);
+                       def_.draw(pi, x, y);
+               } else
+                       mathMacro_.cell(idx_).draw(pi, x, y);
        }
        ///
        size_t idx() const { return idx_; }
        ///
-       int kerning() const { return mathMacro_.cell(idx_).kerning(); }
+       int kerning(BufferView const * bv) const
+       { 
+               if (mathMacro_.editMetrics(bv)
+                   || !mathMacro_.cell(idx_).empty())
+                       return mathMacro_.cell(idx_).kerning(bv); 
+               else
+                       return def_.kerning(bv);
+       }
 
 private:
        ///
@@ -94,9 +110,8 @@ private:
 
 MathMacro::MathMacro(docstring const & name)
        : InsetMathNest(0), name_(name), displayMode_(DISPLAY_INIT),
-               attachedArgsNum_(0), previousCurIdx_(-1), 
-               optionals_(0), nextFoldMode_(true),
-               macro_(0), editing_(false), needsUpdate_(false)
+               attachedArgsNum_(0), optionals_(0), nextFoldMode_(true),
+               macro_(0), needsUpdate_(false)
 {}
 
 
@@ -127,16 +142,9 @@ void MathMacro::cursorPos(BufferView const & bv,
 }
 
 
-int MathMacro::cursorIdx(Cursor const & cur) const {
-       for (size_t i = 0; i != cur.depth(); ++i)
-                       if (&cur[i].inset() == this)
-                               return cur[i].idx();
-       return -1;
-}
-
-
-bool MathMacro::editMode(Cursor const & cur) const {
+bool MathMacro::editMode(BufferView const * bv) const {
        // find this in cursor trace
+       Cursor const & cur = bv->cursor();
        for (size_t i = 0; i != cur.depth(); ++i)
                if (&cur[i].inset() == this) {
                        // look if there is no other macro in edit mode above
@@ -155,62 +163,72 @@ bool MathMacro::editMode(Cursor const & cur) const {
 }
 
 
+bool MathMacro::editMetrics(BufferView const * bv) const
+{
+       return editing_[bv];
+}
+
+
 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       // set edit mode for which we will have calculated metrics. But only
+       editing_[mi.base.bv] = editMode(mi.base.bv);
+
        // calculate new metrics according to display mode
-       if (displayMode_ == DISPLAY_INIT) {
+       if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {
                mathed_string_dim(mi.base.font, from_ascii("\\") + name(), dim);
        } else if (displayMode_ == DISPLAY_UNFOLDED) {
                cell(0).metrics(mi, dim);
                Dimension bsdim;
                mathed_string_dim(mi.base.font, from_ascii("\\"), bsdim);
                dim.wid += bsdim.width() + 1;
-               dim.asc = std::max(bsdim.ascent(), dim.ascent());
-               dim.des = std::max(bsdim.descent(), dim.descent());
+               dim.asc = max(bsdim.ascent(), dim.ascent());
+               dim.des = max(bsdim.descent(), dim.descent());
                metricsMarkers(dim);
        } else {
                BOOST_ASSERT(macro_ != 0);
 
-               // calculate metric finally
+               // metrics are computed here for the cells,
+               // in the proxy we will then use the dim from the cache
+               InsetMathNest::metrics(mi);
+               
+               // calculate metrics finally
                macro_->lock();
                expanded_.cell(0).metrics(mi, dim);
                macro_->unlock();
 
                // calculate dimension with label while editing
-               if (editing_) {
+               if (editing_[mi.base.bv]) {
                        FontInfo font = mi.base.font;
                        augmentFont(font, from_ascii("lyxtex"));
                        Dimension namedim;
                        mathed_string_dim(font, name(), namedim);
 #if 0
                        dim.wid += 2 + namedim.wid + 2 + 2;
-                       dim.asc = std::max(dim.asc, namedim.asc) + 2;
-                       dim.des = std::max(dim.des, namedim.des) + 2;
+                       dim.asc = max(dim.asc, namedim.asc) + 2;
+                       dim.des = max(dim.des, namedim.des) + 2;
 #endif
-                       dim.wid = std::max(1 + namedim.wid + 1, 2 + dim.wid + 2);
+                       dim.wid = max(1 + namedim.wid + 1, 2 + dim.wid + 2);
                        dim.asc += 1 + namedim.height() + 1;
                        dim.des += 2;
                }
        }
-
-       // Cache the inset dimension. 
-       setDimCache(mi, dim);
 }
 
 
-int MathMacro::kerning() const {
-       if (displayMode_ == DISPLAY_NORMAL && !editing_)
-               return expanded_.kerning();
+int MathMacro::kerning(BufferView const * bv) const {
+       if (displayMode_ == DISPLAY_NORMAL && !editing_[bv])
+               return expanded_.kerning(bv);
        else
                return 0;
 }
 
 
-void MathMacro::updateMacro(MetricsInfo & mi
+void MathMacro::updateMacro(MacroContext const & mc
 {
-       if (validName() && mi.macrocontext.has(name())) {
-               macro_ = &mi.macrocontext.get(name());
-               if (macroBackup_ != *macro_) {
+       if (validName()) {
+               macro_ = mc.get(name());            
+               if (macro_ && macroBackup_ != *macro_) {
                        macroBackup_ = *macro_;
                        needsUpdate_ = true;
                }
@@ -220,47 +238,39 @@ void MathMacro::updateMacro(MetricsInfo & mi)
 }
 
 
-void MathMacro::updateRepresentation(MetricsInfo & mi) 
+void MathMacro::updateRepresentation(Cursor const * bvCur)
 {
-       // index of child where the cursor is (or -1 if none is edited)
-       int curIdx = cursorIdx(mi.base.bv->cursor());
-       previousCurIdx_ = curIdx;
-
        // known macro?
-       if (macro_) {
-               requires_ = macro_->requires();
-
-               if (displayMode_ == DISPLAY_NORMAL) {
-                       // set edit mode to draw box around if needed
-                       bool prevEditing = editing_; 
-                       editing_ = editMode(mi.base.bv->cursor());
-
-                       // editMode changed and we have to switch default value and hole of optional?
-                       if (optionals_ > 0 && nargs() > 0 && 
-                                       prevEditing != editing_)
-                               needsUpdate_ = true;
-
-                       // macro changed?
-                       if (needsUpdate_) {
-                               needsUpdate_ = false;
-
-                               // get default values of macro
-                               std::vector<docstring> const & defaults = macro_->defaults();
-
-                               // create MathMacroArgumentValue objects pointing to the cells of the macro
-                               std::vector<MathData> values(nargs());
-                               for (size_t i = 0; i < nargs(); ++i) {
-                                       if (!cell(i).empty() || i >= defaults.size() || 
-                                                       defaults[i].empty() || curIdx == (int)i)
-                                               values[i].insert(0, MathAtom(new ArgumentProxy(*this, i)));
-                                       else
-                                               values[i].insert(0, MathAtom(new ArgumentProxy(*this, i, defaults[i])));
-                               }
-
-                               // expanding macro with the values
-                               macro_->expand(values, expanded_.cell(0));
-                       }
+       if (macro_ == 0)
+               return;
+
+       // update requires
+       requires_ = macro_->requires();
+       
+       // non-normal mode? We are done!
+       if (displayMode_ != DISPLAY_NORMAL)
+               return;
+
+       // macro changed?
+       if (needsUpdate_) {
+               needsUpdate_ = false;
+               
+               // get default values of macro
+               vector<docstring> const & defaults = macro_->defaults();
+               
+               // create MathMacroArgumentValue objects pointing to the cells of the macro
+               vector<MathData> values(nargs());
+               for (size_t i = 0; i < nargs(); ++i) {
+                       ArgumentProxy * proxy;
+                       if (i < defaults.size()) 
+                               proxy = new ArgumentProxy(*this, i, defaults[i]);
+                       else
+                               proxy = new ArgumentProxy(*this, i);
+                       values[i].insert(0, MathAtom(proxy));
                }
+               
+               // expanding macro with the values
+               macro_->expand(values, expanded_.cell(0));
        }
 }
 
@@ -273,7 +283,7 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
        int expx = x;
        int expy = y;
 
-       if (displayMode_ == DISPLAY_INIT) {             
+       if (displayMode_ == DISPLAY_INIT || displayMode_ == DISPLAY_INTERACTIVE_INIT) {         
                PainterInfo pi2(pi.base.bv, pi.pain);
                pi2.base.font.setColor(macro_ ? Color_latex : Color_error);
                //pi2.base.style = LM_ST_TEXT;
@@ -291,7 +301,7 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                for (size_t i = 0; i < nargs(); ++i)
                        cell(i).setXY(*pi.base.bv, x, y);
 
-               if (editing_) {
+               if (editing_[pi.base.bv]) {
                        // draw header and rectangle around
                        FontInfo font = pi.base.font;
                        augmentFont(font, from_ascii("lyxtex"));
@@ -315,13 +325,12 @@ void MathMacro::draw(PainterInfo & pi, int x, int y) const
                        expanded_.cell(0).draw(pi, expx, expy);
 
                // draw frame while editing
-               if (editing_)
+               if (editing_[pi.base.bv])
                        pi.pain.rectangle(x, y - dim.asc, dim.wid, dim.height(), Color_mathmacroframe);
        }
 
-       // another argument selected?
-       int curIdx = cursorIdx(pi.base.bv->cursor());
-       if (previousCurIdx_ != curIdx || editing_ != editMode(pi.base.bv->cursor()))
+       // edit mode changed?
+       if (editing_[pi.base.bv] != editMode(pi.base.bv))
                pi.base.bv->cursor().updateFlags(Update::Force);
 }
 
@@ -352,7 +361,7 @@ void MathMacro::setDisplayMode(MathMacro::DisplayMode mode)
 }
 
 
-MathMacro::DisplayMode MathMacro::computeDisplayMode(MetricsInfo const & mi) const
+MathMacro::DisplayMode MathMacro::computeDisplayMode() const
 {
        if (nextFoldMode_ == true && macro_ && !macro_->locked())
                return DISPLAY_NORMAL;
@@ -414,13 +423,13 @@ Inset * MathMacro::editXY(Cursor & cur, int x, int y)
 }
 
 
-void MathMacro::removeArgument(size_t pos) {
+void MathMacro::removeArgument(Inset::pos_type pos) {
        if (displayMode_ == DISPLAY_NORMAL) {
-               BOOST_ASSERT(pos >= 0 && pos < cells_.size());
+               BOOST_ASSERT(size_t(pos) < cells_.size());
                cells_.erase(cells_.begin() + pos);
-               if (pos < attachedArgsNum_)
+               if (size_t(pos) < attachedArgsNum_)
                        --attachedArgsNum_;
-               if (pos < optionals_) {
+               if (size_t(pos) < optionals_) {
                        --optionals_;
                }
 
@@ -429,13 +438,13 @@ void MathMacro::removeArgument(size_t pos) {
 }
 
 
-void MathMacro::insertArgument(size_t pos) {
+void MathMacro::insertArgument(Inset::pos_type pos) {
        if (displayMode_ == DISPLAY_NORMAL) {
-               BOOST_ASSERT(pos >= 0 && pos <= cells_.size());
+               BOOST_ASSERT(size_t(pos) <= cells_.size());
                cells_.insert(cells_.begin() + pos, MathData());
-               if (pos < attachedArgsNum_)
+               if (size_t(pos) < attachedArgsNum_)
                        ++attachedArgsNum_;
-               if (pos < optionals_)
+               if (size_t(pos) < optionals_)
                        ++optionals_;
 
                needsUpdate_ = true;
@@ -443,7 +452,7 @@ void MathMacro::insertArgument(size_t pos) {
 }
 
 
-void MathMacro::detachArguments(std::vector<MathData> & args, bool strip)
+void MathMacro::detachArguments(vector<MathData> & args, bool strip)
 {
        BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);   
        args = cells_;
@@ -464,7 +473,7 @@ void MathMacro::detachArguments(std::vector<MathData> & args, bool strip)
 }
 
 
-void MathMacro::attachArguments(std::vector<MathData> const & args, size_t arity, int optionals)
+void MathMacro::attachArguments(vector<MathData> const & args, size_t arity, int optionals)
 {
        BOOST_ASSERT(displayMode_ == DISPLAY_NORMAL);
        cells_ = args;
@@ -524,54 +533,56 @@ bool MathMacro::folded() const
 
 void MathMacro::write(WriteStream & os) const
 {
-       if (displayMode_ == DISPLAY_NORMAL) {
-               BOOST_ASSERT(macro_);
-
-               os << "\\" << name();
-               bool first = true;
-               size_t i = 0;
-
-               // Use macroBackup_ instead of macro_ here, because
-               // this is outside the metrics/draw calls, hence the macro_
-               // variable can point to a MacroData which was freed already.
-               std::vector<docstring> const & defaults = macroBackup_.defaults();
-
-               // Optional argument
-               if (os.latex()) {
-                       if (i < optionals_) {
-                               // the first real optional, the others are non-optional in latex
-                               if (!cell(i).empty()) {
-                                       first = false;
-                                       os << "[" << cell(0) << "]";
-                               }
-
-                               ++i;
-                       }
-               } else {
-                       // In lyx mode print all in any case
-                       for (; i < cells_.size() && i < optionals_; ++i) {
-                               first = false;
-                               os << "[" << cell(i) << "]";
-                       }
-               }
-
-               for (; i < cells_.size(); ++i) {
-                       if (cell(i).empty() && i < optionals_) {
-                               os << "{" << defaults[i] << "}";
-                       } else if (cell(i).size() == 1 && cell(i)[0].nucleus()->asCharInset()) {
-                               if (first)
-                                       os << " ";
-                               os << cell(i);
-                       }       else
-                               os << "{" << cell(i) << "}";
-                       first = false;
-               }
-               if (first)
-                       os.pendingSpace(true);
-       } else {
+       // non-normal mode
+       if (displayMode_ != DISPLAY_NORMAL) {
                os << "\\" << name() << " ";
                os.pendingSpace(true);
+               return;
+       }
+
+       // normal mode
+       BOOST_ASSERT(macro_);
+
+       // optional arguments make macros fragile
+       if (optionals_ > 0 && os.fragile())
+               os << "\\protect";
+       
+       os << "\\" << name();
+       bool first = true;
+       
+       // Optional arguments:
+       // First find last non-empty optional argument
+       idx_type emptyOptFrom = 0;
+       idx_type i = 0;
+       for (; i < cells_.size() && i < optionals_; ++i) {
+               if (!cell(i).empty())
+                       emptyOptFrom = i + 1;
+       }
+       
+       // print out optionals
+       for (i=0; i < cells_.size() && i < emptyOptFrom; ++i) {
+               first = false;
+               os << "[" << cell(i) << "]";
        }
+       
+       // skip the tailing empty optionals
+       i = optionals_;
+       
+       // Print remaining macros 
+       for (; i < cells_.size(); ++i) {
+               if (cell(i).size() == 1 
+                        && cell(i)[0].nucleus()->asCharInset()) {
+                       if (first)
+                               os << " ";
+                       os << cell(i);
+               } else
+                       os << "{" << cell(i) << "}";
+               first = false;
+       }
+
+       // add space if there was no argument
+       if (first)
+               os.pendingSpace(true);
 }