src/mathed/MathRow.cpp

   1 /**
   2  * \file MathRow.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jean-Marc Lasgouttes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "MathRow.h"
  14
  15 #include "MathData.h"
  16 #include "MathSupport.h"
  17
  18 #include "BufferView.h"
  19 #include "ColorSet.h"
  20 #include "CoordCache.h"
  21 #include "MetricsInfo.h"
  22
  23 #include "frontends/FontMetrics.h"
  24 #include "frontends/Painter.h"
  25
  26 #include "support/debug.h"
  27 #include "support/docstring.h"
  28 #include "support/lassert.h"
  29
  30 #include <algorithm>
  31 #include <ostream>
  32
  33 using namespace std;
  34
  35 namespace lyx {
  36
  37
  38 MathRow::Element::Element(MetricsInfo const & mi, Type t, MathClass mc)
  39         : type(t), mclass(mc), before(0), after(0), macro_nesting(mi.base.macro_nesting),
  40           marker(InsetMath::NO_MARKER), inset(nullptr), compl_unique_to(0), ar(nullptr),
  41           color(Color_red)
  42 {}
  43
  44
  45 namespace {
  46
  47 // Helper functions for markers
  48
  49 int markerMargin(MathRow::Element const & e)
  50 {
  51         switch(e.marker) {
  52         case InsetMath::MARKER:
  53         case InsetMath::MARKER2:
  54         case InsetMath::BOX_MARKER:
  55                 return 2;
  56         case InsetMath::NO_MARKER:
  57                 return 0;
  58         }
  59         // should not happen
  60         return 0;
  61 }
  62
  63
  64 void afterMetricsMarkers(MetricsInfo const & , MathRow::Element & e,
  65                             Dimension & dim)
  66 {
  67         // handle vertical space for markers
  68         switch(e.marker) {
  69         case InsetMath::NO_MARKER:
  70                 break;
  71         case InsetMath::MARKER:
  72                 ++dim.des;
  73                 break;
  74         case InsetMath::MARKER2:
  75                 ++dim.asc;
  76                 ++dim.des;
  77                 break;
  78         case InsetMath::BOX_MARKER:
  79                 FontInfo font;
  80                 font.setSize(TINY_SIZE);
  81                 Dimension namedim;
  82                 mathed_string_dim(font, e.inset->name(), namedim);
  83                 int const namewid = 1 + namedim.wid + 1;
  84
  85                 if (namewid > dim.wid)
  86                         e.after += namewid - dim.wid;
  87                 ++dim.asc;
  88                 dim.des += 3 + namedim.height();
  89         }
  90 }
  91
  92
  93 void drawMarkers(PainterInfo const & pi, MathRow::Element const & e,
  94                  int const x, int const y)
  95 {
  96         if (e.marker == InsetMath::NO_MARKER)
  97                 return;
  98
  99         CoordCache const & coords = pi.base.bv->coordCache();
 100         Dimension const dim = coords.getInsets().dim(e.inset);
 101
 102         // the marker is before/after the inset. Necessary space has been reserved already.
 103         int const l = x + e.before - (markerMargin(e) > 0 ? 1 : 0);
 104         int const r = x + dim.width() - e.after;
 105
 106         // Grey lower box
 107         if (e.marker == InsetMath::BOX_MARKER) {
 108                 // draw header and rectangle around
 109                 FontInfo font;
 110                 font.setSize(TINY_SIZE);
 111                 font.setColor(Color_mathmacrolabel);
 112                 Dimension namedim;
 113                 mathed_string_dim(font, e.inset->name(), namedim);
 114                 pi.pain.fillRectangle(l, y + dim.des - namedim.height() - 2,
 115                                       dim.wid, namedim.height() + 2, Color_mathmacrobg);
 116                 pi.pain.text(l, y + dim.des - namedim.des - 1, e.inset->name(), font);
 117         }
 118
 119         // Color for corners
 120         bool const highlight = e.inset->mouseHovered(pi.base.bv)
 121                                || e.inset->editing(pi.base.bv);
 122         ColorCode const pen_color = highlight ? Color_mathframe : Color_mathcorners;
 123         // If the corners have the same color as the background, do not paint them.
 124         if (lcolor.getX11HexName(Color_mathbg) == lcolor.getX11HexName(pen_color))
 125                 return;
 126
 127         // Lower corners in all cases
 128         int const d = y + dim.descent();
 129         pi.pain.line(l, d - 3, l, d, pen_color);
 130         pi.pain.line(r, d - 3, r, d, pen_color);
 131         pi.pain.line(l, d, l + 3, d, pen_color);
 132         pi.pain.line(r - 3, d, r, d, pen_color);
 133
 134         // Upper corners
 135         if (e.marker == InsetMath::BOX_MARKER
 136             || e.marker == InsetMath::MARKER2) {
 137                 int const a = y - dim.ascent();
 138                 pi.pain.line(l, a + 3, l, a, pen_color);
 139                 pi.pain.line(r, a + 3, r, a, pen_color);
 140                 pi.pain.line(l, a, l + 3, a, pen_color);
 141                 pi.pain.line(r - 3, a, r, a, pen_color);
 142         }
 143 }
 144
 145 } // namespace
 146
 147
 148 MathRow::MathRow(MetricsInfo & mi, MathData const * ar)
 149 {
 150         // First there is a dummy element of type "open"
 151         push_back(Element(mi, DUMMY, MC_OPEN));
 152
 153         // Then insert the MathData argument
 154         bool const has_contents = ar->addToMathRow(*this, mi);
 155
 156         // A MathRow should not be completely empty
 157         if (!has_contents) {
 158                 Element e(mi, BOX, MC_ORD);
 159                 // empty arrays are visible when they are editable
 160                 e.color = mi.base.macro_nesting == 0 ? Color_mathline : Color_none;
 161                 push_back(e);
 162         }
 163
 164         // Finally there is a dummy element of type "close"
 165         push_back(Element(mi, DUMMY, MC_CLOSE));
 166
 167         /* Do spacing only in math mode. This test is a bit clumsy,
 168          * but it is used in other places for guessing the current mode.
 169          */
 170         bool const dospacing = isMathFont(mi.base.fontname);
 171
 172         // update classes
 173         if (dospacing) {
 174                 for (int i = 1 ; i != static_cast<int>(elements_.size()) - 1 ; ++i) {
 175                         if (elements_[i].mclass != MC_UNKNOWN)
 176                                 update_class(elements_[i].mclass, elements_[before(i)].mclass,
 177                                                          elements_[after(i)].mclass);
 178                 }
 179         }
 180
 181         // set spacing
 182         // We go to the end to handle spacing at the end of equation
 183         for (int i = 1 ; i != static_cast<int>(elements_.size()) ; ++i) {
 184                 Element & e = elements_[i];
 185
 186                 Element & bef = elements_[before(i)];
 187                 if (dospacing && e.mclass != MC_UNKNOWN) {
 188                         int spc = class_spacing(bef.mclass, e.mclass, mi.base);
 189                         bef.after += spc / 2;
 190                         // this is better than spc / 2 to avoid rounding problems
 191                         e.before += spc - spc / 2;
 192                 }
 193
 194                 // finally reserve space for markers
 195                 bef.after = max(bef.after, markerMargin(bef));
 196                 if (e.mclass != MC_UNKNOWN)
 197                         e.before = max(e.before, markerMargin(e));
 198                 // for linearized insets (macros...) too
 199                 if (e.type == BEGIN)
 200                         bef.after = max(bef.after, markerMargin(e));
 201                 if (e.type == END && e.marker != InsetMath::NO_MARKER) {
 202                         Element & aft = elements_[after(i)];
 203                         aft.before = max(aft.before, markerMargin(e));
 204                 }
 205         }
 206
 207         // Do not lose spacing allocated to extremities
 208         if (!elements_.empty()) {
 209                 elements_[after(0)].before += elements_.front().after;
 210                 elements_[before(elements_.size() - 1)].after += elements_.back().before;
 211         }
 212 }
 213
 214
 215 int MathRow::before(int i) const
 216 {
 217         do
 218                 --i;
 219         while (elements_[i].mclass == MC_UNKNOWN);
 220
 221         return i;
 222 }
 223
 224
 225 int MathRow::after(int i) const
 226 {
 227         do
 228                 ++i;
 229         while (elements_[i].mclass == MC_UNKNOWN);
 230
 231         return i;
 232 }
 233
 234
 235 void MathRow::metrics(MetricsInfo & mi, Dimension & dim)
 236 {
 237         dim.wid = 0;
 238         // In order to compute the dimension of macros and their
 239         // arguments, it is necessary to keep track of them.
 240         vector<pair<InsetMath const *, Dimension>> dim_insets;
 241         vector<pair<MathData const *, Dimension>> dim_arrays;
 242         CoordCache & coords = mi.base.bv->coordCache();
 243         for (Element & e : elements_) {
 244                 mi.base.macro_nesting = e.macro_nesting;
 245                 Dimension d;
 246                 switch (e.type) {
 247                 case DUMMY:
 248                         break;
 249                 case INSET:
 250                         e.inset->metrics(mi, d);
 251                         d.wid += e.before + e.after;
 252                         coords.insets().add(e.inset, d);
 253                         break;
 254                 case BEGIN:
 255                         if (e.inset) {
 256                                 dim_insets.push_back(make_pair(e.inset, Dimension()));
 257                                 dim_insets.back().second.wid += e.before + e.after;
 258                                 d.wid = e.before + e.after;
 259                                 e.inset->beforeMetrics();
 260                         }
 261                         if (e.ar)
 262                                 dim_arrays.push_back(make_pair(e.ar, Dimension()));
 263                         break;
 264                 case END:
 265                         if (e.inset) {
 266                                 e.inset->afterMetrics();
 267                                 LATTEST(dim_insets.back().first == e.inset);
 268                                 d = dim_insets.back().second;
 269                                 afterMetricsMarkers(mi, e, d);
 270                                 d.wid += e.before + e.after;
 271                                 coords.insets().add(e.inset, d);
 272                                 dim_insets.pop_back();
 273                                 // We do not want to count the width again, but the
 274                                 // padding and the vertical dimension are meaningful.
 275                                 d.wid = e.before + e.after;
 276                         }
 277                         if (e.ar) {
 278                                 LATTEST(dim_arrays.back().first == e.ar);
 279                                 coords.arrays().add(e.ar, dim_arrays.back().second);
 280                                 dim_arrays.pop_back();
 281                         }
 282                         break;
 283                 case BOX:
 284                         d = theFontMetrics(mi.base.font).dimension('I');
 285                         if (e.color != Color_none) {
 286                                 // allow for one pixel before/after the box.
 287                                 d.wid += e.before + e.after + 2;
 288                         } else {
 289                                 // hide the box, but keep its height
 290                                 d.wid = 0;
 291                         }
 292                         break;
 293                 }
 294
 295                 if (!d.empty()) {
 296                         dim += d;
 297                         // Now add the dimension to current macros and arguments.
 298                         for (auto & dim_macro : dim_insets)
 299                                 dim_macro.second += d;
 300                         for (auto & dim_array : dim_arrays)
 301                                 dim_array.second += d;
 302                 }
 303
 304                 if (e.compl_text.empty())
 305                         continue;
 306                 FontInfo font = mi.base.font;
 307                 augmentFont(font, "mathnormal");
 308                 dim.wid += mathed_string_width(font, e.compl_text);
 309         }
 310         LATTEST(dim_insets.empty() && dim_arrays.empty());
 311 }
 312
 313
 314 void MathRow::draw(PainterInfo & pi, int x, int const y) const
 315 {
 316         CoordCache & coords = pi.base.bv->coordCache();
 317         for (Element const & e : elements_) {
 318                 switch (e.type) {
 319                 case INSET: {
 320                         // This is hackish: the math inset does not know that space
 321                         // has been added before and after it; we alter its dimension
 322                         // while it is drawing, because it relies on this value.
 323                         Dimension const d = coords.insets().dim(e.inset);
 324                         Dimension d2 = d;
 325                         d2.wid -= e.before + e.after;
 326                         coords.insets().add(e.inset, d2);
 327                         if (pi.pain.develMode() && !e.inset->isBufferValid())
 328                                 pi.pain.fillRectangle(x + e.before, y - d2.ascent(),
 329                                                       d2.width(), d2.height(), Color_error);
 330                         e.inset->draw(pi, x + e.before, y);
 331                         coords.insets().add(e.inset, x, y);
 332                         coords.insets().add(e.inset, d);
 333                         drawMarkers(pi, e, x, y);
 334                         x += d.wid;
 335                         break;
 336                 }
 337                 case BEGIN:
 338                         if (e.ar) {
 339                                 coords.arrays().add(e.ar, x, y);
 340                                 e.ar->drawSelection(pi, x, y);
 341                         }
 342                         if (e.inset) {
 343                                 coords.insets().add(e.inset, x, y);
 344                                 drawMarkers(pi, e, x, y);
 345                                 e.inset->beforeDraw(pi);
 346                         }
 347                         x += e.before + e.after;
 348                         break;
 349                 case END:
 350                         if (e.inset)
 351                                 e.inset->afterDraw(pi);
 352                         x += e.before + e.after;
 353                         break;
 354                 case BOX: {
 355                         if (e.color == Color_none)
 356                                 break;
 357                         Dimension const d = theFontMetrics(pi.base.font).dimension('I');
 358                         pi.pain.rectangle(x + e.before + 1, y - d.ascent(),
 359                                           d.width() - 1, d.height() - 1, e.color);
 360                         x += d.wid + 2 + e.before + e.after;
 361                         break;
 362                 }
 363                 case DUMMY:
 364                         break;
 365                 }
 366
 367                 if (e.compl_text.empty())
 368                         continue;
 369                 FontInfo f = pi.base.font;
 370                 augmentFont(f, "mathnormal");
 371
 372                 // draw the unique and the non-unique completion part
 373                 // Note: this is not time-critical as it is
 374                 // only done once per screen.
 375                 docstring const s1 = e.compl_text.substr(0, e.compl_unique_to);
 376                 docstring const s2 = e.compl_text.substr(e.compl_unique_to);
 377
 378                 if (!s1.empty()) {
 379                         f.setColor(Color_inlinecompletion);
 380                         // offset the text by e.after to make sure that the
 381                         // spacing is after the completion, not before.
 382                         pi.pain.text(x - e.after, y, s1, f);
 383                         x += mathed_string_width(f, s1);
 384                 }
 385                 if (!s2.empty()) {
 386                         f.setColor(Color_nonunique_inlinecompletion);
 387                         pi.pain.text(x - e.after, y, s2, f);
 388                         x += mathed_string_width(f, s2);
 389                 }
 390         }
 391 }
 392
 393
 394 int MathRow::kerning(BufferView const * bv) const
 395 {
 396         if (elements_.empty())
 397                 return 0;
 398         InsetMath const * inset = elements_[before(elements_.size() - 1)].inset;
 399         return inset ? inset->kerning(bv) : 0;
 400 }
 401
 402
 403 ostream & operator<<(ostream & os, MathRow::Element const & e)
 404 {
 405         switch (e.type) {
 406         case MathRow::DUMMY:
 407                 os << (e.mclass == MC_OPEN ? "{" : "}");
 408                 break;
 409         case MathRow::INSET:
 410                 os << "<" << e.before << "-"
 411                    << to_utf8(class_to_string(e.mclass))
 412                    << "-" << e.after << ">";
 413                 break;
 414         case MathRow::BEGIN:
 415                 if (e.inset)
 416                         os << "\\" << to_utf8(e.inset->name())
 417                            << "^" << e.macro_nesting << "[";
 418                 if (e.ar)
 419                         os << "(";
 420                 break;
 421         case MathRow::END:
 422                 if (e.ar)
 423                         os << ")";
 424                 if (e.inset)
 425                         os << "]";
 426                 break;
 427         case MathRow::BOX:
 428                 os << "<" << e.before << "-[]-" << e.after << ">";
 429                 break;
 430         }
 431         return os;
 432 }
 433
 434
 435 ostream & operator<<(ostream & os, MathRow const & mrow)
 436 {
 437         for (MathRow::Element const & e : mrow)
 438                 os << e << "  ";
 439         return os;
 440 }
 441
 442 } // namespace lyx