src/insets/insettext.C

   1 /**
   2  * \file insettext.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Vigna
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insettext.h"
  14 #include "insetnewline.h"
  15
  16 #include "buffer.h"
  17 #include "bufferparams.h"
  18 #include "BufferView.h"
  19 #include "CutAndPaste.h"
  20 #include "cursor.h"
  21 #include "debug.h"
  22 #include "dispatchresult.h"
  23 #include "errorlist.h"
  24 #include "funcrequest.h"
  25 #include "gettext.h"
  26 #include "intl.h"
  27 #include "LColor.h"
  28 #include "lyxfind.h"
  29 #include "lyxlex.h"
  30 #include "lyxrc.h"
  31 #include "lyxtext.h"
  32 #include "metricsinfo.h"
  33 #include "output_docbook.h"
  34 #include "output_latex.h"
  35 #include "output_linuxdoc.h"
  36 #include "output_plaintext.h"
  37 #include "paragraph.h"
  38 #include "paragraph_funcs.h"
  39 #include "ParagraphParameters.h"
  40 #include "rowpainter.h"
  41 #include "lyxrow.h"
  42 #include "sgml.h"
  43 #include "texrow.h"
  44 #include "undo.h"
  45
  46 #include "frontends/Alert.h"
  47 #include "frontends/font_metrics.h"
  48 #include "frontends/LyXView.h"
  49 #include "frontends/Painter.h"
  50
  51 #include "support/lyxalgo.h" // lyx::count
  52
  53 #include <boost/bind.hpp>
  54
  55 using bv_funcs::replaceSelection;
  56
  57 using lyx::pos_type;
  58
  59 using lyx::graphics::PreviewLoader;
  60
  61 using lyx::support::isStrUnsignedInt;
  62 using lyx::support::strToUnsignedInt;
  63
  64 using std::endl;
  65 using std::for_each;
  66 using std::max;
  67 using std::string;
  68 using std::auto_ptr;
  69 using std::ostream;
  70 using std::vector;
  71
  72
  73 InsetText::InsetText(BufferParams const & bp)
  74         : autoBreakRows_(false), drawFrame_(NEVER),
  75           frame_color_(LColor::insetframe), text_(0, true)
  76 {
  77         paragraphs().push_back(Paragraph());
  78         paragraphs().begin()->layout(bp.getLyXTextClass().defaultLayout());
  79         if (bp.tracking_changes)
  80                 paragraphs().begin()->trackChanges();
  81         init();
  82 }
  83
  84
  85 InsetText::InsetText(InsetText const & in)
  86         : UpdatableInset(in), text_(in.text_.bv_owner, true)
  87 {
  88         // this is ugly...
  89         operator=(in);
  90 }
  91
  92
  93 void InsetText::operator=(InsetText const & in)
  94 {
  95         UpdatableInset::operator=(in);
  96         autoBreakRows_ = in.autoBreakRows_;
  97         drawFrame_ = in.drawFrame_;
  98         frame_color_ = in.frame_color_;
  99         text_ = LyXText(in.text_.bv_owner, true);
 100         text_.paragraphs() = in.text_.paragraphs();
 101         init();
 102 }
 103
 104
 105 void InsetText::init()
 106 {
 107         ParagraphList::iterator pit = paragraphs().begin();
 108         ParagraphList::iterator end = paragraphs().end();
 109         for (; pit != end; ++pit)
 110                 pit->setInsetOwner(this);
 111         old_par = -1;
 112         in_insetAllowed = false;
 113 }
 114
 115
 116 void InsetText::clear(bool just_mark_erased)
 117 {
 118         ParagraphList & pars = paragraphs();
 119         if (just_mark_erased) {
 120                 ParagraphList::iterator it = pars.begin();
 121                 ParagraphList::iterator end = pars.end();
 122                 for (; it != end; ++it)
 123                         it->markErased();
 124                 return;
 125         }
 126
 127         // This is a gross hack...
 128         LyXLayout_ptr old_layout = pars.begin()->layout();
 129
 130         pars.clear();
 131         pars.push_back(Paragraph());
 132         pars.begin()->setInsetOwner(this);
 133         pars.begin()->layout(old_layout);
 134 }
 135
 136
 137 auto_ptr<InsetBase> InsetText::clone() const
 138 {
 139         return auto_ptr<InsetBase>(new InsetText(*this));
 140 }
 141
 142
 143 void InsetText::write(Buffer const & buf, ostream & os) const
 144 {
 145         os << "Text\n";
 146         text_.write(buf, os);
 147 }
 148
 149
 150 void InsetText::read(Buffer const & buf, LyXLex & lex)
 151 {
 152         clear(false);
 153
 154 #warning John, look here. Doesnt make much sense.
 155         if (buf.params().tracking_changes)
 156                 paragraphs().begin()->trackChanges();
 157
 158         // delete the initial paragraph
 159         Paragraph oldpar = *paragraphs().begin();
 160         paragraphs().clear();
 161         bool res = text_.read(buf, lex);
 162         init();
 163
 164         if (!res) {
 165                 lex.printError("Missing \\end_inset at this point. "
 166                                            "Read: `$$Token'");
 167         }
 168
 169         // sanity check
 170         // ensure we have at least one par.
 171         if (paragraphs().empty())
 172                 paragraphs().push_back(oldpar);
 173 }
 174
 175
 176 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
 177 {
 178         //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
 179         setViewCache(mi.base.bv);
 180         mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 181         text_.metrics(mi, dim);
 182         dim.asc += TEXT_TO_INSET_OFFSET;
 183         dim.des += TEXT_TO_INSET_OFFSET;
 184         dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 185         mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
 186         dim_ = dim;
 187         font_ = mi.base.font;
 188         text_.font_ = mi.base.font;
 189 }
 190
 191
 192 void InsetText::draw(PainterInfo & pi, int x, int y) const
 193 {
 194         // update our idea of where we are
 195         xo_ = x;
 196         yo_ = y;
 197
 198         Painter & pain = pi.pain;
 199
 200         // repaint the background if needed
 201         x += TEXT_TO_INSET_OFFSET;
 202         if (backgroundColor() != LColor::background)
 203                 clearInset(pain, x, y);
 204
 205         BufferView * bv = pi.base.bv;
 206         bv->hideCursor();
 207
 208         if (!owner())
 209                 x += scroll();
 210         y += bv->top_y() - text_.ascent();
 211
 212         text_.draw(pi, x, y);
 213
 214         if (drawFrame_ == ALWAYS || drawFrame_ == LOCKED)
 215                 drawFrame(pain, xo_);
 216 }
 217
 218
 219 void InsetText::drawFrame(Painter & pain, int x) const
 220 {
 221         int const ttoD2 = TEXT_TO_INSET_OFFSET / 2;
 222         int const frame_x = x + ttoD2;
 223         int const frame_y = yo_ - dim_.asc + ttoD2;
 224         int const frame_w = dim_.wid - TEXT_TO_INSET_OFFSET;
 225         int const frame_h = dim_.asc + dim_.des - TEXT_TO_INSET_OFFSET;
 226         pain.rectangle(frame_x, frame_y, frame_w, frame_h, frameColor());
 227 }
 228
 229
 230 void InsetText::updateLocal(BufferView * bv)
 231 {
 232         if (!bv)
 233                 return;
 234
 235         if (!autoBreakRows_ && paragraphs().size() > 1)
 236                 collapseParagraphs(bv);
 237
 238         if (!bv->selection().set())
 239                 bv->resetAnchor();
 240
 241         bv->owner()->view_state_changed();
 242         bv->owner()->updateMenubar();
 243         bv->owner()->updateToolbar();
 244         if (old_par != bv->cursor().par()) {
 245                 bv->owner()->setLayout(text_.cursorPar()->layout()->name());
 246                 old_par = bv->cursor().par();
 247         }
 248 }
 249
 250
 251 string const InsetText::editMessage() const
 252 {
 253         return _("Opened Text Inset");
 254 }
 255
 256
 257 void InsetText::sanitizeEmptyText(BufferView * bv)
 258 {
 259         if (paragraphs().size() == 1
 260             && paragraphs().begin()->empty()
 261             && bv->getParentLanguage(this) != text_.current_font.language()) {
 262                 LyXFont font(LyXFont::ALL_IGNORE);
 263                 font.setLanguage(bv->getParentLanguage(this));
 264                 text_.setFont(font, false);
 265         }
 266 }
 267
 268
 269 extern LCursor theTempCursor;
 270
 271
 272 void InsetText::edit(BufferView * bv, bool left)
 273 {
 274         lyxerr << "InsetText: edit left/right" << endl;
 275         old_par = -1;
 276         setViewCache(bv);
 277         int const par = left ? 0 : paragraphs().size() - 1;
 278         int const pos = left ? 0 : paragraphs().back().size();
 279         text_.setCursor(par, pos);
 280         bv->clearSelection();
 281         finishUndo();
 282         sanitizeEmptyText(bv);
 283         updateLocal(bv);
 284         bv->updateParagraphDialog();
 285 }
 286
 287
 288 void InsetText::edit(BufferView * bv, int x, int y)
 289 {
 290         lyxerr << "InsetText::edit xy" << endl;
 291         old_par = -1;
 292         text_.setCursorFromCoordinates(x - text_.xo_, y + bv->top_y() - text_.yo_);
 293         bv->clearSelection();
 294         finishUndo();
 295         sanitizeEmptyText(bv);
 296         updateLocal(bv);
 297         bv->updateParagraphDialog();
 298 }
 299
 300
 301 DispatchResult
 302 InsetText::priv_dispatch(BufferView & bv, FuncRequest const & cmd)
 303 {
 304         //lyxerr << "InsetText::priv_dispatch (begin), act: "
 305         //      << cmd.action << " " << endl;
 306
 307         setViewCache(&bv);
 308
 309         DispatchResult result;
 310         result.dispatched(true);
 311
 312         bool was_empty = paragraphs().begin()->empty() && paragraphs().size() == 1;
 313
 314         switch (cmd.action) {
 315         case LFUN_MOUSE_PRESS:
 316                 bv.fullCursor(theTempCursor);
 317                 // fall through
 318         default:
 319                 result = text_.dispatch(bv, cmd);
 320                 break;
 321         }
 322
 323         // If the action has deleted all text in the inset, we need
 324         // to change the language to the language of the surronding
 325         // text.
 326         if (!was_empty && paragraphs().begin()->empty() &&
 327             paragraphs().size() == 1) {
 328                 LyXFont font(LyXFont::ALL_IGNORE);
 329                 font.setLanguage(bv.getParentLanguage(this));
 330                 text_.setFont(font, false);
 331         }
 332
 333         //lyxerr << "InsetText::priv_dispatch (end)" << endl;
 334         return result;
 335 }
 336
 337
 338 int InsetText::latex(Buffer const & buf, ostream & os,
 339                      OutputParams const & runparams) const
 340 {
 341         TexRow texrow;
 342         latexParagraphs(buf, paragraphs(), os, texrow, runparams);
 343         return texrow.rows();
 344 }
 345
 346
 347 int InsetText::plaintext(Buffer const & buf, ostream & os,
 348                      OutputParams const & runparams) const
 349 {
 350         ParagraphList::const_iterator beg = paragraphs().begin();
 351         ParagraphList::const_iterator end = paragraphs().end();
 352         ParagraphList::const_iterator it = beg;
 353         for (; it != end; ++it)
 354                 asciiParagraph(buf, *it, os, runparams, it == beg);
 355
 356         //FIXME: Give the total numbers of lines
 357         return 0;
 358 }
 359
 360
 361 int InsetText::linuxdoc(Buffer const & buf, ostream & os,
 362                         OutputParams const & runparams) const
 363 {
 364         linuxdocParagraphs(buf, paragraphs(), os, runparams);
 365         return 0;
 366 }
 367
 368
 369 int InsetText::docbook(Buffer const & buf, ostream & os,
 370                        OutputParams const & runparams) const
 371 {
 372         docbookParagraphs(buf, paragraphs(), os, runparams);
 373         return 0;
 374 }
 375
 376
 377 void InsetText::validate(LaTeXFeatures & features) const
 378 {
 379         for_each(paragraphs().begin(), paragraphs().end(),
 380                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
 381 }
 382
 383
 384 void InsetText::getCursorPos(int, int & x, int & y) const
 385 {
 386         x = text_.cursorX() + TEXT_TO_INSET_OFFSET;
 387         y = text_.cursorY() - dim_.asc + TEXT_TO_INSET_OFFSET;
 388 }
 389
 390
 391 bool InsetText::insetAllowed(InsetOld::Code code) const
 392 {
 393         // in_insetAllowed is a really gross hack,
 394         // to allow us to call the owner's insetAllowed
 395         // without stack overflow, which can happen
 396         // when the owner uses InsetCollapsable::insetAllowed()
 397         bool ret = true;
 398         if (in_insetAllowed)
 399                 return ret;
 400         in_insetAllowed = true;
 401         if (owner())
 402                 ret = owner()->insetAllowed(code);
 403         in_insetAllowed = false;
 404         return ret;
 405 }
 406
 407
 408 bool InsetText::showInsetDialog(BufferView *) const
 409 {
 410         return false;
 411 }
 412
 413
 414 void InsetText::getLabelList(Buffer const & buffer,
 415                              std::vector<string> & list) const
 416 {
 417         ParagraphList::const_iterator pit = paragraphs().begin();
 418         ParagraphList::const_iterator pend = paragraphs().end();
 419         for (; pit != pend; ++pit) {
 420                 InsetList::const_iterator beg = pit->insetlist.begin();
 421                 InsetList::const_iterator end = pit->insetlist.end();
 422                 for (; beg != end; ++beg)
 423                         beg->inset->getLabelList(buffer, list);
 424         }
 425 }
 426
 427
 428 void InsetText::markNew(bool track_changes)
 429 {
 430         ParagraphList::iterator pit = paragraphs().begin();
 431         ParagraphList::iterator end = paragraphs().end();
 432         for (; pit != end; ++pit) {
 433                 if (track_changes) {
 434                         pit->trackChanges();
 435                 } else {
 436                         // no-op when not tracking
 437                         pit->cleanChanges();
 438                 }
 439         }
 440 }
 441
 442
 443 void InsetText::setText(string const & data, LyXFont const & font)
 444 {
 445         clear(false);
 446         for (unsigned int i = 0; i < data.length(); ++i)
 447                 paragraphs().begin()->insertChar(i, data[i], font);
 448 }
 449
 450
 451 void InsetText::setAutoBreakRows(bool flag)
 452 {
 453         if (flag != autoBreakRows_) {
 454                 autoBreakRows_ = flag;
 455                 if (!flag)
 456                         removeNewlines();
 457         }
 458 }
 459
 460
 461 void InsetText::setDrawFrame(DrawFrame how)
 462 {
 463         drawFrame_ = how;
 464 }
 465
 466
 467 LColor_color InsetText::frameColor() const
 468 {
 469         return LColor::color(frame_color_);
 470 }
 471
 472
 473 void InsetText::setFrameColor(LColor_color col)
 474 {
 475         frame_color_ = col;
 476 }
 477
 478
 479 void InsetText::setViewCache(BufferView const * bv) const
 480 {
 481         if (bv && bv != text_.bv_owner) {
 482                 //lyxerr << "setting view cache from "
 483                 //      << text_.bv_owner << " to " << bv << "\n";
 484                 text_.bv_owner = const_cast<BufferView *>(bv);
 485         }
 486 }
 487
 488
 489 void InsetText::removeNewlines()
 490 {
 491         ParagraphList::iterator it = paragraphs().begin();
 492         ParagraphList::iterator end = paragraphs().end();
 493         for (; it != end; ++it)
 494                 for (int i = 0; i < it->size(); ++i)
 495                         if (it->isNewline(i))
 496                                 it->erase(i);
 497 }
 498
 499
 500 int InsetText::scroll(bool /*recursive*/) const
 501 {
 502         return UpdatableInset::scroll(false);
 503 }
 504
 505
 506 void InsetText::clearInset(Painter & pain, int x, int y) const
 507 {
 508         int w = dim_.wid;
 509         int h = dim_.asc + dim_.des;
 510         int ty = y - dim_.asc;
 511
 512         if (ty < 0) {
 513                 h += ty;
 514                 ty = 0;
 515         }
 516         if (ty + h > pain.paperHeight())
 517                 h = pain.paperHeight();
 518         if (xo_ + w > pain.paperWidth())
 519                 w = pain.paperWidth();
 520         pain.fillRectangle(x + 1, ty + 1, w - 3, h - 1, backgroundColor());
 521 }
 522
 523
 524 LyXText * InsetText::getText(int i) const
 525 {
 526         return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
 527 }
 528
 529
 530 void InsetText::collapseParagraphs(BufferView * bv)
 531 {
 532         while (paragraphs().size() > 1) {
 533                 ParagraphList::iterator const first = paragraphs().begin();
 534                 ParagraphList::iterator second = first;
 535                 ++second;
 536                 size_t const first_par_size = first->size();
 537
 538                 if (!first->empty() &&
 539                     !second->empty() &&
 540                     !first->isSeparator(first_par_size - 1)) {
 541                         first->insertChar(first_par_size, ' ');
 542                 }
 543
 544                 bv->clearSelection();
 545                 mergeParagraph(bv->buffer()->params(), paragraphs(), first);
 546         }
 547 }
 548
 549
 550 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
 551 {
 552 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
 553 // And it probably does. You have to take a look at this John. (Lgb)
 554 #warning John, have a look here. (Lgb)
 555         ParagraphList::iterator pit = plist.begin();
 556         ParagraphList::iterator ins = paragraphs().insert(paragraphs().end(), *pit);
 557         ++pit;
 558         mergeParagraph(buffer->params(), paragraphs(), boost::prior(ins));
 559
 560         ParagraphList::iterator pend = plist.end();
 561         for (; pit != pend; ++pit)
 562                 paragraphs().push_back(*pit);
 563 }
 564
 565
 566 void InsetText::addPreview(PreviewLoader & loader) const
 567 {
 568         ParagraphList::const_iterator pit = paragraphs().begin();
 569         ParagraphList::const_iterator pend = paragraphs().end();
 570
 571         for (; pit != pend; ++pit) {
 572                 InsetList::const_iterator it  = pit->insetlist.begin();
 573                 InsetList::const_iterator end = pit->insetlist.end();
 574                 for (; it != end; ++it)
 575                         it->inset->addPreview(loader);
 576         }
 577 }
 578
 579
 580 ParagraphList & InsetText::paragraphs() const
 581 {
 582         return const_cast<ParagraphList &>(text_.paragraphs());
 583 }