src/insets/InsetScript.cpp

   1 /**
   2  * \file InsetScript.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Georg Baum
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "InsetScript.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.h"
  18 #include "Cursor.h"
  19 #include "Dimension.h"
  20 #include "DispatchResult.h"
  21 #include "Exporter.h"
  22 #include "FuncRequest.h"
  23 #include "FuncStatus.h"
  24 #include "LaTeXFeatures.h"
  25 #include "Lexer.h"
  26 #include "LyXAction.h"
  27 #include "MetricsInfo.h"
  28 #include "OutputParams.h"
  29 #include "output_xhtml.h"
  30 #include "TextClass.h"
  31 #include "TextMetrics.h"
  32
  33 #include "support/docstream.h"
  34 #include "support/gettext.h"
  35 #include "support/lstrings.h"
  36 #include "support/Translator.h"
  37
  38 #include "frontends/Application.h"
  39 #include "frontends/FontMetrics.h"
  40 #include "frontends/Painter.h"
  41
  42 #include <algorithm>
  43
  44 using namespace std;
  45
  46 namespace lyx {
  47
  48 namespace {
  49
  50 typedef Translator<string, InsetScriptParams::Type> ScriptTranslator;
  51 typedef Translator<docstring, InsetScriptParams::Type> ScriptTranslatorLoc;
  52
  53 ScriptTranslator const init_scripttranslator()
  54 {
  55         ScriptTranslator translator("subscript", InsetScriptParams::Subscript);
  56         translator.addPair("superscript", InsetScriptParams::Superscript);
  57         return translator;
  58 }
  59
  60
  61 ScriptTranslatorLoc const init_scripttranslator_loc()
  62 {
  63         ScriptTranslatorLoc translator(_("Subscript"), InsetScriptParams::Subscript);
  64         translator.addPair(_("Superscript"), InsetScriptParams::Superscript);
  65         return translator;
  66 }
  67
  68
  69 ScriptTranslator const & scripttranslator()
  70 {
  71         static ScriptTranslator translator = init_scripttranslator();
  72         return translator;
  73 }
  74
  75
  76 ScriptTranslatorLoc const & scripttranslator_loc()
  77 {
  78         static ScriptTranslatorLoc translator = init_scripttranslator_loc();
  79         return translator;
  80 }
  81
  82 } // anon
  83
  84
  85 InsetScriptParams::InsetScriptParams()
  86         : type(Subscript)
  87 {}
  88
  89
  90 void InsetScriptParams::write(ostream & os) const
  91 {
  92         string const label = scripttranslator().find(type);
  93         os << "script " << label << "\n";
  94 }
  95
  96
  97 void InsetScriptParams::read(Lexer & lex)
  98 {
  99         string label;
 100         lex >> label;
 101         if (lex)
 102                 type = scripttranslator().find(label);
 103 }
 104
 105
 106 int InsetScriptParams::shift(FontInfo const & font) const
 107 {
 108         frontend::FontMetrics const & fm = theFontMetrics(font);
 109         switch (type) {
 110         case Subscript:
 111                 return fm.maxAscent() / 3;
 112         case Superscript:
 113                 return -fm.maxAscent() / 2;
 114         }
 115         // shut up compiler
 116         return 0;
 117 }
 118
 119
 120 /////////////////////////////////////////////////////////////////////
 121 //
 122 // InsetScript
 123 //
 124 /////////////////////////////////////////////////////////////////////
 125
 126 InsetScript::InsetScript(Buffer * buf, InsetScriptParams const & params)
 127         : InsetText(buf, InsetText::PlainLayout), params_(params)
 128 {
 129         setDrawFrame(false);
 130 }
 131
 132
 133 InsetScript::InsetScript(Buffer * buf, string const & label)
 134         : InsetText(buf)
 135 {
 136         setDrawFrame(false);
 137         params_.type = scripttranslator().find(label);
 138 }
 139
 140
 141 InsetScript::~InsetScript()
 142 {
 143 }
 144
 145
 146 docstring InsetScript::name() const
 147 {
 148         return from_ascii("script:" + scripttranslator().find(params_.type));
 149 }
 150
 151
 152 Inset::DisplayType InsetScript::display() const
 153 {
 154         return Inline;
 155 }
 156
 157
 158 void InsetScript::metrics(MetricsInfo & mi, Dimension & dim) const
 159 {
 160         int const shift = params_.shift(mi.base.font);
 161         ScriptChanger dummy(mi.base);
 162         InsetText::metrics(mi, dim);
 163         dim.asc -= shift;
 164         dim.des += shift;
 165 }
 166
 167
 168 void InsetScript::draw(PainterInfo & pi, int x, int y) const
 169 {
 170         int const shift = params_.shift(pi.base.font);
 171         ScriptChanger dummy(pi.base);
 172         InsetText::draw(pi, x, y + shift);
 173 }
 174
 175
 176 void InsetScript::cursorPos(BufferView const & bv,
 177                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 178 {
 179         Font const font = bv.textMetrics(&text()).displayFont(sl.pit(), sl.pos());
 180         int const shift = params_.shift(font.fontInfo());
 181         InsetText::cursorPos(bv, sl, boundary, x, y);
 182         y += shift;
 183 }
 184
 185
 186 void InsetScript::write(ostream & os) const
 187 {
 188         params_.write(os);
 189         text().write(os);
 190 }
 191
 192
 193 void InsetScript::read(Lexer & lex)
 194 {
 195         params_.read(lex);
 196         InsetText::read(lex);
 197 }
 198
 199
 200 void InsetScript::edit(Cursor & cur, bool front, EntryDirection entry_from)
 201 {
 202         cur.push(*this);
 203         InsetText::edit(cur, front, entry_from);
 204 }
 205
 206
 207 Inset * InsetScript::editXY(Cursor & cur, int x, int y)
 208 {
 209         cur.push(*this);
 210         return InsetText::editXY(cur, x, y);
 211 }
 212
 213 void InsetScript::doDispatch(Cursor & cur, FuncRequest & cmd)
 214 {
 215         switch (cmd.action()) {
 216         case LFUN_INSET_MODIFY:
 217                 string2params(to_utf8(cmd.argument()), params_);
 218                 break;
 219         default:
 220                 InsetText::doDispatch(cur, cmd);
 221                 break;
 222         }
 223 }
 224
 225
 226 bool InsetScript::insetAllowed(InsetCode code) const
 227 {
 228         switch (code) {
 229         // code that is not allowed in a script
 230         case BIBITEM_CODE:
 231         case BIBTEX_CODE:
 232         case BOX_CODE:
 233         case BRANCH_CODE:
 234         case CAPTION_CODE:
 235         case COLLAPSABLE_CODE:
 236         case FLOAT_CODE:
 237         case FLOAT_LIST_CODE:
 238         case FOOT_CODE:
 239         case INCLUDE_CODE:
 240         case INDEX_PRINT_CODE:
 241         case LISTINGS_CODE:
 242         case MARGIN_CODE:
 243         case MATH_MACRO_CODE:
 244         case MATHMACRO_CODE:
 245         case NEWLINE_CODE:
 246         case NEWPAGE_CODE:
 247         case NOMENCL_PRINT_CODE:
 248         case QUOTE_CODE:
 249         case PREVIEW_CODE:
 250         case TABULAR_CODE:
 251         case TOC_CODE:
 252         case WRAP_CODE:
 253                 return false;
 254         default:
 255                 return InsetText::insetAllowed(code);
 256         }
 257 }
 258
 259 bool InsetScript::getStatus(Cursor & cur, FuncRequest const & cmd,
 260                 FuncStatus & flag) const
 261 {
 262         switch (cmd.action()) {
 263         case LFUN_BREAK_PARAGRAPH:
 264         case LFUN_LAYOUT:
 265         case LFUN_LAYOUT_PARAGRAPH:
 266         case LFUN_MATH_DISPLAY:
 267         case LFUN_BOX_INSERT:
 268         case LFUN_BRANCH_INSERT:
 269         case LFUN_CAPTION_INSERT:
 270         case LFUN_FLOAT_INSERT:
 271         case LFUN_FLOAT_LIST_INSERT:
 272         case LFUN_FLOAT_WIDE_INSERT:
 273         case LFUN_FOOTNOTE_INSERT:
 274         case LFUN_HFILL_INSERT:
 275         case LFUN_INDEX_PRINT:
 276         case LFUN_LISTING_INSERT:
 277         case LFUN_MARGINALNOTE_INSERT:
 278         case LFUN_NEWLINE_INSERT:
 279         case LFUN_NEWPAGE_INSERT:
 280         case LFUN_NOMENCL_PRINT:
 281         case LFUN_PREVIEW_INSERT:
 282         case LFUN_QUOTE_INSERT:
 283         case LFUN_TABULAR_INSERT:
 284         case LFUN_WRAP_INSERT:
 285                 flag.setEnabled(false);
 286                 return true;
 287         case LFUN_INSET_MODIFY:
 288                 flag.setEnabled(true);
 289                 return true;
 290         case LFUN_COMMAND_SEQUENCE: {
 291                 // argument contains ';'-terminated commands
 292                 string arg = to_utf8(cmd.argument());
 293                 // prevent insertion of display math formulas like AMS align
 294                 while (!arg.empty()) {
 295                         string first;
 296                         arg = support::split(arg, first, ';');
 297                         FuncRequest func(lyxaction.lookupFunc(first));
 298                         if (func.action() == LFUN_MATH_MUTATE) {
 299                                 flag.setEnabled(false);
 300                                 return true;
 301                         }
 302                 }
 303                 break;
 304         }
 305         default:
 306                 break;
 307         }
 308         return InsetText::getStatus(cur, cmd, flag);
 309 }
 310
 311
 312 docstring InsetScript::toolTip(BufferView const &, int, int) const
 313 {
 314         OutputParams rp(&buffer().params().encoding());
 315         odocstringstream ods;
 316         InsetText::plaintext(ods, rp);
 317         docstring content_tip = ods.str();
 318         // shorten it if necessary
 319         if (content_tip.size() > 200)
 320                 content_tip = content_tip.substr(0, 200) + "...";
 321         docstring res = scripttranslator_loc().find(params_.type);
 322         if (!content_tip.empty())
 323                 res += from_ascii(": ") + content_tip;
 324         return res;
 325 }
 326
 327
 328 void InsetScript::validate(LaTeXFeatures & features) const
 329 {
 330         if (params_.type == InsetScriptParams::Subscript)
 331                 features.require("subscript");
 332         InsetText::validate(features);
 333 }
 334
 335
 336 int InsetScript::latex(odocstream & os, OutputParams const & runparams) const
 337 {
 338         switch (params_.type) {
 339         case InsetScriptParams::Subscript:
 340                 os << "\\textsubscript{";
 341                 break;
 342         case InsetScriptParams::Superscript:
 343                 os << "\\textsuperscript{";
 344                 break;
 345         }
 346         int const i = InsetText::latex(os, runparams);
 347         os << "}";
 348
 349         return i;
 350 }
 351
 352
 353 int InsetScript::plaintext(odocstream & os, OutputParams const & runparams) const
 354 {
 355         odocstringstream oss;
 356         InsetText::plaintext(oss, runparams);
 357         docstring const text = oss.str();
 358         switch (params_.type) {
 359         case InsetScriptParams::Subscript:
 360                 if (text.size() == 1) {
 361                         char_type const c = support::subscript(text[0]);
 362                         if (c != text[0]) {
 363                                 os.put(c);
 364                                 return 0;
 365                         }
 366                 }
 367                 os << '[' << buffer().B_("subscript") << ':';
 368                 break;
 369         case InsetScriptParams::Superscript:
 370                 if (text.size() == 1) {
 371                         char_type const c = support::superscript(text[0]);
 372                         if (c != text[0]) {
 373                                 os.put(c);
 374                                 return 0;
 375                         }
 376                 }
 377                 os << '[' << buffer().B_("superscript") << ':';
 378                 break;
 379         }
 380         InsetText::plaintext(os, runparams);
 381         os << ']';
 382
 383         return PLAINTEXT_NEWLINE;
 384 }
 385
 386
 387 int InsetScript::docbook(odocstream & os, OutputParams const & runparams) const
 388 {
 389         string cmdname;
 390         switch (params_.type) {
 391         case InsetScriptParams::Subscript:
 392                 cmdname = "subscript";
 393                 break;
 394         case InsetScriptParams::Superscript:
 395                 cmdname = "superscript";
 396                 break;
 397         }
 398         os << '<' + cmdname + '>';
 399         int const i = InsetText::docbook(os, runparams);
 400         os << "</" + cmdname + '>';
 401
 402         return i;
 403 }
 404
 405
 406 docstring InsetScript::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
 407 {
 408         string cmdname;
 409         switch (params_.type) {
 410         case InsetScriptParams::Subscript:
 411                 cmdname = "sub";
 412                 break;
 413         case InsetScriptParams::Superscript:
 414                 cmdname = "sup";
 415                 break;
 416         }
 417
 418         xs << html::StartTag(cmdname);
 419         docstring const ret = InsetText::xhtml(xs, runparams);
 420         xs << html::EndTag(cmdname);
 421         return ret;
 422 }
 423
 424
 425 docstring InsetScript::contextMenu(BufferView const &, int, int) const
 426 {
 427         return from_ascii("context-script");
 428 }
 429
 430
 431 string InsetScript::params2string(InsetScriptParams const & params)
 432 {
 433         ostringstream data;
 434         data << "script ";
 435         params.write(data);
 436         return data.str();
 437 }
 438
 439
 440 void InsetScript::string2params(string const & in, InsetScriptParams & params)
 441 {
 442         params = InsetScriptParams();
 443
 444         if (in.empty())
 445                 return;
 446
 447         istringstream data(in);
 448         Lexer lex;
 449         lex.setStream(data);
 450         lex.setContext("InsetScript::string2params");
 451         lex >> "script" >> "script";
 452
 453         params.read(lex);
 454 }
 455
 456
 457 } // namespace lyx