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