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(LCursor & cur)
 231 {
 232         if (!autoBreakRows_ && paragraphs().size() > 1) {
 233                 // collapseParagraphs
 234                 while (paragraphs().size() > 1) {
 235                         ParagraphList::iterator const first = paragraphs().begin();
 236                         ParagraphList::iterator second = first;
 237                         ++second;
 238                         size_t const first_par_size = first->size();
 239
 240                         if (!first->empty() &&
 241                                         !second->empty() &&
 242                                         !first->isSeparator(first_par_size - 1)) {
 243                                 first->insertChar(first_par_size, ' ');
 244                         }
 245
 246                         cur.clearSelection();
 247                         mergeParagraph(cur.bv().buffer()->params(), paragraphs(), first);
 248                 }
 249         }
 250
 251         if (!cur.selection())
 252                 cur.resetAnchor();
 253
 254         LyXView * lv = cur.bv().owner();
 255         lv->view_state_changed();
 256         lv->updateMenubar();
 257         lv->updateToolbar();
 258         if (old_par != cur.par()) {
 259                 lv->setLayout(text_.cursorPar()->layout()->name());
 260                 old_par = cur.par();
 261         }
 262 }
 263
 264
 265 string const InsetText::editMessage() const
 266 {
 267         return _("Opened Text Inset");
 268 }
 269
 270
 271 void InsetText::sanitizeEmptyText(BufferView & bv)
 272 {
 273         if (paragraphs().size() == 1
 274             && paragraphs().begin()->empty()
 275             && bv.getParentLanguage(this) != text_.current_font.language()) {
 276                 LyXFont font(LyXFont::ALL_IGNORE);
 277                 font.setLanguage(bv.getParentLanguage(this));
 278                 text_.setFont(font, false);
 279         }
 280 }
 281
 282
 283 extern CursorBase theTempCursor;
 284
 285
 286 void InsetText::edit(LCursor & cur, bool left)
 287 {
 288         lyxerr << "InsetText: edit left/right" << endl;
 289         old_par = -1;
 290         setViewCache(&cur.bv());
 291         int const par = left ? 0 : paragraphs().size() - 1;
 292         int const pos = left ? 0 : paragraphs().back().size();
 293         text_.setCursor(par, pos);
 294         cur.clearSelection();
 295         finishUndo();
 296         sanitizeEmptyText(cur.bv());
 297         updateLocal(cur);
 298         cur.bv().updateParagraphDialog();
 299 }
 300
 301
 302 void InsetText::edit(LCursor & cur, int x, int y)
 303 {
 304         lyxerr << "InsetText::edit xy" << endl;
 305         old_par = -1;
 306         text_.setCursorFromCoordinates(x - text_.xo_, y + cur.bv().top_y() - text_.yo_);
 307         cur.clearSelection();
 308         finishUndo();
 309         sanitizeEmptyText(cur.bv());
 310         updateLocal(cur);
 311         cur.bv().updateParagraphDialog();
 312 }
 313
 314
 315 DispatchResult InsetText::priv_dispatch(LCursor & cur, FuncRequest const & cmd)
 316 {
 317         //lyxerr << "InsetText::priv_dispatch (begin), act: "
 318         //      << cmd.action << " " << endl;
 319
 320         setViewCache(&cur.bv());
 321
 322         DispatchResult result;
 323         result.dispatched(true);
 324
 325         bool was_empty = paragraphs().begin()->empty() && paragraphs().size() == 1;
 326
 327         switch (cmd.action) {
 328         case LFUN_MOUSE_PRESS:
 329                 cur.cursor_ = theTempCursor;
 330                 cur.resetAnchor();
 331                 result = text_.dispatch(cur, cmd);
 332                 break;
 333
 334         default:
 335                 result = text_.dispatch(cur, cmd);
 336                 break;
 337         }
 338
 339         // If the action has deleted all text in the inset, we need
 340         // to change the language to the language of the surronding
 341         // text.
 342         if (!was_empty && paragraphs().begin()->empty() &&
 343             paragraphs().size() == 1) {
 344                 LyXFont font(LyXFont::ALL_IGNORE);
 345                 font.setLanguage(cur.bv().getParentLanguage(this));
 346                 text_.setFont(font, false);
 347         }
 348
 349         //lyxerr << "InsetText::priv_dispatch (end)" << endl;
 350         return result;
 351 }
 352
 353
 354 int InsetText::latex(Buffer const & buf, ostream & os,
 355                      OutputParams const & runparams) const
 356 {
 357         TexRow texrow;
 358         latexParagraphs(buf, paragraphs(), os, texrow, runparams);
 359         return texrow.rows();
 360 }
 361
 362
 363 int InsetText::plaintext(Buffer const & buf, ostream & os,
 364                      OutputParams const & runparams) const
 365 {
 366         ParagraphList::const_iterator beg = paragraphs().begin();
 367         ParagraphList::const_iterator end = paragraphs().end();
 368         ParagraphList::const_iterator it = beg;
 369         for (; it != end; ++it)
 370                 asciiParagraph(buf, *it, os, runparams, it == beg);
 371
 372         //FIXME: Give the total numbers of lines
 373         return 0;
 374 }
 375
 376
 377 int InsetText::linuxdoc(Buffer const & buf, ostream & os,
 378                         OutputParams const & runparams) const
 379 {
 380         linuxdocParagraphs(buf, paragraphs(), os, runparams);
 381         return 0;
 382 }
 383
 384
 385 int InsetText::docbook(Buffer const & buf, ostream & os,
 386                        OutputParams const & runparams) const
 387 {
 388         docbookParagraphs(buf, paragraphs(), os, runparams);
 389         return 0;
 390 }
 391
 392
 393 void InsetText::validate(LaTeXFeatures & features) const
 394 {
 395         for_each(paragraphs().begin(), paragraphs().end(),
 396                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
 397 }
 398
 399
 400 void InsetText::getCursorPos(int, int & x, int & y) const
 401 {
 402         x = text_.cursorX() + TEXT_TO_INSET_OFFSET;
 403         y = text_.cursorY() - dim_.asc + TEXT_TO_INSET_OFFSET;
 404 }
 405
 406
 407 bool InsetText::insetAllowed(InsetOld::Code code) const
 408 {
 409         // in_insetAllowed is a really gross hack,
 410         // to allow us to call the owner's insetAllowed
 411         // without stack overflow, which can happen
 412         // when the owner uses InsetCollapsable::insetAllowed()
 413         bool ret = true;
 414         if (in_insetAllowed)
 415                 return ret;
 416         in_insetAllowed = true;
 417         if (owner())
 418                 ret = owner()->insetAllowed(code);
 419         in_insetAllowed = false;
 420         return ret;
 421 }
 422
 423
 424 bool InsetText::showInsetDialog(BufferView *) const
 425 {
 426         return false;
 427 }
 428
 429
 430 void InsetText::getLabelList(Buffer const & buffer,
 431                              std::vector<string> & list) const
 432 {
 433         ParagraphList::const_iterator pit = paragraphs().begin();
 434         ParagraphList::const_iterator pend = paragraphs().end();
 435         for (; pit != pend; ++pit) {
 436                 InsetList::const_iterator beg = pit->insetlist.begin();
 437                 InsetList::const_iterator end = pit->insetlist.end();
 438                 for (; beg != end; ++beg)
 439                         beg->inset->getLabelList(buffer, list);
 440         }
 441 }
 442
 443
 444 void InsetText::markNew(bool track_changes)
 445 {
 446         ParagraphList::iterator pit = paragraphs().begin();
 447         ParagraphList::iterator end = paragraphs().end();
 448         for (; pit != end; ++pit) {
 449                 if (track_changes) {
 450                         pit->trackChanges();
 451                 } else {
 452                         // no-op when not tracking
 453                         pit->cleanChanges();
 454                 }
 455         }
 456 }
 457
 458
 459 void InsetText::setText(string const & data, LyXFont const & font)
 460 {
 461         clear(false);
 462         for (unsigned int i = 0; i < data.length(); ++i)
 463                 paragraphs().begin()->insertChar(i, data[i], font);
 464 }
 465
 466
 467 void InsetText::setAutoBreakRows(bool flag)
 468 {
 469         if (flag != autoBreakRows_) {
 470                 autoBreakRows_ = flag;
 471                 if (!flag)
 472                         removeNewlines();
 473         }
 474 }
 475
 476
 477 void InsetText::setDrawFrame(DrawFrame how)
 478 {
 479         drawFrame_ = how;
 480 }
 481
 482
 483 LColor_color InsetText::frameColor() const
 484 {
 485         return LColor::color(frame_color_);
 486 }
 487
 488
 489 void InsetText::setFrameColor(LColor_color col)
 490 {
 491         frame_color_ = col;
 492 }
 493
 494
 495 void InsetText::setViewCache(BufferView const * bv) const
 496 {
 497         if (bv && bv != text_.bv_owner) {
 498                 //lyxerr << "setting view cache from "
 499                 //      << text_.bv_owner << " to " << bv << "\n";
 500                 text_.bv_owner = const_cast<BufferView *>(bv);
 501         }
 502 }
 503
 504
 505 void InsetText::removeNewlines()
 506 {
 507         ParagraphList::iterator it = paragraphs().begin();
 508         ParagraphList::iterator end = paragraphs().end();
 509         for (; it != end; ++it)
 510                 for (int i = 0; i < it->size(); ++i)
 511                         if (it->isNewline(i))
 512                                 it->erase(i);
 513 }
 514
 515
 516 int InsetText::scroll(bool /*recursive*/) const
 517 {
 518         return UpdatableInset::scroll(false);
 519 }
 520
 521
 522 void InsetText::clearInset(Painter & pain, int x, int y) const
 523 {
 524         int w = dim_.wid;
 525         int h = dim_.asc + dim_.des;
 526         int ty = y - dim_.asc;
 527
 528         if (ty < 0) {
 529                 h += ty;
 530                 ty = 0;
 531         }
 532         if (ty + h > pain.paperHeight())
 533                 h = pain.paperHeight();
 534         if (xo_ + w > pain.paperWidth())
 535                 w = pain.paperWidth();
 536         pain.fillRectangle(x + 1, ty + 1, w - 3, h - 1, backgroundColor());
 537 }
 538
 539
 540 LyXText * InsetText::getText(int i) const
 541 {
 542         return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
 543 }
 544
 545
 546 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
 547 {
 548 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
 549 // And it probably does. You have to take a look at this John. (Lgb)
 550 #warning John, have a look here. (Lgb)
 551         ParagraphList::iterator pit = plist.begin();
 552         ParagraphList::iterator ins = paragraphs().insert(paragraphs().end(), *pit);
 553         ++pit;
 554         mergeParagraph(buffer->params(), paragraphs(), boost::prior(ins));
 555
 556         ParagraphList::iterator pend = plist.end();
 557         for (; pit != pend; ++pit)
 558                 paragraphs().push_back(*pit);
 559 }
 560
 561
 562 void InsetText::addPreview(PreviewLoader & loader) const
 563 {
 564         ParagraphList::const_iterator pit = paragraphs().begin();
 565         ParagraphList::const_iterator pend = paragraphs().end();
 566
 567         for (; pit != pend; ++pit) {
 568                 InsetList::const_iterator it  = pit->insetlist.begin();
 569                 InsetList::const_iterator end = pit->insetlist.end();
 570                 for (; it != end; ++it)
 571                         it->inset->addPreview(loader);
 572         }
 573 }
 574
 575
 576 ParagraphList & InsetText::paragraphs() const
 577 {
 578         return const_cast<ParagraphList &>(text_.paragraphs());
 579 }