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