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