src/mathed/math_macro.C

   1 /**
   2  * \file math_macro.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "math_macro.h"
  15 #include "math_support.h"
  16 #include "math_extern.h"
  17 #include "math_macrotable.h"
  18 #include "math_macrotemplate.h"
  19 #include "math_mathmlstream.h"
  20 #include "cursor.h"
  21 #include "debug.h"
  22 #include "LaTeXFeatures.h"
  23
  24
  25 using std::string;
  26 using std::max;
  27 using std::auto_ptr;
  28 using std::endl;
  29
  30
  31 MathMacro::MathMacro(string const & name)
  32         : MathNestInset(MathMacroTable::provide(name)->asMacroTemplate()->numargs()),
  33                 tmplate_(MathMacroTable::provide(name))
  34 {}
  35
  36
  37 MathMacro::MathMacro(MathMacro const & m)
  38         : MathNestInset(m),
  39                 tmplate_(m.tmplate_) // don't copy 'expanded_'!
  40 {}
  41
  42
  43
  44 auto_ptr<InsetBase> MathMacro::clone() const
  45 {
  46         return auto_ptr<InsetBase>(new MathMacro(*this));
  47 }
  48
  49
  50 string MathMacro::name() const
  51 {
  52         return tmplate_->asMacroTemplate()->name();
  53 }
  54
  55
  56 bool MathMacro::defining() const
  57 {
  58         return 0;
  59         //return mathcursor && mathcursor->formula()->getInsetName() == name();
  60 }
  61
  62
  63 void MathMacro::expand() const
  64 {
  65         expanded_ = tmplate_->cell(tmplate_->cell(1).empty() ? 0 : 1);
  66 }
  67
  68
  69 void MathMacro::metrics(MetricsInfo & mi, Dimension & dim) const
  70 {
  71         augmentFont(font_, "lyxtex");
  72         mi_ = mi;
  73
  74         if (defining()) {
  75
  76                 mathed_string_dim(font_, name(), dim);
  77
  78         } else if (editing(mi.base.bv)) {
  79
  80                 expand();
  81                 expanded_.metrics(mi_, dim);
  82                 metricsMarkers(dim);
  83
  84                 dim.wid += mathed_string_width(font_, name()) + 10;
  85
  86                 int ww = mathed_string_width(font_, "#1: ");
  87
  88                 for (idx_type i = 0; i < nargs(); ++i) {
  89                         MathArray const & c = cell(i);
  90                         c.metrics(mi_);
  91                         dim.wid  = max(dim.wid, c.width() + ww);
  92                         dim.des += max(c.ascent(),  dim.asc) + 5;
  93                         dim.des += max(c.descent(), dim.des) + 5;
  94                 }
  95
  96         } else {
  97
  98                 expand();
  99                 expanded_.substitute(*this);
 100                 expanded_.metrics(mi_, dim);
 101
 102         }
 103
 104         dim_ = dim;
 105 }
 106
 107
 108 void MathMacro::draw(PainterInfo & pi, int x, int y) const
 109 {
 110         metrics(mi_, dim_);
 111
 112         LyXFont texfont;
 113         augmentFont(texfont, "lyxtex");
 114
 115         if (defining()) {
 116                 drawStr(pi, texfont, x, y, name());
 117                 return;
 118         }
 119
 120         if (editing(pi.base.bv)) {
 121                 int h = y - dim_.ascent() + 2 + expanded_.ascent();
 122                 drawStr(pi, font_, x + 3, h, name());
 123
 124                 int const w = mathed_string_width(font_, name());
 125                 expanded_.draw(pi, x + w + 12, h);
 126                 h += expanded_.descent();
 127
 128                 Dimension ldim;
 129                 mathed_string_dim(font_, "#1: ", ldim);
 130
 131                 for (idx_type i = 0; i < nargs(); ++i) {
 132                         MathArray const & c = cell(i);
 133                         h += max(c.ascent(), ldim.asc) + 5;
 134                         c.draw(pi, x + ldim.wid, h);
 135                         char str[] = "#1:";
 136                         str[1] += static_cast<char>(i);
 137                         drawStr(pi, texfont, x + 3, h, str);
 138                         h += max(c.descent(), ldim.des) + 5;
 139                 }
 140                 return;
 141         }
 142
 143         expanded_.draw(pi, x, y);
 144 }
 145
 146
 147 void MathMacro::dump() const
 148 {
 149         MathMacroTable::dump();
 150         lyxerr << "\n macro: '" << this << "'\n"
 151                << " name: '" << name() << "'\n"
 152                << " template: '";
 153         WriteStream wi(lyxerr);
 154         tmplate_->write(wi);
 155         lyxerr << "'" << endl;
 156 }
 157
 158
 159 bool MathMacro::idxUpDown(LCursor & cur, bool up) const
 160 {
 161         if (up) {
 162                 if (!MathNestInset::idxLeft(cur))
 163                         return false;
 164         } else {
 165                 if (!MathNestInset::idxRight(cur))
 166                         return false;
 167         }
 168         cur.pos() = cur.cell().x2pos(cur.x_target());
 169         return true;
 170 }
 171
 172
 173 bool MathMacro::idxLeft(LCursor &) const
 174 {
 175         return false;
 176 }
 177
 178
 179 bool MathMacro::idxRight(LCursor &) const
 180 {
 181         return false;
 182 }
 183
 184
 185 void MathMacro::validate(LaTeXFeatures & features) const
 186 {
 187         if (name() == "binom" || name() == "mathcircumflex")
 188                 features.require(name());
 189         //MathInset::validate(features);
 190 }
 191
 192
 193 void MathMacro::maple(MapleStream & os) const
 194 {
 195         updateExpansion();
 196         ::maple(expanded_, os);
 197 }
 198
 199
 200 void MathMacro::mathmlize(MathMLStream & os) const
 201 {
 202         updateExpansion();
 203         ::mathmlize(expanded_, os);
 204 }
 205
 206
 207 void MathMacro::octave(OctaveStream & os) const
 208 {
 209         updateExpansion();
 210         ::octave(expanded_, os);
 211 }
 212
 213
 214 void MathMacro::updateExpansion() const
 215 {
 216         expand();
 217         expanded_.substitute(*this);
 218 }
 219
 220
 221 void MathMacro::infoize(std::ostream & os) const
 222 {
 223         os << "Macro: " << name();
 224 }
 225
 226
 227 void MathMacro::infoize2(std::ostream & os) const
 228 {
 229         os << "Macro: " << name();
 230 }