src/insets/InsetNewline.cpp

   1 /**
   2  * \file InsetNewline.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetNewline.h"
  15
  16 #include "Dimension.h"
  17 #include "FuncRequest.h"
  18 #include "FuncStatus.h"
  19 #include "Lexer.h"
  20 #include "MetricsInfo.h"
  21 #include "OutputParams.h"
  22
  23 #include "frontends/Application.h"
  24 #include "frontends/FontMetrics.h"
  25 #include "frontends/Painter.h"
  26
  27 #include "support/debug.h"
  28 #include "support/docstream.h"
  29 #include "support/docstring.h"
  30
  31 using namespace std;
  32
  33 namespace lyx {
  34
  35 InsetNewline::InsetNewline()
  36 {}
  37
  38
  39 void InsetNewlineParams::write(ostream & os) const
  40 {
  41         string command;
  42         switch (kind) {
  43         case InsetNewlineParams::NEWLINE:
  44                 os << "newline";
  45                 break;
  46         case InsetNewlineParams::LINEBREAK:
  47                 os <<  "linebreak";
  48                 break;
  49         }
  50 }
  51
  52
  53 void InsetNewlineParams::read(Lexer & lex)
  54 {
  55         string token;
  56         lex.setContext("InsetNewlineParams::read");
  57         lex >> token;
  58         if (token == "newline")
  59                 kind = InsetNewlineParams::NEWLINE;
  60         else if (token == "linebreak")
  61                 kind = InsetNewlineParams::LINEBREAK;
  62         else
  63                 lex.printError("Unknown kind: `$$Token'");
  64         lex >> "\\end_inset";
  65 }
  66
  67
  68 void InsetNewline::write(ostream & os) const
  69 {
  70         os << "Newline ";
  71         params_.write(os);
  72 }
  73
  74
  75 void InsetNewline::read(Lexer & lex)
  76 {
  77         params_.read(lex);
  78 }
  79
  80
  81 void InsetNewline::metrics(MetricsInfo & mi, Dimension & dim) const
  82 {
  83         frontend::FontMetrics const & fm = theFontMetrics(mi.base.font);
  84         dim.asc = fm.maxAscent();
  85         dim.des = fm.maxDescent();
  86         dim.wid = fm.width('n');
  87 }
  88
  89
  90 void InsetNewline::doDispatch(Cursor & cur, FuncRequest & cmd)
  91 {
  92         switch (cmd.action) {
  93
  94         case LFUN_INSET_MODIFY: {
  95                 InsetNewlineParams params;
  96                 string2params(to_utf8(cmd.argument()), params);
  97                 params_.kind = params.kind;
  98                 break;
  99         }
 100
 101         default:
 102                 Inset::doDispatch(cur, cmd);
 103                 break;
 104         }
 105 }
 106
 107
 108 bool InsetNewline::getStatus(Cursor & cur, FuncRequest const & cmd,
 109         FuncStatus & status) const
 110 {
 111         switch (cmd.action) {
 112         // we handle these
 113         case LFUN_INSET_MODIFY:
 114                 if (cmd.getArg(0) == "newline") {
 115                         InsetNewlineParams params;
 116                         string2params(to_utf8(cmd.argument()), params);
 117                         status.setOnOff(params_.kind == params.kind);
 118                 }
 119                 status.setEnabled(true);
 120                 return true;
 121         default:
 122                 return Inset::getStatus(cur, cmd, status);
 123         }
 124 }
 125
 126
 127 ColorCode InsetNewline::ColorName() const
 128 {
 129         switch (params_.kind) {
 130                 case InsetNewlineParams::NEWLINE:
 131                         return Color_eolmarker;
 132                         break;
 133                 case InsetNewlineParams::LINEBREAK:
 134                         return Color_pagebreak;
 135                         break;
 136         }
 137         // not really useful, but to avoids gcc complaints
 138         return Color_eolmarker;
 139 }
 140
 141
 142 int InsetNewline::latex(odocstream & os, OutputParams const & rp) const
 143 {
 144         switch (params_.kind) {
 145                 case InsetNewlineParams::NEWLINE:
 146                         if (rp.inTableCell == OutputParams::PLAIN)
 147                                 os << "\\newline\n";
 148                         else
 149                                 os << "\\\\\n";
 150                         break;
 151                 case InsetNewlineParams::LINEBREAK:
 152                         os << "\\linebreak{}\n";
 153                         break;
 154                 default:
 155                         os << "\\\\\n";
 156                         break;
 157         }
 158         return 0;
 159 }
 160
 161
 162 int InsetNewline::plaintext(odocstream & os, OutputParams const &) const
 163 {
 164         os << '\n';
 165         return PLAINTEXT_NEWLINE;
 166 }
 167
 168
 169 int InsetNewline::docbook(odocstream & os, OutputParams const &) const
 170 {
 171         os << '\n';
 172         return 0;
 173 }
 174
 175
 176 void InsetNewline::draw(PainterInfo & pi, int x, int y) const
 177 {
 178         FontInfo font;
 179         font.setColor(ColorName());
 180
 181         frontend::FontMetrics const & fm = theFontMetrics(pi.base.font);
 182         int const wid = fm.width('n');
 183         int const asc = fm.maxAscent();
 184
 185         int xp[3];
 186         int yp[3];
 187
 188         yp[0] = int(y - 0.875 * asc * 0.75);
 189         yp[1] = int(y - 0.500 * asc * 0.75);
 190         yp[2] = int(y - 0.125 * asc * 0.75);
 191
 192         if (pi.ltr_pos) {
 193                 xp[0] = int(x + wid * 0.375);
 194                 xp[1] = int(x);
 195                 xp[2] = int(x + wid * 0.375);
 196         } else {
 197                 xp[0] = int(x + wid * 0.625);
 198                 xp[1] = int(x + wid);
 199                 xp[2] = int(x + wid * 0.625);
 200         }
 201
 202         pi.pain.lines(xp, yp, 3, ColorName());
 203
 204         yp[0] = int(y - 0.500 * asc * 0.75);
 205         yp[1] = int(y - 0.500 * asc * 0.75);
 206         yp[2] = int(y - asc * 0.75);
 207
 208         if (pi.ltr_pos) {
 209                 xp[0] = int(x);
 210                 xp[1] = int(x + wid);
 211                 xp[2] = int(x + wid);
 212         } else {
 213                 xp[0] = int(x + wid);
 214                 xp[1] = int(x);
 215                 xp[2] = int(x);
 216         }
 217
 218         pi.pain.lines(xp, yp, 3, ColorName());
 219
 220         if (params_.kind == InsetNewlineParams::LINEBREAK) {
 221
 222                 yp[2] = int(y - 0.500 * asc * 0.75);
 223
 224                 if (pi.ltr_pos) {
 225                         xp[0] = int(x + 1.3 * wid);
 226                         xp[1] = int(x + 2 * wid);
 227                         xp[2] = int(x + 2 * wid);
 228                 } else {
 229                         xp[0] = int(x - 0.3 * wid);
 230                         xp[1] = int(x - wid);
 231                         xp[2] = int(x - wid);
 232                 }
 233                 pi.pain.lines(xp, yp, 3, ColorName());
 234
 235                 yp[0] = int(y - 0.875 * asc * 0.75);
 236                 yp[1] = int(y - 0.500 * asc * 0.75);
 237                 yp[2] = int(y - 0.125 * asc * 0.75);
 238
 239                 if (pi.ltr_pos) {
 240                         xp[0] = int(x + 2 * wid * 0.813);
 241                         xp[1] = int(x + 2 * wid);
 242                         xp[2] = int(x + 2 * wid * 0.813);
 243                 } else {
 244                         xp[0] = int(x - wid * 0.625);
 245                         xp[1] = int(x - wid);
 246                         xp[2] = int(x - wid * 0.625);
 247                 }
 248                 pi.pain.lines(xp, yp, 3, ColorName());
 249         }
 250 }
 251
 252
 253 docstring InsetNewline::contextMenu(BufferView const &, int, int) const
 254 {
 255         return from_ascii("context-newline");
 256 }
 257
 258
 259 void InsetNewline::string2params(string const & in, InsetNewlineParams & params)
 260 {
 261         params = InsetNewlineParams();
 262         if (in.empty())
 263                 return;
 264         istringstream data(in);
 265         Lexer lex;
 266         lex.setStream(data);
 267         lex.setContext("InsetNewline::string2params");
 268         lex >> "newline";
 269         params.read(lex);
 270 }
 271
 272
 273 string InsetNewline::params2string(InsetNewlineParams const & params)
 274 {
 275         ostringstream data;
 276         data << "newline" << ' ';
 277         params.write(data);
 278         return data.str();
 279 }
 280
 281
 282 } // namespace lyx