src/mathed/InsetMathGrid.cpp

   1 /**
   2  * \file InsetMathGrid.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12 #include <algorithm>
  13
  14 #include "InsetMathGrid.h"
  15
  16 #include "InsetMathUnknown.h"
  17 #include "MathData.h"
  18 #include "MathParser.h"
  19 #include "MathStream.h"
  20 #include "MetricsInfo.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "Cursor.h"
  26 #include "CutAndPaste.h"
  27 #include "FuncRequest.h"
  28 #include "FuncStatus.h"
  29 #include "LaTeXFeatures.h"
  30 #include "TexRow.h"
  31
  32 #include "frontends/Clipboard.h"
  33 #include "frontends/Painter.h"
  34
  35 #include "support/debug.h"
  36 #include "support/docstream.h"
  37 #include "support/gettext.h"
  38 #include "support/lstrings.h"
  39 #include "support/lassert.h"
  40
  41 #include <sstream>
  42
  43 using namespace std;
  44 using namespace lyx::support;
  45
  46
  47
  48 namespace lyx {
  49
  50 static docstring verboseHLine(int n)
  51 {
  52         docstring res;
  53         for (int i = 0; i < n; ++i)
  54                 res += "\\hline";
  55         if (n)
  56                 res += ' ';
  57         return res;
  58 }
  59
  60
  61 static int extractInt(istream & is)
  62 {
  63         int num = 1;
  64         is >> num;
  65         return (num == 0) ? 1 : num;
  66 }
  67
  68
  69 static void resetGrid(InsetMathGrid & grid)
  70 {
  71         while (grid.ncols() > 1)
  72                 grid.delCol(grid.ncols() - 1);
  73         while (grid.nrows() > 1)
  74                 grid.delRow(grid.nrows() - 1);
  75         grid.cell(0).erase(0, grid.cell(0).size());
  76         grid.setDefaults();
  77 }
  78
  79
  80
  81 //////////////////////////////////////////////////////////////
  82
  83
  84 InsetMathGrid::CellInfo::CellInfo()
  85         : multi_(CELL_NORMAL)
  86 {}
  87
  88
  89
  90 //////////////////////////////////////////////////////////////
  91
  92
  93 InsetMathGrid::RowInfo::RowInfo()
  94         : descent_(0), ascent_(0), offset_(0), lines_(0), skip_(0),
  95           allow_newpage_(true)
  96 {}
  97
  98
  99
 100 int InsetMathGrid::RowInfo::skipPixels(MetricsInfo const & mi) const
 101 {
 102         return crskip_.inPixels(mi.base);
 103 }
 104
 105
 106
 107 //////////////////////////////////////////////////////////////
 108
 109
 110 InsetMathGrid::ColInfo::ColInfo()
 111         : align_('c'), width_(0), offset_(0), lines_(0), skip_(0)
 112 {}
 113
 114
 115 //////////////////////////////////////////////////////////////
 116
 117
 118 InsetMathGrid::InsetMathGrid(Buffer * buf)
 119         : InsetMathNest(buf, 1),
 120           rowinfo_(1 + 1),
 121                 colinfo_(1 + 1),
 122                 cellinfo_(1),
 123                 v_align_('c')
 124 {
 125         setDefaults();
 126 }
 127
 128
 129 InsetMathGrid::InsetMathGrid(Buffer * buf, col_type m, row_type n)
 130         : InsetMathNest(buf, m * n),
 131           rowinfo_(n + 1),
 132                 colinfo_(m + 1),
 133                 cellinfo_(m * n),
 134                 v_align_('c')
 135 {
 136         setDefaults();
 137 }
 138
 139
 140 InsetMathGrid::InsetMathGrid(Buffer * buf, col_type m, row_type n, char v,
 141         docstring const & h)
 142         : InsetMathNest(buf, m * n),
 143           rowinfo_(n + 1),
 144           colinfo_(m + 1),
 145                 cellinfo_(m * n),
 146                 v_align_(v)
 147 {
 148         setDefaults();
 149         setVerticalAlignment(v);
 150         setHorizontalAlignments(h);
 151 }
 152
 153
 154 Inset * InsetMathGrid::clone() const
 155 {
 156         return new InsetMathGrid(*this);
 157 }
 158
 159
 160 InsetMath::idx_type InsetMathGrid::index(row_type row, col_type col) const
 161 {
 162         return col + ncols() * row;
 163 }
 164
 165
 166 void InsetMathGrid::setDefaults()
 167 {
 168         if (ncols() <= 0)
 169                 lyxerr << "positive number of columns expected" << endl;
 170         //if (nrows() <= 0)
 171         //      lyxerr << "positive number of rows expected" << endl;
 172         for (col_type col = 0; col < ncols(); ++col) {
 173                 colinfo_[col].align_ = defaultColAlign(col);
 174                 colinfo_[col].skip_  = defaultColSpace(col);
 175                 colinfo_[col].special_.clear();
 176         }
 177         for (idx_type idx = 0; idx < nargs(); ++idx)
 178                 cellinfo_[idx].multi_ = CELL_NORMAL;
 179 }
 180
 181
 182 bool InsetMathGrid::interpretString(Cursor & cur, docstring const & str)
 183 {
 184         if (str == "\\hline") {
 185                 FuncRequest fr = FuncRequest(LFUN_TABULAR_FEATURE, "add-hline-above");
 186                 FuncStatus status;
 187                 if (getStatus(cur, fr, status)) {
 188                         if (status.enabled()) {
 189                                 rowinfo_[cur.row()].lines_++;
 190                                 return true;
 191                         }
 192                 }
 193         }
 194         return InsetMathNest::interpretString(cur, str);
 195 }
 196
 197
 198 void InsetMathGrid::setHorizontalAlignments(docstring const & hh)
 199 {
 200         col_type col = 0;
 201         for (docstring::const_iterator it = hh.begin(); it != hh.end(); ++it) {
 202                 char_type c = *it;
 203                 if (c == '|') {
 204                         colinfo_[col].lines_++;
 205                 } else if ((c == 'p' || c == 'm' || c == 'b'||
 206                             c == '!' || c == '@' || c == '>' || c == '<') &&
 207                            it + 1 != hh.end() && *(it + 1) == '{') {
 208                         // @{decl.} and p{width} are standard LaTeX, the
 209                         // others are extensions by array.sty
 210                         bool const newcolumn = c == 'p' || c == 'm' || c == 'b';
 211                         if (newcolumn) {
 212                                 // this declares a new column
 213                                 if (col >= ncols())
 214                                         // Only intercolumn stuff is allowed
 215                                         // in the last dummy column
 216                                         break;
 217                                 colinfo_[col].align_ = 'l';
 218                         } else {
 219                                 // this is intercolumn stuff
 220                                 if (colinfo_[col].special_.empty())
 221                                         // Overtake possible lines
 222                                         colinfo_[col].special_ = docstring(colinfo_[col].lines_, '|');
 223                         }
 224                         int brace_open = 0;
 225                         int brace_close = 0;
 226                         while (it != hh.end()) {
 227                                 c = *it;
 228                                 colinfo_[col].special_ += c;
 229                                 if (c == '{')
 230                                         ++brace_open;
 231                                 else if (c == '}')
 232                                         ++brace_close;
 233                                 ++it;
 234                                 if (brace_open > 0 && brace_open == brace_close)
 235                                         break;
 236                         }
 237                         --it;
 238                         if (newcolumn) {
 239                                 colinfo_[col].lines_ = count(
 240                                         colinfo_[col].special_.begin(),
 241                                         colinfo_[col].special_.end(), '|');
 242                                 LYXERR(Debug::MATHED, "special column separator: `"
 243                                         << to_utf8(colinfo_[col].special_) << '\'');
 244                                 ++col;
 245                                 colinfo_[col].lines_ = 0;
 246                                 colinfo_[col].special_.clear();
 247                         }
 248                 } else if (col >= ncols()) {
 249                         // Only intercolumn stuff is allowed in the last
 250                         // dummy column
 251                         break;
 252                 } else if (c == 'c' || c == 'l' || c == 'r') {
 253                         colinfo_[col].align_ = static_cast<char>(c);
 254                         if (!colinfo_[col].special_.empty()) {
 255                                 colinfo_[col].special_ += c;
 256                                 colinfo_[col].lines_ = count(
 257                                                 colinfo_[col].special_.begin(),
 258                                                 colinfo_[col].special_.end(), '|');
 259                                 LYXERR(Debug::MATHED, "special column separator: `"
 260                                         << to_utf8(colinfo_[col].special_) << '\'');
 261                         }
 262                         ++col;
 263                         colinfo_[col].lines_ = 0;
 264                         colinfo_[col].special_.clear();
 265                 } else {
 266                         lyxerr << "unknown column separator: '" << c << "'" << endl;
 267                 }
 268         }
 269
 270 /*
 271         col_type n = hh.size();
 272         if (n > ncols())
 273                 n = ncols();
 274         for (col_type col = 0; col < n; ++col)
 275                 colinfo_[col].align_ = hh[col];
 276 */
 277 }
 278
 279
 280 InsetMathGrid::col_type InsetMathGrid::guessColumns(docstring const & hh)
 281 {
 282         col_type col = 0;
 283         for (docstring::const_iterator it = hh.begin(); it != hh.end(); ++it)
 284                 if (*it == 'c' || *it == 'l' || *it == 'r'||
 285                     *it == 'p' || *it == 'm' || *it == 'b')
 286                         ++col;
 287         // let's have at least one column, even if we did not recognize its
 288         // alignment
 289         if (col == 0)
 290                 col = 1;
 291         return col;
 292 }
 293
 294
 295 void InsetMathGrid::setHorizontalAlignment(char h, col_type col)
 296 {
 297         colinfo_[col].align_ = h;
 298         if (!colinfo_[col].special_.empty()) {
 299                 char_type & c = colinfo_[col].special_[colinfo_[col].special_.size() - 1];
 300                 if (c == 'l' || c == 'c' || c == 'r')
 301                         c = h;
 302         }
 303         // FIXME: Change alignment of p, m and b columns, too
 304 }
 305
 306
 307 char InsetMathGrid::horizontalAlignment(col_type col) const
 308 {
 309         return colinfo_[col].align_;
 310 }
 311
 312
 313 docstring InsetMathGrid::horizontalAlignments() const
 314 {
 315         docstring res;
 316         for (col_type col = 0; col < ncols(); ++col) {
 317                 if (colinfo_[col].special_.empty()) {
 318                         res += docstring(colinfo_[col].lines_, '|');
 319                         res += colinfo_[col].align_;
 320                 } else
 321                         res += colinfo_[col].special_;
 322         }
 323         if (colinfo_[ncols()].special_.empty())
 324                 return res + docstring(colinfo_[ncols()].lines_, '|');
 325         return res + colinfo_[ncols()].special_;
 326 }
 327
 328
 329 void InsetMathGrid::setVerticalAlignment(char c)
 330 {
 331         v_align_ = c;
 332 }
 333
 334
 335 char InsetMathGrid::verticalAlignment() const
 336 {
 337         return v_align_;
 338 }
 339
 340
 341 InsetMathGrid::col_type InsetMathGrid::ncols() const
 342 {
 343         return colinfo_.size() - 1;
 344 }
 345
 346
 347 InsetMathGrid::row_type InsetMathGrid::nrows() const
 348 {
 349         return rowinfo_.size() - 1;
 350 }
 351
 352
 353 InsetMathGrid::col_type InsetMathGrid::col(idx_type idx) const
 354 {
 355         return idx % ncols();
 356 }
 357
 358
 359 InsetMathGrid::row_type InsetMathGrid::row(idx_type idx) const
 360 {
 361         return idx / ncols();
 362 }
 363
 364
 365 InsetMathGrid::col_type InsetMathGrid::ncellcols(idx_type idx) const
 366 {
 367         col_type cols = 1;
 368         if (cellinfo_[idx].multi_ == CELL_NORMAL)
 369                 return cols;
 370         // If the cell at idx is already CELL_PART_OF_MULTICOLUMN we return
 371         // the number of remaining columns, not the ones of the complete
 372         // multicolumn cell. This makes it possible to always go to the next
 373         // cell with idx + ncellcols(idx) - 1.
 374         row_type const r = row(idx);
 375         while (idx+cols < nargs() && row(idx+cols) == r &&
 376                cellinfo_[idx+cols].multi_ == CELL_PART_OF_MULTICOLUMN)
 377                 cols++;
 378         return cols;
 379 }
 380
 381
 382 void InsetMathGrid::vcrskip(Length const & crskip, row_type row)
 383 {
 384         rowinfo_[row].crskip_ = crskip;
 385 }
 386
 387
 388 Length InsetMathGrid::vcrskip(row_type row) const
 389 {
 390         return rowinfo_[row].crskip_;
 391 }
 392
 393
 394 void InsetMathGrid::metrics(MetricsInfo & mi, Dimension & dim) const
 395 {
 396         // let the cells adjust themselves
 397         for (idx_type i = 0; i < nargs(); ++i) {
 398                 if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
 399                         Dimension dimc;
 400                         cell(i).metrics(mi, dimc);
 401                 }
 402         }
 403
 404         BufferView & bv = *mi.base.bv;
 405
 406         // compute absolute sizes of vertical structure
 407         for (row_type row = 0; row < nrows(); ++row) {
 408                 int asc  = 0;
 409                 int desc = 0;
 410                 for (col_type col = 0; col < ncols(); ++col) {
 411                         idx_type const i = index(row, col);
 412                         if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
 413                                 Dimension const & dimc = cell(i).dimension(bv);
 414                                 asc  = max(asc,  dimc.asc);
 415                                 desc = max(desc, dimc.des);
 416                         }
 417                 }
 418                 rowinfo_[row].ascent_  = asc;
 419                 rowinfo_[row].descent_ = desc;
 420         }
 421         rowinfo_[0].ascent_       += hlinesep() * rowinfo_[0].lines_;
 422         rowinfo_[nrows()].ascent_  = 0;
 423         rowinfo_[nrows()].descent_ = 0;
 424
 425         // compute vertical offsets
 426         rowinfo_[0].offset_ = 0;
 427         for (row_type row = 1; row <= nrows(); ++row) {
 428                 rowinfo_[row].offset_ =
 429                         rowinfo_[row - 1].offset_ +
 430                         rowinfo_[row - 1].descent_ +
 431                         rowinfo_[row - 1].skipPixels(mi) +
 432                         rowsep() +
 433                         rowinfo_[row].lines_ * hlinesep() +
 434                         rowinfo_[row].ascent_;
 435         }
 436
 437         // adjust vertical offset
 438         int h = 0;
 439         switch (v_align_) {
 440                 case 't':
 441                         h = 0;
 442                         break;
 443                 case 'b':
 444                         h = rowinfo_[nrows() - 1].offset_;
 445                         break;
 446                 default:
 447                         h = rowinfo_[nrows() - 1].offset_ / 2;
 448         }
 449         for (row_type row = 0; row <= nrows(); ++row)
 450                 rowinfo_[row].offset_ -= h;
 451
 452
 453         // multicolumn cell widths, as a map from first column to width in a
 454         // vector of last columns.
 455         // This is only used if the grid has more than one row, since for
 456         // one-row grids multicolumn cells do not need special handling
 457         vector<map<col_type, int> > mcolwidths(ncols());
 458
 459         // compute absolute sizes of horizontal structure
 460         for (col_type col = 0; col < ncols(); ++col) {
 461                 int wid = 0;
 462                 for (row_type row = 0; row < nrows(); ++row) {
 463                         idx_type const i = index(row, col);
 464                         if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
 465                                 int const w = cell(i).dimension(bv).wid;
 466                                 col_type const cols = ncellcols(i);
 467                                 if (cols > 1 && nrows() > 1) {
 468                                         col_type last = col+cols-1;
 469                                         LASSERT(last < ncols(), last = ncols()-1);
 470                                         map<col_type, int>::iterator it =
 471                                                 mcolwidths[last].find(col);
 472                                         if (it == mcolwidths[last].end())
 473                                                 mcolwidths[last][col] = w;
 474                                         else
 475                                                 it->second = max(it->second, w);
 476                                 } else
 477                                         wid = max(wid, w);
 478                         }
 479                 }
 480                 colinfo_[col].width_ = wid;
 481         }
 482         colinfo_[ncols()].width_  = 0;
 483
 484         // compute horizontal offsets
 485         colinfo_[0].offset_ = border();
 486         for (col_type col = 1; col <= ncols(); ++col) {
 487                 colinfo_[col].offset_ =
 488                         colinfo_[col - 1].offset_ +
 489                         colinfo_[col - 1].width_ +
 490                         displayColSpace(col - 1) +
 491                         colsep() +
 492                         colinfo_[col].lines_ * vlinesep();
 493         }
 494
 495         // increase column widths for multicolumn cells if needed
 496         // FIXME: multicolumn lines are not yet considered
 497         for (col_type last = 0; last < ncols(); ++last) {
 498                 map<col_type, int> const & widths = mcolwidths[last];
 499                 // We increase the width of the last column of the multicol
 500                 // cell (some sort of left alignment). Since we iterate through
 501                 // the last and the first columns from left to right, we ensure
 502                 // that increased widths of previous columns are correctly
 503                 // taken into account for later columns, thus preventing
 504                 // unneeded width increasing.
 505                 for (map<col_type, int>::const_iterator it = widths.begin();
 506                      it != widths.end(); ++it) {
 507                         int const wid = it->second;
 508                         col_type const first = it->first;
 509                         int const nextoffset =
 510                                 colinfo_[first].offset_ +
 511                                 wid +
 512                                 displayColSpace(last) +
 513                                 colsep() +
 514                                 colinfo_[last+1].lines_ * vlinesep();
 515                         int const dx = nextoffset - colinfo_[last+1].offset_;
 516                         if (dx > 0) {
 517                                 colinfo_[last].width_ += dx;
 518                                 for (col_type col = last + 1; col <= ncols(); ++col)
 519                                         colinfo_[col].offset_ += dx;
 520                         }
 521                 }
 522         }
 523
 524
 525         dim.wid = colinfo_[ncols() - 1].offset_
 526                 + colinfo_[ncols() - 1].width_
 527                 + vlinesep() * colinfo_[ncols()].lines_
 528                 + border();
 529
 530         dim.asc = - rowinfo_[0].offset_
 531                 + rowinfo_[0].ascent_
 532                 + hlinesep() * rowinfo_[0].lines_
 533                 + border();
 534
 535         dim.des = rowinfo_[nrows() - 1].offset_
 536                 + rowinfo_[nrows() - 1].descent_
 537                 + hlinesep() * rowinfo_[nrows()].lines_
 538                 + border();
 539
 540
 541 /*
 542         // Increase ws_[i] for 'R' columns (except the first one)
 543         for (int i = 1; i < nc_; ++i)
 544                 if (align_[i] == 'R')
 545                         ws_[i] += 10 * df_width;
 546         // Increase ws_[i] for 'C' column
 547         if (align_[0] == 'C')
 548                 if (ws_[0] < 7 * workwidth / 8)
 549                         ws_[0] = 7 * workwidth / 8;
 550
 551         // Adjust local tabs
 552         width = colsep();
 553         for (cxrow = row_.begin(); cxrow; ++cxrow) {
 554                 int rg = COLSEP;
 555                 int lf = 0;
 556                 for (int i = 0; i < nc_; ++i) {
 557                         bool isvoid = false;
 558                         if (cxrow->getTab(i) <= 0) {
 559                                 cxrow->setTab(i, df_width);
 560                                 isvoid = true;
 561                         }
 562                         switch (align_[i]) {
 563                         case 'l':
 564                                 lf = 0;
 565                                 break;
 566                         case 'c':
 567                                 lf = (ws_[i] - cxrow->getTab(i))/2;
 568                                 break;
 569                         case 'r':
 570                         case 'R':
 571                                 lf = ws_[i] - cxrow->getTab(i);
 572                                 break;
 573                         case 'C':
 574                                 if (cxrow == row_.begin())
 575                                         lf = 0;
 576                                 else if (cxrow.is_last())
 577                                         lf = ws_[i] - cxrow->getTab(i);
 578                                 else
 579                                         lf = (ws_[i] - cxrow->getTab(i))/2;
 580                                 break;
 581                         }
 582                         int const ww = (isvoid) ? lf : lf + cxrow->getTab(i);
 583                         cxrow->setTab(i, lf + rg);
 584                         rg = ws_[i] - ww + colsep();
 585                         if (cxrow == row_.begin())
 586                                 width += ws_[i] + colsep();
 587                 }
 588                 cxrow->setBaseline(cxrow->getBaseline() - ascent);
 589         }
 590 */
 591         metricsMarkers2(dim);
 592         // Cache the inset dimension.
 593         setDimCache(mi, dim);
 594 }
 595
 596
 597 void InsetMathGrid::draw(PainterInfo & pi, int x, int y) const
 598 {
 599         drawWithMargin(pi, x, y, 1, 1);
 600 }
 601
 602
 603 void InsetMathGrid::drawWithMargin(PainterInfo & pi, int x, int y,
 604         int lmargin, int rmargin) const
 605 {
 606         Dimension const dim = dimension(*pi.base.bv);
 607         BufferView const & bv = *pi.base.bv;
 608
 609         for (idx_type idx = 0; idx < nargs(); ++idx) {
 610                 if (cellinfo_[idx].multi_ != CELL_PART_OF_MULTICOLUMN) {
 611                         cell(idx).draw(pi,
 612                                 x + lmargin + cellXOffset(bv, idx),
 613                                 y + cellYOffset(idx));
 614
 615                         // draw inner lines cell by cell because of possible multicolumns
 616                         // FIXME: multicolumn lines are not yet considered
 617                         row_type const r = row(idx);
 618                         col_type const c = col(idx);
 619                         if (r > 0 && r < nrows()) {
 620                                 for (unsigned int i = 0; i < rowinfo_[r].lines_; ++i) {
 621                                         int const yy = y + rowinfo_[r].offset_
 622                                                 - rowinfo_[r].ascent_
 623                                                 - i * hlinesep()
 624                                                 - hlinesep()/2 - rowsep()/2;
 625                                         pi.pain.line(
 626                                                 x + lmargin + colinfo_[c].offset_,
 627                                                 yy,
 628                                                 x + lmargin + colinfo_[c+1].offset_,
 629                                                 yy, Color_foreground);
 630                                 }
 631                         }
 632                         if (c > 0 && c < ncols()) {
 633                                 for (unsigned int i = 0; i < colinfo_[c].lines_; ++i) {
 634                                         int const xx = x + lmargin
 635                                                 + colinfo_[c].offset_
 636                                                 - i * vlinesep()
 637                                                 - vlinesep()/2 - colsep()/2;
 638                                         int top_offset;
 639                                         // prevRowHasLine needs to be changed if multicolumn lines are supported
 640                                         bool const prevRowHasLine(r > 0);
 641                                         if (prevRowHasLine)
 642                                                 // start from offset of previous row to create a continous line
 643                                                 top_offset = rowinfo_[r - 1].offset_ + rowinfo_[r - 1].descent_;
 644                                         else
 645                                                 top_offset = rowinfo_[r].offset_- rowinfo_[r].ascent_;
 646                                         pi.pain.line(xx, y + top_offset,
 647                                                 xx, y + rowinfo_[r].offset_ + rowinfo_[r].descent_,
 648                                                 Color_foreground);
 649                                 }
 650                         }
 651                 }
 652         }
 653
 654         // draw outer lines in one go
 655         for (row_type row = 0; row <= nrows(); row += nrows())
 656                 for (unsigned int i = 0; i < rowinfo_[row].lines_; ++i) {
 657                         int yy = y + rowinfo_[row].offset_ - rowinfo_[row].ascent_
 658                                 - i * hlinesep() - hlinesep()/2 - rowsep()/2;
 659                         pi.pain.line(x + lmargin + 1, yy,
 660                                      x + dim.width() - rmargin - 1, yy,
 661                                      Color_foreground);
 662                 }
 663
 664         for (col_type col = 0; col <= ncols(); col += ncols())
 665                 for (unsigned int i = 0; i < colinfo_[col].lines_; ++i) {
 666                         int xx = x + lmargin + colinfo_[col].offset_
 667                                 - i * vlinesep() - vlinesep()/2 - colsep()/2;
 668                         pi.pain.line(xx, y - dim.ascent() + 1,
 669                                      xx, y + dim.descent() - 1,
 670                                      Color_foreground);
 671                 }
 672         drawMarkers2(pi, x, y);
 673 }
 674
 675
 676 void InsetMathGrid::metricsT(TextMetricsInfo const & mi, Dimension & dim) const
 677 {
 678         // let the cells adjust themselves
 679         for (idx_type i = 0; i < nargs(); ++i)
 680                 if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN)
 681                         cell(i).metricsT(mi, dim);
 682
 683         // compute absolute sizes of vertical structure
 684         for (row_type row = 0; row < nrows(); ++row) {
 685                 int asc  = 0;
 686                 int desc = 0;
 687                 for (col_type col = 0; col < ncols(); ++col) {
 688                         idx_type const i = index(row, col);
 689                         if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
 690                                 //MathData const & c = cell(i);
 691                                 // FIXME: BROKEN!
 692                                 Dimension dimc;
 693                                 asc  = max(asc,  dimc.ascent());
 694                                 desc = max(desc, dimc.descent());
 695                         }
 696                 }
 697                 rowinfo_[row].ascent_  = asc;
 698                 rowinfo_[row].descent_ = desc;
 699         }
 700         //rowinfo_[0].ascent_       += hlinesep() * rowinfo_[0].lines_;
 701         rowinfo_[nrows()].ascent_  = 0;
 702         rowinfo_[nrows()].descent_ = 0;
 703
 704         // compute vertical offsets
 705         rowinfo_[0].offset_ = 0;
 706         for (row_type row = 1; row <= nrows(); ++row) {
 707                 rowinfo_[row].offset_  =
 708                         rowinfo_[row - 1].offset_  +
 709                         rowinfo_[row - 1].descent_ +
 710                         //rowinfo_[row - 1].skipPixels(mi) +
 711                         1 + //rowsep() +
 712                         //rowinfo_[row].lines_ * hlinesep() +
 713                         rowinfo_[row].ascent_;
 714         }
 715
 716         // adjust vertical offset
 717         int h = 0;
 718         switch (v_align_) {
 719                 case 't':
 720                         h = 0;
 721                         break;
 722                 case 'b':
 723                         h = rowinfo_[nrows() - 1].offset_;
 724                         break;
 725                 default:
 726                         h = rowinfo_[nrows() - 1].offset_ / 2;
 727         }
 728         for (row_type row = 0; row <= nrows(); ++row)
 729                 rowinfo_[row].offset_ -= h;
 730
 731
 732         // compute absolute sizes of horizontal structure
 733         for (col_type col = 0; col < ncols(); ++col) {
 734                 int wid = 0;
 735                 for (row_type row = 0; row < nrows(); ++row) {
 736                         // FIXME: BROKEN!
 737                         //idx_type const i = index(row, col);
 738                         //if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN)
 739                         //      wid = max(wid, cell(i).width());
 740                 }
 741                 colinfo_[col].width_ = wid;
 742         }
 743         colinfo_[ncols()].width_  = 0;
 744
 745         // compute horizontal offsets
 746         colinfo_[0].offset_ = border();
 747         for (col_type col = 1; col <= ncols(); ++col) {
 748                 colinfo_[col].offset_ =
 749                         colinfo_[col - 1].offset_ +
 750                         colinfo_[col - 1].width_ +
 751                         displayColSpace(col - 1) +
 752                         1 ; //colsep() +
 753                         //colinfo_[col].lines_ * vlinesep();
 754         }
 755
 756
 757         dim.wid  =  colinfo_[ncols() - 1].offset_
 758                        + colinfo_[ncols() - 1].width_
 759                  //+ vlinesep() * colinfo_[ncols()].lines_
 760                        + 2;
 761
 762         dim.asc  = -rowinfo_[0].offset_
 763                        + rowinfo_[0].ascent_
 764                  //+ hlinesep() * rowinfo_[0].lines_
 765                        + 1;
 766
 767         dim.des  =  rowinfo_[nrows() - 1].offset_
 768                        + rowinfo_[nrows() - 1].descent_
 769                  //+ hlinesep() * rowinfo_[nrows()].lines_
 770                        + 1;
 771 }
 772
 773
 774 void InsetMathGrid::drawT(TextPainter & /*pain*/, int /*x*/, int /*y*/) const
 775 {
 776 //      for (idx_type idx = 0; idx < nargs(); ++idx)
 777 //              if (cellinfo_[idx].multi_ != CELL_PART_OF_MULTICOLUMN)
 778 //                      cell(idx).drawT(pain, x + cellXOffset(idx), y + cellYOffset(idx));
 779 }
 780
 781
 782 void InsetMathGrid::updateBuffer(ParIterator const & it, UpdateType utype)
 783 {
 784         // pass down
 785         for (idx_type idx = 0; idx < nargs(); ++idx)
 786                 if (cellinfo_[idx].multi_ != CELL_PART_OF_MULTICOLUMN)
 787                         cell(idx).updateBuffer(it, utype);
 788 }
 789
 790
 791 docstring InsetMathGrid::eolString(row_type row, bool fragile,
 792                 bool /*latex*/, bool last_eoln) const
 793 {
 794         docstring eol;
 795
 796         if (!rowinfo_[row].crskip_.zero())
 797                 eol += '[' + from_utf8(rowinfo_[row].crskip_.asLatexString()) + ']';
 798         else if(!rowinfo_[row].allow_newpage_)
 799                 eol += '*';
 800
 801         // make sure an upcoming '[' does not break anything
 802         if (row + 1 < nrows()) {
 803                 MathData const & c = cell(index(row + 1, 0));
 804                 if (!c.empty() && c.front()->getChar() == '[')
 805                         //eol += "[0pt]";
 806                         eol += "{}";
 807         }
 808
 809         // only add \\ if necessary
 810         if (eol.empty() && row + 1 == nrows() && (nrows() == 1 || !last_eoln))
 811                 return docstring();
 812
 813         return (fragile ? "\\protect\\\\" : "\\\\") + eol;
 814 }
 815
 816
 817 docstring InsetMathGrid::eocString(col_type col, col_type lastcol) const
 818 {
 819         if (col + 1 == lastcol)
 820                 return docstring();
 821         return from_ascii(" & ");
 822 }
 823
 824
 825 void InsetMathGrid::addRow(row_type row)
 826 {
 827         rowinfo_.insert(rowinfo_.begin() + row + 1, RowInfo());
 828         cells_.insert
 829                 (cells_.begin() + (row + 1) * ncols(), ncols(), MathData());
 830         cellinfo_.insert
 831                 (cellinfo_.begin() + (row + 1) * ncols(), ncols(), CellInfo());
 832 }
 833
 834
 835 void InsetMathGrid::delRow(row_type row)
 836 {
 837         if (nrows() == 1)
 838                 return;
 839
 840         cells_type::iterator it = cells_.begin() + row * ncols();
 841         cells_.erase(it, it + ncols());
 842
 843         vector<CellInfo>::iterator jt = cellinfo_.begin() + row * ncols();
 844         cellinfo_.erase(jt, jt + ncols());
 845
 846         rowinfo_.erase(rowinfo_.begin() + row);
 847 }
 848
 849
 850 void InsetMathGrid::copyRow(row_type row)
 851 {
 852         addRow(row);
 853         for (col_type col = 0; col < ncols(); ++col)
 854                 cells_[(row + 1) * ncols() + col] = cells_[row * ncols() + col];
 855 }
 856
 857
 858 void InsetMathGrid::swapRow(row_type row)
 859 {
 860         if (nrows() == 1)
 861                 return;
 862         if (row + 1 == nrows())
 863                 --row;
 864         for (col_type col = 0; col < ncols(); ++col)
 865                 swap(cells_[row * ncols() + col], cells_[(row + 1) * ncols() + col]);
 866 }
 867
 868
 869 void InsetMathGrid::addCol(col_type newcol)
 870 {
 871         const col_type nc = ncols();
 872         const row_type nr = nrows();
 873         cells_type new_cells((nc + 1) * nr);
 874         vector<CellInfo> new_cellinfo((nc + 1) * nr);
 875
 876         for (row_type row = 0; row < nr; ++row)
 877                 for (col_type col = 0; col < nc; ++col) {
 878                         new_cells[row * (nc + 1) + col + (col >= newcol)]
 879                                 = cells_[row * nc + col];
 880                         new_cellinfo[row * (nc + 1) + col + (col >= newcol)]
 881                                 = cellinfo_[row * nc + col];
 882                 }
 883         swap(cells_, new_cells);
 884         swap(cellinfo_, new_cellinfo);
 885
 886         ColInfo inf;
 887         inf.skip_  = defaultColSpace(newcol);
 888         inf.align_ = defaultColAlign(newcol);
 889         colinfo_.insert(colinfo_.begin() + newcol, inf);
 890 }
 891
 892
 893 void InsetMathGrid::delCol(col_type col)
 894 {
 895         if (ncols() == 1)
 896                 return;
 897
 898         cells_type tmpcells;
 899         vector<CellInfo> tmpcellinfo;
 900         for (col_type i = 0; i < nargs(); ++i)
 901                 if (i % ncols() != col) {
 902                         tmpcells.push_back(cells_[i]);
 903                         tmpcellinfo.push_back(cellinfo_[i]);
 904                 }
 905         swap(cells_, tmpcells);
 906         swap(cellinfo_, tmpcellinfo);
 907
 908         colinfo_.erase(colinfo_.begin() + col);
 909 }
 910
 911
 912 void InsetMathGrid::copyCol(col_type col)
 913 {
 914         addCol(col+1);
 915         for (row_type row = 0; row < nrows(); ++row)
 916                 cells_[row * ncols() + col + 1] = cells_[row * ncols() + col];
 917 }
 918
 919
 920 void InsetMathGrid::swapCol(col_type col)
 921 {
 922         if (ncols() == 1)
 923                 return;
 924         if (col + 1 == ncols())
 925                 --col;
 926         for (row_type row = 0; row < nrows(); ++row)
 927                 swap(cells_[row * ncols() + col], cells_[row * ncols() + col + 1]);
 928 }
 929
 930
 931 int InsetMathGrid::cellXOffset(BufferView const & bv, idx_type idx) const
 932 {
 933         if (cellinfo_[idx].multi_ == CELL_PART_OF_MULTICOLUMN)
 934                 return 0;
 935         col_type c = col(idx);
 936         int x = colinfo_[c].offset_;
 937         char align = displayColAlign(idx);
 938         Dimension const & celldim = cell(idx).dimension(bv);
 939         if (align == 'r' || align == 'R')
 940                 x += cellWidth(idx) - celldim.wid;
 941         if (align == 'c' || align == 'C')
 942                 x += (cellWidth(idx) - celldim.wid) / 2;
 943         return x;
 944 }
 945
 946
 947 int InsetMathGrid::cellYOffset(idx_type idx) const
 948 {
 949         return rowinfo_[row(idx)].offset_;
 950 }
 951
 952
 953 int InsetMathGrid::cellWidth(idx_type idx) const
 954 {
 955         switch (cellinfo_[idx].multi_) {
 956         case CELL_NORMAL:
 957                 return colinfo_[col(idx)].width_;
 958         case CELL_BEGIN_OF_MULTICOLUMN: {
 959                 col_type c1 = col(idx);
 960                 col_type c2 = c1 + ncellcols(idx);
 961                 return colinfo_[c2].offset_
 962                         - colinfo_[c1].offset_
 963                         - displayColSpace(c2)
 964                         - colsep()
 965                         - colinfo_[c2].lines_ * vlinesep();
 966         }
 967         case CELL_PART_OF_MULTICOLUMN:
 968                 return 0;
 969         }
 970         return 0;
 971 }
 972
 973
 974 bool InsetMathGrid::idxUpDown(Cursor & cur, bool up) const
 975 {
 976         if (up) {
 977                 if (cur.row() == 0)
 978                         return false;
 979                 cur.idx() -= ncols();
 980         } else {
 981                 if (cur.row() + 1 >= nrows())
 982                         return false;
 983                 cur.idx() += ncols();
 984         }
 985         // If we are in a multicolumn cell, move to the "real" cell
 986         while (cellinfo_[cur.idx()].multi_ == CELL_PART_OF_MULTICOLUMN) {
 987                 LASSERT(cur.idx() > 0, return false);
 988                 --cur.idx();
 989         }
 990         cur.pos() = cur.cell().x2pos(&cur.bv(), cur.x_target() - cur.cell().xo(cur.bv()));
 991         return true;
 992 }
 993
 994
 995 bool InsetMathGrid::idxBackward(Cursor & cur) const
 996 {
 997         // leave matrix if at the front edge
 998         if (cur.col() == 0)
 999                 return false;
1000         --cur.idx();
1001         // If we are in a multicolumn cell, move to the "real" cell
1002         while (cellinfo_[cur.idx()].multi_ == CELL_PART_OF_MULTICOLUMN) {
1003                 LASSERT(cur.idx() > 0, return false);
1004                 --cur.idx();
1005         }
1006         cur.pos() = cur.lastpos();
1007         return true;
1008 }
1009
1010
1011 bool InsetMathGrid::idxForward(Cursor & cur) const
1012 {
1013         // leave matrix if at the back edge
1014         if (cur.col() + 1 == ncols())
1015                 return false;
1016         ++cur.idx();
1017         // If we are in a multicolumn cell, move to the next cell
1018         while (cellinfo_[cur.idx()].multi_ == CELL_PART_OF_MULTICOLUMN) {
1019                 // leave matrix if at the back edge
1020                 if (cur.col() + 1 == ncols())
1021                         return false;
1022                 ++cur.idx();
1023         }
1024         cur.pos() = 0;
1025         return true;
1026 }
1027
1028
1029 bool InsetMathGrid::idxFirst(Cursor & cur) const
1030 {
1031         switch (v_align_) {
1032                 case 't':
1033                         cur.idx() = 0;
1034                         break;
1035                 case 'b':
1036                         cur.idx() = (nrows() - 1) * ncols();
1037                         break;
1038                 default:
1039                         cur.idx() = ((nrows() - 1) / 2) * ncols();
1040         }
1041         // If we are in a multicolumn cell, move to the "real" cell
1042         while (cellinfo_[cur.idx()].multi_ == CELL_PART_OF_MULTICOLUMN) {
1043                 LASSERT(cur.idx() > 0, return false);
1044                 --cur.idx();
1045         }
1046         cur.pos() = 0;
1047         return true;
1048 }
1049
1050
1051 bool InsetMathGrid::idxLast(Cursor & cur) const
1052 {
1053         switch (v_align_) {
1054                 case 't':
1055                         cur.idx() = ncols() - 1;
1056                         break;
1057                 case 'b':
1058                         cur.idx() = nargs() - 1;
1059                         break;
1060                 default:
1061                         cur.idx() = ((nrows() - 1) / 2 + 1) * ncols() - 1;
1062         }
1063         // If we are in a multicolumn cell, move to the "real" cell
1064         while (cellinfo_[cur.idx()].multi_ == CELL_PART_OF_MULTICOLUMN) {
1065                 LASSERT(cur.idx() > 0, return false);
1066                 --cur.idx();
1067         }
1068         cur.pos() = cur.lastpos();
1069         return true;
1070 }
1071
1072
1073 bool InsetMathGrid::idxDelete(idx_type & idx)
1074 {
1075         // nothing to do if we have just one row
1076         if (nrows() == 1)
1077                 return false;
1078
1079         // nothing to do if we are in the middle of the last row of the inset
1080         if (idx + ncols() > nargs())
1081                 return false;
1082
1083         // try to delete entire sequence of ncols() empty cells if possible
1084         for (idx_type i = idx; i < idx + ncols(); ++i)
1085                 if (!cell(i).empty())
1086                         return false;
1087
1088         // move cells if necessary
1089         for (idx_type i = index(row(idx), 0); i < idx; ++i)
1090                 swap(cell(i), cell(i + ncols()));
1091
1092         delRow(row(idx));
1093
1094         if (idx >= nargs())
1095                 idx = nargs() - 1;
1096
1097         // undo effect of Ctrl-Tab (i.e. pull next cell)
1098         //if (idx + 1 != nargs())
1099         //      cell(idx).swap(cell(idx + 1));
1100
1101         // we handled the event..
1102         return true;
1103 }
1104
1105
1106 // reimplement old behaviour when pressing Delete in the last position
1107 // of a cell
1108 void InsetMathGrid::idxGlue(idx_type idx)
1109 {
1110         col_type c = col(idx);
1111         if (c + 1 == ncols()) {
1112                 if (row(idx) + 1 != nrows()) {
1113                         for (col_type cc = 0; cc < ncols(); ++cc)
1114                                 cell(idx).append(cell(idx + cc + 1));
1115                         delRow(row(idx) + 1);
1116                 }
1117         } else {
1118                 idx_type idx_next = idx + 1;
1119                 while (idx_next < nargs() &&
1120                        cellinfo_[idx_next].multi_ == CELL_PART_OF_MULTICOLUMN)
1121                         ++idx_next;
1122                 if (idx_next < nargs())
1123                         cell(idx).append(cell(idx_next));
1124                 col_type oldcol = c + 1;
1125                 for (col_type cc = c + 2; cc < ncols(); ++cc)
1126                         cell(idx - oldcol + cc) = cell(idx - oldcol + 1 + cc);
1127                 cell(idx - c + ncols() - 1).clear();
1128         }
1129 }
1130
1131
1132 InsetMathGrid::RowInfo const & InsetMathGrid::rowinfo(row_type row) const
1133 {
1134         return rowinfo_[row];
1135 }
1136
1137
1138 InsetMathGrid::RowInfo & InsetMathGrid::rowinfo(row_type row)
1139 {
1140         return rowinfo_[row];
1141 }
1142
1143
1144 bool InsetMathGrid::idxBetween(idx_type idx, idx_type from, idx_type to) const
1145 {
1146         row_type const ri = row(idx);
1147         row_type const r1 = min(row(from), row(to));
1148         row_type const r2 = max(row(from), row(to));
1149         col_type const ci = col(idx);
1150         col_type const c1 = min(col(from), col(to));
1151         col_type const c2 = max(col(from), col(to));
1152         return r1 <= ri && ri <= r2 && c1 <= ci && ci <= c2;
1153 }
1154
1155
1156 void InsetMathGrid::normalize(NormalStream & os) const
1157 {
1158         os << "[grid ";
1159         for (row_type row = 0; row < nrows(); ++row) {
1160                 os << "[row ";
1161                 for (col_type col = 0; col < ncols(); ++col) {
1162                         idx_type const i = index(row, col);
1163                         switch (cellinfo_[i].multi_) {
1164                         case CELL_NORMAL:
1165                                 os << "[cell " << cell(i) << ']';
1166                                 break;
1167                         case CELL_BEGIN_OF_MULTICOLUMN:
1168                                 os << "[cell colspan="
1169                                    << static_cast<int>(ncellcols(i)) << ' '
1170                                    << cell(i) << ']';
1171                                 break;
1172                         case CELL_PART_OF_MULTICOLUMN:
1173                                 break;
1174                         }
1175                 }
1176                 os << ']';
1177         }
1178         os << ']';
1179 }
1180
1181
1182 void InsetMathGrid::mathmlize(MathStream & os) const
1183 {
1184         bool const havetable = nrows() > 1 || ncols() > 1;
1185         if (havetable)
1186                 os << MTag("mtable");
1187         char const * const celltag = havetable ? "mtd" : "mrow";
1188         for (row_type row = 0; row < nrows(); ++row) {
1189                 if (havetable)
1190                         os << MTag("mtr");
1191                 for (col_type col = 0; col < ncols(); ++col) {
1192                         idx_type const i = index(row, col);
1193                         if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
1194                                 col_type const cellcols = ncellcols(i);
1195                                 ostringstream attr;
1196                                 if (havetable && cellcols > 1)
1197                                         attr << "colspan='" << cellcols << '\'';
1198                                 os << MTag(celltag, attr.str());
1199                                 os << cell(index(row, col));
1200                                 os << ETag(celltag);
1201                         }
1202                 }
1203                 if (havetable)
1204                         os << ETag("mtr");
1205         }
1206         if (havetable)
1207                 os << ETag("mtable");
1208 }
1209
1210
1211 // FIXME XHTML
1212 // We need to do something about alignment here.
1213 void InsetMathGrid::htmlize(HtmlStream & os, string attrib) const
1214 {
1215         bool const havetable = nrows() > 1 || ncols() > 1;
1216         if (!havetable) {
1217                 os << cell(index(0, 0));
1218                 return;
1219         }
1220         os << MTag("table", attrib);
1221         for (row_type row = 0; row < nrows(); ++row) {
1222                 os << MTag("tr");
1223                 for (col_type col = 0; col < ncols(); ++col) {
1224                         idx_type const i = index(row, col);
1225                         if (cellinfo_[i].multi_ != CELL_PART_OF_MULTICOLUMN) {
1226                                 col_type const cellcols = ncellcols(i);
1227                                 ostringstream attr;
1228                                 if (cellcols > 1)
1229                                         attr << "colspan='" << cellcols << '\'';
1230                                 os << MTag("td", attr.str());
1231                                 os << cell(index(row, col));
1232                                 os << ETag("td");
1233                         }
1234                 }
1235                 os << ETag("tr");
1236         }
1237         os << ETag("table");
1238 }
1239
1240
1241 void InsetMathGrid::htmlize(HtmlStream & os) const
1242 {
1243         htmlize(os, "class='mathtable'");
1244 }
1245
1246
1247 void InsetMathGrid::validate(LaTeXFeatures & features) const
1248 {
1249         if (features.runparams().math_flavor == OutputParams::MathAsHTML
1250             && (nrows() > 1 || ncols() > 1)) {
1251                 // CSS taken from InsetMathCases
1252                 features.addCSSSnippet(
1253                         "table.mathtable{display: inline-block; text-align: center; border: none;"
1254                         "border-left: thin solid black; vertical-align: middle; padding-left: 0.5ex;}\n"
1255                         "table.mathtable td {text-align: left; border: none;}");
1256         }
1257         InsetMathNest::validate(features);
1258 }
1259
1260
1261 void InsetMathGrid::write(WriteStream & os) const
1262 {
1263         write(os, 0, 0, nrows(), ncols());
1264 }
1265
1266 void InsetMathGrid::write(WriteStream & os,
1267                           row_type beg_row, col_type beg_col,
1268                           row_type end_row, col_type end_col) const
1269 {
1270         MathEnsurer ensurer(os, false);
1271         docstring eol;
1272         for (row_type row = beg_row; row < end_row; ++row) {
1273                 os << verboseHLine(rowinfo_[row].lines_);
1274                 // don't write & and empty cells at end of line,
1275                 // unless there are vertical lines
1276                 col_type lastcol = 0;
1277                 bool emptyline = true;
1278                 bool last_eoln = true;
1279                 for (col_type col = beg_col; col < end_col; ++col) {
1280                         idx_type const idx = index(row, col);
1281                         bool const empty_cell = cell(idx).empty();
1282                         if (!empty_cell || cellinfo_[idx].multi_ != CELL_NORMAL)
1283                                 last_eoln = false;
1284                         if (!empty_cell || cellinfo_[idx].multi_ != CELL_NORMAL ||
1285                             colinfo_[col + 1].lines_) {
1286                                 lastcol = col + 1;
1287                                 emptyline = false;
1288                         }
1289                 }
1290                 for (col_type col = beg_col; col < end_col;) {
1291                         int nccols = 1;
1292                         idx_type const idx = index(row, col);
1293                         RowEntry entry = TexRow::mathEntry(id(),idx);
1294                         os.texrow().start(entry);
1295                         if (col >= lastcol) {
1296                                 ++col;
1297                                 continue;
1298                         }
1299                         Changer dummy = os.changeRowEntry(entry);
1300                         if (cellinfo_[idx].multi_ == CELL_BEGIN_OF_MULTICOLUMN) {
1301                                 size_t s = col + 1;
1302                                 while (s < ncols() &&
1303                                        cellinfo_[index(row, s)].multi_ == CELL_PART_OF_MULTICOLUMN)
1304                                         s++;
1305                                 nccols = s - col;
1306                                 os << "\\multicolumn{" << nccols
1307                                    << "}{" << cellinfo_[idx].align_
1308                                    << "}{";
1309                         }
1310                         os << cell(idx);
1311                         if (os.pendingBrace())
1312                                 ModeSpecifier specifier(os, TEXT_MODE);
1313                         if (cellinfo_[idx].multi_ == CELL_BEGIN_OF_MULTICOLUMN)
1314                                 os << '}';
1315                         os << eocString(col + nccols - 1, lastcol);
1316                         col += nccols;
1317                 }
1318                 eol = eolString(row, os.fragile(), os.latex(), last_eoln);
1319                 os << eol;
1320                 // append newline only if line wasn't completely empty
1321                 // and the formula is not written on a single line
1322                 bool const empty = emptyline && eol.empty();
1323                 if (!empty && nrows() > 1)
1324                         os << "\n";
1325         }
1326         // @TODO use end_row instead of nrows() ?
1327         docstring const s = verboseHLine(rowinfo_[nrows()].lines_);
1328         if (!s.empty()) {
1329                 if (eol.empty()) {
1330                         if (os.fragile())
1331                                 os << "\\protect";
1332                         os << "\\\\";
1333                 }
1334                 os << s;
1335         }
1336 }
1337
1338
1339 int InsetMathGrid::colsep() const
1340 {
1341         return 6;
1342 }
1343
1344
1345 int InsetMathGrid::rowsep() const
1346 {
1347         return 6;
1348 }
1349
1350
1351 int InsetMathGrid::hlinesep() const
1352 {
1353         return 3;
1354 }
1355
1356
1357 int InsetMathGrid::vlinesep() const
1358 {
1359         return 3;
1360 }
1361
1362
1363 int InsetMathGrid::border() const
1364 {
1365         return 1;
1366 }
1367
1368
1369 void InsetMathGrid::splitCell(Cursor & cur)
1370 {
1371         if (cur.idx() == cur.lastidx())
1372                 return;
1373         MathData ar = cur.cell();
1374         ar.erase(0, cur.pos());
1375         cur.cell().erase(cur.pos(), cur.lastpos());
1376         ++cur.idx();
1377         while (cur.idx() << nargs() &&
1378                cellinfo_[cur.idx()].multi_ == CELL_BEGIN_OF_MULTICOLUMN)
1379                 ++cur.idx();
1380         cur.pos() = 0;
1381         cur.cell().insert(0, ar);
1382 }
1383
1384
1385 char InsetMathGrid::displayColAlign(idx_type idx) const
1386 {
1387         if (cellinfo_[idx].multi_ == CELL_BEGIN_OF_MULTICOLUMN) {
1388                 // align_ may also contain lines like "||r|", so this is
1389                 // not complete, but we catch at least the simple cases.
1390                 if (cellinfo_[idx].align_ == "c")
1391                         return 'c';
1392                 if (cellinfo_[idx].align_ == "l")
1393                         return 'l';
1394                 if (cellinfo_[idx].align_ == "r")
1395                         return 'r';
1396         }
1397         return colinfo_[col(idx)].align_;
1398 }
1399
1400
1401 int InsetMathGrid::displayColSpace(col_type col) const
1402 {
1403         return colinfo_[col].skip_;
1404 }
1405
1406 void InsetMathGrid::doDispatch(Cursor & cur, FuncRequest & cmd)
1407 {
1408         //lyxerr << "*** InsetMathGrid: request: " << cmd << endl;
1409
1410         Parse::flags parseflg = Parse::QUIET | Parse::USETEXT;
1411
1412         FuncCode const act = cmd.action();
1413         switch (act) {
1414
1415         // insert file functions
1416         case LFUN_LINE_DELETE_FORWARD:
1417                 cur.recordUndoInset();
1418                 //autocorrect_ = false;
1419                 //macroModeClose();
1420                 //if (selection_) {
1421                 //      selDel();
1422                 //      break;
1423                 //}
1424                 if (nrows() > 1)
1425                         delRow(cur.row());
1426                 if (cur.idx() > cur.lastidx())
1427                         cur.idx() = cur.lastidx();
1428                 if (cur.pos() > cur.lastpos())
1429                         cur.pos() = cur.lastpos();
1430                 break;
1431
1432         case LFUN_CELL_SPLIT:
1433                 cur.recordUndo();
1434                 splitCell(cur);
1435                 break;
1436
1437         case LFUN_CELL_BACKWARD:
1438                 // See below.
1439                 cur.selection(false);
1440                 if (!idxPrev(cur)) {
1441                         cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
1442                         cur.undispatched();
1443                 }
1444                 break;
1445
1446         case LFUN_CELL_FORWARD:
1447                 // Can't handle selection by additional 'shift' as this is
1448                 // hard bound to LFUN_CELL_BACKWARD
1449                 cur.selection(false);
1450                 if (!idxNext(cur)) {
1451                         cmd = FuncRequest(LFUN_FINISHED_FORWARD);
1452                         cur.undispatched();
1453                 }
1454                 break;
1455
1456         case LFUN_NEWLINE_INSERT: {
1457                 cur.recordUndoInset();
1458                 row_type const r = cur.row();
1459                 addRow(r);
1460
1461                 // split line
1462                 for (col_type c = col(cur.idx()) + 1; c < ncols(); ++c)
1463                         swap(cell(index(r, c)), cell(index(r + 1, c)));
1464
1465                 // split cell
1466                 splitCell(cur);
1467                 if (ncols() > 1)
1468                         swap(cell(cur.idx()), cell(cur.idx() + ncols() - 1));
1469                 if (cur.idx() > 0)
1470                         --cur.idx();
1471                 cur.pos() = cur.lastpos();
1472                 cur.forceBufferUpdate();
1473                 //mathcursor->normalize();
1474                 //cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
1475                 break;
1476         }
1477
1478         case LFUN_TABULAR_FEATURE: {
1479                 cur.recordUndoInset();
1480                 //lyxerr << "handling tabular-feature " << to_utf8(cmd.argument()) << endl;
1481                 istringstream is(to_utf8(cmd.argument()));
1482                 string s;
1483                 is >> s;
1484                 if (s == "valign-top")
1485                         setVerticalAlignment('t');
1486                 else if (s == "valign-middle")
1487                         setVerticalAlignment('c');
1488                 else if (s == "valign-bottom")
1489                         setVerticalAlignment('b');
1490                 else if (s == "align-left")
1491                         setHorizontalAlignment('l', cur.col());
1492                 else if (s == "align-right")
1493                         setHorizontalAlignment('r', cur.col());
1494                 else if (s == "align-center")
1495                         setHorizontalAlignment('c', cur.col());
1496                 else if (s == "append-row")
1497                         for (int i = 0, n = extractInt(is); i < n; ++i)
1498                                 addRow(cur.row());
1499                 else if (s == "delete-row") {
1500                         cur.clearSelection(); // bug 4323
1501                         for (int i = 0, n = extractInt(is); i < n; ++i) {
1502                                 delRow(cur.row());
1503                                 if (cur.idx() >= nargs())
1504                                         cur.idx() -= ncols();
1505                         }
1506                         cur.pos() = 0; // trick, see below
1507                 }
1508                 else if (s == "copy-row") {
1509                         // Here (as later) we save the cursor col/row
1510                         // in order to restore it after operation.
1511                         row_type const r = cur.row();
1512                         col_type const c = cur.col();
1513                         for (int i = 0, n = extractInt(is); i < n; ++i)
1514                                 copyRow(cur.row());
1515                         cur.idx() = index(r, c);
1516                 }
1517                 else if (s == "swap-row") {
1518                         swapRow(cur.row());
1519                         // Trick to suppress same-idx-means-different-cell
1520                         // assertion crash:
1521                         cur.pos() = 0;
1522                 }
1523                 else if (s == "add-hline-above")
1524                         rowinfo_[cur.row()].lines_++;
1525                 else if (s == "add-hline-below")
1526                         rowinfo_[cur.row()+1].lines_++;
1527                 else if (s == "delete-hline-above")
1528                         rowinfo_[cur.row()].lines_--;
1529                 else if (s == "delete-hline-below")
1530                         rowinfo_[cur.row()+1].lines_--;
1531                 else if (s == "append-column") {
1532                         row_type const r = cur.row();
1533                         col_type const c = cur.col();
1534                         for (int i = 0, n = extractInt(is); i < n; ++i)
1535                                 addCol(cur.col() + 1);
1536                         cur.idx() = index(r, c);
1537                 }
1538                 else if (s == "delete-column") {
1539                         cur.clearSelection(); // bug 4323
1540                         row_type const r = cur.row();
1541                         col_type const c = cur.col();
1542                         for (int i = 0, n = extractInt(is); i < n; ++i)
1543                                 delCol(col(cur.idx()));
1544                         cur.idx() = index(r, min(c, cur.ncols() - 1));
1545                         cur.pos() = 0; // trick, see above
1546                 }
1547                 else if (s == "copy-column") {
1548                         row_type const r = cur.row();
1549                         col_type const c = cur.col();
1550                         copyCol(cur.col());
1551                         cur.idx() = index(r, c);
1552                 }
1553                 else if (s == "swap-column") {
1554                         swapCol(cur.col());
1555                         cur.pos() = 0; // trick, see above
1556                 }
1557                 else if (s == "add-vline-left") {
1558                         colinfo_[cur.col()].lines_++;
1559                         if (!colinfo_[cur.col()].special_.empty())
1560                                 colinfo_[cur.col()].special_ += '|';
1561                 }
1562                 else if (s == "add-vline-right") {
1563                         colinfo_[cur.col()+1].lines_++;
1564                         if (!colinfo_[cur.col()+1].special_.empty())
1565                                 colinfo_[cur.col()+1].special_.insert(0, 1, '|');
1566                 }
1567                 else if (s == "delete-vline-left") {
1568                         colinfo_[cur.col()].lines_--;
1569                         docstring & special = colinfo_[cur.col()].special_;
1570                         if (!special.empty()) {
1571                                 docstring::size_type i = special.rfind('|');
1572                                 LASSERT(i != docstring::npos, break);
1573                                 special.erase(i, 1);
1574                         }
1575                 }
1576                 else if (s == "delete-vline-right") {
1577                         colinfo_[cur.col()+1].lines_--;
1578                         docstring & special = colinfo_[cur.col()+1].special_;
1579                         if (!special.empty()) {
1580                                 docstring::size_type i = special.find('|');
1581                                 LASSERT(i != docstring::npos, break);
1582                                 special.erase(i, 1);
1583                         }
1584                 }
1585                 else {
1586                         cur.undispatched();
1587                         break;
1588                 }
1589                 // perhaps this should be FINISHED_BACKWARD -- just for clarity?
1590                 //lyxerr << "returning FINISHED_LEFT" << endl;
1591                 break;
1592         }
1593
1594         case LFUN_CLIPBOARD_PASTE:
1595                 parseflg |= Parse::VERBATIM;
1596                 // fall through
1597         case LFUN_PASTE: {
1598                 if (cur.currentMode() <= TEXT_MODE)
1599                         parseflg |= Parse::TEXTMODE;
1600                 cur.message(_("Paste"));
1601                 cap::replaceSelection(cur);
1602                 docstring topaste;
1603                 if (cmd.argument().empty() && !theClipboard().isInternal())
1604                         topaste = theClipboard().getAsText(frontend::Clipboard::PlainTextType);
1605                 else {
1606                         idocstringstream is(cmd.argument());
1607                         int n = 0;
1608                         is >> n;
1609                         topaste = cap::selection(n, buffer().params().documentClassPtr());
1610                 }
1611                 InsetMathGrid grid(buffer_, 1, 1);
1612                 if (!topaste.empty())
1613                         if ((topaste.size() == 1 && isAscii(topaste))
1614                             || !mathed_parse_normal(grid, topaste, parseflg)) {
1615                                 resetGrid(grid);
1616                                 mathed_parse_normal(grid, topaste, parseflg | Parse::VERBATIM);
1617                         }
1618
1619                 bool hline_enabled = false;
1620                 FuncRequest fr = FuncRequest(LFUN_TABULAR_FEATURE, "add-hline-above");
1621                 FuncStatus status;
1622                 if (getStatus(cur, fr, status))
1623                         hline_enabled = status.enabled();
1624                 if (grid.nargs() == 1) {
1625                         // single cell/part of cell
1626                         cur.recordUndoInset();
1627                         cur.cell().insert(cur.pos(), grid.cell(0));
1628                         cur.pos() += grid.cell(0).size();
1629                         if (hline_enabled)
1630                                 rowinfo_[cur.row()].lines_ += grid.rowinfo_[0].lines_;
1631                         else {
1632                                 for (unsigned int l = 0; l < grid.rowinfo_[0].lines_; ++l) {
1633                                          cur.cell().insert(0,
1634                                                 MathAtom(new InsetMathUnknown(from_ascii("\\hline"))));
1635                                          cur.pos()++;
1636                                 }
1637                         }
1638                 } else {
1639                         // multiple cells
1640                         cur.recordUndoInset();
1641                         col_type const numcols =
1642                                 min(grid.ncols(), ncols() - col(cur.idx()));
1643                         row_type const numrows =
1644                                 min(grid.nrows(), nrows() - cur.row());
1645                         for (row_type r = 0; r < numrows; ++r) {
1646                                 for (col_type c = 0; c < numcols; ++c) {
1647                                         idx_type i = index(r + cur.row(), c + col(cur.idx()));
1648                                         cell(i).insert(0, grid.cell(grid.index(r, c)));
1649                                 }
1650                                 if (hline_enabled)
1651                                         rowinfo_[r].lines_ += grid.rowinfo_[r].lines_;
1652                                 else {
1653                                         for (unsigned int l = 0; l < grid.rowinfo_[r].lines_; ++l) {
1654                                                 idx_type i = index(r + cur.row(), 0);
1655                                                 cell(i).insert(0,
1656                                                         MathAtom(new InsetMathUnknown(from_ascii("\\hline"))));
1657                                         }
1658                                 }
1659                                 // append the left over horizontal cells to the last column
1660                                 idx_type i = index(r + cur.row(), ncols() - 1);
1661                                 for (InsetMath::col_type c = numcols; c < grid.ncols(); ++c)
1662                                         cell(i).append(grid.cell(grid.index(r, c)));
1663                         }
1664                         // append the left over vertical cells to the last _cell_
1665                         idx_type i = nargs() - 1;
1666                         for (row_type r = numrows; r < grid.nrows(); ++r) {
1667                                 for (col_type c = 0; c < grid.ncols(); ++c)
1668                                         cell(i).append(grid.cell(grid.index(r, c)));
1669                                 if (hline_enabled)
1670                                         rowinfo_[r].lines_ += grid.rowinfo_[r].lines_;
1671                                 else {
1672                                         for (unsigned int l = 0; l < grid.rowinfo_[r].lines_; ++l) {
1673                                                 cell(i).insert(0,
1674                                                         MathAtom(new InsetMathUnknown(from_ascii("\\hline"))));
1675                                         }
1676                                 }
1677                         }
1678                 }
1679                 cur.clearSelection(); // bug 393
1680                 // FIXME audit setBuffer calls
1681                 cur.inset().setBuffer(*buffer_);
1682                 cur.forceBufferUpdate();
1683                 cur.finishUndo();
1684                 break;
1685         }
1686
1687         case LFUN_LINE_BEGIN:
1688         case LFUN_WORD_BACKWARD:
1689         case LFUN_WORD_LEFT:
1690                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
1691                 // fall through
1692         case LFUN_LINE_BEGIN_SELECT:
1693         case LFUN_WORD_BACKWARD_SELECT:
1694         case LFUN_WORD_LEFT_SELECT:
1695                 cur.selHandle(act == LFUN_WORD_BACKWARD_SELECT ||
1696                                 act == LFUN_WORD_LEFT_SELECT ||
1697                                 act == LFUN_LINE_BEGIN_SELECT);
1698                 cur.macroModeClose();
1699                 if (cur.pos() != 0) {
1700                         cur.pos() = 0;
1701                 } else if (cur.idx() % cur.ncols() != 0) {
1702                         cur.idx() -= cur.idx() % cur.ncols();
1703                         cur.pos() = 0;
1704                 } else if (cur.idx() != 0) {
1705                         cur.idx() = 0;
1706                         cur.pos() = 0;
1707                 } else {
1708                         cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
1709                         cur.undispatched();
1710                 }
1711                 break;
1712
1713         case LFUN_WORD_FORWARD:
1714         case LFUN_WORD_RIGHT:
1715         case LFUN_LINE_END:
1716                 cur.screenUpdateFlags(Update::Decoration | Update::FitCursor);
1717                 // fall through
1718         case LFUN_WORD_FORWARD_SELECT:
1719         case LFUN_WORD_RIGHT_SELECT:
1720         case LFUN_LINE_END_SELECT:
1721                 cur.selHandle(act == LFUN_WORD_FORWARD_SELECT ||
1722                                 act == LFUN_WORD_RIGHT_SELECT ||
1723                                 act == LFUN_LINE_END_SELECT);
1724                 cur.macroModeClose();
1725                 cur.clearTargetX();
1726                 if (cur.pos() != cur.lastpos()) {
1727                         cur.pos() = cur.lastpos();
1728                 } else if ((cur.idx() + 1) % cur.ncols() != 0) {
1729                         cur.idx() += cur.ncols() - 1 - cur.idx() % cur.ncols();
1730                         cur.pos() = cur.lastpos();
1731                 } else if (cur.idx() != cur.lastidx()) {
1732                         cur.idx() = cur.lastidx();
1733                         cur.pos() = cur.lastpos();
1734                 } else {
1735                         cmd = FuncRequest(LFUN_FINISHED_FORWARD);
1736                         cur.undispatched();
1737                 }
1738                 break;
1739
1740         default:
1741                 InsetMathNest::doDispatch(cur, cmd);
1742         }
1743 }
1744
1745
1746 bool InsetMathGrid::getStatus(Cursor & cur, FuncRequest const & cmd,
1747                 FuncStatus & status) const
1748 {
1749         switch (cmd.action()) {
1750         case LFUN_TABULAR_FEATURE: {
1751                 string s = cmd.getArg(0);
1752                 if (&cur.inset() != this) {
1753                         // Table actions requires that the cursor is _inside_ the
1754                         // table.
1755                         status.setEnabled(false);
1756                         status.message(from_utf8(N_("Cursor not in table")));
1757                         return true;
1758                 }
1759                 if (nrows() <= 1 && (s == "delete-row" || s == "swap-row")) {
1760                         status.setEnabled(false);
1761                         status.message(from_utf8(N_("Only one row")));
1762                         return true;
1763                 }
1764                 if (ncols() <= 1 &&
1765                     (s == "delete-column" || s == "swap-column")) {
1766                         status.setEnabled(false);
1767                         status.message(from_utf8(N_("Only one column")));
1768                         return true;
1769                 }
1770                 if ((rowinfo_[cur.row()].lines_ == 0 &&
1771                      s == "delete-hline-above") ||
1772                     (rowinfo_[cur.row() + 1].lines_ == 0 &&
1773                      s == "delete-hline-below")) {
1774                         status.setEnabled(false);
1775                         status.message(from_utf8(N_("No hline to delete")));
1776                         return true;
1777                 }
1778
1779                 if ((colinfo_[cur.col()].lines_ == 0 &&
1780                      s == "delete-vline-left") ||
1781                     (colinfo_[cur.col() + 1].lines_ == 0 &&
1782                      s == "delete-vline-right")) {
1783                         status.setEnabled(false);
1784                         status.message(from_utf8(N_("No vline to delete")));
1785                         return true;
1786                 }
1787                 if (s == "valign-top" || s == "valign-middle" ||
1788                     s == "valign-bottom" || s == "align-left" ||
1789                     s == "align-right" || s == "align-center") {
1790                         status.setEnabled(true);
1791                         char const ha = horizontalAlignment(cur.col());
1792                         char const va = verticalAlignment();
1793                         status.setOnOff((s == "align-left" && ha == 'l')
1794                                         || (s == "align-right"   && ha == 'r')
1795                                         || (s == "align-center"  && ha == 'c')
1796                                         || (s == "valign-top"    && va == 't')
1797                                         || (s == "valign-bottom" && va == 'b')
1798                                         || (s == "valign-middle" && va == 'c'));
1799                         return true;
1800                 }
1801                 if (s == "append-row" || s == "delete-row" ||
1802                     s == "copy-row" || s == "swap-row" ||
1803                     s == "add-hline-above" || s == "add-hline-below" ||
1804                     s == "delete-hline-above" || s == "delete-hline-below" ||
1805                     s == "append-column" || s == "delete-column" ||
1806                     s == "copy-column" || s == "swap-column" ||
1807                     s == "add-vline-left" || s == "add-vline-right" ||
1808                     s == "delete-vline-left" || s == "delete-vline-right") {
1809                         status.setEnabled(true);
1810                 } else {
1811                         status.setEnabled(false);
1812                         status.message(bformat(
1813                             from_utf8(N_("Unknown tabular feature '%1$s'")),
1814                             from_utf8(s)));
1815                 }
1816
1817 #if 0
1818                 // FIXME: What did this code do?
1819                 // Please check whether it is still needed!
1820                 // should be more precise
1821                 if (v_align_ == '\0') {
1822                         status.enable(true);
1823                         break;
1824                 }
1825                 if (cmd.argument().empty()) {
1826                         status.enable(false);
1827                         break;
1828                 }
1829                 if (!contains("tcb", cmd.argument()[0])) {
1830                         status.enable(false);
1831                         break;
1832                 }
1833                 status.setOnOff(cmd.argument()[0] == v_align_);
1834                 status.setEnabled(true);
1835 #endif
1836                 return true;
1837         }
1838
1839         case LFUN_CELL_SPLIT:
1840                 status.setEnabled(cur.idx() != cur.lastidx());
1841                 return true;
1842
1843         case LFUN_CELL_BACKWARD:
1844         case LFUN_CELL_FORWARD:
1845                 status.setEnabled(true);
1846                 return true;
1847
1848         default:
1849                 break;
1850         }
1851         return InsetMathNest::getStatus(cur, cmd, status);
1852 }
1853
1854
1855 // static
1856 char InsetMathGrid::colAlign(HullType type, col_type col)
1857 {
1858         switch (type) {
1859         case hullEqnArray:
1860                 return "rcl"[col % 3];
1861
1862         case hullMultline:
1863         case hullGather:
1864                 return 'c';
1865
1866         case hullAlign:
1867         case hullAlignAt:
1868         case hullXAlignAt:
1869         case hullXXAlignAt:
1870         case hullFlAlign:
1871                 return "rl"[col & 1];
1872
1873         case hullUnknown:
1874         case hullNone:
1875         case hullSimple:
1876         case hullEquation:
1877         case hullRegexp:
1878                 return 'c';
1879         }
1880         // avoid warning
1881         return 'c';
1882 }
1883
1884
1885 //static
1886 int InsetMathGrid::colSpace(HullType type, col_type col)
1887 {
1888         int alignInterSpace = 0;
1889         switch (type) {
1890         case hullUnknown:
1891         case hullNone:
1892         case hullSimple:
1893         case hullEquation:
1894         case hullMultline:
1895         case hullGather:
1896         case hullRegexp:
1897                 return 0;
1898
1899         case hullEqnArray:
1900                 return 5;
1901
1902         case hullAlign:
1903                 alignInterSpace = 20;
1904                 break;
1905         case hullAlignAt:
1906                 alignInterSpace = 0;
1907                 break;
1908         case hullXAlignAt:
1909                 alignInterSpace = 40;
1910                 break;
1911         case hullXXAlignAt:
1912         case hullFlAlign:
1913                 alignInterSpace = 60;
1914                 break;
1915         }
1916         return (col % 2) ? alignInterSpace : 0;
1917 }
1918
1919
1920 } // namespace lyx