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[SCRIPT_CODE] = InsetName("script");
 119         insetnames[CELL_CODE] = InsetName("tablecell");
 120         insetnames[MATH_AMSARRAY_CODE] = InsetName("mathamsarray");
 121         insetnames[MATH_ARRAY_CODE] = InsetName("matharray");
 122         insetnames[MATH_BIG_CODE] = InsetName("mathbig");
 123         insetnames[MATH_BOLDSYMBOL_CODE] = InsetName("mathboldsymbol");
 124         insetnames[MATH_BOX_CODE] = InsetName("mathbox");
 125         insetnames[MATH_BRACE_CODE] = InsetName("mathbrace");
 126         insetnames[MATH_CASES_CODE] = InsetName("mathcases");
 127         insetnames[MATH_CHAR_CODE] = InsetName("mathchar");
 128         insetnames[MATH_COLOR_CODE] = InsetName("mathcolor");
 129         insetnames[MATH_COMMENT_CODE] = InsetName("mathcomment");
 130         insetnames[MATH_DECORATION_CODE] = InsetName("mathdecoration");
 131         insetnames[MATH_DELIM_CODE] = InsetName("mathdelim");
 132         insetnames[MATH_DIFF_CODE] = InsetName("mathdiff");
 133         insetnames[MATH_DOTS_CODE] = InsetName("mathdots");
 134         insetnames[MATH_ENSUREMATH_CODE] = InsetName("mathensuremath");
 135         insetnames[MATH_ENV_CODE] = InsetName("mathenv");
 136         insetnames[MATH_EXFUNC_CODE] = InsetName("mathexfunc");
 137         insetnames[MATH_EXINT_CODE] = InsetName("mathexint");
 138         insetnames[MATH_FONT_CODE] = InsetName("mathfont");
 139         insetnames[MATH_FONTOLD_CODE] = InsetName("mathfontold");
 140         insetnames[MATH_FRAC_CODE] = InsetName("mathfrac");
 141         insetnames[MATH_GRID_CODE] = InsetName("mathgrid");
 142         insetnames[MATH_CODE] = InsetName("math");
 143         insetnames[MATH_HULL_CODE] = InsetName("mathhull");
 144         insetnames[MATH_KERN_CODE] = InsetName("mathkern");
 145         insetnames[MATH_LEFTEQN_CODE] = InsetName("mathlefteqn");
 146         insetnames[MATH_LIM_CODE] = InsetName("mathlim");
 147         insetnames[MATH_MATRIX_CODE] = InsetName("mathmatrix");
 148         insetnames[MATH_MBOX_CODE] = InsetName("mathmbox");
 149         insetnames[MATH_NEST_CODE] = InsetName("mathnest");
 150         insetnames[MATH_NUMBER_CODE] = InsetName("mathnumber");
 151         insetnames[MATH_OVERSET_CODE] = InsetName("mathoverset");
 152         insetnames[MATH_PAR_CODE] = InsetName("mathpar");
 153         insetnames[MATH_PHANTOM_CODE] = InsetName("mathphantom");
 154         insetnames[MATH_REF_CODE] = InsetName("mathref");
 155         insetnames[MATH_ROOT_CODE] = InsetName("mathroot");
 156         insetnames[MATH_SCRIPT_CODE] = InsetName("mathscript");
 157         insetnames[MATH_SIZE_CODE] = InsetName("mathsize");
 158         insetnames[MATH_SPACE_CODE] = InsetName("mathspace", _("Horizontal Math Space"));
 159         insetnames[MATH_SPECIALCHAR_CODE] = InsetName("mathspecialchar");
 160         insetnames[MATH_SPLIT_CODE] = InsetName("mathsplit");
 161         insetnames[MATH_SQRT_CODE] = InsetName("mathsqrt");
 162         insetnames[MATH_STACKREL_CODE] = InsetName("mathstackrel");
 163         insetnames[MATH_STRING_CODE] = InsetName("mathstring");
 164         insetnames[MATH_SUBSTACK_CODE] = InsetName("mathsubstack");
 165         insetnames[MATH_SYMBOL_CODE] = InsetName("mathsymbol");
 166         insetnames[MATH_TABULAR_CODE] = InsetName("mathtabular");
 167         insetnames[MATH_UNDERSET_CODE] = InsetName("mathunderset");
 168         insetnames[MATH_UNKNOWN_CODE] = InsetName("mathunknown");
 169         insetnames[MATH_XARROW_CODE] = InsetName("mathxarrow");
 170         insetnames[MATH_XYARROW_CODE] = InsetName("mathxyarrow");
 171         insetnames[MATH_XYMATRIX_CODE] = InsetName("mathxymatrix");
 172         insetnames[MATH_DIAGRAM_CODE] = InsetName("mathdiagram");
 173         insetnames[MATH_MACRO_CODE] = InsetName("mathmacro");
 174
 175         passed = true;
 176 }
 177
 178
 179 void Inset::setBuffer(Buffer & buffer)
 180 {
 181         buffer_ = &buffer;
 182 }
 183
 184
 185 Buffer & Inset::buffer()
 186 {
 187         if (!buffer_) {
 188                 odocstringstream s;
 189                 string const iname = insetName(lyxCode());
 190                 LYXERR0("Inset: " << this << " LyX Code: " << lyxCode()
 191                                         << " name: " << iname);
 192                 s << "LyX Code: " << lyxCode() << " name: " << iname;
 193                 LASSERT(false, /**/);
 194                 throw ExceptionMessage(BufferException,
 195                         from_ascii("Inset::buffer_ member not initialized!"), s.str());
 196         }
 197         return *buffer_;
 198 }
 199
 200
 201 Buffer const & Inset::buffer() const
 202 {
 203         return const_cast<Inset *>(this)->buffer();
 204 }
 205
 206
 207 bool Inset::isBufferLoaded() const
 208 {
 209         return buffer_ && theBufferList().isLoaded(buffer_);
 210 }
 211
 212
 213 bool Inset::isBufferValid() const
 214 {
 215         return buffer_
 216                 && (isBufferLoaded() || buffer_->isClone());
 217 }
 218
 219
 220 docstring Inset::layoutName() const
 221 {
 222         return from_ascii("unknown");
 223 }
 224
 225
 226 bool Inset::isFreeSpacing() const
 227 {
 228         return getLayout().isFreeSpacing();
 229 }
 230
 231
 232 bool Inset::allowEmpty() const
 233 {
 234         return getLayout().isKeepEmpty();
 235 }
 236
 237
 238 bool Inset::forceLTR() const
 239 {
 240         return getLayout().forceLTR();
 241 }
 242
 243
 244 bool Inset::isInToc() const
 245 {
 246         return getLayout().isInToc();
 247 }
 248
 249
 250 docstring Inset::toolTip(BufferView const &, int, int) const
 251 {
 252         return docstring();
 253 }
 254
 255
 256 void Inset::forToc(docstring &, size_t) const
 257 {
 258 }
 259
 260
 261 string Inset::contextMenu(BufferView const &, int, int) const
 262 {
 263         return contextMenuName();
 264 }
 265
 266
 267 string Inset::contextMenuName() const
 268 {
 269         return string();
 270 }
 271
 272
 273 Dimension const Inset::dimension(BufferView const & bv) const
 274 {
 275         return bv.coordCache().getInsets().dim(this);
 276 }
 277
 278
 279 InsetCode insetCode(string const & name)
 280 {
 281         build_translator();
 282         for (int i = 1; i != int(INSET_CODE_SIZE); ++i) {
 283                 if (insetnames[i].name == name)
 284                         return InsetCode(i);
 285         }
 286         return NO_CODE;
 287 }
 288
 289
 290 string insetName(InsetCode c)
 291 {
 292         build_translator();
 293         return insetnames[c].name;
 294 }
 295
 296
 297 docstring insetDisplayName(InsetCode c)
 298 {
 299         build_translator();
 300         return insetnames[c].display_name;
 301 }
 302
 303
 304 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 305 {
 306         if (buffer_ == 0) {
 307                 lyxerr << "Unassigned buffer_ member in Inset::dispatch()" << std::endl;
 308                 lyxerr << "LyX Code: " << lyxCode() << " name: "
 309                        << insetName(lyxCode()) << std::endl;
 310         } else if (cur.buffer() != buffer_)
 311                 lyxerr << "cur.buffer() != buffer_ in Inset::dispatch()" << std::endl;
 312         cur.screenUpdateFlags(Update::Force | Update::FitCursor);
 313         cur.dispatched();
 314         doDispatch(cur, cmd);
 315 }
 316
 317
 318 bool Inset::showInsetDialog(BufferView * bv) const
 319 {
 320         InsetCode const code = lyxCode();
 321         switch (code){
 322         case ERT_CODE:
 323         case FLOAT_CODE:
 324         case BOX_CODE:
 325         case BIBITEM_CODE:
 326         case BRANCH_CODE:
 327         case INFO_CODE:
 328         case MATH_SPACE_CODE:
 329         case SPACE_CODE:
 330         case TABULAR_CODE:
 331         case VSPACE_CODE:
 332                 bv->showDialog(insetName(code));
 333                 break;
 334         default:
 335                 return false;
 336         }
 337         return true;
 338 }
 339
 340
 341 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
 342 {
 343         switch (cmd.action()) {
 344         case LFUN_MOUSE_RELEASE:
 345                 // if the derived inset did not explicitly handle mouse_release,
 346                 // we assume we request the settings dialog
 347                 if (!cur.selection() && cmd.button() == mouse_button::button1
 348                           && hasSettings()) {
 349                         FuncRequest tmpcmd(LFUN_INSET_SETTINGS);
 350                         dispatch(cur, tmpcmd);
 351                 }
 352                 break;
 353
 354         case LFUN_INSET_SETTINGS:
 355                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 356                         showInsetDialog(&cur.bv());
 357                         cur.dispatched();
 358                 } else
 359                         cur.undispatched();
 360                 break;
 361
 362         default:
 363                 cur.noScreenUpdate();
 364                 cur.undispatched();
 365                 break;
 366         }
 367 }
 368
 369
 370 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 371         FuncStatus & flag) const
 372 {
 373         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 374         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 375         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 376         // not belong to us, i. e. the dialog was open, and the user moved
 377         // the cursor in our inset) in lyx::getStatus().
 378         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 379         // LFUN_INSET_APPLY is disabled.
 380
 381         switch (cmd.action()) {
 382         case LFUN_INSET_MODIFY:
 383                 // Allow modification of our data.
 384                 // This needs to be handled in the doDispatch method of our
 385                 // instantiatable children.
 386                 // FIXME: Why don't we let the insets determine whether this
 387                 // should be enabled or not ? Now we need this check for
 388                 // the tabular features. (vfr)
 389                 if (cmd.getArg(0) == "tabular")
 390                         return false;
 391                 flag.setEnabled(true);
 392                 return true;
 393
 394         case LFUN_INSET_INSERT:
 395                 // Don't allow insertion of new insets.
 396                 // Every inset that wants to allow new insets from open
 397                 // dialogs needs to override this.
 398                 flag.setEnabled(false);
 399                 return true;
 400
 401         case LFUN_INSET_SETTINGS:
 402                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 403                         bool const enable = hasSettings();
 404                         flag.setEnabled(enable);
 405                         return true;
 406                 } else {
 407                         return false;
 408                 }
 409
 410         case LFUN_IN_MATHMACROTEMPLATE:
 411                 // By default we're not in a MathMacroTemplate inset
 412                 flag.setEnabled(false);
 413                 return true;
 414
 415         default:
 416                 break;
 417         }
 418         return false;
 419 }
 420
 421
 422 void Inset::edit(Cursor &, bool, EntryDirection)
 423 {
 424         LYXERR(Debug::INSETS, "edit left/right");
 425 }
 426
 427
 428 Inset * Inset::editXY(Cursor &, int x, int y)
 429 {
 430         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
 431         return this;
 432 }
 433
 434
 435 Inset::idx_type Inset::index(row_type row, col_type col) const
 436 {
 437         if (row != 0)
 438                 LYXERR0("illegal row: " << row);
 439         if (col != 0)
 440                 LYXERR0("illegal col: " << col);
 441         return 0;
 442 }
 443
 444
 445 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 446 {
 447         return from <= idx && idx <= to;
 448 }
 449
 450
 451 bool Inset::idxUpDown(Cursor &, bool) const
 452 {
 453         return false;
 454 }
 455
 456
 457 int Inset::docbook(odocstream &, OutputParams const &) const
 458 {
 459         return 0;
 460 }
 461
 462
 463 docstring Inset::xhtml(XHTMLStream & xs, OutputParams const &) const
 464 {
 465         xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
 466         return docstring();
 467 }
 468
 469
 470 bool Inset::directWrite() const
 471 {
 472         return false;
 473 }
 474
 475
 476 bool Inset::editable() const
 477 {
 478         return false;
 479 }
 480
 481
 482 bool Inset::hasSettings() const
 483 {
 484         return false;
 485 }
 486
 487
 488
 489 bool Inset::autoDelete() const
 490 {
 491         return false;
 492 }
 493
 494
 495 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 496                 bool, int & x, int & y) const
 497 {
 498         LYXERR0("Inset::cursorPos called directly");
 499         x = 100;
 500         y = 100;
 501 }
 502
 503
 504 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 505 {
 506         dim.wid += 2 * framesize;
 507         dim.des += framesize;
 508 }
 509
 510
 511 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 512 {
 513         dim.wid += 2 * framesize;
 514         dim.asc += framesize;
 515         dim.des += framesize;
 516 }
 517
 518
 519 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 520 {
 521         ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
 522                 Color_mathframe : Color_mathcorners;
 523
 524         Dimension const dim = dimension(*pi.base.bv);
 525
 526         int const t = x + dim.width() - 1;
 527         int const d = y + dim.descent();
 528         pi.pain.line(x, d - 3, x, d, pen_color);
 529         pi.pain.line(t, d - 3, t, d, pen_color);
 530         pi.pain.line(x, d, x + 3, d, pen_color);
 531         pi.pain.line(t - 3, d, t, d, pen_color);
 532         setPosCache(pi, x, y);
 533 }
 534
 535
 536 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
 537 {
 538         ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
 539                 Color_mathframe : Color_mathcorners;
 540
 541         drawMarkers(pi, x, y);
 542         Dimension const dim = dimension(*pi.base.bv);
 543         int const t = x + dim.width() - 1;
 544         int const a = y - dim.ascent();
 545         pi.pain.line(x, a + 3, x, a, pen_color);
 546         pi.pain.line(t, a + 3, t, a, pen_color);
 547         pi.pain.line(x, a, x + 3, a, pen_color);
 548         pi.pain.line(t - 3, a, t, a, pen_color);
 549         setPosCache(pi, x, y);
 550 }
 551
 552
 553 bool Inset::editing(BufferView const * bv) const
 554 {
 555         return bv->cursor().isInside(this);
 556 }
 557
 558
 559 int Inset::xo(BufferView const & bv) const
 560 {
 561         return bv.coordCache().getInsets().x(this);
 562 }
 563
 564
 565 int Inset::yo(BufferView const & bv) const
 566 {
 567         return bv.coordCache().getInsets().y(this);
 568 }
 569
 570
 571 bool Inset::covers(BufferView const & bv, int x, int y) const
 572 {
 573         return bv.coordCache().getInsets().covers(this, x, y);
 574 }
 575
 576
 577 InsetLayout const & Inset::getLayout() const
 578 {
 579         if (!buffer_)
 580                 return DocumentClass::plainInsetLayout();
 581         return buffer().params().documentClass().insetLayout(layoutName());
 582 }
 583
 584
 585 bool Inset::undefined() const
 586 {
 587         docstring const & n = getLayout().name();
 588         return n.empty() || n == DocumentClass::plainInsetLayout().name();
 589 }
 590
 591
 592 void Inset::dump() const
 593 {
 594         write(lyxerr);
 595 }
 596
 597
 598 ColorCode Inset::backgroundColor(PainterInfo const & /*pi*/) const
 599 {
 600         return Color_none;
 601 }
 602
 603
 604 ColorCode Inset::labelColor() const
 605 {
 606         return Color_foreground;
 607 }
 608
 609
 610 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
 611 {
 612         //LYXERR("Inset: set position cache to " << x << " " << y);
 613         pi.base.bv->coordCache().insets().add(this, x, y);
 614 }
 615
 616
 617 void Inset::setDimCache(MetricsInfo const & mi, Dimension const & dim) const
 618 {
 619         mi.base.bv->coordCache().insets().add(this, dim);
 620 }
 621
 622
 623 Buffer const * Inset::updateFrontend() const
 624 {
 625         //FIXME (Abdel 03/12/10): see bugs #6814 and #6949
 626         // If the Buffer is null and we end up here this is most probably because we
 627         // are in the CutAndPaste stack. See InsetGraphics, RenderGraphics and
 628         // RenderPreview.
 629         if (!buffer_)
 630                 return 0;
 631         return theApp() ? theApp()->updateInset(this) : 0;
 632 }
 633
 634
 635 docstring Inset::completionPrefix(Cursor const &) const
 636 {
 637         return docstring();
 638 }
 639
 640 } // namespace lyx