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_plaintext.h"
  36 #include "paragraph.h"
  37 #include "paragraph_funcs.h"
  38 #include "ParagraphParameters.h"
  39 #include "rowpainter.h"
  40 #include "lyxrow.h"
  41 #include "sgml.h"
  42 #include "texrow.h"
  43 #include "undo.h"
  44
  45 #include "frontends/Alert.h"
  46 #include "frontends/font_metrics.h"
  47 #include "frontends/Painter.h"
  48
  49 #include "support/lyxalgo.h" // lyx::count
  50
  51 #include <boost/bind.hpp>
  52 #include <boost/current_function.hpp>
  53
  54 #include <sstream>
  55
  56 using lyx::docstring;
  57 using lyx::pos_type;
  58
  59 using lyx::graphics::PreviewLoader;
  60
  61 using lyx::support::isStrUnsignedInt;
  62
  63 using boost::bind;
  64 using boost::ref;
  65
  66 using std::endl;
  67 using std::for_each;
  68 using std::max;
  69 using std::string;
  70 using std::auto_ptr;
  71 using std::ostream;
  72 using std::vector;
  73
  74
  75 int InsetText::border_ = 2;
  76
  77
  78 InsetText::InsetText(BufferParams const & bp)
  79         : drawFrame_(false), frame_color_(LColor::insetframe), text_(0)
  80 {
  81         paragraphs().push_back(Paragraph());
  82         paragraphs().back().layout(bp.getLyXTextClass().defaultLayout());
  83         // Dispose of the infamous L-shaped cursor.
  84         text_.current_font.setLanguage(bp.language);
  85         text_.real_current_font.setLanguage(bp.language);
  86         init();
  87 }
  88
  89
  90 InsetText::InsetText(InsetText const & in)
  91         : InsetOld(in), text_(in.text_.bv_owner)
  92 {
  93         text_.autoBreakRows_ = in.text_.autoBreakRows_;
  94         drawFrame_ = in.drawFrame_;
  95         frame_color_ = in.frame_color_;
  96         text_.paragraphs() = in.text_.paragraphs();
  97         // Hand current buffer language down to "cloned" textinsets
  98         // e.g. tabular cells
  99         text_.current_font = in.text_.current_font;
 100         text_.real_current_font = in.text_.real_current_font;
 101         init();
 102 }
 103
 104
 105 InsetText::InsetText()
 106         : text_(0)
 107 {}
 108
 109
 110 void InsetText::init()
 111 {
 112         for_each(paragraphs().begin(), paragraphs().end(),
 113                  bind(&Paragraph::setInsetOwner, _1, this));
 114 }
 115
 116
 117 void InsetText::markErased(bool erased)
 118 {
 119         ParagraphList & pars = paragraphs();
 120         for_each(pars.begin(), pars.end(),
 121                  bind(&Paragraph::markErased, _1, erased));
 122 }
 123
 124
 125 void InsetText::clear()
 126 {
 127         ParagraphList & pars = paragraphs();
 128
 129         // This is a gross hack...
 130         LyXLayout_ptr old_layout = pars.begin()->layout();
 131
 132         pars.clear();
 133         pars.push_back(Paragraph());
 134         pars.begin()->setInsetOwner(this);
 135         pars.begin()->layout(old_layout);
 136 }
 137
 138
 139 auto_ptr<InsetBase> InsetText::doClone() const
 140 {
 141         return auto_ptr<InsetBase>(new InsetText(*this));
 142 }
 143
 144
 145 void InsetText::write(Buffer const & buf, ostream & os) const
 146 {
 147         os << "Text\n";
 148         text_.write(buf, os);
 149 }
 150
 151
 152 void InsetText::read(Buffer const & buf, LyXLex & lex)
 153 {
 154         clear();
 155
 156         // delete the initial paragraph
 157         Paragraph oldpar = *paragraphs().begin();
 158         paragraphs().clear();
 159         ErrorList errorList;
 160         bool res = text_.read(buf, lex, errorList);
 161         init();
 162
 163         if (!res) {
 164                 lex.printError("Missing \\end_inset at this point. "
 165                                            "Read: `$$Token'");
 166         }
 167
 168         // sanity check
 169         // ensure we have at least one paragraph.
 170         if (paragraphs().empty())
 171                 paragraphs().push_back(oldpar);
 172 }
 173
 174
 175 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
 176 {
 177         //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
 178         setViewCache(mi.base.bv);
 179         mi.base.textwidth -= 2 * border_;
 180         font_ = mi.base.font;
 181         // Hand font through to contained lyxtext:
 182         text_.font_ = mi.base.font;
 183         text_.metrics(mi, dim);
 184         dim.asc += border_;
 185         dim.des += border_;
 186         dim.wid += 2 * border_;
 187         mi.base.textwidth += 2 * border_;
 188         dim_ = dim;
 189 }
 190
 191
 192 void InsetText::draw(PainterInfo & pi, int x, int y) const
 193 {
 194         BOOST_ASSERT(!text_.paragraphs().front().rows().empty());
 195         // update our idea of where we are
 196         setPosCache(pi, x, y);
 197
 198         text_.background_color_ = backgroundColor();
 199         text_.draw(pi, x + border_, y);
 200
 201         if (drawFrame_) {
 202                 int const w = text_.width() + 2 * border_;
 203                 int const a = text_.ascent() + border_;
 204                 int const h = a + text_.descent() + border_;
 205                 pi.pain.rectangle(x, y - a, (Wide() ? text_.maxwidth_ : w), h,
 206                         frameColor());
 207         }
 208 }
 209
 210
 211 void InsetText::drawSelection(PainterInfo & pi, int x, int y) const
 212 {
 213         int const w = text_.width() + 2 * border_;
 214         int const a = text_.ascent() + border_;
 215         int const h = a + text_.descent() + border_;
 216         pi.pain.fillRectangle(x, y - a, (Wide() ? text_.maxwidth_ : w), h,
 217                 backgroundColor());
 218         text_.drawSelection(pi, x, y);
 219 }
 220
 221
 222 docstring const InsetText::editMessage() const
 223 {
 224         return _("Opened Text Inset");
 225 }
 226
 227
 228 void InsetText::edit(LCursor & cur, bool left)
 229 {
 230         //lyxerr << "InsetText: edit left/right" << endl;
 231         setViewCache(&cur.bv());
 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 InsetBase * InsetText::editXY(LCursor & cur, int x, int y)
 241 {
 242         return text_.editXY(cur, x, y);
 243 }
 244
 245
 246 void InsetText::doDispatch(LCursor & cur, FuncRequest & cmd)
 247 {
 248         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
 249                              << " [ cmd.action = "
 250                              << cmd.action << ']' << endl;
 251         setViewCache(&cur.bv());
 252         text_.dispatch(cur, cmd);
 253 }
 254
 255
 256 bool InsetText::getStatus(LCursor & cur, FuncRequest const & cmd,
 257         FuncStatus & status) const
 258 {
 259         return text_.getStatus(cur, cmd, status);
 260 }
 261
 262
 263 int InsetText::latex(Buffer const & buf, ostream & os,
 264                      OutputParams const & runparams) const
 265 {
 266         TexRow texrow;
 267         latexParagraphs(buf, paragraphs(), os, texrow, runparams);
 268         return texrow.rows();
 269 }
 270
 271
 272 int InsetText::plaintext(Buffer const & buf, ostream & os,
 273                      OutputParams const & runparams) const
 274 {
 275         ParagraphList::const_iterator beg = paragraphs().begin();
 276         ParagraphList::const_iterator end = paragraphs().end();
 277         ParagraphList::const_iterator it = beg;
 278         bool ref_printed = false;
 279         std::ostringstream oss;
 280         for (; it != end; ++it)
 281                 asciiParagraph(buf, *it, oss, runparams, ref_printed);
 282
 283         string const str = oss.str();
 284         os << str;
 285         // Return how many newlines we issued.
 286         return int(lyx::count(str.begin(), str.end(), '\n'));
 287 }
 288
 289
 290 int InsetText::docbook(Buffer const & buf, ostream & os,
 291                        OutputParams const & runparams) const
 292 {
 293         docbookParagraphs(paragraphs(), buf, os, runparams);
 294         return 0;
 295 }
 296
 297
 298 void InsetText::validate(LaTeXFeatures & features) const
 299 {
 300         for_each(paragraphs().begin(), paragraphs().end(),
 301                  bind(&Paragraph::validate, _1, ref(features)));
 302 }
 303
 304
 305 void InsetText::cursorPos
 306         (CursorSlice const & sl, bool boundary, int & x, int & y) const
 307 {
 308         x = text_.cursorX(sl, boundary) + border_;
 309         y = text_.cursorY(sl, boundary);
 310 }
 311
 312
 313 bool InsetText::showInsetDialog(BufferView *) const
 314 {
 315         return false;
 316 }
 317
 318
 319 void InsetText::markNew(bool track_changes)
 320 {
 321         ParagraphList::iterator pit = paragraphs().begin();
 322         ParagraphList::iterator end = paragraphs().end();
 323         for (; pit != end; ++pit) {
 324                 // FIXME: change tracking (MG)
 325                 // if (track_changes)
 326                 //   set pit's text to UNCHANGED
 327                 // else
 328                 //   set pit's text to INSERTED in CT mode; reset CT info otherwise
 329         }
 330 }
 331
 332
 333 void InsetText::setText(docstring const & data, LyXFont const & font)
 334 {
 335         clear();
 336         Paragraph & first = paragraphs().front();
 337         for (unsigned int i = 0; i < data.length(); ++i)
 338                 first.insertChar(i, data[i], font);
 339 }
 340
 341
 342 void InsetText::setAutoBreakRows(bool flag)
 343 {
 344         if (flag == text_.autoBreakRows_)
 345                 return;
 346
 347         text_.autoBreakRows_ = flag;
 348         if (flag)
 349                 return;
 350
 351         // remove previously existing newlines
 352         ParagraphList::iterator it = paragraphs().begin();
 353         ParagraphList::iterator end = paragraphs().end();
 354         for (; it != end; ++it)
 355                 for (int i = 0; i < it->size(); ++i)
 356                         if (it->isNewline(i))
 357                                 it->erase(i);
 358 }
 359
 360
 361 void InsetText::setDrawFrame(bool flag)
 362 {
 363         drawFrame_ = flag;
 364 }
 365
 366
 367 LColor_color InsetText::frameColor() const
 368 {
 369         return LColor::color(frame_color_);
 370 }
 371
 372
 373 void InsetText::setFrameColor(LColor_color col)
 374 {
 375         frame_color_ = col;
 376 }
 377
 378
 379 void InsetText::setViewCache(BufferView const * bv) const
 380 {
 381         if (bv && bv != text_.bv_owner) {
 382                 //lyxerr << "setting view cache from "
 383                 //      << text_.bv_owner << " to " << bv << "\n";
 384                 text_.bv_owner = const_cast<BufferView *>(bv);
 385         }
 386 }
 387
 388
 389 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
 390 {
 391 #ifdef WITH_WARNINGS
 392 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
 393 // And it probably does. You have to take a look at this John. (Lgb)
 394 #warning John, have a look here. (Lgb)
 395 #endif
 396         ParagraphList & pl = paragraphs();
 397
 398         ParagraphList::iterator pit = plist.begin();
 399         ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
 400         ++pit;
 401         mergeParagraph(buffer->params(), pl,
 402                        std::distance(pl.begin(), ins) - 1);
 403
 404         for_each(pit, plist.end(),
 405                  bind(&ParagraphList::push_back, ref(pl), _1));
 406 }
 407
 408
 409 void InsetText::addPreview(PreviewLoader & loader) const
 410 {
 411         ParagraphList::const_iterator pit = paragraphs().begin();
 412         ParagraphList::const_iterator pend = paragraphs().end();
 413
 414         for (; pit != pend; ++pit) {
 415                 InsetList::const_iterator it  = pit->insetlist.begin();
 416                 InsetList::const_iterator end = pit->insetlist.end();
 417                 for (; it != end; ++it)
 418                         it->inset->addPreview(loader);
 419         }
 420 }
 421
 422
 423 //FIXME: instead of this hack, which only works by chance,
 424 // cells should have their own insetcell type, which returns CELL_CODE!
 425 bool InsetText::neverIndent() const
 426 {
 427         // this is only true for tabular cells
 428         return !text_.isMainText() && lyxCode() == TEXT_CODE;
 429 }
 430
 431
 432 ParagraphList const & InsetText::paragraphs() const
 433 {
 434         return text_.paragraphs();
 435 }
 436
 437
 438 ParagraphList & InsetText::paragraphs()
 439 {
 440         return text_.paragraphs();
 441 }