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         };
 103
 104         std::size_t const insetnames_size =
 105                 sizeof(insetnames) / sizeof(insetnames[0]);
 106
 107         std::map<std::string, Inset::Code> data;
 108         for (std::size_t i = 0; i != insetnames_size; ++i) {
 109                 InsetName const & var = insetnames[i];
 110                 data[var.name] = var.code;
 111         }
 112
 113         return data;
 114 }
 115
 116
 117 /// pretty arbitrary dimensions
 118 Inset::Inset()
 119         : dim_(10, 10, 10), background_color_(Color::background)
 120 {}
 121
 122
 123 Inset::Inset(Inset const & inset)
 124         : dim_(inset.dim_), background_color_(inset.background_color_)
 125 {}
 126
 127
 128 std::auto_ptr<Inset> Inset::clone() const
 129 {
 130         std::auto_ptr<Inset> b = doClone();
 131         BOOST_ASSERT(typeid(*b) == typeid(*this));
 132         return b;
 133 }
 134
 135
 136 Inset::Code Inset::translate(std::string const & name)
 137 {
 138         static TranslatorMap const translator = build_translator();
 139
 140         TranslatorMap::const_iterator it = translator.find(name);
 141         return it == translator.end() ? NO_CODE : it->second;
 142 }
 143
 144
 145 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
 146 {
 147         cur.updateFlags(Update::Force | Update::FitCursor);
 148         cur.dispatched();
 149         doDispatch(cur, cmd);
 150 }
 151
 152
 153 void Inset::doDispatch(Cursor & cur, FuncRequest &)
 154 {
 155         cur.noUpdate();
 156         cur.undispatched();
 157 }
 158
 159
 160 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
 161         FuncStatus & flag) const
 162 {
 163         // LFUN_INSET_APPLY is sent from the dialogs when the data should
 164         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
 165         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
 166         // not belong to us, i. e. the dialog was open, and the user moved
 167         // the cursor in our inset) in LyXFunc::getStatus().
 168         // Dialogs::checkStatus() ensures that the dialog is deactivated if
 169         // LFUN_INSET_APPLY is disabled.
 170
 171         switch (cmd.action) {
 172         case LFUN_INSET_MODIFY:
 173                 // Allow modification of our data.
 174                 // This needs to be handled in the doDispatch method of our
 175                 // instantiatable children.
 176                 flag.enabled(true);
 177                 return true;
 178
 179         case LFUN_INSET_INSERT:
 180                 // Don't allow insertion of new insets.
 181                 // Every inset that wants to allow new insets from open
 182                 // dialogs needs to override this.
 183                 flag.enabled(false);
 184                 return true;
 185
 186         default:
 187                 return false;
 188         }
 189 }
 190
 191
 192 void Inset::edit(Cursor &, bool)
 193 {
 194         LYXERR(Debug::INSETS) << BOOST_CURRENT_FUNCTION
 195                               << ": edit left/right" << std::endl;
 196 }
 197
 198
 199 Inset * Inset::editXY(Cursor &, int x, int y)
 200 {
 201         LYXERR(Debug::INSETS) << BOOST_CURRENT_FUNCTION
 202                               << ": x=" << x << " y= " << y
 203                               << std::endl;
 204         return this;
 205 }
 206
 207
 208 Inset::idx_type Inset::index(row_type row, col_type col) const
 209 {
 210         if (row != 0)
 211                 lyxerr << BOOST_CURRENT_FUNCTION
 212                        << ": illegal row: " << row << std::endl;
 213         if (col != 0)
 214                 lyxerr << BOOST_CURRENT_FUNCTION
 215                        << ": illegal col: " << col << std::endl;
 216         return 0;
 217 }
 218
 219
 220 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
 221 {
 222         return from <= idx && idx <= to;
 223 }
 224
 225
 226 bool Inset::idxUpDown(Cursor &, bool) const
 227 {
 228         return false;
 229 }
 230
 231
 232 int Inset::docbook(Buffer const &,
 233         odocstream &, OutputParams const &) const
 234 {
 235         return 0;
 236 }
 237
 238
 239 bool Inset::directWrite() const
 240 {
 241         return false;
 242 }
 243
 244
 245 Inset::EDITABLE Inset::editable() const
 246 {
 247         return NOT_EDITABLE;
 248 }
 249
 250
 251 bool Inset::autoDelete() const
 252 {
 253         return false;
 254 }
 255
 256
 257 docstring const Inset::editMessage() const
 258 {
 259         return _("Opened inset");
 260 }
 261
 262
 263 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
 264                 bool, int & x, int & y) const
 265 {
 266         lyxerr << "Inset::cursorPos called directly" << std::endl;
 267         x = 100;
 268         y = 100;
 269 }
 270
 271
 272 void Inset::metricsMarkers(Dimension & dim, int framesize) const
 273 {
 274         dim.wid += 2 * framesize;
 275         dim.asc += framesize;
 276 }
 277
 278
 279 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
 280 {
 281         dim.wid += 2 * framesize;
 282         dim.asc += framesize;
 283         dim.des += framesize;
 284 }
 285
 286
 287 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
 288 {
 289         Color::color pen_color = editing(pi.base.bv)?
 290                 Color::mathframe : Color::background;
 291
 292         int const t = x + width() - 1;
 293         int const d = y + descent();
 294         pi.pain.line(x, d - 3, x, d, pen_color);
 295         pi.pain.line(t, d - 3, t, d, pen_color);
 296         pi.pain.line(x, d, x + 3, d, pen_color);
 297         pi.pain.line(t - 3, d, t, d, pen_color);
 298         setPosCache(pi, x, y);
 299 }
 300
 301
 302 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
 303 {
 304         Color::color pen_color = editing(pi.base.bv)?
 305                 Color::mathframe : Color::background;
 306
 307         drawMarkers(pi, x, y);
 308         int const t = x + width() - 1;
 309         int const a = y - ascent();
 310         pi.pain.line(x, a + 3, x, a, pen_color);
 311         pi.pain.line(t, a + 3, t, a, pen_color);
 312         pi.pain.line(x, a, x + 3, a, pen_color);
 313         pi.pain.line(t - 3, a, t, a, pen_color);
 314         setPosCache(pi, x, y);
 315 }
 316
 317
 318 bool Inset::editing(BufferView * bv) const
 319 {
 320         return bv->cursor().isInside(this);
 321 }
 322
 323
 324 int Inset::xo(BufferView const & bv) const
 325 {
 326         return bv.coordCache().getInsets().x(this);
 327 }
 328
 329
 330 int Inset::yo(BufferView const & bv) const
 331 {
 332         return bv.coordCache().getInsets().y(this);
 333 }
 334
 335
 336 bool Inset::covers(BufferView const & bv, int x, int y) const
 337 {
 338         //lyxerr << "Inset::covers, x: " << x << " y: " << y
 339         //      << " xo: " << xo(bv) << " yo: " << yo()
 340         //      << " x1: " << xo(bv) << " x2: " << xo() + width()
 341         //      << " y1: " << yo(bv) - ascent() << " y2: " << yo() + descent()
 342         //      << std::endl;
 343         return bv.coordCache().getInsets().has(this)
 344                         && x >= xo(bv)
 345                         && x <= xo(bv) + width()
 346                         && y >= yo(bv) - ascent()
 347                         && y <= yo(bv) + descent();
 348 }
 349
 350
 351 void Inset::dump() const
 352 {
 353         Buffer buf("foo", 1);
 354         write(buf, lyxerr);
 355 }
 356
 357
 358 void Inset::setBackgroundColor(Color_color color)
 359 {
 360         background_color_ = color;
 361 }
 362
 363
 364 Color_color Inset::backgroundColor() const
 365 {
 366         return Color::color(background_color_);
 367 }
 368
 369
 370 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
 371 {
 372         //lyxerr << "Inset:: position cache to " << x << " " << y << std::endl;
 373         pi.base.bv->coordCache().insets().add(this, x, y);
 374 }
 375
 376
 377 /////////////////////////////////////////
 378
 379 bool isEditableInset(Inset const * inset)
 380 {
 381         return inset && inset->editable();
 382 }
 383
 384
 385 bool isHighlyEditableInset(Inset const * inset)
 386 {
 387         return inset && inset->editable() == Inset::HIGHLY_EDITABLE;
 388 }
 389
 390
 391 } // namespace lyx