src/mathed/math_hullinset.C

   1 #include <config.h>
   2
   3 #ifdef __GNUG__
   4 #pragma implementation
   5 #endif
   6
   7 #include "math_hullinset.h"
   8 #include "math_mathmlstream.h"
   9 #include "math_streamstr.h"
  10 #include "math_support.h"
  11 #include "debug.h"
  12 #include "frontends/Painter.h"
  13 #include "textpainter.h"
  14 #include "Lsstream.h"
  15 #include "LaTeXFeatures.h"
  16 #include "support/LAssert.h"
  17
  18 #include <vector>
  19
  20 using std::vector;
  21 using std::max;
  22 using std::endl;
  23
  24 namespace {
  25
  26         int getCols(string const & type)
  27         {
  28                 if (type == "eqnarray")
  29                         return 3;
  30                 if (type == "align")
  31                         return 2;
  32                 if (type == "alignat")
  33                         return 2;
  34                 if (type == "xalignat")
  35                         return 2;
  36                 if (type == "xxalignat")
  37                         return 2;
  38                 return 1;
  39         }
  40
  41
  42         // returns position of first relation operator in the array
  43         // used for "intelligent splitting"
  44         MathArray::size_type firstRelOp(MathArray const & ar)
  45         {
  46                 for (MathArray::const_iterator it = ar.begin(); it != ar.end(); ++it)
  47                         if ((*it)->isRelOp())
  48                                 return it - ar.begin();
  49                 return ar.size();
  50         }
  51
  52
  53         char const * star(bool numbered)
  54         {
  55                 return numbered ? "" : "*";
  56         }
  57
  58
  59         int typecode(string const & s)
  60         {
  61                 if (s == "none")      return 0;
  62                 if (s == "simple")    return 1;
  63                 if (s == "equation")  return 2;
  64                 if (s == "eqnarray")  return 3;
  65                 if (s == "align")     return 4;
  66                 if (s == "alignat")   return 5;
  67                 if (s == "xalignat")  return 6;
  68                 if (s == "xxalignat") return 7;
  69                 if (s == "multline")  return 8;
  70                 if (s == "gather")    return 9;
  71                 lyxerr << "unknown hull type '" << s << "'\n";
  72                 return 0;
  73         }
  74
  75         bool smaller(string const & s, string const & t)
  76         {
  77                 return typecode(s) < typecode(t);
  78         }
  79
  80
  81 } // end anon namespace
  82
  83
  84 MathHullInset::MathHullInset()
  85         : MathGridInset(1, 1), type_("none"), nonum_(1), label_(1)
  86 {
  87         setDefaults();
  88 }
  89
  90
  91 MathHullInset::MathHullInset(string const & type)
  92         : MathGridInset(getCols(type), 1), type_(type), nonum_(1), label_(1)
  93 {
  94         setDefaults();
  95 }
  96
  97
  98 MathInset * MathHullInset::clone() const
  99 {
 100         return new MathHullInset(*this);
 101 }
 102
 103
 104 MathInset::mode_type MathHullInset::currentMode() const
 105 {
 106         if (type_ == "none")
 107                 return UNDECIDED_MODE;
 108         // definitely math mode ...
 109         return MATH_MODE;
 110 }
 111
 112
 113 bool MathHullInset::idxFirst(idx_type & idx, pos_type & pos) const
 114 {
 115         idx = 0;
 116         pos = 0;
 117         return true;
 118 }
 119
 120
 121 bool MathHullInset::idxLast(idx_type & idx, pos_type & pos) const
 122 {
 123         idx = nargs() - 1;
 124         pos = cell(idx).size();
 125         return true;
 126 }
 127
 128
 129 char MathHullInset::defaultColAlign(col_type col)
 130 {
 131         if (type_ == "eqnarray")
 132                 return "rcl"[col];
 133         if (typecode(type_) >= typecode("align"))
 134                 return "rl"[col & 1];
 135         return 'c';
 136 }
 137
 138
 139 int MathHullInset::defaultColSpace(col_type col)
 140 {
 141         if (type_ == "align" || type_ == "alignat")
 142                 return 0;
 143         if (type_ == "xalignat")
 144                 return (col & 1) ? 20 : 0;
 145         if (type_ == "xxalignat")
 146                 return (col & 1) ? 40 : 0;
 147         return 0;
 148 }
 149
 150
 151 char const * MathHullInset::standardFont() const
 152 {
 153         if (type_ == "none")
 154                 return "lyxnochange";
 155         return "mathnormal";
 156 }
 157
 158
 159 void MathHullInset::metrics(MathMetricsInfo & mi) const
 160 {
 161         MathFontSetChanger dummy(mi.base, standardFont());
 162
 163         // let the cells adjust themselves
 164         MathGridInset::metrics(mi);
 165
 166         if (display()) {
 167                 dim_.a += 12;
 168                 dim_.d += 12;
 169         }
 170
 171         if (numberedType()) {
 172                 MathFontSetChanger dummy(mi.base, "mathbf");
 173                 int l = 0;
 174                 for (row_type row = 0; row < nrows(); ++row)
 175                         l = max(l, mathed_string_width(mi.base.font, nicelabel(row)));
 176
 177                 if (l)
 178                         dim_.w += 30 + l;
 179         }
 180
 181         // make it at least as high as the current font
 182         int asc = 0;
 183         int des = 0;
 184         math_font_max_dim(mi.base.font, asc, des);
 185         dim_.a = max(dim_.a,  asc);
 186         dim_.d = max(dim_.d, des);
 187
 188         // for markers
 189         metricsMarkers2();
 190 }
 191
 192
 193 void MathHullInset::draw(MathPainterInfo & pi, int x, int y) const
 194 {
 195         MathFontSetChanger dummy(pi.base, standardFont());
 196         MathGridInset::draw(pi, x + 1, y);
 197
 198         if (numberedType()) {
 199                 int const xx = x + colinfo_.back().offset_ + colinfo_.back().width_ + 20;
 200                 for (row_type row = 0; row < nrows(); ++row) {
 201                         int const yy = y + rowinfo_[row].offset_;
 202                         MathFontSetChanger dummy(pi.base, "mathrm");
 203                         drawStr(pi, pi.base.font, xx, yy, nicelabel(row));
 204                 }
 205         }
 206
 207         drawMarkers2(pi, x, y);
 208 }
 209
 210
 211 void MathHullInset::metricsT(TextMetricsInfo const & mi) const
 212 {
 213         if (display()) {
 214                 MathGridInset::metricsT(mi);
 215         } else {
 216                 ostringstream os;
 217                 WriteStream wi(os, false, true);
 218                 write(wi);
 219                 dim_.w = os.str().size();
 220                 dim_.a = 1;
 221                 dim_.d = 0;
 222         }
 223 }
 224
 225
 226 void MathHullInset::drawT(TextPainter & pain, int x, int y) const
 227 {
 228         if (display()) {
 229                 MathGridInset::drawT(pain, x, y);
 230         } else {
 231                 ostringstream os;
 232                 WriteStream wi(os, false, true);
 233                 write(wi);
 234                 pain.draw(x, y, os.str().c_str());
 235         }
 236 }
 237
 238
 239 string MathHullInset::label(row_type row) const
 240 {
 241         row_type n = nrows();
 242         lyx::Assert(row < n);
 243         return label_[row];
 244 }
 245
 246
 247 void MathHullInset::label(row_type row, string const & label)
 248 {
 249         lyxerr << "setting label '" << label << "' for row " << row << endl;
 250         label_[row] = label;
 251 }
 252
 253
 254 void MathHullInset::numbered(row_type row, bool num)
 255 {
 256         nonum_[row] = !num;
 257 }
 258
 259
 260 bool MathHullInset::numbered(row_type row) const
 261 {
 262         return !nonum_[row];
 263 }
 264
 265
 266 bool MathHullInset::ams() const
 267 {
 268         return
 269                 type_ == "align" ||
 270                 type_ == "multline" ||
 271                 type_ == "gather" ||
 272                 type_ == "alignat" ||
 273                 type_ == "xalignat" ||
 274                 type_ == "xxalignat";
 275 }
 276
 277
 278 bool MathHullInset::display() const
 279 {
 280         return type_ != "simple" && type_ != "none";
 281 }
 282
 283
 284 vector<string> MathHullInset::getLabelList() const
 285 {
 286         vector<string> res;
 287         for (row_type row = 0; row < nrows(); ++row)
 288                 if (!label_[row].empty() && nonum_[row] != 1)
 289                         res.push_back(label_[row]);
 290         return res;
 291 }
 292
 293
 294 bool MathHullInset::numberedType() const
 295 {
 296         if (type_ == "none")
 297                 return false;
 298         if (type_ == "simple")
 299                 return false;
 300         if (type_ == "xxalignat")
 301                 return false;
 302         for (row_type row = 0; row < nrows(); ++row)
 303                 if (!nonum_[row])
 304                         return true;
 305         return false;
 306 }
 307
 308
 309 void MathHullInset::validate(LaTeXFeatures & features) const
 310 {
 311         if (ams())
 312                 features.require("amsmath");
 313
 314
 315         // Validation is necessary only if not using AMS math.
 316         // To be safe, we will always run mathedvalidate.
 317         //if (features.amsstyle)
 318         //  return;
 319
 320         features.require("boldsymbol");
 321         //features.binom      = true;
 322
 323         MathNestInset::validate(features);
 324 }
 325
 326
 327 void MathHullInset::header_write(WriteStream & os) const
 328 {
 329         bool n = numberedType();
 330
 331         if (type_ == "none")
 332                 ;
 333
 334         else if (type_ == "simple") {
 335                 os << '$';
 336                 if (cell(0).empty())
 337                         os << ' ';
 338         }
 339
 340         else if (type_ == "equation") {
 341                 if (n)
 342                         os << "\\begin{equation" << star(n) << "}\n";
 343                 else
 344                         os << "\\[\n";
 345         }
 346
 347         else if (type_ == "eqnarray" || type_ == "align")
 348                         os << "\\begin{" << type_ << star(n) << "}\n";
 349
 350         else if (type_ == "alignat" || type_ == "xalignat")
 351                 os << "\\begin{" << type_ << star(n) << "}"
 352                   << "{" << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
 353
 354         else if (type_ == "xxalignat")
 355                 os << "\\begin{" << type_ << "}"
 356                   << "{" << static_cast<unsigned int>((ncols() + 1)/2) << "}\n";
 357
 358         else if (type_ == "multline" || type_ == "gather")
 359                 os << "\\begin{" << type_ << "}\n";
 360
 361         else
 362                 os << "\\begin{unknown" << star(n) << "}";
 363 }
 364
 365
 366 void MathHullInset::footer_write(WriteStream & os) const
 367 {
 368         bool n = numberedType();
 369
 370         if (type_ == "none")
 371                 os << "\n";
 372
 373         else if (type_ == "simple")
 374                 os << '$';
 375
 376         else if (type_ == "equation")
 377                 if (n)
 378                         os << "\\end{equation" << star(n) << "}\n";
 379                 else
 380                         os << "\\]\n";
 381
 382         else if (type_ == "eqnarray" || type_ == "align" || type_ == "alignat"
 383               || type_ == "xalignat")
 384                 os << "\n\\end{" << type_ << star(n) << "}\n";
 385
 386         else if (type_ == "xxalignat" || type_ == "multline" || type_ == "gather")
 387                 os << "\n\\end{" << type_ << "}\n";
 388
 389         else
 390                 os << "\\end{unknown" << star(n) << "}";
 391 }
 392
 393
 394 void MathHullInset::addRow(row_type row)
 395 {
 396         nonum_.insert(nonum_.begin() + row + 1, !numberedType());
 397         label_.insert(label_.begin() + row + 1, string());
 398         MathGridInset::addRow(row);
 399 }
 400
 401
 402 void MathHullInset::delRow(row_type row)
 403 {
 404         MathGridInset::delRow(row);
 405         nonum_.erase(nonum_.begin() + row);
 406         label_.erase(label_.begin() + row);
 407 }
 408
 409
 410 void MathHullInset::addFancyCol(col_type col)
 411 {
 412         if (type_ == "equation")
 413                 mutate("eqnarray");
 414
 415         else if (type_ == "eqnarray") {
 416                 mutate("align");
 417                 addFancyCol(col);
 418         }
 419
 420         else if (type_ == "align" || type_ == "alignat"
 421               || type_ == "xalignat" || type_ == "xxalignat")
 422                 MathGridInset::addCol(col);
 423 }
 424
 425
 426 void MathHullInset::delFancyCol(col_type col)
 427 {
 428         if (type_ == "alignat" || type_ == "xalignat" || type_ == "xxalignat")
 429                 MathGridInset::delCol(col);
 430 }
 431
 432
 433 string MathHullInset::nicelabel(row_type row) const
 434 {
 435         if (nonum_[row])
 436                 return string();
 437         if (label_[row].empty())
 438                 return string("(#)");
 439         return "(" + label_[row] + ")";
 440 }
 441
 442
 443 void MathHullInset::glueall()
 444 {
 445         MathArray ar;
 446         for (idx_type i = 0; i < nargs(); ++i)
 447                 ar.push_back(cell(i));
 448         *this = MathHullInset("simple");
 449         cell(0) = ar;
 450         setDefaults();
 451 }
 452
 453
 454 string const & MathHullInset::getType() const
 455 {
 456         return type_;
 457 }
 458
 459
 460 void MathHullInset::setType(string const & type)
 461 {
 462         type_ = type;
 463         setDefaults();
 464 }
 465
 466
 467
 468 void MathHullInset::mutate(string const & newtype)
 469 {
 470         //lyxerr << "mutating from '" << type_ << "' to '" << newtype << "'\n";
 471
 472         // we try to move along the chain
 473         // none <-> simple <-> equation <-> eqnarray
 474
 475         if (newtype == "dump") {
 476                 dump();
 477         }
 478
 479         else if (newtype == type_) {
 480                 // done
 481         }
 482
 483         else if (type_ == "none") {
 484                 setType("simple");
 485                 numbered(0, false);
 486                 mutate(newtype);
 487         }
 488
 489         else if (type_ == "simple") {
 490                 if (newtype == "none") {
 491                         setType("none");
 492                 } else {
 493                         setType("equation");
 494                         numbered(0, false);
 495                         mutate(newtype);
 496                 }
 497         }
 498
 499         else if (type_ == "equation") {
 500                 if (smaller(newtype, type_)) {
 501                         setType("simple");
 502                         mutate(newtype);
 503                 } else if (newtype == "eqnarray") {
 504                         MathGridInset::addCol(1);
 505                         MathGridInset::addCol(1);
 506
 507                         // split it "nicely" on the firest relop
 508                         pos_type pos = firstRelOp(cell(0));
 509                         cell(1) = MathArray(cell(0), pos, cell(0).size());
 510                         cell(0).erase(pos, cell(0).size());
 511
 512                         if (cell(1).size()) {
 513                                 cell(2) = MathArray(cell(1), 1, cell(1).size());
 514                                 cell(1).erase(1, cell(1).size());
 515                         }
 516                         setType("eqnarray");
 517                         mutate(newtype);
 518                 } else {
 519                         MathGridInset::addCol(1);
 520                         // split it "nicely"
 521                         pos_type pos = firstRelOp(cell(0));
 522                         cell(1) = cell(0);
 523                         cell(0).erase(pos, cell(0).size());
 524                         cell(1).erase(0, pos);
 525                         setType("align");
 526                         mutate(newtype);
 527                 }
 528         }
 529
 530         else if (type_ == "eqnarray") {
 531                 if (smaller(newtype, type_)) {
 532                         // set correct (no)numbering
 533                         bool allnonum = true;
 534                         for (row_type row = 0; row < nrows(); ++row)
 535                                 if (!nonum_[row])
 536                                         allnonum = false;
 537
 538                         // set first non-empty label
 539                         string label;
 540                         for (row_type row = 0; row < nrows(); ++row) {
 541                                 if (!label_[row].empty()) {
 542                                         label = label_[row];
 543                                         break;
 544                                 }
 545                         }
 546
 547                         glueall();
 548                         nonum_[0] = allnonum;
 549                         label_[0] = label;
 550                         mutate(newtype);
 551                 } else { // align & Co.
 552                         for (row_type row = 0; row < nrows(); ++row) {
 553                                 idx_type c = 3 * row + 1;
 554                                 cell(c).push_back(cell(c + 1));
 555                         }
 556                         MathGridInset::delCol(2);
 557                         setType("align");
 558                         mutate(newtype);
 559                 }
 560         }
 561
 562         else if (type_ == "align") {
 563                 if (smaller(newtype, type_)) {
 564                         MathGridInset::addCol(1);
 565                         setType("eqnarray");
 566                         mutate(newtype);
 567                 } else {
 568                         setType(newtype);
 569                 }
 570         }
 571
 572         else if (type_ == "multline") {
 573                 if (newtype == "gather") {
 574                         setType("gather");
 575                 } else {
 576                         lyxerr << "mutation from '" << type_
 577                                 << "' to '" << newtype << "' not implemented"
 578                                                  << endl;
 579                 }
 580         }
 581
 582         else if (type_ == "gather") {
 583                 if (newtype == "multline") {
 584                         setType("multline");
 585                 } else {
 586                         lyxerr << "mutation from '" << type_
 587                                 << "' to '" << newtype << "' not implemented" << endl;
 588                 }
 589         }
 590
 591         else {
 592                 lyxerr << "mutation from '" << type_
 593                                          << "' to '" << newtype << "' not implemented" << endl;
 594         }
 595 }
 596
 597
 598 void MathHullInset::write(WriteStream & os) const
 599 {
 600         header_write(os);
 601
 602         bool n = numberedType();
 603
 604         for (row_type row = 0; row < nrows(); ++row) {
 605                 for (col_type col = 0; col < ncols(); ++col)
 606                         os << cell(index(row, col)) << eocString(col);
 607                 if (n) {
 608                         if (!label_[row].empty())
 609                                 os << "\\label{" << label_[row] << "}";
 610                         if (nonum_[row])
 611                                 os << "\\nonumber ";
 612                 }
 613                 os << eolString(row);
 614         }
 615
 616         footer_write(os);
 617 }
 618
 619
 620 void MathHullInset::normalize(NormalStream & os) const
 621 {
 622         os << "[formula " << type_ << " ";
 623         MathGridInset::normalize(os);
 624         os << "] ";
 625 }
 626
 627
 628 void MathHullInset::mathmlize(MathMLStream & os) const
 629 {
 630         MathGridInset::mathmlize(os);
 631 }
 632
 633
 634 void MathHullInset::infoize(std::ostream & os) const
 635 {
 636         os << "Type: " << type_;
 637 }
 638
 639
 640 void MathHullInset::check() const
 641 {
 642         lyx::Assert(nonum_.size() == nrows());
 643         lyx::Assert(label_.size() == nrows());
 644 }