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