src/insets/insetbase.C

   1 /**
   2  * \file insetbase.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insetbase.h"
  14
  15 #include "buffer.h"
  16 #include "coordcache.h"
  17 #include "BufferView.h"
  18 #include "LColor.h"
  19 #include "cursor.h"
  20 #include "debug.h"
  21 #include "dimension.h"
  22 #include "dispatchresult.h"
  23 #include "funcrequest.h"
  24 #include "FuncStatus.h"
  25 #include "gettext.h"
  26 #include "lyxtext.h"
  27 #include "metricsinfo.h"
  28
  29 #include "frontends/Painter.h"
  30
  31 #include <map>
  32 #include <typeinfo>
  33
  34
  35 namespace {
  36
  37 class InsetName {
  38 public:
  39         InsetName(std::string const & n, InsetBase::Code c)
  40                 : name(n), code(c) {}
  41         std::string name;
  42         InsetBase::Code code;
  43 };
  44
  45
  46 typedef std::map<std::string, InsetBase::Code> TranslatorMap;
  47
  48
  49 TranslatorMap const build_translator()
  50 {
  51         InsetName const insetnames[] = {
  52                 InsetName("toc", InsetBase::TOC_CODE),
  53                 InsetName("quote", InsetBase::QUOTE_CODE),
  54                 InsetName("ref", InsetBase::REF_CODE),
  55                 InsetName("url", InsetBase::URL_CODE),
  56                 InsetName("htmlurl", InsetBase::HTMLURL_CODE),
  57                 InsetName("separator", InsetBase::SEPARATOR_CODE),
  58                 InsetName("ending", InsetBase::ENDING_CODE),
  59                 InsetName("label", InsetBase::LABEL_CODE),
  60                 InsetName("note", InsetBase::NOTE_CODE),
  61                 InsetName("accent", InsetBase::ACCENT_CODE),
  62                 InsetName("math", InsetBase::MATH_CODE),
  63                 InsetName("index", InsetBase::INDEX_CODE),
  64                 InsetName("include", InsetBase::INCLUDE_CODE),
  65                 InsetName("graphics", InsetBase::GRAPHICS_CODE),
  66                 InsetName("bibitem", InsetBase::BIBITEM_CODE),
  67                 InsetName("bibtex", InsetBase::BIBTEX_CODE),
  68                 InsetName("text", InsetBase::TEXT_CODE),
  69                 InsetName("ert", InsetBase::ERT_CODE),
  70                 InsetName("foot", InsetBase::FOOT_CODE),
  71                 InsetName("margin", InsetBase::MARGIN_CODE),
  72                 InsetName("float", InsetBase::FLOAT_CODE),
  73                 InsetName("wrap", InsetBase::WRAP_CODE),
  74                 InsetName("specialchar", InsetBase::SPECIALCHAR_CODE),
  75                 InsetName("tabular", InsetBase::TABULAR_CODE),
  76                 InsetName("external", InsetBase::EXTERNAL_CODE),
  77                 InsetName("caption", InsetBase::CAPTION_CODE),
  78                 InsetName("mathmacro", InsetBase::MATHMACRO_CODE),
  79                 InsetName("error", InsetBase::ERROR_CODE),
  80                 InsetName("cite", InsetBase::CITE_CODE),
  81                 InsetName("float_list", InsetBase::FLOAT_LIST_CODE),
  82                 InsetName("index_print", InsetBase::INDEX_PRINT_CODE),
  83                 InsetName("optarg", InsetBase::OPTARG_CODE),
  84                 InsetName("environment", InsetBase::ENVIRONMENT_CODE),
  85                 InsetName("hfill", InsetBase::HFILL_CODE),
  86                 InsetName("newline", InsetBase::NEWLINE_CODE),
  87                 InsetName("line", InsetBase::LINE_CODE),
  88                 InsetName("branch", InsetBase::BRANCH_CODE),
  89                 InsetName("box", InsetBase::BOX_CODE),
  90                 InsetName("charstyle", InsetBase::CHARSTYLE_CODE),
  91                 InsetName("vspace", InsetBase::VSPACE_CODE),
  92                 InsetName("mathmacroarg", InsetBase::MATHMACROARG_CODE),
  93         };
  94
  95         std::size_t const insetnames_size =
  96                 sizeof(insetnames) / sizeof(insetnames[0]);
  97
  98         std::map<std::string, InsetBase::Code> data;
  99         for (std::size_t i = 0; i != insetnames_size; ++i) {
 100                 InsetName const & var = insetnames[i];
 101                 data[var.name] = var.code;
 102         }
 103
 104         return data;
 105 }
 106
 107 } // namespace anon
 108
 109
 110 InsetBase::InsetBase()
 111 {}
 112
 113
 114 InsetBase::InsetBase(InsetBase const &)
 115 {}
 116
 117
 118 std::auto_ptr<InsetBase> InsetBase::clone() const
 119 {
 120         std::auto_ptr<InsetBase> b = doClone();
 121         BOOST_ASSERT(typeid(*b) == typeid(*this));
 122         return b;
 123 }
 124
 125
 126 InsetBase::Code InsetBase::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 InsetBase::dispatch(LCursor & cur, FuncRequest & cmd)
 136 {
 137         cur.needsUpdate();
 138         cur.dispatched();
 139         doDispatch(cur, cmd);
 140 }
 141
 142
 143 void InsetBase::doDispatch(LCursor & cur, FuncRequest &)
 144 {
 145         cur.noUpdate();
 146         cur.undispatched();
 147 }
 148
 149
 150 bool InsetBase::getStatus(LCursor &, 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 InsetBase::edit(LCursor &, bool)
 183 {
 184         lyxerr << "InsetBase: edit left/right" << std::endl;
 185 }
 186
 187
 188 InsetBase * InsetBase::editXY(LCursor &, int x, int y)
 189 {
 190         lyxerr << "InsetBase: editXY x:" << x << " y: " << y << std::endl;
 191         return this;
 192 }
 193
 194
 195 InsetBase::idx_type InsetBase::index(row_type row, col_type col) const
 196 {
 197         if (row != 0)
 198                 lyxerr << "illegal row: " << row << std::endl;
 199         if (col != 0)
 200                 lyxerr << "illegal col: " << col << std::endl;
 201         return 0;
 202 }
 203
 204
 205 bool InsetBase::idxBetween(idx_type idx, idx_type from, idx_type to) const
 206 {
 207         return from <= idx && idx <= to;
 208 }
 209
 210
 211 bool InsetBase::idxUpDown(LCursor &, bool) const
 212 {
 213         return false;
 214 }
 215
 216
 217 int InsetBase::plaintext(Buffer const &,
 218         std::ostream &, OutputParams const &) const
 219 {
 220         return 0;
 221 }
 222
 223
 224 int InsetBase::linuxdoc(Buffer const &,
 225         std::ostream &, OutputParams const &) const
 226 {
 227         return 0;
 228 }
 229
 230
 231 int InsetBase::docbook(Buffer const &,
 232         std::ostream &, OutputParams const &) const
 233 {
 234         return 0;
 235 }
 236
 237
 238 bool InsetBase::directWrite() const
 239 {
 240         return false;
 241 }
 242
 243
 244 InsetBase::EDITABLE InsetBase::editable() const
 245 {
 246         return NOT_EDITABLE;
 247 }
 248
 249
 250 bool InsetBase::autoDelete() const
 251 {
 252         return false;
 253 }
 254
 255
 256 std::string const InsetBase::editMessage() const
 257 {
 258         return _("Opened inset");
 259 }
 260
 261
 262 std::string const & InsetBase::getInsetName() const
 263 {
 264         static std::string const name = "unknown";
 265         return name;
 266 }
 267
 268
 269 void InsetBase::markErased()
 270 {}
 271
 272
 273 void InsetBase::cursorPos(CursorSlice const &, bool, int & x, int & y) const
 274 {
 275         lyxerr << "InsetBase::cursorPos called directly" << std::endl;
 276         x = 100;
 277         y = 100;
 278 }
 279
 280
 281 void InsetBase::metricsMarkers(Dimension & dim, int framesize) const
 282 {
 283         dim.wid += 2 * framesize;
 284         dim.asc += framesize;
 285 }
 286
 287
 288 void InsetBase::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 InsetBase::drawMarkers(PainterInfo & pi, int x, int y) const
 297 {
 298         if (!editing(pi.base.bv))
 299                 return;
 300         int const t = x + width() - 1;
 301         int const d = y + descent();
 302         pi.pain.line(x, d - 3, x, d, LColor::mathframe);
 303         pi.pain.line(t, d - 3, t, d, LColor::mathframe);
 304         pi.pain.line(x, d, x + 3, d, LColor::mathframe);
 305         pi.pain.line(t - 3, d, t, d, LColor::mathframe);
 306         setPosCache(pi, x, y);
 307 }
 308
 309
 310 void InsetBase::drawMarkers2(PainterInfo & pi, int x, int y) const
 311 {
 312         if (!editing(pi.base.bv))
 313                 return;
 314         drawMarkers(pi, x, y);
 315         int const t = x + width() - 1;
 316         int const a = y - ascent();
 317         pi.pain.line(x, a + 3, x, a, LColor::mathframe);
 318         pi.pain.line(t, a + 3, t, a, LColor::mathframe);
 319         pi.pain.line(x, a, x + 3, a, LColor::mathframe);
 320         pi.pain.line(t - 3, a, t, a, LColor::mathframe);
 321         setPosCache(pi, x, y);
 322 }
 323
 324
 325 bool InsetBase::editing(BufferView * bv) const
 326 {
 327         return bv->cursor().isInside(this);
 328 }
 329
 330
 331 int InsetBase::xo() const
 332 {
 333         return theCoords.getInsets().x(this);
 334 }
 335
 336
 337 int InsetBase::yo() const
 338 {
 339         return theCoords.getInsets().y(this);
 340 }
 341
 342
 343 bool InsetBase::covers(int x, int y) const
 344 {
 345         //lyxerr << "InsetBase::covers, x: " << x << " y: " << y
 346         //      << " xo: " << xo() << " yo: " << yo()
 347         //      << " x1: " << xo() << " x2: " << xo() + width()
 348         //      << " y1: " << yo() - ascent() << " y2: " << yo() + descent()
 349         //      << std::endl;
 350         return theCoords.getInsets().has(this)
 351                         && x >= xo()
 352                         && x <= xo() + width()
 353                         && y >= yo() - ascent()
 354                         && y <= yo() + descent();
 355 }
 356
 357
 358 void InsetBase::dump() const
 359 {
 360         Buffer buf("foo", 1);
 361         write(buf, lyxerr);
 362 }
 363
 364
 365 /////////////////////////////////////////
 366
 367 bool isEditableInset(InsetBase const * inset)
 368 {
 369         return inset && inset->editable();
 370 }
 371
 372
 373 bool isHighlyEditableInset(InsetBase const * inset)
 374 {
 375         return inset && inset->editable() == InsetBase::HIGHLY_EDITABLE;
 376 }