src/insets/InsetText.cpp

   1 /**
   2  * \file InsetText.cpp
   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 "buffer_funcs.h"
  18 #include "BufferParams.h"
  19 #include "BufferView.h"
  20 #include "CoordCache.h"
  21 #include "CutAndPaste.h"
  22 #include "Cursor.h"
  23 #include "debug.h"
  24 #include "DispatchResult.h"
  25 #include "ErrorList.h"
  26 #include "FuncRequest.h"
  27 #include "gettext.h"
  28 #include "Intl.h"
  29 #include "Color.h"
  30 #include "lyxfind.h"
  31 #include "Lexer.h"
  32 #include "LyXRC.h"
  33 #include "Text.h"
  34 #include "MetricsInfo.h"
  35 #include "OutputParams.h"
  36 #include "output_docbook.h"
  37 #include "output_latex.h"
  38 #include "output_plaintext.h"
  39 #include "Paragraph.h"
  40 #include "paragraph_funcs.h"
  41 #include "ParagraphParameters.h"
  42 #include "ParIterator.h"
  43 #include "Row.h"
  44 #include "sgml.h"
  45 #include "TexRow.h"
  46 #include "Undo.h"
  47
  48 #include "frontends/alert.h"
  49 #include "frontends/Painter.h"
  50
  51 #include "support/lyxalgo.h" // count
  52
  53 #include <boost/bind.hpp>
  54 #include <boost/current_function.hpp>
  55 #include <boost/signal.hpp>
  56
  57 #include <sstream>
  58
  59
  60 namespace lyx {
  61
  62 using graphics::PreviewLoader;
  63
  64 using support::isStrUnsignedInt;
  65
  66 using boost::bind;
  67 using boost::ref;
  68
  69 using std::endl;
  70 using std::for_each;
  71 using std::max;
  72 using std::string;
  73 using std::auto_ptr;
  74 using std::ostream;
  75 using std::vector;
  76
  77
  78 int InsetText::border_ = 2;
  79
  80
  81 InsetText::InsetText(BufferParams const & bp)
  82         : drawFrame_(false), frame_color_(Color::insetframe)
  83 {
  84         paragraphs().push_back(Paragraph());
  85         paragraphs().back().layout(bp.getTextClass().defaultLayout());
  86         // Dispose of the infamous L-shaped cursor.
  87         text_.current_font.setLanguage(bp.language);
  88         text_.real_current_font.setLanguage(bp.language);
  89         init();
  90 }
  91
  92
  93 InsetText::InsetText(InsetText const & in)
  94         : Inset(in), text_()
  95 {
  96         text_.autoBreakRows_ = in.text_.autoBreakRows_;
  97         drawFrame_ = in.drawFrame_;
  98         frame_color_ = in.frame_color_;
  99         text_.paragraphs() = in.text_.paragraphs();
 100         // Hand current buffer language down to "cloned" textinsets
 101         // e.g. tabular cells
 102         text_.current_font = in.text_.current_font;
 103         text_.real_current_font = in.text_.real_current_font;
 104         init();
 105 }
 106
 107
 108 InsetText::InsetText()
 109 {}
 110
 111
 112 void InsetText::init()
 113 {
 114         for_each(paragraphs().begin(), paragraphs().end(),
 115                  bind(&Paragraph::setInsetOwner, _1, this));
 116 }
 117
 118
 119 void InsetText::clear()
 120 {
 121         ParagraphList & pars = paragraphs();
 122
 123         // This is a gross hack...
 124         LayoutPtr old_layout = pars.begin()->layout();
 125
 126         pars.clear();
 127         pars.push_back(Paragraph());
 128         pars.begin()->setInsetOwner(this);
 129         pars.begin()->layout(old_layout);
 130 }
 131
 132
 133 auto_ptr<Inset> InsetText::doClone() const
 134 {
 135         return auto_ptr<Inset>(new InsetText(*this));
 136 }
 137
 138
 139 void InsetText::write(Buffer const & buf, ostream & os) const
 140 {
 141         os << "Text\n";
 142         text_.write(buf, os);
 143 }
 144
 145
 146 void InsetText::read(Buffer const & buf, Lexer & lex)
 147 {
 148         clear();
 149
 150         // delete the initial paragraph
 151         Paragraph oldpar = *paragraphs().begin();
 152         paragraphs().clear();
 153         ErrorList errorList;
 154         bool res = text_.read(buf, lex, errorList);
 155         init();
 156
 157         if (!res) {
 158                 lex.printError("Missing \\end_inset at this point. "
 159                                            "Read: `$$Token'");
 160         }
 161
 162         // sanity check
 163         // ensure we have at least one paragraph.
 164         if (paragraphs().empty())
 165                 paragraphs().push_back(oldpar);
 166 }
 167
 168
 169 bool InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
 170 {
 171         TextMetrics & tm = mi.base.bv->textMetrics(&text_);
 172
 173         //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
 174         mi.base.textwidth -= 2 * border_;
 175         font_ = mi.base.font;
 176         // Hand font through to contained lyxtext:
 177         text_.font_ = mi.base.font;
 178         tm.metrics(mi, dim);
 179         dim.asc += border_;
 180         dim.des += border_;
 181         dim.wid += 2 * border_;
 182         mi.base.textwidth += 2 * border_;
 183         bool const changed = dim_ != dim;
 184         dim_ = dim;
 185         return changed;
 186 }
 187
 188
 189 void InsetText::draw(PainterInfo & pi, int x, int y) const
 190 {
 191         // update our idea of where we are
 192         setPosCache(pi, x, y);
 193
 194         TextMetrics & tm = pi.base.bv->textMetrics(&text_);
 195
 196         tm.draw(pi, x + border_, y);
 197
 198         if (drawFrame_) {
 199                 int const w = tm.width() + 2 * border_;
 200                 int const a = tm.ascent() + border_;
 201                 int const h = a + tm.descent() + border_;
 202                 pi.pain.rectangle(x, y - a,
 203                                   (hasFixedWidth() ? tm.maxWidth() : w),
 204                                   h, frameColor());
 205         }
 206 }
 207
 208
 209 void InsetText::drawSelection(PainterInfo & pi, int x, int y) const
 210 {
 211         TextMetrics & tm = pi.base.bv->textMetrics(&text_);
 212
 213         int const w = tm.width() + 2 * border_;
 214         int const a = tm.ascent() + border_;
 215         int const h = a + tm.descent() + border_;
 216         pi.pain.fillRectangle(x, y - a,
 217                               (hasFixedWidth() ? tm.maxWidth() : w),
 218                               h, backgroundColor());
 219         text_.drawSelection(pi, x + border_, y);
 220 }
 221
 222
 223 docstring const InsetText::editMessage() const
 224 {
 225         return _("Opened Text Inset");
 226 }
 227
 228
 229 void InsetText::edit(Cursor & cur, bool left)
 230 {
 231         //lyxerr << "InsetText: edit left/right" << endl;
 232         int const pit = left ? 0 : paragraphs().size() - 1;
 233         int const pos = left ? 0 : paragraphs().back().size();
 234         text_.setCursor(cur.top(), pit, pos);
 235         cur.clearSelection();
 236         finishUndo();
 237 }
 238
 239
 240 Inset * InsetText::editXY(Cursor & cur, int x, int y)
 241 {
 242         return text_.editXY(cur, x, y);
 243 }
 244
 245
 246 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 247 {
 248         LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
 249                              << " [ cmd.action = "
 250                              << cmd.action << ']' << endl;
 251         text_.dispatch(cur, cmd);
 252 }
 253
 254
 255 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
 256         FuncStatus & status) const
 257 {
 258         return text_.getStatus(cur, cmd, status);
 259 }
 260
 261
 262 void InsetText::setChange(Change const & change)
 263 {
 264         ParagraphList::iterator pit = paragraphs().begin();
 265         ParagraphList::iterator end = paragraphs().end();
 266         for (; pit != end; ++pit) {
 267                 pit->setChange(change);
 268         }
 269 }
 270
 271
 272 void InsetText::acceptChanges(BufferParams const & bparams)
 273 {
 274         text_.acceptChanges(bparams);
 275 }
 276
 277
 278 void InsetText::rejectChanges(BufferParams const & bparams)
 279 {
 280         text_.rejectChanges(bparams);
 281 }
 282
 283
 284 int InsetText::latex(Buffer const & buf, odocstream & os,
 285                      OutputParams const & runparams) const
 286 {
 287         TexRow texrow;
 288         latexParagraphs(buf, paragraphs(), os, texrow, runparams);
 289         return texrow.rows();
 290 }
 291
 292
 293 int InsetText::plaintext(Buffer const & buf, odocstream & os,
 294                          OutputParams const & runparams) const
 295 {
 296         ParagraphList::const_iterator beg = paragraphs().begin();
 297         ParagraphList::const_iterator end = paragraphs().end();
 298         ParagraphList::const_iterator it = beg;
 299         bool ref_printed = false;
 300         int len = 0;
 301         for (; it != end; ++it) {
 302                 if (it != beg) {
 303                         os << '\n';
 304                         if (runparams.linelen > 0)
 305                                 os << '\n';
 306                 }
 307                 odocstringstream oss;
 308                 writePlaintextParagraph(buf, *it, oss, runparams, ref_printed);
 309                 docstring const str = oss.str();
 310                 os << str;
 311                 // FIXME: len is not computed fully correctly; in principle,
 312                 // we have to count the characters after the last '\n'
 313                 len = str.size();
 314         }
 315
 316         return len;
 317 }
 318
 319
 320 int InsetText::docbook(Buffer const & buf, odocstream & os,
 321                        OutputParams const & runparams) const
 322 {
 323         docbookParagraphs(paragraphs(), buf, os, runparams);
 324         return 0;
 325 }
 326
 327
 328 void InsetText::validate(LaTeXFeatures & features) const
 329 {
 330         for_each(paragraphs().begin(), paragraphs().end(),
 331                  bind(&Paragraph::validate, _1, ref(features)));
 332 }
 333
 334
 335 void InsetText::cursorPos(BufferView const & bv,
 336                 CursorSlice const & sl, bool boundary, int & x, int & y) const
 337 {
 338         x = text_.cursorX(bv, sl, boundary) + border_;
 339         y = text_.cursorY(bv, sl, boundary);
 340 }
 341
 342
 343 bool InsetText::showInsetDialog(BufferView *) const
 344 {
 345         return false;
 346 }
 347
 348
 349 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
 350 {
 351         clear();
 352         Paragraph & first = paragraphs().front();
 353         for (unsigned int i = 0; i < data.length(); ++i)
 354                 first.insertChar(i, data[i], font, trackChanges);
 355 }
 356
 357
 358 void InsetText::setAutoBreakRows(bool flag)
 359 {
 360         if (flag == text_.autoBreakRows_)
 361                 return;
 362
 363         text_.autoBreakRows_ = flag;
 364         if (flag)
 365                 return;
 366
 367         // remove previously existing newlines
 368         ParagraphList::iterator it = paragraphs().begin();
 369         ParagraphList::iterator end = paragraphs().end();
 370         for (; it != end; ++it)
 371                 for (int i = 0; i < it->size(); ++i)
 372                         if (it->isNewline(i))
 373                                 // do not track the change, because the user
 374                                 // is not allowed to revert/reject it
 375                                 it->eraseChar(i, false);
 376 }
 377
 378
 379 void InsetText::setDrawFrame(bool flag)
 380 {
 381         drawFrame_ = flag;
 382 }
 383
 384
 385 Color_color InsetText::frameColor() const
 386 {
 387         return Color::color(frame_color_);
 388 }
 389
 390
 391 void InsetText::setFrameColor(Color_color col)
 392 {
 393         frame_color_ = col;
 394 }
 395
 396
 397 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
 398 {
 399         // There is little we can do here to keep track of changes.
 400         // As of 2006/10/20, appendParagraphs is used exclusively by
 401         // LyXTabular::setMultiColumn. In this context, the paragraph break
 402         // is lost irreversibly and the appended text doesn't really change
 403
 404         ParagraphList & pl = paragraphs();
 405
 406         ParagraphList::iterator pit = plist.begin();
 407         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 408         ++pit;
 409         mergeParagraph(buffer->params(), pl,
 410                        std::distance(pl.begin(), ins) - 1);
 411
 412         for_each(pit, plist.end(),
 413                  bind(&ParagraphList::push_back, ref(pl), _1));
 414 }
 415
 416
 417 void InsetText::addPreview(PreviewLoader & loader) const
 418 {
 419         ParagraphList::const_iterator pit = paragraphs().begin();
 420         ParagraphList::const_iterator pend = paragraphs().end();
 421
 422         for (; pit != pend; ++pit) {
 423                 InsetList::const_iterator it  = pit->insetlist.begin();
 424                 InsetList::const_iterator end = pit->insetlist.end();
 425                 for (; it != end; ++it)
 426                         it->inset->addPreview(loader);
 427         }
 428 }
 429
 430
 431 //FIXME: instead of this hack, which only works by chance,
 432 // cells should have their own insetcell type, which returns CELL_CODE!
 433 bool InsetText::neverIndent(Buffer const & buffer) const
 434 {
 435         // this is only true for tabular cells
 436         return !text_.isMainText(buffer) && lyxCode() == TEXT_CODE;
 437 }
 438
 439
 440 ParagraphList const & InsetText::paragraphs() const
 441 {
 442         return text_.paragraphs();
 443 }
 444
 445
 446 ParagraphList & InsetText::paragraphs()
 447 {
 448         return text_.paragraphs();
 449 }
 450
 451
 452 void InsetText::updateLabels(Buffer const & buf, ParIterator const & it)
 453 {
 454         ParIterator it2 = it;
 455         it2.forwardPos();
 456         BOOST_ASSERT(&it2.inset() == this && it2.pit() == 0);
 457         lyx::updateLabels(buf, it2);
 458 }
 459
 460
 461 } // namespace lyx