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_cursor.h"
  24 #include "math_extern.h"
  25 #include "math_macrotable.h"
  26 #include "math_macrotemplate.h"
  27 #include "math_mathmlstream.h"
  28 #include "support/lstrings.h"
  29 #include "support/LAssert.h"
  30 #include "debug.h"
  31 #include "Painter.h"
  32 #include "LaTeXFeatures.h"
  33
  34
  35 MathMacro::MathMacro(string const & name)
  36         : MathNestInset(MathMacroTable::provide(name)->asMacroTemplate()->numargs()),
  37                 tmplate_(MathMacroTable::provide(name))
  38 {}
  39
  40
  41 MathMacro::MathMacro(MathMacro const & m)
  42         : MathNestInset(m),
  43                 tmplate_(m.tmplate_) // don't copy 'expanded_'!
  44 {}
  45
  46
  47
  48 MathInset * MathMacro::clone() const
  49 {
  50         return new MathMacro(*this);
  51 }
  52
  53
  54 const char * MathMacro::name() const
  55 {
  56         return tmplate_->asMacroTemplate()->name().c_str();
  57 }
  58
  59
  60 bool MathMacro::defining() const
  61 {
  62         return 0;
  63         //return mathcursor && mathcursor->formula()->getInsetName() == name();
  64 }
  65
  66
  67 bool MathMacro::editing() const
  68 {
  69         return mathcursor && mathcursor->isInside(this);
  70 }
  71
  72
  73 void MathMacro::metrics(MathMetricsInfo const & mi) const
  74 {
  75         mi_ = mi;
  76
  77         if (defining()) {
  78                 mathed_string_dim(LM_TC_TEX, mi_, name(), ascent_, descent_, width_);
  79                 return;
  80         }
  81
  82         if (editing()) {
  83                 expanded_ = tmplate_->xcell(0);
  84                 expanded_.metrics(mi_);
  85                 width_   = expanded_.width()   + 4;
  86                 ascent_  = expanded_.ascent()  + 2;
  87                 descent_ = expanded_.descent() + 2;
  88
  89                 width_ +=  mathed_string_width(LM_TC_TEXTRM, mi_, name()) + 10;
  90
  91                 int lasc;
  92                 int ldes;
  93                 int lwid;
  94                 mathed_string_dim(LM_TC_TEXTRM, mi_, "#1: ", lasc, ldes, lwid);
  95
  96                 for (idx_type i = 0; i < nargs(); ++i) {
  97                         MathXArray const & c = xcell(i);
  98                         c.metrics(mi_);
  99                         width_    = std::max(width_, c.width() + lwid);
 100                         descent_ += std::max(c.ascent(),  lasc) + 5;
 101                         descent_ += std::max(c.descent(), ldes) + 5;
 102                 }
 103                 return;
 104         }
 105
 106         expanded_ = tmplate_->xcell(0);
 107         expanded_.data_.substitute(*this);
 108         expanded_.metrics(mi_);
 109         width_   = expanded_.width();
 110         ascent_  = expanded_.ascent();
 111         descent_ = expanded_.descent();
 112 }
 113
 114
 115 void MathMacro::draw(Painter & pain, int x, int y) const
 116 {
 117         metrics(mi_);
 118
 119         if (defining()) {
 120                 drawStr(pain, LM_TC_TEX, mi_, x, y, name());
 121                 return;
 122         }
 123
 124         if (editing()) {
 125                 int h = y - ascent() + 2 + expanded_.ascent();
 126                 drawStr(pain, LM_TC_TEXTRM, mi_, x + 3, h, name());
 127
 128                 int const w = mathed_string_width(LM_TC_TEXTRM, mi_, name());
 129                 expanded_.draw(pain, x + w + 12, h);
 130                 h += expanded_.descent();
 131
 132                 int lasc;
 133                 int ldes;
 134                 int lwid;
 135                 mathed_string_dim(LM_TC_TEXTRM, mi_, "#1: ", lasc, ldes, lwid);
 136
 137                 for (idx_type i = 0; i < nargs(); ++i) {
 138                         MathXArray const & c = xcell(i);
 139                         h += std::max(c.ascent(), lasc) + 5;
 140                         c.draw(pain, x + lwid, h);
 141                         char str[] = "#1:";
 142                         str[1] += static_cast<char>(i);
 143                         drawStr(pain, LM_TC_TEX, mi_, x + 3, h, str);
 144                         h += std::max(c.descent(), ldes) + 5;
 145                 }
 146                 return;
 147         }
 148
 149         expanded_.draw(pain, x, y);
 150 }
 151
 152
 153 void MathMacro::dump() const
 154 {
 155         MathMacroTable::dump();
 156         lyxerr << "\n macro: '" << this << "'\n";
 157         lyxerr << " name: '" << name() << "'\n";
 158         lyxerr << " template: '";
 159         WriteStream wi(lyxerr);
 160         tmplate_->write(wi);
 161         lyxerr << "'\n";
 162 }
 163
 164
 165 bool MathMacro::idxUp(idx_type & idx) const
 166 {
 167         pos_type pos;
 168         return MathNestInset::idxLeft(idx, pos);
 169 }
 170
 171
 172 bool MathMacro::idxDown(idx_type & idx) const
 173 {
 174         pos_type pos;
 175         return 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")
 194                 features.require("binom");
 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         expanded_ = tmplate_->xcell(0);
 242         expanded_.data_.substitute(*this);
 243 }