src/insets/Inset.cpp

   1 /**
   2  * \file Inset.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alejandro Aguilar Sierra
   7  * \author Jürgen Vigna
   8  * \author Lars Gullik Bjønnes
   9  * \author Matthias Ettrich
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "Inset.h"
  18
  19 #include "buffer_funcs.h"
  20 #include "Buffer.h"
  21 #include "BufferList.h"
  22 #include "BufferParams.h"
  23 #include "BufferView.h"
  24 #include "CoordCache.h"
  25 #include "Cursor.h"
  26 #include "Dimension.h"
  27 #include "DispatchResult.h"
  28 #include "FuncRequest.h"
  29 #include "FuncStatus.h"
  30 #include "InsetLayout.h"
  31 #include "MetricsInfo.h"
  32 #include "output_xhtml.h"
  33 #include "xml.h"
  34 #include "Text.h"
  35 #include "TextClass.h"
  36 #include "TocBackend.h"
  37
  38 #include "frontends/Application.h"
  39 #include "frontends/Painter.h"
  40
  41 #include "support/debug.h"
  42 #include "support/docstream.h"
  43 #include "support/ExceptionMessage.h"
  44 #include "support/gettext.h"
  45 #include "support/lassert.h"
  46
  47 #include <map>
  48
  49 using namespace std;
  50 using namespace lyx::support;
  51
  52 namespace lyx {
  53
  54 class InsetName {
  55 public:
  56         InsetName(string const & n = string(), docstring const & dn = docstring())
  57                 : name(n), display_name(dn) {}
  58         string name;
  59         docstring display_name;
  60 };
  61
  62
  63 static InsetName insetnames[INSET_CODE_SIZE];
  64
  65
  66 // This list should be kept in sync with the list of dialogs in
  67 // src/frontends/qt/GuiView.cpp, I.e., if a dialog goes with an
  68 // inset, the dialog should have the same name as the inset.
  69 // Changes should be also recorded in LFUN_DIALOG_SHOW doxygen
  70 // docs in LyXAction.cpp.
  71 static void build_translator()
  72 {
  73         static bool passed = false;
  74         if (passed)
  75                 return;
  76         insetnames[TOC_CODE] = InsetName("toc");
  77         insetnames[QUOTE_CODE] = InsetName("quote");
  78         insetnames[REF_CODE] = InsetName("ref");
  79         insetnames[COUNTER_CODE] = InsetName("counter");
  80         insetnames[HYPERLINK_CODE] = InsetName("href");
  81         insetnames[SEPARATOR_CODE] = InsetName("separator");
  82         insetnames[ENDING_CODE] = InsetName("ending");
  83         insetnames[LABEL_CODE] = InsetName("label");
  84         insetnames[NOTE_CODE] = InsetName("note");
  85         insetnames[PHANTOM_CODE] = InsetName("phantom");
  86         insetnames[ACCENT_CODE] = InsetName("accent");
  87         insetnames[MATH_CODE] = InsetName("math");
  88         insetnames[INDEX_CODE] = InsetName("index");
  89         insetnames[NOMENCL_CODE] = InsetName("nomenclature");
  90         insetnames[INCLUDE_CODE] = InsetName("include");
  91         insetnames[GRAPHICS_CODE] = InsetName("graphics");
  92         insetnames[BIBITEM_CODE] = InsetName("bibitem", _("Bibliography Entry"));
  93         insetnames[BIBTEX_CODE] = InsetName("bibtex");
  94         insetnames[TEXT_CODE] = InsetName("text");
  95         insetnames[ERT_CODE] = InsetName("ert", _("TeX Code"));
  96         insetnames[FOOT_CODE] = InsetName("foot");
  97         insetnames[MARGIN_CODE] = InsetName("margin");
  98         insetnames[FLOAT_CODE] = InsetName("float", _("Float"));
  99         insetnames[WRAP_CODE] = InsetName("wrap");
 100         insetnames[SPECIALCHAR_CODE] = InsetName("specialchar");
 101         insetnames[IPA_CODE] = InsetName("ipa");
 102         insetnames[IPACHAR_CODE] = InsetName("ipachar");
 103         insetnames[IPADECO_CODE] = InsetName("ipadeco");
 104         insetnames[TABULAR_CODE] = InsetName("tabular", _("Table"));
 105         insetnames[EXTERNAL_CODE] = InsetName("external");
 106         insetnames[CAPTION_CODE] = InsetName("caption");
 107         insetnames[MATHMACRO_CODE] = InsetName("mathmacro");
 108         insetnames[CITE_CODE] = InsetName("citation");
 109         insetnames[FLOAT_LIST_CODE] = InsetName("floatlist");
 110         insetnames[INDEX_PRINT_CODE] = InsetName("index_print");
 111         insetnames[NOMENCL_PRINT_CODE] = InsetName("nomencl_print");
 112         insetnames[ARG_CODE] = InsetName("optarg");
 113         insetnames[NEWLINE_CODE] = InsetName("newline");
 114         insetnames[LINE_CODE] = InsetName("line");
 115         insetnames[BRANCH_CODE] = InsetName("branch", _("Branch"));
 116         insetnames[BOX_CODE] = InsetName("box", _("Box"));
 117         insetnames[FLEX_CODE] = InsetName("flex");
 118         insetnames[SPACE_CODE] = InsetName("space", _("Horizontal Space"));
 119         insetnames[VSPACE_CODE] = InsetName("vspace", _("Vertical Space"));
 120         insetnames[MATH_MACROARG_CODE] = InsetName("mathmacroarg");
 121         insetnames[LISTINGS_CODE] = InsetName("listings");
 122         insetnames[INFO_CODE] = InsetName("info", _("Info"));
 123         insetnames[COLLAPSIBLE_CODE] = InsetName("collapsible");
 124         insetnames[NEWPAGE_CODE] = InsetName("newpage");
 125         insetnames[SCRIPT_CODE] = InsetName("script");
 126         insetnames[CELL_CODE] = InsetName("tablecell");
 127         insetnames[MATH_AMSARRAY_CODE] = InsetName("mathamsarray");
 128         insetnames[MATH_ARRAY_CODE] = InsetName("matharray");
 129         insetnames[MATH_BIG_CODE] = InsetName("mathbig");
 130         insetnames[MATH_BOLDSYMBOL_CODE] = InsetName("mathboldsymbol");
 131         insetnames[MATH_BOX_CODE] = InsetName("mathbox");
 132         insetnames[MATH_BRACE_CODE] = InsetName("mathbrace");
 133         insetnames[MATH_CANCEL_CODE] = InsetName("mathcancel");
 134         insetnames[MATH_CANCELTO_CODE] = InsetName("mathcancelto");
 135         insetnames[MATH_CASES_CODE] = InsetName("mathcases");
 136         insetnames[MATH_CHAR_CODE] = InsetName("mathchar");
 137         insetnames[MATH_COLOR_CODE] = InsetName("mathcolor");
 138         insetnames[MATH_COMMENT_CODE] = InsetName("mathcomment");
 139         insetnames[MATH_DECORATION_CODE] = InsetName("mathdecoration");
 140         insetnames[MATH_DELIM_CODE] = InsetName("mathdelim");
 141         insetnames[MATH_DIFF_CODE] = InsetName("mathdiff");
 142         insetnames[MATH_DOTS_CODE] = InsetName("mathdots");
 143         insetnames[MATH_ENSUREMATH_CODE] = InsetName("mathensuremath");
 144         insetnames[MATH_ENV_CODE] = InsetName("mathenv");
 145         insetnames[MATH_EXFUNC_CODE] = InsetName("mathexfunc");
 146         insetnames[MATH_EXINT_CODE] = InsetName("mathexint");
 147         insetnames[MATH_FONT_CODE] = InsetName("mathfont");
 148         insetnames[MATH_FONTOLD_CODE] = InsetName("mathfontold");
 149         insetnames[MATH_FRAC_CODE] = InsetName("mathfrac");
 150         insetnames[MATH_GRID_CODE] = InsetName("mathgrid");
 151         insetnames[MATH_CODE] = InsetName("math");
 152         insetnames[MATH_HULL_CODE] = InsetName("mathhull");
 153         insetnames[MATH_KERN_CODE] = InsetName("mathkern");
 154         insetnames[MATH_LEFTEQN_CODE] = InsetName("mathlefteqn");
 155         insetnames[MATH_LIM_CODE] = InsetName("mathlim");
 156         insetnames[MATH_MATRIX_CODE] = InsetName("mathmatrix");
 157         insetnames[MATH_MBOX_CODE] = InsetName("mathmbox");
 158         insetnames[MATH_NEST_CODE] = InsetName("mathnest");
 159         insetnames[MATH_NUMBER_CODE] = InsetName("mathnumber");
 160         insetnames[MATH_OVERSET_CODE] = InsetName("mathoverset");
 161         insetnames[MATH_PAR_CODE] = InsetName("mathpar");
 162         insetnames[MATH_PHANTOM_CODE] = InsetName("mathphantom");
 163         insetnames[MATH_REF_CODE] = InsetName("mathref");
 164         insetnames[MATH_ROOT_CODE] = InsetName("mathroot");
 165         insetnames[MATH_SCRIPT_CODE] = InsetName("mathscript");
 166         insetnames[MATH_SIZE_CODE] = InsetName("mathsize");
 167         insetnames[MATH_SPACE_CODE] = InsetName("mathspace", _("Horizontal Math Space"));
 168         insetnames[MATH_SPECIALCHAR_CODE] = InsetName("mathspecialchar");
 169         insetnames[MATH_SPLIT_CODE] = InsetName("mathsplit");
 170         insetnames[MATH_SQRT_CODE] = InsetName("mathsqrt");
 171         insetnames[MATH_STACKREL_CODE] = InsetName("mathstackrel");
 172         insetnames[MATH_STRING_CODE] = InsetName("mathstring");
 173         insetnames[MATH_SUBSTACK_CODE] = InsetName("mathsubstack");
 174         insetnames[MATH_SYMBOL_CODE] = InsetName("mathsymbol");
 175         insetnames[MATH_TABULAR_CODE] = InsetName("mathtabular");
 176         insetnames[MATH_UNDERSET_CODE] = InsetName("mathunderset");
 177         insetnames[MATH_UNKNOWN_CODE] = InsetName("mathunknown");
 178         insetnames[MATH_XARROW_CODE] = InsetName("mathxarrow");
 179         insetnames[MATH_XYMATRIX_CODE] = InsetName("mathxymatrix");
 180         insetnames[MATH_DIAGRAM_CODE] = InsetName("mathdiagram");
 181         insetnames[MATH_MACRO_CODE] = InsetName("mathmacro");
 182
 183         passed = true;
 184 }
 185
 186
 187 void Inset::setBuffer(Buffer & buffer)
 188 {
 189         buffer_ = &buffer;
 190 }
 191
 192
 193 void Inset::resetBuffer()
 194 {
 195         buffer_ = nullptr;
 196 }
 197
 198
 199 Buffer & Inset::buffer()
 200 {
 201         if (!buffer_) {
 202                 odocstringstream s;
 203                 string const iname = insetName(lyxCode());
 204                 LYXERR0("Inset: " << this << " LyX Code: " << lyxCode()
 205                                         << " name: " << iname);
 206                 s << "LyX Code: " << lyxCode() << " name: " << from_ascii(iname);
 207                 LATTEST(false);
 208                 throw ExceptionMessage(BufferException,
 209                         from_ascii("Inset::buffer_ member not initialized!"), s.str());
 210         }
 211         return *buffer_;
 212 }
 213
 214
 215 Buffer const & Inset::buffer() const
 216 {
 217         return const_cast<Inset *>(this)->buffer();
 218 }
 219
 220
 221 bool Inset::isBufferLoaded() const
 222 {
 223         return buffer_ && theBufferList().isLoaded(buffer_);
 224 }
 225
 226
 227 bool Inset::isBufferValid() const
 228 {
 229         return buffer_
 230                 && (isBufferLoaded() || buffer_->isInternal() || buffer_->isClone());
 231 }
 232
 233
 234 docstring Inset::layoutName() const
 235 {
 236         return from_ascii("unknown");
 237 }
 238
 239
 240 bool Inset::isFreeSpacing() const
 241 {
 242         return getLayout().isFreeSpacing();
 243 }
 244
 245
 246 bool Inset::allowEmpty() const
 247 {
 248         return getLayout().isKeepEmpty();
 249 }
 250
 251
 252 bool Inset::forceLTR(OutputParams const &) const
 253 {
 254         return getLayout().forceLTR();
 255 }
 256
 257
 258 bool Inset::isInToc() const
 259 {
 260         return getLayout().isInToc();
 261 }
 262
 263
 264 docstring Inset::toolTip(BufferView const &, int, int) const
 265 {
 266         return docstring();
 267 }
 268
 269
 270 void Inset::forOutliner(docstring &, size_t const, bool const) const
 271 {
 272 }
 273
 274
 275 string Inset::contextMenu(BufferView const &, int, int) const
 276 {
 277         return contextMenuName();
 278 }
 279
 280
 281 string Inset::contextMenuName() const
 282 {
 283         return string();
 284 }
 285
 286
 287 Dimension const Inset::dimension(BufferView const & bv) const
 288 {
 289         return bv.coordCache().getInsets().dim(this);
 290 }
 291
 292
 293 InsetCode insetCode(string const & name)
 294 {
 295         build_translator();
 296         for (int i = 1; i != int(INSET_CODE_SIZE); ++i) {
 297                 if (insetnames[i].name == name)
 298                         return InsetCode(i);
 299         }
 300         return NO_CODE;
 301 }
 302
 303
 304 string insetName(InsetCode c)
 305 {
 306         build_translator();
 307         return insetnames[c].name;
 308 }
 309
 310
 311 docstring insetDisplayName(InsetCode c)
 312 {
 313         build_translator();
 314         return insetnames[c].display_name;
 315 }
 316
 317
 318 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 319 {
 320         if (buffer_ == 0) {
 321                 lyxerr << "Unassigned buffer_ member in Inset::dispatch()" << std::endl;
 322                 lyxerr << "LyX Code: " << lyxCode() << " name: "
 323                        << insetName(lyxCode()) << std::endl;
 324         } else if (cur.buffer() != buffer_)
 325                 lyxerr << "cur.buffer() != buffer_ in Inset::dispatch()" << std::endl;
 326         cur.screenUpdateFlags(Update::Force | Update::FitCursor);
 327         cur.dispatched();
 328         doDispatch(cur, cmd);
 329 }
 330
 331
 332 bool Inset::showInsetDialog(BufferView * bv) const
 333 {
 334         InsetCode const code = lyxCode();
 335         switch (code){
 336         case ERT_CODE:
 337         case FLOAT_CODE:
 338         case BOX_CODE:
 339         case BIBITEM_CODE:
 340         case BRANCH_CODE:
 341         case INFO_CODE:
 342         case MATH_SPACE_CODE:
 343         case SPACE_CODE:
 344         case TABULAR_CODE:
 345         case VSPACE_CODE:
 346                 bv->showDialog(insetName(code));
 347                 break;
 348         default:
 349                 return false;
 350         }
 351         return true;
 352 }
 353
 354
 355 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
 356 {
 357         switch (cmd.action()) {
 358         case LFUN_MOUSE_RELEASE:
 359                 // if the derived inset did not explicitly handle mouse_release,
 360                 // we assume we request the settings dialog
 361                 if (!cur.selection() && cmd.button() == mouse_button::button1
 362                     && clickable(cur.bv(), cmd.x(), cmd.y()) && hasSettings()) {
 363                         FuncRequest tmpcmd(LFUN_INSET_SETTINGS);
 364                         dispatch(cur, tmpcmd);
 365                 }
 366                 break;
 367
 368         case LFUN_INSET_SETTINGS:
 369                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 370                         showInsetDialog(&cur.bv());
 371                         cur.dispatched();
 372                 } else
 373                         cur.undispatched();
 374                 break;
 375
 376         default:
 377                 cur.noScreenUpdate();
 378                 cur.undispatched();
 379                 break;
 380         }
 381 }
 382
 383
 384 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 385         FuncStatus & status) const
 386 {
 387         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 388         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 389         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 390         // not belong to us, i. e. the dialog was open, and the user moved
 391         // the cursor in our inset) in lyx::getStatus().
 392         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 393         // LFUN_INSET_APPLY is disabled.
 394
 395         switch (cmd.action()) {
 396         case LFUN_INSET_MODIFY:
 397                 // Allow modification of our data.
 398                 // This needs to be handled in the doDispatch method of our
 399                 // instantiatable children.
 400                 status.setEnabled(true);
 401                 return true;
 402
 403         case LFUN_INSET_INSERT:
 404                 // Don't allow insertion of new insets.
 405                 // Every inset that wants to allow new insets from open
 406                 // dialogs needs to override this.
 407                 status.setEnabled(false);
 408                 return true;
 409
 410         case LFUN_INSET_SETTINGS:
 411                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 412                         bool const enable = hasSettings();
 413                         status.setEnabled(enable);
 414                         return true;
 415                 } else {
 416                         return false;
 417                 }
 418
 419         case LFUN_IN_MATHMACROTEMPLATE:
 420                 // By default we're not in a InsetMathMacroTemplate inset
 421                 status.setEnabled(false);
 422                 return true;
 423
 424         case LFUN_IN_IPA:
 425                 // By default we're not in an IPA inset
 426                 status.setEnabled(false);
 427                 return true;
 428
 429         default:
 430                 break;
 431         }
 432         return false;
 433 }
 434
 435
 436 void Inset::edit(Cursor &, bool, EntryDirection)
 437 {
 438         LYXERR(Debug::INSETS, "edit left/right");
 439 }
 440
 441
 442 Inset * Inset::editXY(Cursor &, int x, int y)
 443 {
 444         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
 445         return this;
 446 }
 447
 448
 449 idx_type Inset::index(row_type row, col_type col) const
 450 {
 451         if (row != 0)
 452                 LYXERR0("illegal row: " << row);
 453         if (col != 0)
 454                 LYXERR0("illegal col: " << col);
 455         return 0;
 456 }
 457
 458
 459 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 460 {
 461         return from <= idx && idx <= to;
 462 }
 463
 464
 465 bool Inset::idxUpDown(Cursor &, bool) const
 466 {
 467         return false;
 468 }
 469
 470
 471 void Inset::docbook(XMLStream & xs, OutputParams const &) const
 472 {
 473         xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
 474 }
 475
 476
 477 docstring Inset::xhtml(XMLStream & xs, OutputParams const &) const
 478 {
 479         xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
 480         return docstring();
 481 }
 482
 483
 484 bool Inset::directWrite() const
 485 {
 486         return false;
 487 }
 488
 489
 490 bool Inset::editable() const
 491 {
 492         return false;
 493 }
 494
 495
 496 bool Inset::hasSettings() const
 497 {
 498         return false;
 499 }
 500
 501
 502
 503 bool Inset::autoDelete() const
 504 {
 505         return false;
 506 }
 507
 508
 509 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 510                 bool, int & x, int & y) const
 511 {
 512         LYXERR0("Inset::cursorPos called directly");
 513         x = 100;
 514         y = 100;
 515 }
 516
 517
 518 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 519 {
 520         dim.wid += 2 * framesize;
 521         dim.des += framesize;
 522 }
 523
 524
 525 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 526 {
 527         dim.wid += 2 * framesize;
 528         dim.asc += framesize;
 529         dim.des += framesize;
 530 }
 531
 532
 533 void Inset::drawBackground(PainterInfo & pi, int x, int y) const
 534 {
 535         if (pi.full_repaint && backgroundColor(pi) == Color_none)
 536                 return;
 537         Dimension const dim = dimension(*pi.base.bv);
 538         pi.pain.fillRectangle(x, y - dim.asc, dim.wid, dim.asc + dim.des,
 539                               pi.backgroundColor(this));
 540 }
 541
 542
 543 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 544 {
 545         ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
 546                 Color_mathframe : Color_mathcorners;
 547
 548         Dimension const dim = dimension(*pi.base.bv);
 549
 550         int const t = x + dim.width() - 1;
 551         int const d = y + dim.descent();
 552         pi.pain.line(x, d - 3, x, d, pen_color);
 553         pi.pain.line(t, d - 3, t, d, pen_color);
 554         pi.pain.line(x, d, x + 3, d, pen_color);
 555         pi.pain.line(t - 3, d, t, d, pen_color);
 556 }
 557
 558
 559 bool Inset::editing(BufferView const * bv) const
 560 {
 561         return bv->cursor().isInside(this);
 562 }
 563
 564
 565 int Inset::xo(BufferView const & bv) const
 566 {
 567         return bv.coordCache().getInsets().x(this);
 568 }
 569
 570
 571 int Inset::yo(BufferView const & bv) const
 572 {
 573         return bv.coordCache().getInsets().y(this);
 574 }
 575
 576
 577 bool Inset::covers(BufferView const & bv, int x, int y) const
 578 {
 579         return bv.coordCache().getInsets().covers(this, x, y);
 580 }
 581
 582
 583 InsetLayout const & Inset::getLayout() const
 584 {
 585         if (!buffer_)
 586                 return DocumentClass::plainInsetLayout();
 587         return buffer().params().documentClass().insetLayout(layoutName());
 588 }
 589
 590
 591 bool Inset::isPassThru() const
 592 {
 593         return getLayout().isPassThru();
 594 }
 595
 596
 597 bool Inset::undefined() const
 598 {
 599         docstring const & n = getLayout().name();
 600         return n.empty() || n == DocumentClass::plainInsetLayout().name();
 601 }
 602
 603
 604 CtObject Inset::getCtObject(OutputParams const &) const
 605 {
 606         return CtObject::Normal;
 607 }
 608
 609
 610 void Inset::dump() const
 611 {
 612         write(lyxerr);
 613 }
 614
 615
 616 ColorCode Inset::backgroundColor(PainterInfo const & /*pi*/) const
 617 {
 618         return Color_none;
 619 }
 620
 621
 622 ColorCode Inset::labelColor() const
 623 {
 624         return Color_foreground;
 625 }
 626
 627
 628 Buffer const * Inset::updateFrontend() const
 629 {
 630         //FIXME (Abdel 03/12/10): see bugs #6814 and #6949
 631         // If the Buffer is null and we end up here this is most probably because we
 632         // are in the CutAndPaste stack. See InsetGraphics, RenderGraphics and
 633         // RenderPreview.
 634         if (!buffer_)
 635                 return 0;
 636         return theApp() ? theApp()->updateInset(this) : 0;
 637 }
 638
 639
 640 bool Inset::resetFontEdit() const
 641 {
 642         return getLayout().resetsFont() || !inheritFont();
 643 }
 644
 645
 646 docstring Inset::completionPrefix(Cursor const &) const
 647 {
 648         return docstring();
 649 }
 650
 651 } // namespace lyx