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