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