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/convert.h"
  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, InsetCode c) : name(n), code(c) {}
  54         string name;
  55         InsetCode code;
  56 };
  57
  58
  59 typedef map<string, InsetCode> TranslatorMap;
  60
  61
  62 static TranslatorMap const build_translator()
  63 {
  64         InsetName const insetnames[] = {
  65                 InsetName("toc", TOC_CODE),
  66                 InsetName("quote", QUOTE_CODE),
  67                 InsetName("ref", REF_CODE),
  68                 InsetName("href", HYPERLINK_CODE),
  69                 InsetName("separator", SEPARATOR_CODE),
  70                 InsetName("ending", ENDING_CODE),
  71                 InsetName("label", LABEL_CODE),
  72                 InsetName("note", NOTE_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", MATHMACROARG_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         };
 111
 112         size_t const insetnames_size =
 113                 sizeof(insetnames) / sizeof(insetnames[0]);
 114
 115         map<string, InsetCode> data;
 116         for (size_t i = 0; i != insetnames_size; ++i) {
 117                 InsetName const & var = insetnames[i];
 118                 data[var.name] = var.code;
 119         }
 120
 121         return data;
 122 }
 123
 124
 125 void Inset::setBuffer(Buffer & buffer)
 126 {
 127         buffer_ = &buffer;
 128 }
 129
 130
 131 Buffer & Inset::buffer()
 132 {
 133         if (!buffer_) {
 134                 odocstringstream s;
 135                 lyxerr << "LyX Code: " << lyxCode() << " name: " << name() << std::endl;
 136                 s << "LyX Code: " << lyxCode() << " name: " << name();
 137                 LASSERT(false, /**/);
 138                 throw ExceptionMessage(BufferException,
 139                         from_ascii("Inset::buffer_ member not initialized!"), s.str());
 140         }
 141         return *buffer_;
 142 }
 143
 144
 145 Buffer const & Inset::buffer() const
 146 {
 147         return const_cast<Inset *>(this)->buffer();
 148 }
 149
 150
 151 bool Inset::isBufferValid() const
 152 {
 153         return buffer_ && theBufferList().isLoaded(buffer_);
 154 }
 155
 156
 157 docstring Inset::name() const
 158 {
 159         return from_ascii("unknown");
 160 }
 161
 162
 163 void Inset::initView()
 164 {
 165         if (isLabeled())
 166                 lyx::updateLabels(buffer());
 167 }
 168
 169
 170 docstring Inset::toolTip(BufferView const &, int, int) const
 171 {
 172         return docstring();
 173 }
 174
 175
 176 docstring Inset::contextMenu(BufferView const &, int, int) const
 177 {
 178         return docstring();
 179 }
 180
 181
 182 Dimension const Inset::dimension(BufferView const & bv) const
 183 {
 184         return bv.coordCache().getInsets().dim(this);
 185 }
 186
 187
 188 InsetCode insetCode(string const & name)
 189 {
 190         static TranslatorMap const translator = build_translator();
 191
 192         TranslatorMap::const_iterator it = translator.find(name);
 193         return it == translator.end() ? NO_CODE : it->second;
 194 }
 195
 196
 197 string insetName(InsetCode c)
 198 {
 199         static TranslatorMap const translator = build_translator();
 200
 201         TranslatorMap::const_iterator it =  translator.begin();
 202         TranslatorMap::const_iterator end = translator.end();
 203         for (; it != end; ++it) {
 204                 if (it->second == c)
 205                         return it->first;
 206         }
 207         return string();
 208 }
 209
 210
 211 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 212 {
 213         cur.updateFlags(Update::Force | Update::FitCursor);
 214         cur.dispatched();
 215         doDispatch(cur, cmd);
 216 }
 217
 218
 219 void Inset::doDispatch(Cursor & cur, FuncRequest &cmd)
 220 {
 221         switch (cmd.action) {
 222         case LFUN_INSET_TOGGLE:
 223                 edit(cur, true);
 224                 cur.dispatched();
 225                 break;
 226         default:
 227                 cur.noUpdate();
 228                 cur.undispatched();
 229                 break;
 230         }
 231 }
 232
 233
 234 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 235         FuncStatus & flag) const
 236 {
 237         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 238         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 239         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 240         // not belong to us, i. e. the dialog was open, and the user moved
 241         // the cursor in our inset) in LyXFunc::getStatus().
 242         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 243         // LFUN_INSET_APPLY is disabled.
 244
 245         switch (cmd.action) {
 246         case LFUN_INSET_MODIFY:
 247                 // Allow modification of our data.
 248                 // This needs to be handled in the doDispatch method of our
 249                 // instantiatable children.
 250                 flag.setEnabled(true);
 251                 return true;
 252
 253         case LFUN_INSET_INSERT:
 254                 // Don't allow insertion of new insets.
 255                 // Every inset that wants to allow new insets from open
 256                 // dialogs needs to override this.
 257                 flag.setEnabled(false);
 258                 return true;
 259
 260         case LFUN_INSET_TOGGLE:
 261                 // remove this if we dissociate toggle from edit.
 262                 flag.setEnabled(editable() == IS_EDITABLE);
 263                 return true;
 264
 265         default:
 266                 break;
 267         }
 268         return false;
 269 }
 270
 271
 272 void Inset::edit(Cursor &, bool, EntryDirection)
 273 {
 274         LYXERR(Debug::INSETS, "edit left/right");
 275 }
 276
 277
 278 Inset * Inset::editXY(Cursor &, int x, int y)
 279 {
 280         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
 281         return this;
 282 }
 283
 284
 285 Inset::idx_type Inset::index(row_type row, col_type col) const
 286 {
 287         if (row != 0)
 288                 LYXERR0("illegal row: " << row);
 289         if (col != 0)
 290                 LYXERR0("illegal col: " << col);
 291         return 0;
 292 }
 293
 294
 295 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 296 {
 297         return from <= idx && idx <= to;
 298 }
 299
 300
 301 bool Inset::idxUpDown(Cursor &, bool) const
 302 {
 303         return false;
 304 }
 305
 306
 307 int Inset::docbook(odocstream &, OutputParams const &) const
 308 {
 309         return 0;
 310 }
 311
 312
 313 bool Inset::directWrite() const
 314 {
 315         return false;
 316 }
 317
 318
 319 Inset::EDITABLE Inset::editable() const
 320 {
 321         return NOT_EDITABLE;
 322 }
 323
 324
 325 bool Inset::autoDelete() const
 326 {
 327         return false;
 328 }
 329
 330
 331 docstring Inset::editMessage() const
 332 {
 333         return _("Opened inset");
 334 }
 335
 336
 337 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 338                 bool, int & x, int & y) const
 339 {
 340         LYXERR0("Inset::cursorPos called directly");
 341         x = 100;
 342         y = 100;
 343 }
 344
 345
 346 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 347 {
 348         dim.wid += 2 * framesize;
 349         dim.des += framesize;
 350 }
 351
 352
 353 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 354 {
 355         dim.wid += 2 * framesize;
 356         dim.asc += framesize;
 357         dim.des += framesize;
 358 }
 359
 360
 361 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 362 {
 363         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
 364                 Color_mathframe : Color_mathcorners;
 365
 366         Dimension const dim = dimension(*pi.base.bv);
 367
 368         int const t = x + dim.width() - 1;
 369         int const d = y + dim.descent();
 370         pi.pain.line(x, d - 3, x, d, pen_color);
 371         pi.pain.line(t, d - 3, t, d, pen_color);
 372         pi.pain.line(x, d, x + 3, d, pen_color);
 373         pi.pain.line(t - 3, d, t, d, pen_color);
 374         setPosCache(pi, x, y);
 375 }
 376
 377
 378 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
 379 {
 380         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
 381                 Color_mathframe : Color_mathcorners;
 382
 383         drawMarkers(pi, x, y);
 384         Dimension const dim = dimension(*pi.base.bv);
 385         int const t = x + dim.width() - 1;
 386         int const a = y - dim.ascent();
 387         pi.pain.line(x, a + 3, x, a, pen_color);
 388         pi.pain.line(t, a + 3, t, a, pen_color);
 389         pi.pain.line(x, a, x + 3, a, pen_color);
 390         pi.pain.line(t - 3, a, t, a, pen_color);
 391         setPosCache(pi, x, y);
 392 }
 393
 394
 395 bool Inset::editing(BufferView const * bv) const
 396 {
 397         return bv->cursor().isInside(this);
 398 }
 399
 400
 401 int Inset::xo(BufferView const & bv) const
 402 {
 403         return bv.coordCache().getInsets().x(this);
 404 }
 405
 406
 407 int Inset::yo(BufferView const & bv) const
 408 {
 409         return bv.coordCache().getInsets().y(this);
 410 }
 411
 412
 413 bool Inset::covers(BufferView const & bv, int x, int y) const
 414 {
 415         return bv.coordCache().getInsets().covers(this, x, y);
 416 }
 417
 418
 419 InsetLayout const & Inset::getLayout(BufferParams const & bp) const
 420 {
 421         return bp.documentClass().insetLayout(name());
 422 }
 423
 424
 425 void Inset::dump() const
 426 {
 427         write(lyxerr);
 428 }
 429
 430
 431 ColorCode Inset::backgroundColor() const
 432 {
 433         return Color_background;
 434 }
 435
 436
 437 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
 438 {
 439         //LYXERR("Inset: set position cache to " << x << " " << y);
 440         pi.base.bv->coordCache().insets().add(this, x, y);
 441 }
 442
 443
 444 void Inset::setDimCache(MetricsInfo const & mi, Dimension const & dim) const
 445 {
 446         mi.base.bv->coordCache().insets().add(this, dim);
 447 }
 448
 449
 450 Buffer const * Inset::updateFrontend() const
 451 {
 452         return theApp() ? theApp()->updateInset(this) : 0;
 453 }
 454
 455
 456 docstring Inset::completionPrefix(Cursor const &) const
 457 {
 458         return docstring();
 459 }
 460
 461 } // namespace lyx