src/mathed/InsetMathSplit.cpp

   1 /**
   2  * \file InsetMathSplit.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
  13 #include "InsetMathSplit.h"
  14
  15 #include "MathData.h"
  16 #include "MathStream.h"
  17 #include "MathStream.h"
  18
  19 #include "FuncRequest.h"
  20 #include "FuncStatus.h"
  21 #include "support/gettext.h"
  22 #include "LaTeXFeatures.h"
  23
  24 #include "support/lstrings.h"
  25
  26 #include <ostream>
  27
  28 using namespace std;
  29
  30 namespace lyx {
  31
  32 using support::bformat;
  33
  34
  35 // FIXME: handle numbers in gui, currently they are only read and written
  36
  37 InsetMathSplit::InsetMathSplit(Buffer * buf, docstring const & name,
  38         char valign, bool numbered)
  39         : InsetMathGrid(buf, 1, 1, valign, docstring()), name_(name),
  40           numbered_(numbered)
  41 {
  42 }
  43
  44
  45 Inset * InsetMathSplit::clone() const
  46 {
  47         return new InsetMathSplit(*this);
  48 }
  49
  50
  51 // FIXME: InsetMathGrid should be changed to let the real column alignment be
  52 // given by a virtual method like displayColAlign, because the values produced
  53 // by defaultColAlign can be invalidated by lfuns such as add-column. I suspect
  54 // that for the moment the values produced by defaultColAlign are not used,
  55 // notably because alignment is not implemented in the LyXHTML output.
  56 char InsetMathSplit::defaultColAlign(col_type col)
  57 {
  58         if (name_ == "gathered")
  59                 return 'c';
  60         if (name_ == "lgathered")
  61                 return 'l';
  62         if (name_ == "rgathered")
  63                 return 'r';
  64         if (name_ == "split"
  65             || name_ == "aligned"
  66             || name_ == "align"
  67             || name_ == "alignedat")
  68                 return colAlign(hullAlign, col);
  69         return 'l';
  70 }
  71
  72
  73 char InsetMathSplit::displayColAlign(idx_type idx) const
  74 {
  75         if (name_ == "gathered")
  76                 return 'c';
  77         if (name_ == "lgathered")
  78                 return 'l';
  79         if (name_ == "rgathered")
  80                 return 'r';
  81         if (name_ == "split"
  82             || name_ == "aligned"
  83             || name_ == "align"
  84             || name_ == "alignedat")
  85                 return colAlign(hullAlign, col(idx));
  86         return InsetMathGrid::displayColAlign(idx);
  87 }
  88
  89
  90 int InsetMathSplit::displayColSpace(col_type col) const
  91 {
  92         if (name_ == "split" || name_ == "aligned" || name_ == "align")
  93                 return colSpace(hullAlign, col);
  94         if (name_ == "alignedat")
  95                 return colSpace(hullAlignAt, col);
  96         return 0;
  97 }
  98
  99
 100
 101 void InsetMathSplit::draw(PainterInfo & pi, int x, int y) const
 102 {
 103         InsetMathGrid::draw(pi, x, y);
 104         setPosCache(pi, x, y);
 105 }
 106
 107
 108 bool InsetMathSplit::getStatus(Cursor & cur, FuncRequest const & cmd,
 109                 FuncStatus & flag) const
 110 {
 111         switch (cmd.action()) {
 112         case LFUN_TABULAR_FEATURE: {
 113                 string s = cmd.getArg(0);
 114                 if (s == "add-vline-left" || s == "add-vline-right") {
 115                         flag.message(bformat(
 116                                 from_utf8(N_("Can't add vertical grid lines in '%1$s'")),
 117                                 name_));
 118                         flag.setEnabled(false);
 119                         return true;
 120                 }
 121                 if (s == "align-left" || s == "align-center" || s == "align-right") {
 122                         flag.setEnabled(false);
 123                         return true;
 124                 }
 125                 break;
 126         }
 127         default:
 128                 break;
 129         }
 130         return InsetMathGrid::getStatus(cur, cmd, flag);
 131 }
 132
 133
 134 void InsetMathSplit::write(WriteStream & ws) const
 135 {
 136         MathEnsurer ensurer(ws);
 137         if (ws.fragile())
 138                 ws << "\\protect";
 139         docstring suffix;
 140         if (!numbered_ && name_ == "align")
 141                 suffix = from_ascii("*");
 142         ws << "\\begin{" << name_ << suffix << '}';
 143         bool open = ws.startOuterRow();
 144         if (name_ != "split" && name_ != "align" && verticalAlignment() != 'c')
 145                 ws << '[' << verticalAlignment() << ']';
 146         if (name_ == "alignedat")
 147                 ws << '{' << static_cast<unsigned int>((ncols() + 1)/2) << '}';
 148         InsetMathGrid::write(ws);
 149         if (ws.fragile())
 150                 ws << "\\protect";
 151         ws << "\\end{" << name_ << suffix << "}\n";
 152         if (open)
 153                 ws.startOuterRow();
 154 }
 155
 156
 157 void InsetMathSplit::infoize(odocstream & os) const
 158 {
 159         docstring name = name_;
 160         name[0] = support::uppercase(name[0]);
 161         if (name_ == "align" && !numbered_)
 162                 os << name << "* ";
 163         else
 164                 os << name << ' ';
 165 }
 166
 167
 168 void InsetMathSplit::mathmlize(MathStream & ms) const
 169 {
 170         // split, gathered, aligned, alignedat
 171         // At the moment, those seem to display just fine without any
 172         // special treatment.
 173         // FIXME
 174         // lgathered and rgathered could use the proper alignment, but
 175         // it's not clear how to do that without copying a lot of code.
 176         // One idea would be to wrap the table in an <mrow>, and set the
 177         // alignment there via CSS.
 178         // FIXME how to handle numbered and unnumbered align?
 179         InsetMathGrid::mathmlize(ms);
 180 }
 181
 182
 183 void InsetMathSplit::htmlize(HtmlStream & ms) const
 184 {
 185         // split, gathered, aligned, alignedat
 186         // At the moment, those seem to display just fine without any
 187         // special treatment.
 188         // FIXME
 189         // lgathered and rgathered could use the proper alignment.
 190         // FIXME how to handle numbered and unnumbered align?
 191         InsetMathGrid::htmlize(ms);
 192 }
 193
 194
 195 void InsetMathSplit::validate(LaTeXFeatures & features) const
 196 {
 197         if (name_ == "split" || name_ == "gathered" || name_ == "aligned" ||
 198             name_ == "alignedat" || name_ == "align")
 199                 features.require("amsmath");
 200         else if (name_ == "lgathered" || name_ == "rgathered")
 201                 features.require("mathtools");
 202         InsetMathGrid::validate(features);
 203 }
 204
 205
 206 } // namespace lyx