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 InsetLayout const & Inset::getLayout() const
 241 {
 242         if (!buffer_)
 243                 return DocumentClass::plainInsetLayout();
 244         return buffer().params().documentClass().insetLayout(layoutName());
 245 }
 246
 247
 248 bool Inset::isPassThru() const
 249 {
 250         return getLayout().isPassThru();
 251 }
 252
 253
 254 bool Inset::isFreeSpacing() const
 255 {
 256         return getLayout().isFreeSpacing();
 257 }
 258
 259
 260 bool Inset::allowEmpty() const
 261 {
 262         return getLayout().isKeepEmpty();
 263 }
 264
 265
 266 bool Inset::forceLTR(OutputParams const &) const
 267 {
 268         return getLayout().forceLTR();
 269 }
 270
 271
 272 bool Inset::isInToc() const
 273 {
 274         return getLayout().isInToc();
 275 }
 276
 277
 278 FontInfo Inset::getFont() const
 279 {
 280         return getLayout().font();
 281 }
 282
 283
 284 FontInfo Inset::getLabelfont() const
 285 {
 286         return getLayout().labelfont();
 287 }
 288
 289
 290 docstring Inset::toolTip(BufferView const &, int, int) const
 291 {
 292         return docstring();
 293 }
 294
 295
 296 void Inset::forOutliner(docstring &, size_t const, bool const) const
 297 {
 298 }
 299
 300
 301 string Inset::contextMenu(BufferView const &, int, int) const
 302 {
 303         return contextMenuName();
 304 }
 305
 306
 307 string Inset::contextMenuName() const
 308 {
 309         return string();
 310 }
 311
 312
 313 Dimension const Inset::dimension(BufferView const & bv) const
 314 {
 315         return bv.coordCache().getInsets().dim(this);
 316 }
 317
 318
 319 InsetCode insetCode(string const & name)
 320 {
 321         build_translator();
 322         for (int i = 1; i != int(INSET_CODE_SIZE); ++i) {
 323                 if (insetnames[i].name == name)
 324                         return InsetCode(i);
 325         }
 326         return NO_CODE;
 327 }
 328
 329
 330 string insetName(InsetCode c)
 331 {
 332         build_translator();
 333         return insetnames[c].name;
 334 }
 335
 336
 337 docstring insetDisplayName(InsetCode c)
 338 {
 339         build_translator();
 340         return insetnames[c].display_name;
 341 }
 342
 343
 344 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 345 {
 346         if (buffer_ == nullptr) {
 347                 lyxerr << "Unassigned buffer_ member in Inset::dispatch()" << std::endl;
 348                 lyxerr << "LyX Code: " << lyxCode() << " name: "
 349                        << insetName(lyxCode()) << std::endl;
 350         } else if (cur.buffer() != buffer_)
 351                 lyxerr << "cur.buffer() != buffer_ in Inset::dispatch()" << std::endl;
 352         cur.screenUpdateFlags(Update::Force | Update::FitCursor);
 353         cur.dispatched();
 354         doDispatch(cur, cmd);
 355         if (cmd.origin() == FuncRequest::TOC)
 356                 cur.bv().processUpdateFlags(cur.result().screenUpdate());
 357 }
 358
 359
 360 bool Inset::showInsetDialog(BufferView * bv) const
 361 {
 362         InsetCode const code = lyxCode();
 363         switch (code){
 364         case ERT_CODE:
 365         case FLOAT_CODE:
 366         case BOX_CODE:
 367         case BIBITEM_CODE:
 368         case BRANCH_CODE:
 369         case INFO_CODE:
 370         case MATH_SPACE_CODE:
 371         case SPACE_CODE:
 372         case TABULAR_CODE:
 373         case VSPACE_CODE:
 374                 bv->showDialog(insetName(code));
 375                 break;
 376         default:
 377                 return false;
 378         }
 379         return true;
 380 }
 381
 382
 383 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
 384 {
 385         switch (cmd.action()) {
 386         case LFUN_MOUSE_RELEASE:
 387                 // if the derived inset did not explicitly handle mouse_release,
 388                 // we assume we request the settings dialog
 389                 if (!cur.selection() && cmd.button() == mouse_button::button1
 390                     && clickable(cur.bv(), cmd.x(), cmd.y()) && hasSettings()) {
 391                         FuncRequest tmpcmd(LFUN_INSET_SETTINGS);
 392                         dispatch(cur, tmpcmd);
 393                 }
 394                 break;
 395
 396         case LFUN_INSET_SETTINGS:
 397                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 398                         showInsetDialog(&cur.bv());
 399                         cur.dispatched();
 400                 } else
 401                         cur.undispatched();
 402                 break;
 403
 404         default:
 405                 cur.noScreenUpdate();
 406                 cur.undispatched();
 407                 break;
 408         }
 409 }
 410
 411
 412 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 413         FuncStatus & status) const
 414 {
 415         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 416         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 417         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 418         // not belong to us, i. e. the dialog was open, and the user moved
 419         // the cursor in our inset) in lyx::getStatus().
 420         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 421         // LFUN_INSET_APPLY is disabled.
 422
 423         switch (cmd.action()) {
 424         case LFUN_INSET_MODIFY:
 425                 // Allow modification of our data.
 426                 // This needs to be handled in the doDispatch method of our
 427                 // instantiatable children.
 428                 status.setEnabled(true);
 429                 return true;
 430
 431         case LFUN_INSET_INSERT:
 432                 // Don't allow insertion of new insets.
 433                 // Every inset that wants to allow new insets from open
 434                 // dialogs needs to override this.
 435                 status.setEnabled(false);
 436                 return true;
 437
 438         case LFUN_INSET_SETTINGS:
 439                 if (cmd.argument().empty() || cmd.getArg(0) == insetName(lyxCode())) {
 440                         bool const enable = hasSettings();
 441                         status.setEnabled(enable);
 442                         return true;
 443                 } else {
 444                         return false;
 445                 }
 446
 447         case LFUN_IN_MATHMACROTEMPLATE:
 448                 // By default we're not in a InsetMathMacroTemplate inset
 449                 status.setEnabled(false);
 450                 return true;
 451
 452         case LFUN_IN_IPA:
 453                 // By default we're not in an IPA inset
 454                 status.setEnabled(false);
 455                 return true;
 456
 457         default:
 458                 break;
 459         }
 460         return false;
 461 }
 462
 463
 464 void Inset::edit(Cursor &, bool, EntryDirection)
 465 {
 466         LYXERR(Debug::INSETS, "edit left/right");
 467 }
 468
 469
 470 Inset * Inset::editXY(Cursor &, int x, int y)
 471 {
 472         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
 473         return this;
 474 }
 475
 476
 477 idx_type Inset::index(row_type row, col_type col) const
 478 {
 479         if (row != 0)
 480                 LYXERR0("illegal row: " << row);
 481         if (col != 0)
 482                 LYXERR0("illegal col: " << col);
 483         return 0;
 484 }
 485
 486
 487 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 488 {
 489         return from <= idx && idx <= to;
 490 }
 491
 492
 493 bool Inset::idxUpDown(Cursor &, bool) const
 494 {
 495         return false;
 496 }
 497
 498
 499 void Inset::docbook(XMLStream & xs, OutputParams const &) const
 500 {
 501         xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
 502 }
 503
 504
 505 docstring Inset::xhtml(XMLStream & xs, OutputParams const &) const
 506 {
 507         xs << "[[Inset: " << from_ascii(insetName(lyxCode())) << "]]";
 508         return docstring();
 509 }
 510
 511
 512 bool Inset::directWrite() const
 513 {
 514         return false;
 515 }
 516
 517
 518 bool Inset::editable() const
 519 {
 520         return false;
 521 }
 522
 523
 524 bool Inset::hasSettings() const
 525 {
 526         return false;
 527 }
 528
 529
 530
 531 bool Inset::autoDelete() const
 532 {
 533         return false;
 534 }
 535
 536
 537 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 538                 bool, int & x, int & y) const
 539 {
 540         LYXERR0("Inset::cursorPos called directly");
 541         x = 100;
 542         y = 100;
 543 }
 544
 545
 546 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 547 {
 548         dim.wid += 2 * framesize;
 549         dim.des += framesize;
 550 }
 551
 552
 553 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 554 {
 555         dim.wid += 2 * framesize;
 556         dim.asc += framesize;
 557         dim.des += framesize;
 558 }
 559
 560
 561 void Inset::drawBackground(PainterInfo & pi, int x, int y) const
 562 {
 563         if (pi.full_repaint && backgroundColor(pi) == Color_none)
 564                 return;
 565         Dimension const dim = dimension(*pi.base.bv);
 566         pi.pain.fillRectangle(x, y - dim.asc, dim.wid, dim.asc + dim.des,
 567                               pi.backgroundColor(this));
 568 }
 569
 570
 571 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 572 {
 573         ColorCode pen_color = mouseHovered(pi.base.bv) || editing(pi.base.bv)?
 574                 Color_mathframe : Color_mathcorners;
 575
 576         Dimension const dim = dimension(*pi.base.bv);
 577
 578         int const t = x + dim.width() - 1;
 579         int const d = y + dim.descent();
 580         pi.pain.line(x, d - 3, x, d, pen_color);
 581         pi.pain.line(t, d - 3, t, d, pen_color);
 582         pi.pain.line(x, d, x + 3, d, pen_color);
 583         pi.pain.line(t - 3, d, t, d, pen_color);
 584 }
 585
 586
 587 bool Inset::editing(BufferView const * bv) const
 588 {
 589         if (bv->mouseSelecting())
 590                 // Avoid flicker when selecting with the mouse: when so, do not make
 591                 // decisions about metrics based on the mouse location.
 592                 return bv->cursor().realAnchor().isInside(this);
 593         else
 594                 return bv->cursor().isInside(this);
 595 }
 596
 597
 598 int Inset::xo(BufferView const & bv) const
 599 {
 600         return bv.coordCache().getInsets().x(this);
 601 }
 602
 603
 604 int Inset::yo(BufferView const & bv) const
 605 {
 606         return bv.coordCache().getInsets().y(this);
 607 }
 608
 609
 610 bool Inset::covers(BufferView const & bv, int x, int y) const
 611 {
 612         return bv.coordCache().getInsets().covers(this, x, y);
 613 }
 614
 615
 616 bool Inset::undefined() const
 617 {
 618         docstring const & n = getLayout().name();
 619         return n.empty() || n == DocumentClass::plainInsetLayout().name();
 620 }
 621
 622
 623 CtObject Inset::getCtObject(OutputParams const &) const
 624 {
 625         return CtObject::Normal;
 626 }
 627
 628
 629 void Inset::dump() const
 630 {
 631         write(lyxerr);
 632 }
 633
 634
 635 ColorCode Inset::backgroundColor(PainterInfo const & /*pi*/) const
 636 {
 637         return Color_none;
 638 }
 639
 640
 641 ColorCode Inset::labelColor() const
 642 {
 643         return Color_foreground;
 644 }
 645
 646
 647 Buffer const * Inset::updateFrontend() const
 648 {
 649         //FIXME (Abdel 03/12/10): see bugs #6814 and #6949
 650         // If the Buffer is null and we end up here this is most probably because we
 651         // are in the CutAndPaste stack. See InsetGraphics, RenderGraphics and
 652         // RenderPreview.
 653         if (!buffer_)
 654                 return nullptr;
 655         return theApp() ? theApp()->updateInset(this) : nullptr;
 656 }
 657
 658
 659 bool Inset::resetFontEdit() const
 660 {
 661         return getLayout().resetsFont() || !inheritFont();
 662 }
 663
 664
 665 docstring Inset::completionPrefix(Cursor const &) const
 666 {
 667         return docstring();
 668 }
 669
 670 } // namespace lyx