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 "array.h"
  23 #include "support/lstrings.h"
  24 #include "support/LAssert.h"
  25 #include "debug.h"
  26 #include "support.h"
  27 #include "math_cursor.h"
  28 #include "math_macrotable.h"
  29 #include "math_macrotemplate.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()   + 6;
 109         ascent_  = expanded_.ascent()  + 3;
 110         descent_ = expanded_.descent() + 3;
 111 }
 112
 113
 114 void MathMacro::draw(Painter & pain, int x, int y) const
 115 {
 116         xo(x);
 117         yo(y);
 118
 119         metrics(mi_);
 120
 121         if (defining()) {
 122                 drawStr(pain, LM_TC_TEX, mi_, x, y, name());
 123                 return;
 124         }
 125
 126         if (editing()) {
 127                 int h = y - ascent() + 2 + expanded_.ascent();
 128                 drawStr(pain, LM_TC_TEXTRM, mi_, x + 3, h, name());
 129
 130                 int const w = mathed_string_width(LM_TC_TEXTRM, mi_, name());
 131                 expanded_.draw(pain, x + w + 12, h);
 132                 h += expanded_.descent();
 133
 134                 int lasc;
 135                 int ldes;
 136                 int lwid;
 137                 mathed_string_dim(LM_TC_TEXTRM, mi_, "#1: ", lasc, ldes, lwid);
 138
 139                 for (idx_type i = 0; i < nargs(); ++i) {
 140                         MathXArray const & c = xcell(i);
 141                         h += std::max(c.ascent(), lasc) + 5;
 142                         c.draw(pain, x + lwid, h);
 143                         char str[] = "#1:";
 144                         str[1] += static_cast<char>(i);
 145                         drawStr(pain, LM_TC_TEX, mi_, x + 3, h, str);
 146                         h += std::max(c.descent(), ldes) + 5;
 147                 }
 148                 return;
 149         }
 150
 151         expanded_.draw(pain, x + 3, y);
 152 }
 153
 154
 155 void MathMacro::dump() const
 156 {
 157         MathMacroTable::dump();
 158         lyxerr << "\n macro: '" << this << "'\n";
 159         lyxerr << " name: '" << name() << "'\n";
 160         lyxerr << " template: '";
 161         MathWriteInfo wi(lyxerr);
 162         tmplate_->write(wi);
 163         lyxerr << "'\n";
 164 }
 165
 166
 167 void MathMacro::write(MathWriteInfo & os) const
 168 {
 169         os << '\\' << name();
 170         for (idx_type i = 0; i < nargs(); ++i)
 171                 os << '{' << cell(i) << '}';
 172         if (nargs() == 0)
 173                 os << ' ';
 174 }
 175
 176
 177 void MathMacro::writeNormal(std::ostream & os) const
 178 {
 179         os << "[macro " << name() << " ";
 180         for (idx_type i = 0; i < nargs(); ++i) {
 181                 cell(i).writeNormal(os);
 182                 os << ' ';
 183         }
 184         os << "] ";
 185 }
 186
 187
 188 bool MathMacro::idxUp(idx_type & idx, pos_type & pos) const
 189 {
 190         return MathNestInset::idxLeft(idx, pos);
 191 }
 192
 193
 194 bool MathMacro::idxDown(idx_type & idx, pos_type & pos) const
 195 {
 196         return MathNestInset::idxRight(idx, pos);
 197 }
 198
 199
 200 bool MathMacro::idxLeft(idx_type &, pos_type &) const
 201 {
 202         return false;
 203 }
 204
 205
 206 bool MathMacro::idxRight(idx_type &, pos_type &) const
 207 {
 208         return false;
 209 }
 210
 211
 212 void MathMacro::validate(LaTeXFeatures & features) const
 213 {
 214         if (name() == "binom")
 215                 features.binom = true;
 216         //MathInset::validate(features);
 217 }