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