src/mathed/math_macro.C

   1 /*
   2  *  File:        math_macro.C
   3  *  Purpose:     Implementation of macro class for mathed
   4  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
   5  *  Created:     November 1996
   6  *  Description: WYSIWYG math macros
   7  *
   8  *  Dependencies: Math
   9  *
  10  *  Copyright: 1996, 1997 Alejandro Aguilar Sierra
  11  *
  12  *  Version: 0.2, Math & Lyx project.
  13  *
  14  *  This code is under the GNU General Public Licence version 2 or later.
  15  */
  16
  17 #ifdef __GNUG__
  18 #pragma implementation
  19 #endif
  20
  21 #include "math_macro.h"
  22 #include "math_support.h"
  23 #include "math_extern.h"
  24 #include "math_macrotable.h"
  25 #include "math_macrotemplate.h"
  26 #include "math_mathmlstream.h"
  27 #include "math_streamstr.h"
  28 #include "support/lstrings.h"
  29 #include "support/LAssert.h"
  30 #include "debug.h"
  31 #include "LaTeXFeatures.h"
  32
  33
  34 using std::max;
  35
  36
  37 MathMacro::MathMacro(string const & name)
  38         : MathNestInset(MathMacroTable::provide(name)->asMacroTemplate()->numargs()),
  39                 tmplate_(MathMacroTable::provide(name))
  40 {}
  41
  42
  43 MathMacro::MathMacro(MathMacro const & m)
  44         : MathNestInset(m),
  45                 tmplate_(m.tmplate_) // don't copy 'expanded_'!
  46 {}
  47
  48
  49
  50 MathInset * MathMacro::clone() const
  51 {
  52         return new MathMacro(*this);
  53 }
  54
  55
  56 string const & MathMacro::name() const
  57 {
  58         return tmplate_->asMacroTemplate()->name();
  59 }
  60
  61
  62 bool MathMacro::defining() const
  63 {
  64         return 0;
  65         //return mathcursor && mathcursor->formula()->getInsetName() == name();
  66 }
  67
  68
  69 void MathMacro::expand() const
  70 {
  71         expanded_ = tmplate_->xcell(tmplate_->cell(1).empty() ? 0 : 1);
  72 }
  73
  74
  75 void MathMacro::metrics(MathMetricsInfo & mi) const
  76 {
  77         augmentFont(font_, "lyxtex");
  78         mi_ = mi;
  79
  80         if (defining()) {
  81                 mathed_string_dim(font_, name(), ascent_, descent_, width_);
  82                 return;
  83         }
  84
  85         if (editing()) {
  86                 expand();
  87                 expanded_.metrics(mi_);
  88                 width_   = expanded_.width()   + 4;
  89                 ascent_  = expanded_.ascent()  + 2;
  90                 descent_ = expanded_.descent() + 2;
  91
  92                 width_ +=  mathed_string_width(font_, name()) + 10;
  93
  94                 int lasc;
  95                 int ldes;
  96                 int lwid;
  97                 mathed_string_dim(font_, "#1: ", lasc, ldes, lwid);
  98
  99                 for (idx_type i = 0; i < nargs(); ++i) {
 100                         MathXArray const & c = xcell(i);
 101                         c.metrics(mi_);
 102                         width_    = max(width_, c.width() + lwid);
 103                         descent_ += max(c.ascent(),  lasc) + 5;
 104                         descent_ += max(c.descent(), ldes) + 5;
 105                 }
 106                 return;
 107         }
 108
 109         expand();
 110         expanded_.data_.substitute(*this);
 111         expanded_.metrics(mi_);
 112         width_   = expanded_.width();
 113         ascent_  = expanded_.ascent();
 114         descent_ = expanded_.descent();
 115 }
 116
 117
 118 void MathMacro::draw(MathPainterInfo & pi, int x, int y) const
 119 {
 120         metrics(mi_);
 121
 122         LyXFont texfont;
 123         augmentFont(texfont, "lyxtex");
 124
 125         if (defining()) {
 126                 drawStr(pi, texfont, x, y, name());
 127                 return;
 128         }
 129
 130         if (editing()) {
 131                 int h = y - ascent() + 2 + expanded_.ascent();
 132                 drawStr(pi, font_, x + 3, h, name());
 133
 134                 int const w = mathed_string_width(font_, name());
 135                 expanded_.draw(pi, x + w + 12, h);
 136                 h += expanded_.descent();
 137
 138                 int lasc;
 139                 int ldes;
 140                 int lwid;
 141                 mathed_string_dim(font_, "#1: ", lasc, ldes, lwid);
 142
 143                 for (idx_type i = 0; i < nargs(); ++i) {
 144                         MathXArray const & c = xcell(i);
 145                         h += max(c.ascent(), lasc) + 5;
 146                         c.draw(pi, x + lwid, h);
 147                         char str[] = "#1:";
 148                         str[1] += static_cast<char>(i);
 149                         drawStr(pi, texfont, x + 3, h, str);
 150                         h += max(c.descent(), ldes) + 5;
 151                 }
 152                 return;
 153         }
 154
 155         expanded_.draw(pi, x, y);
 156 }
 157
 158
 159 void MathMacro::dump() const
 160 {
 161         MathMacroTable::dump();
 162         lyxerr << "\n macro: '" << this << "'\n";
 163         lyxerr << " name: '" << name() << "'\n";
 164         lyxerr << " template: '";
 165         WriteStream wi(lyxerr);
 166         tmplate_->write(wi);
 167         lyxerr << "'\n";
 168 }
 169
 170
 171 bool MathMacro::idxUpDown(idx_type & idx, bool up) const
 172 {
 173         pos_type pos;
 174         return
 175                 up ? MathNestInset::idxLeft(idx, pos) : MathNestInset::idxRight(idx, pos);
 176 }
 177
 178
 179 bool MathMacro::idxLeft(idx_type &, pos_type &) const
 180 {
 181         return false;
 182 }
 183
 184
 185 bool MathMacro::idxRight(idx_type &, pos_type &) const
 186 {
 187         return false;
 188 }
 189
 190
 191 void MathMacro::validate(LaTeXFeatures & features) const
 192 {
 193         if (name() == "binom" || name() == "mathcircumflex")
 194                 features.require(name());
 195         //MathInset::validate(features);
 196 }
 197
 198
 199 void MathMacro::maplize(MapleStream & os) const
 200 {
 201         updateExpansion();
 202         ::maplize(expanded_.data_, os);
 203 }
 204
 205
 206 void MathMacro::mathmlize(MathMLStream & os) const
 207 {
 208         updateExpansion();
 209         ::mathmlize(expanded_.data_, os);
 210 }
 211
 212
 213 void MathMacro::octavize(OctaveStream & os) const
 214 {
 215         updateExpansion();
 216         ::octavize(expanded_.data_, os);
 217 }
 218
 219
 220 void MathMacro::normalize(NormalStream & os) const
 221 {
 222         os << "[macro " << name() << " ";
 223         for (idx_type i = 0; i < nargs(); ++i)
 224                 os << cell(i) << ' ';
 225         os << ']';
 226 }
 227
 228
 229 void MathMacro::write(WriteStream & os) const
 230 {
 231         os << '\\' << name();
 232         for (idx_type i = 0; i < nargs(); ++i)
 233                 os << '{' << cell(i) << '}';
 234         if (nargs() == 0)
 235                 os << ' ';
 236 }
 237
 238
 239 void MathMacro::updateExpansion() const
 240 {
 241         expand();
 242         expanded_.data_.substitute(*this);
 243 }