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/Painter.h"
  49
  50 #include "support/lyxalgo.h" // lyx::count
  51
  52 #include <boost/bind.hpp>
  53 #include <boost/current_function.hpp>
  54
  55 using lyx::pos_type;
  56
  57 using lyx::graphics::PreviewLoader;
  58
  59 using lyx::support::isStrUnsignedInt;
  60
  61 using boost::bind;
  62 using boost::ref;
  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 int InsetText::border_ = 2;
  74
  75
  76 InsetText::InsetText(BufferParams const & bp)
  77         : drawFrame_(false), frame_color_(LColor::insetframe), text_(0)
  78 {
  79         paragraphs().push_back(Paragraph());
  80         paragraphs().back().layout(bp.getLyXTextClass().defaultLayout());
  81         if (bp.tracking_changes)
  82                 paragraphs().back().trackChanges();
  83         init();
  84 }
  85
  86
  87 InsetText::InsetText(InsetText const & in)
  88         : InsetOld(in), text_(in.text_.bv_owner)
  89 {
  90         text_.autoBreakRows_ = in.text_.autoBreakRows_;
  91         drawFrame_ = in.drawFrame_;
  92         frame_color_ = in.frame_color_;
  93         text_.paragraphs() = in.text_.paragraphs();
  94         init();
  95 }
  96
  97
  98 InsetText::InsetText()
  99         : text_(0)
 100 {}
 101
 102
 103 void InsetText::init()
 104 {
 105         for_each(paragraphs().begin(), paragraphs().end(),
 106                  bind(&Paragraph::setInsetOwner, _1, this));
 107         old_pit = -1;
 108 }
 109
 110
 111 void InsetText::clear(bool just_mark_erased)
 112 {
 113         ParagraphList & pars = paragraphs();
 114         if (just_mark_erased) {
 115                 for_each(pars.begin(), pars.end(),
 116                          bind(&Paragraph::markErased, _1));
 117                 return;
 118         }
 119
 120         // This is a gross hack...
 121         LyXLayout_ptr old_layout = pars.begin()->layout();
 122
 123         pars.clear();
 124         pars.push_back(Paragraph());
 125         pars.begin()->setInsetOwner(this);
 126         pars.begin()->layout(old_layout);
 127 }
 128
 129
 130 auto_ptr<InsetBase> InsetText::doClone() const
 131 {
 132         return auto_ptr<InsetBase>(new InsetText(*this));
 133 }
 134
 135
 136 void InsetText::write(Buffer const & buf, ostream & os) const
 137 {
 138         os << "Text\n";
 139         text_.write(buf, os);
 140 }
 141
 142
 143 void InsetText::read(Buffer const & buf, LyXLex & lex)
 144 {
 145         clear(false);
 146
 147 #ifdef WITH_WARNINGS
 148 #warning John, look here. Doesnt make much sense.
 149 #endif
 150         if (buf.params().tracking_changes)
 151                 paragraphs().begin()->trackChanges();
 152
 153         // delete the initial paragraph
 154         Paragraph oldpar = *paragraphs().begin();
 155         paragraphs().clear();
 156         bool res = text_.read(buf, lex);
 157         init();
 158
 159         if (!res) {
 160                 lex.printError("Missing \\end_inset at this point. "
 161                                            "Read: `$$Token'");
 162         }
 163
 164         // sanity check
 165         // ensure we have at least one paragraph.
 166         if (paragraphs().empty())
 167                 paragraphs().push_back(oldpar);
 168 }
 169
 170
 171 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
 172 {
 173         //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
 174         setViewCache(mi.base.bv);
 175         mi.base.textwidth -= 2 * border_;
 176         font_ = mi.base.font;
 177         text_.font_ = mi.base.font;
 178         text_.metrics(mi, dim);
 179         dim.asc += border_;
 180         dim.des += border_;
 181         dim.wid += 2 * border_;
 182         mi.base.textwidth += 2 * border_;
 183         dim_ = dim;
 184 }
 185
 186
 187 void InsetText::draw(PainterInfo & pi, int x, int y) const
 188 {
 189         BOOST_ASSERT(!text_.paragraphs().front().rows().empty());
 190         // update our idea of where we are
 191         setPosCache(pi, x, y);
 192
 193         BufferView * bv = pi.base.bv;
 194         bv->hideCursor();
 195
 196         text_.draw(pi, x + border_, y);
 197
 198         if (drawFrame_)
 199                 drawFrame(pi.pain, x, y);
 200 }
 201
 202
 203 void InsetText::drawSelection(PainterInfo & pi, int x, int y) const
 204 {
 205         // repaint the background if needed
 206         if (backgroundColor() != LColor::background)
 207                 clearInset(pi.pain, x, y);
 208         text_.drawSelection(pi, x, y);
 209 }
 210
 211
 212 void InsetText::drawFrame(Painter & pain, int x, int y) const
 213 {
 214         int const w = text_.width() + 2 * border_;
 215         int const a = text_.ascent() + border_;
 216         int const h = a + text_.descent() + border_;
 217         pain.rectangle(x, y - a, w, h, frameColor());
 218 }
 219
 220
 221 void InsetText::clearInset(Painter & pain, int x, int y) const
 222 {
 223         int const w = text_.width() + 2 * border_;
 224         int const a = text_.ascent() + border_;
 225         int const h = a + text_.descent() + border_;
 226         pain.fillRectangle(x, y - a, w, h, backgroundColor());
 227 }
 228
 229
 230 string const InsetText::editMessage() const
 231 {
 232         return _("Opened Text Inset");
 233 }
 234
 235
 236 void InsetText::edit(LCursor & cur, bool left)
 237 {
 238         //lyxerr << "InsetText: edit left/right" << endl;
 239         old_pit = -1;
 240         setViewCache(&cur.bv());
 241         int const pit = left ? 0 : paragraphs().size() - 1;
 242         int const pos = left ? 0 : paragraphs().back().size();
 243         text_.setCursor(cur.top(), pit, pos);
 244         cur.clearSelection();
 245         finishUndo();
 246 }
 247
 248
 249 InsetBase * InsetText::editXY(LCursor & cur, int x, int y)
 250 {
 251         old_pit = -1;
 252         return text_.editXY(cur, x, y);
 253 }
 254
 255
 256 void InsetText::doDispatch(LCursor & cur, FuncRequest & cmd)
 257 {
 258         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
 259     << " [ cmd.action = " << cmd.action << ']' << endl;
 260         setViewCache(&cur.bv());
 261         text_.dispatch(cur, cmd);
 262 }
 263
 264
 265 bool InsetText::getStatus(LCursor & cur, FuncRequest const & cmd,
 266         FuncStatus & status) const
 267 {
 268         return text_.getStatus(cur, cmd, status);
 269 }
 270
 271
 272 int InsetText::latex(Buffer const & buf, ostream & os,
 273                      OutputParams const & runparams) const
 274 {
 275         TexRow texrow;
 276         latexParagraphs(buf, paragraphs(), os, texrow, runparams);
 277         return texrow.rows();
 278 }
 279
 280
 281 int InsetText::plaintext(Buffer const & buf, ostream & os,
 282                      OutputParams const & runparams) const
 283 {
 284         ParagraphList::const_iterator beg = paragraphs().begin();
 285         ParagraphList::const_iterator end = paragraphs().end();
 286         ParagraphList::const_iterator it = beg;
 287         bool ref_printed = false;
 288         for (; it != end; ++it)
 289                 asciiParagraph(buf, *it, os, runparams, ref_printed);
 290
 291         // FIXME: Give the total numbers of lines
 292         return 0;
 293 }
 294
 295
 296 int InsetText::linuxdoc(Buffer const & buf, ostream & os,
 297                         OutputParams const & runparams) const
 298 {
 299         linuxdocParagraphs(buf, paragraphs(), os, runparams);
 300         return 0;
 301 }
 302
 303
 304 int InsetText::docbook(Buffer const & buf, ostream & os,
 305                        OutputParams const & runparams) const
 306 {
 307         docbookParagraphs(paragraphs(), buf, os, runparams);
 308         return 0;
 309 }
 310
 311
 312 void InsetText::validate(LaTeXFeatures & features) const
 313 {
 314         for_each(paragraphs().begin(), paragraphs().end(),
 315                  bind(&Paragraph::validate, _1, ref(features)));
 316 }
 317
 318
 319 void InsetText::cursorPos
 320         (CursorSlice const & sl, bool boundary, int & x, int & y) const
 321 {
 322         x = text_.cursorX(sl, boundary) + border_;
 323         y = text_.cursorY(sl, boundary);
 324 }
 325
 326
 327 bool InsetText::showInsetDialog(BufferView *) const
 328 {
 329         return false;
 330 }
 331
 332
 333 void InsetText::getLabelList(Buffer const & buffer,
 334                              std::vector<string> & list) const
 335 {
 336         ParagraphList::const_iterator pit = paragraphs().begin();
 337         ParagraphList::const_iterator pend = paragraphs().end();
 338         for (; pit != pend; ++pit) {
 339                 InsetList::const_iterator beg = pit->insetlist.begin();
 340                 InsetList::const_iterator end = pit->insetlist.end();
 341                 for (; beg != end; ++beg)
 342                         beg->inset->getLabelList(buffer, list);
 343         }
 344 }
 345
 346
 347 void InsetText::markNew(bool track_changes)
 348 {
 349         ParagraphList::iterator pit = paragraphs().begin();
 350         ParagraphList::iterator end = paragraphs().end();
 351         for (; pit != end; ++pit) {
 352                 if (track_changes)
 353                         pit->trackChanges();
 354                 else // no-op when not tracking
 355                         pit->cleanChanges();
 356         }
 357 }
 358
 359
 360 void InsetText::setText(string const & data, LyXFont const & font)
 361 {
 362         clear(false);
 363         Paragraph & first = paragraphs().front();
 364         for (unsigned int i = 0; i < data.length(); ++i)
 365                 first.insertChar(i, data[i], font);
 366 }
 367
 368
 369 void InsetText::setAutoBreakRows(bool flag)
 370 {
 371         if (flag != text_.autoBreakRows_) {
 372                 text_.autoBreakRows_ = flag;
 373                 if (!flag)
 374                         removeNewlines();
 375         }
 376 }
 377
 378
 379 void InsetText::setDrawFrame(bool flag)
 380 {
 381         drawFrame_ = flag;
 382 }
 383
 384
 385 LColor_color InsetText::frameColor() const
 386 {
 387         return LColor::color(frame_color_);
 388 }
 389
 390
 391 void InsetText::setFrameColor(LColor_color col)
 392 {
 393         frame_color_ = col;
 394 }
 395
 396
 397 void InsetText::setViewCache(BufferView const * bv) const
 398 {
 399         if (bv && bv != text_.bv_owner) {
 400                 //lyxerr << "setting view cache from "
 401                 //      << text_.bv_owner << " to " << bv << "\n";
 402                 text_.bv_owner = const_cast<BufferView *>(bv);
 403         }
 404 }
 405
 406
 407 void InsetText::removeNewlines()
 408 {
 409         ParagraphList::iterator it = paragraphs().begin();
 410         ParagraphList::iterator end = paragraphs().end();
 411         for (; it != end; ++it)
 412                 for (int i = 0; i < it->size(); ++i)
 413                         if (it->isNewline(i))
 414                                 it->erase(i);
 415 }
 416
 417
 418 LyXText * InsetText::getText(int i) const
 419 {
 420         return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
 421 }
 422
 423
 424 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
 425 {
 426 #ifdef WITH_WARNINGS
 427 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
 428 // And it probably does. You have to take a look at this John. (Lgb)
 429 #warning John, have a look here. (Lgb)
 430 #endif
 431         ParagraphList & pl = paragraphs();
 432
 433         ParagraphList::iterator pit = plist.begin();
 434         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 435         ++pit;
 436         mergeParagraph(buffer->params(), pl, ins - pl.begin() - 1);
 437
 438         for_each(pit, plist.end(),
 439                  bind(&ParagraphList::push_back, ref(pl), _1));
 440 }
 441
 442
 443 void InsetText::addPreview(PreviewLoader & loader) const
 444 {
 445         ParagraphList::const_iterator pit = paragraphs().begin();
 446         ParagraphList::const_iterator pend = paragraphs().end();
 447
 448         for (; pit != pend; ++pit) {
 449                 InsetList::const_iterator it  = pit->insetlist.begin();
 450                 InsetList::const_iterator end = pit->insetlist.end();
 451                 for (; it != end; ++it)
 452                         it->inset->addPreview(loader);
 453         }
 454 }
 455
 456
 457 ParagraphList const & InsetText::paragraphs() const
 458 {
 459         return text_.paragraphs();
 460 }
 461
 462
 463 ParagraphList & InsetText::paragraphs()
 464 {
 465         return text_.paragraphs();
 466 }