src/insets/insetcharstyle.C

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