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