src/insets/InsetCharStyle.cpp

   1 /**
   2  * \file InsetCharStyle.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Martin Vermeer
   8  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "InsetCharStyle.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "BufferView.h"
  20 #include "DispatchResult.h"
  21 #include "FuncRequest.h"
  22 #include "FuncStatus.h"
  23 #include "Cursor.h"
  24 #include "gettext.h"
  25 #include "LaTeXFeatures.h"
  26 #include "Color.h"
  27 #include "Lexer.h"
  28 #include "Text.h"
  29 #include "MetricsInfo.h"
  30 #include "Paragraph.h"
  31 #include "paragraph_funcs.h"
  32 #include "sgml.h"
  33
  34 #include "frontends/FontMetrics.h"
  35 #include "frontends/Painter.h"
  36
  37 #include "support/convert.h"
  38
  39 #include <sstream>
  40
  41
  42 namespace lyx {
  43
  44 using std::string;
  45 using std::auto_ptr;
  46 using std::istringstream;
  47 using std::max;
  48 using std::ostream;
  49 using std::ostringstream;
  50
  51
  52 void InsetCharStyle::init()
  53 {
  54         setInlined();
  55         setDrawFrame(false);
  56 }
  57
  58
  59 InsetCharStyle::InsetCharStyle(BufferParams const & bp, string const s)
  60         : InsetCollapsable(bp)
  61 {
  62         params_.type = s;
  63         setUndefined();
  64         init();
  65 }
  66
  67
  68 InsetCharStyle::InsetCharStyle(BufferParams const & bp,
  69                                 CharStyles::iterator cs)
  70         : InsetCollapsable(bp)
  71 {
  72         params_.type = cs->name;
  73         setDefined(cs);
  74         init();
  75 }
  76
  77
  78 InsetCharStyle::InsetCharStyle(InsetCharStyle const & in)
  79         : InsetCollapsable(in), params_(in.params_)
  80 {
  81         init();
  82 }
  83
  84
  85 auto_ptr<Inset> InsetCharStyle::doClone() const
  86 {
  87         return auto_ptr<Inset>(new InsetCharStyle(*this));
  88 }
  89
  90
  91 bool InsetCharStyle::undefined() const
  92 {
  93         return params_.latexname.empty();
  94 }
  95
  96
  97 void InsetCharStyle::setUndefined()
  98 {
  99         params_.latextype.clear();
 100         params_.latexname.clear();
 101         params_.latexparam.clear();
 102         params_.font = Font(Font::ALL_INHERIT);
 103         params_.labelfont = Font(Font::ALL_INHERIT);
 104         params_.labelfont.setColor(Color::error);
 105         params_.show_label = true;
 106 }
 107
 108
 109 void InsetCharStyle::setDefined(CharStyles::iterator cs)
 110 {
 111         params_.latextype = cs->latextype;
 112         params_.latexname = cs->latexname;
 113         params_.latexparam = cs->latexparam;
 114         params_.font = cs->font;
 115         params_.labelfont = cs->labelfont;
 116         params_.show_label = true;
 117 }
 118
 119
 120 docstring const InsetCharStyle::editMessage() const
 121 {
 122         return _("Opened CharStyle Inset");
 123 }
 124
 125
 126 void InsetCharStyle::write(Buffer const & buf, ostream & os) const
 127 {
 128         params_.write(os);
 129         InsetCollapsable::write(buf, os);
 130 }
 131
 132
 133 void InsetCharStyle::read(Buffer const & buf, Lexer & lex)
 134 {
 135         params_.read(lex);
 136         InsetCollapsable::read(buf, lex);
 137         setInlined();
 138 }
 139
 140
 141 bool InsetCharStyle::metrics(MetricsInfo & mi, Dimension & dim) const
 142 {
 143         Font tmpfont = mi.base.font;
 144         getDrawFont(mi.base.font);
 145         mi.base.font.reduce(Font(Font::ALL_SANE));
 146         mi.base.font.realize(tmpfont);
 147         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 148         InsetText::metrics(mi, dim);
 149         mi.base.font = tmpfont;
 150         if (params_.show_label) {
 151                 // consider width of the inset label
 152                 Font font(params_.labelfont);
 153                 font.realize(Font(Font::ALL_SANE));
 154                 font.decSize();
 155                 font.decSize();
 156                 int w = 0;
 157                 int a = 0;
 158                 int d = 0;
 159                 // FIXME UNICODE
 160                 docstring s(from_utf8(params_.type));
 161                 if (undefined())
 162                         s = _("Undef: ") + s;
 163                 theFontMetrics(font).rectText(s, w, a, d);
 164                 dim.wid = max(dim.wid, w);
 165         }
 166         dim.asc += TEXT_TO_INSET_OFFSET;
 167         dim.des += TEXT_TO_INSET_OFFSET;
 168         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 169         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 170         if (params_.show_label)
 171                 dim.des += ascent();
 172         bool const changed = dim_ != dim;
 173         dim_ = dim;
 174         return changed;
 175 }
 176
 177
 178 void InsetCharStyle::draw(PainterInfo & pi, int x, int y) const
 179 {
 180         setPosCache(pi, x, y);
 181
 182         Font tmpfont = pi.base.font;
 183         getDrawFont(pi.base.font);
 184         // I don't understand why the above .reduce and .realize aren't
 185         //needed, or even wanted, here. It just works. -- MV 10.04.2005
 186         InsetText::draw(pi, x + TEXT_TO_INSET_OFFSET, y);
 187         pi.base.font = tmpfont;
 188
 189         int desc = InsetText::descent();
 190         if (params_.show_label)
 191                 desc -= ascent();
 192
 193         pi.pain.line(x, y + desc - 4, x, y + desc, params_.labelfont.color());
 194         pi.pain.line(x, y + desc, x + dim_.wid - 3, y + desc,
 195                 params_.labelfont.color());
 196         pi.pain.line(x + dim_.wid - 3, y + desc, x + dim_.wid - 3, y + desc - 4,
 197                 params_.labelfont.color());
 198
 199         // the name of the charstyle. Can be toggled.
 200         if (params_.show_label) {
 201                 Font font(params_.labelfont);
 202                 font.realize(Font(Font::ALL_SANE));
 203                 font.decSize();
 204                 font.decSize();
 205                 int w = 0;
 206                 int a = 0;
 207                 int d = 0;
 208                 // FIXME UNICODE
 209                 docstring s(from_utf8(params_.type));
 210                 if (undefined())
 211                         s = _("Undef: ") + s;
 212                 theFontMetrics(font).rectText(s, w, a, d);
 213                 pi.pain.rectText(x + (dim_.wid - w) / 2, y + desc + a,
 214                         s, font, Color::none, Color::none);
 215         }
 216
 217         // a visual clue when the cursor is inside the inset
 218         Cursor & cur = pi.base.bv->cursor();
 219         if (cur.isInside(this)) {
 220                 y -= ascent();
 221                 pi.pain.line(x, y + 4, x, y, params_.labelfont.color());
 222                 pi.pain.line(x + 4, y, x, y, params_.labelfont.color());
 223                 pi.pain.line(x + dim_.wid - 3, y + 4, x + dim_.wid - 3, y,
 224                         params_.labelfont.color());
 225                 pi.pain.line(x + dim_.wid - 7, y, x + dim_.wid - 3, y,
 226                         params_.labelfont.color());
 227         }
 228 }
 229
 230
 231 void InsetCharStyle::getDrawFont(Font & font) const
 232 {
 233         font = params_.font;
 234 }
 235
 236
 237 void InsetCharStyle::doDispatch(Cursor & cur, FuncRequest & cmd)
 238 {
 239         setInlined();
 240         switch (cmd.action) {
 241
 242         case LFUN_MOUSE_PRESS:
 243                         if (cmd.button() == mouse_button::button3)
 244                                 params_.show_label = !params_.show_label;
 245                         else
 246                                 InsetText::doDispatch(cur, cmd);
 247                         break;
 248
 249         case LFUN_INSET_TOGGLE:
 250                 if (cmd.argument() == "open")
 251                         params_.show_label = true;
 252                 else if (cmd.argument() == "close")
 253                         params_.show_label = false;
 254                 else if (cmd.argument() == "toggle" || cmd.argument().empty())
 255                         params_.show_label = !params_.show_label;
 256                 else // if assign or anything else
 257                         cur.undispatched();
 258                 cur.dispatched();
 259                 break;
 260
 261         default:
 262                 InsetCollapsable::doDispatch(cur, cmd);
 263                 break;
 264         }
 265 }
 266
 267
 268 bool InsetCharStyle::getStatus(Cursor & cur, FuncRequest const & cmd,
 269         FuncStatus & status) const
 270 {
 271         switch (cmd.action) {
 272                 // paragraph breaks not allowed in charstyle insets
 273                 case LFUN_BREAK_PARAGRAPH:
 274                 case LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT:
 275                 case LFUN_BREAK_PARAGRAPH_SKIP:
 276                         status.enabled(false);
 277                         return true;
 278
 279                 default:
 280                         return InsetCollapsable::getStatus(cur, cmd, status);
 281                 }
 282 }
 283
 284
 285 int InsetCharStyle::latex(Buffer const & buf, odocstream & os,
 286                           OutputParams const & runparams) const
 287 {
 288         if (!undefined()) {
 289                 // FIXME UNICODE
 290                 os << '\\' << from_utf8(params_.latexname);
 291                 if (!params_.latexparam.empty())
 292                         os << from_utf8(params_.latexparam);
 293                 os << '{';
 294         }
 295         int i = InsetText::latex(buf, os, runparams);
 296         if (!undefined())
 297                 os << "}";
 298         return i;
 299 }
 300
 301
 302 int InsetCharStyle::plaintext(Buffer const & buf, odocstream & os,
 303                               OutputParams const & runparams) const
 304 {
 305         return InsetText::plaintext(buf, os, runparams);
 306 }
 307
 308
 309 int InsetCharStyle::docbook(Buffer const & buf, odocstream & os,
 310                             OutputParams const & runparams) const
 311 {
 312         ParagraphList::const_iterator beg = paragraphs().begin();
 313         ParagraphList::const_iterator par = paragraphs().begin();
 314         ParagraphList::const_iterator end = paragraphs().end();
 315
 316         if (!undefined())
 317                 // FIXME UNICODE
 318                 sgml::openTag(os, params_.latexname,
 319                               par->getID(buf, runparams) + params_.latexparam);
 320
 321         for (; par != end; ++par) {
 322                 par->simpleDocBookOnePar(buf, os, runparams,
 323                                          outerFont(std::distance(beg, par),
 324                                                    paragraphs()));
 325         }
 326
 327         if (!undefined())
 328                 sgml::closeTag(os, params_.latexname);
 329
 330         return 0;
 331 }
 332
 333
 334 void InsetCharStyle::textString(Buffer const & buf, odocstream & os) const
 335 {
 336         os << paragraphs().begin()->asString(buf, true);
 337 }
 338
 339
 340 void InsetCharStyle::validate(LaTeXFeatures & features) const
 341 {
 342         // Force inclusion of preamble snippet in layout file
 343         features.require(params_.type);
 344         InsetText::validate(features);
 345 }
 346
 347
 348 void InsetCharStyleParams::write(ostream & os) const
 349 {
 350         os << "CharStyle " << type << "\n";
 351         os << "show_label " << convert<string>(show_label) << "\n";
 352 }
 353
 354
 355 void InsetCharStyleParams::read(Lexer & lex)
 356 {
 357         while (lex.isOK()) {
 358                 lex.next();
 359                 string token = lex.getString();
 360
 361                 if (token == "CharStyle") {
 362                         lex.next();
 363                         type = lex.getString();
 364                 }
 365
 366                 else if (token == "show_label") {
 367                         lex.next();
 368                         show_label = lex.getBool();
 369                 }
 370
 371                 else if (token == "status") {
 372                         lex.pushToken(token);
 373                         break;
 374                 }
 375         }
 376 }
 377
 378
 379 } // namespace lyx