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