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.h"
  20 #include "BufferParams.h"
  21 #include "BufferView.h"
  22 #include "Color.h"
  23 #include "CoordCache.h"
  24 #include "Cursor.h"
  25 #include "debug.h"
  26 #include "debug.h"
  27 #include "Dimension.h"
  28 #include "DispatchResult.h"
  29 #include "FuncRequest.h"
  30 #include "FuncStatus.h"
  31 #include "gettext.h"
  32 #include "Text.h"
  33 #include "TextClass.h"
  34 #include "MetricsInfo.h"
  35 #include "MetricsInfo.h"
  36
  37 #include "frontends/Painter.h"
  38
  39 #include <boost/current_function.hpp>
  40
  41 #include <map>
  42 #include <typeinfo>
  43
  44
  45 namespace lyx {
  46
  47 class InsetName {
  48 public:
  49         InsetName(std::string const & n, Inset::Code c)
  50                 : name(n), code(c) {}
  51         std::string name;
  52         Inset::Code code;
  53 };
  54
  55
  56 typedef std::map<std::string, Inset::Code> TranslatorMap;
  57
  58
  59 static TranslatorMap const build_translator()
  60 {
  61         InsetName const insetnames[] = {
  62                 InsetName("toc", Inset::TOC_CODE),
  63                 InsetName("quote", Inset::QUOTE_CODE),
  64                 InsetName("ref", Inset::REF_CODE),
  65                 InsetName("url", Inset::URL_CODE),
  66                 InsetName("htmlurl", Inset::HTMLURL_CODE),
  67                 InsetName("separator", Inset::SEPARATOR_CODE),
  68                 InsetName("ending", Inset::ENDING_CODE),
  69                 InsetName("label", Inset::LABEL_CODE),
  70                 InsetName("note", Inset::NOTE_CODE),
  71                 InsetName("accent", Inset::ACCENT_CODE),
  72                 InsetName("math", Inset::MATH_CODE),
  73                 InsetName("index", Inset::INDEX_CODE),
  74                 InsetName("nomenclature", Inset::NOMENCL_CODE),
  75                 InsetName("include", Inset::INCLUDE_CODE),
  76                 InsetName("graphics", Inset::GRAPHICS_CODE),
  77                 InsetName("bibitem", Inset::BIBITEM_CODE),
  78                 InsetName("bibtex", Inset::BIBTEX_CODE),
  79                 InsetName("text", Inset::TEXT_CODE),
  80                 InsetName("ert", Inset::ERT_CODE),
  81                 InsetName("foot", Inset::FOOT_CODE),
  82                 InsetName("margin", Inset::MARGIN_CODE),
  83                 InsetName("float", Inset::FLOAT_CODE),
  84                 InsetName("wrap", Inset::WRAP_CODE),
  85                 InsetName("specialchar", Inset::SPECIALCHAR_CODE),
  86                 InsetName("tabular", Inset::TABULAR_CODE),
  87                 InsetName("external", Inset::EXTERNAL_CODE),
  88                 InsetName("caption", Inset::CAPTION_CODE),
  89                 InsetName("mathmacro", Inset::MATHMACRO_CODE),
  90                 InsetName("cite", Inset::CITE_CODE),
  91                 InsetName("float_list", Inset::FLOAT_LIST_CODE),
  92                 InsetName("index_print", Inset::INDEX_PRINT_CODE),
  93                 InsetName("nomencl_print", Inset::NOMENCL_PRINT_CODE),
  94                 InsetName("optarg", Inset::OPTARG_CODE),
  95                 InsetName("environment", Inset::ENVIRONMENT_CODE),
  96                 InsetName("hfill", Inset::HFILL_CODE),
  97                 InsetName("newline", Inset::NEWLINE_CODE),
  98                 InsetName("line", Inset::LINE_CODE),
  99                 InsetName("branch", Inset::BRANCH_CODE),
 100                 InsetName("box", Inset::BOX_CODE),
 101                 InsetName("charstyle", Inset::CHARSTYLE_CODE),
 102                 InsetName("vspace", Inset::VSPACE_CODE),
 103                 InsetName("mathmacroarg", Inset::MATHMACROARG_CODE),
 104                 InsetName("listings", Inset::LISTINGS_CODE),
 105         };
 106
 107         std::size_t const insetnames_size =
 108                 sizeof(insetnames) / sizeof(insetnames[0]);
 109
 110         std::map<std::string, Inset::Code> data;
 111         for (std::size_t i = 0; i != insetnames_size; ++i) {
 112                 InsetName const & var = insetnames[i];
 113                 data[var.name] = var.code;
 114         }
 115
 116         return data;
 117 }
 118
 119
 120 /// pretty arbitrary dimensions
 121 Inset::Inset()
 122         : dim_(10, 10, 10)
 123 {}
 124
 125
 126 Inset::Code Inset::translate(std::string const & name)
 127 {
 128         static TranslatorMap const translator = build_translator();
 129
 130         TranslatorMap::const_iterator it = translator.find(name);
 131         return it == translator.end() ? NO_CODE : it->second;
 132 }
 133
 134
 135 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 136 {
 137         cur.updateFlags(Update::Force | Update::FitCursor);
 138         cur.dispatched();
 139         doDispatch(cur, cmd);
 140 }
 141
 142
 143 void Inset::doDispatch(Cursor & cur, FuncRequest &)
 144 {
 145         cur.noUpdate();
 146         cur.undispatched();
 147 }
 148
 149
 150 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 151         FuncStatus & flag) const
 152 {
 153         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 154         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 155         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 156         // not belong to us, i. e. the dialog was open, and the user moved
 157         // the cursor in our inset) in LyXFunc::getStatus().
 158         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 159         // LFUN_INSET_APPLY is disabled.
 160
 161         switch (cmd.action) {
 162         case LFUN_INSET_MODIFY:
 163                 // Allow modification of our data.
 164                 // This needs to be handled in the doDispatch method of our
 165                 // instantiatable children.
 166                 flag.enabled(true);
 167                 return true;
 168
 169         case LFUN_INSET_INSERT:
 170                 // Don't allow insertion of new insets.
 171                 // Every inset that wants to allow new insets from open
 172                 // dialogs needs to override this.
 173                 flag.enabled(false);
 174                 return true;
 175
 176         default:
 177                 return false;
 178         }
 179 }
 180
 181
 182 void Inset::edit(Cursor &, bool)
 183 {
 184         LYXERR(Debug::INSETS) << BOOST_CURRENT_FUNCTION
 185                               << ": edit left/right" << std::endl;
 186 }
 187
 188
 189 Inset * Inset::editXY(Cursor &, int x, int y)
 190 {
 191         LYXERR(Debug::INSETS) << BOOST_CURRENT_FUNCTION
 192                               << ": x=" << x << " y= " << y
 193                               << std::endl;
 194         return this;
 195 }
 196
 197
 198 Inset::idx_type Inset::index(row_type row, col_type col) const
 199 {
 200         if (row != 0)
 201                 lyxerr << BOOST_CURRENT_FUNCTION
 202                        << ": illegal row: " << row << std::endl;
 203         if (col != 0)
 204                 lyxerr << BOOST_CURRENT_FUNCTION
 205                        << ": illegal col: " << col << std::endl;
 206         return 0;
 207 }
 208
 209
 210 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 211 {
 212         return from <= idx && idx <= to;
 213 }
 214
 215
 216 bool Inset::idxUpDown(Cursor &, bool) const
 217 {
 218         return false;
 219 }
 220
 221
 222 int Inset::docbook(Buffer const &,
 223         odocstream &, OutputParams const &) const
 224 {
 225         return 0;
 226 }
 227
 228
 229 bool Inset::directWrite() const
 230 {
 231         return false;
 232 }
 233
 234
 235 Inset::EDITABLE Inset::editable() const
 236 {
 237         return NOT_EDITABLE;
 238 }
 239
 240
 241 bool Inset::autoDelete() const
 242 {
 243         return false;
 244 }
 245
 246
 247 docstring const Inset::editMessage() const
 248 {
 249         return _("Opened inset");
 250 }
 251
 252
 253 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 254                 bool, int & x, int & y) const
 255 {
 256         lyxerr << "Inset::cursorPos called directly" << std::endl;
 257         x = 100;
 258         y = 100;
 259 }
 260
 261
 262 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 263 {
 264         dim.wid += 2 * framesize;
 265         dim.des += framesize;
 266 }
 267
 268
 269 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 270 {
 271         dim.wid += 2 * framesize;
 272         dim.asc += framesize;
 273         dim.des += framesize;
 274 }
 275
 276
 277 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 278 {
 279         Color::color pen_color = mouseHovered() || editing(pi.base.bv)?
 280                 Color::mathframe : Color::mathcorners;
 281
 282         int const t = x + width() - 1;
 283         int const d = y + descent();
 284         pi.pain.line(x, d - 3, x, d, pen_color);
 285         pi.pain.line(t, d - 3, t, d, pen_color);
 286         pi.pain.line(x, d, x + 3, d, pen_color);
 287         pi.pain.line(t - 3, d, t, d, pen_color);
 288         setPosCache(pi, x, y);
 289 }
 290
 291
 292 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
 293 {
 294         Color::color pen_color = mouseHovered() || editing(pi.base.bv)?
 295                 Color::mathframe : Color::mathcorners;
 296
 297         drawMarkers(pi, x, y);
 298         int const t = x + width() - 1;
 299         int const a = y - ascent();
 300         pi.pain.line(x, a + 3, x, a, pen_color);
 301         pi.pain.line(t, a + 3, t, a, pen_color);
 302         pi.pain.line(x, a, x + 3, a, pen_color);
 303         pi.pain.line(t - 3, a, t, a, pen_color);
 304         setPosCache(pi, x, y);
 305 }
 306
 307
 308 bool Inset::editing(BufferView * bv) const
 309 {
 310         return bv->cursor().isInside(this);
 311 }
 312
 313
 314 int Inset::xo(BufferView const & bv) const
 315 {
 316         return bv.coordCache().getInsets().x(this);
 317 }
 318
 319
 320 int Inset::yo(BufferView const & bv) const
 321 {
 322         return bv.coordCache().getInsets().y(this);
 323 }
 324
 325
 326 bool Inset::covers(BufferView const & bv, int x, int y) const
 327 {
 328         //lyxerr << "Inset::covers, x: " << x << " y: " << y
 329         //      << " xo: " << xo(bv) << " yo: " << yo()
 330         //      << " x1: " << xo(bv) << " x2: " << xo() + width()
 331         //      << " y1: " << yo(bv) - ascent() << " y2: " << yo() + descent()
 332         //      << std::endl;
 333         return bv.coordCache().getInsets().has(this)
 334                         && x >= xo(bv)
 335                         && x <= xo(bv) + width()
 336                         && y >= yo(bv) - ascent()
 337                         && y <= yo(bv) + descent();
 338 }
 339
 340
 341 InsetLayout const & Inset::getLayout(BufferParams const & bp) const
 342 {
 343         return bp.getTextClass().insetlayout(name());
 344 }
 345
 346
 347 void Inset::dump() const
 348 {
 349         Buffer buf("foo", 1);
 350         write(buf, lyxerr);
 351 }
 352
 353
 354 Color_color Inset::backgroundColor() const
 355 {
 356         return Color::background;
 357 }
 358
 359
 360 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
 361 {
 362         //lyxerr << "Inset:: position cache to " << x << " " << y << std::endl;
 363         pi.base.bv->coordCache().insets().add(this, x, y);
 364 }
 365
 366
 367 /////////////////////////////////////////
 368
 369 bool isEditableInset(Inset const * inset)
 370 {
 371         return inset && inset->editable();
 372 }
 373
 374
 375 bool isHighlyEditableInset(Inset const * inset)
 376 {
 377         return inset && inset->editable() == Inset::HIGHLY_EDITABLE;
 378 }
 379
 380
 381 } // namespace lyx