src/ParagraphMetrics.cpp

   1 /**
   2  * \file Paragraph.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author Angus Leeming
  10  * \author John Levon
  11  * \author André Pönitz
  12  * \author Dekel Tsur
  13  * \author Jürgen Vigna
  14  *
  15  * Full author contact details are available in file CREDITS.
  16  */
  17
  18 #include <config.h>
  19
  20 #include "ParagraphMetrics.h"
  21
  22 #include "Buffer.h"
  23 #include "BufferParams.h"
  24 #include "BufferView.h"
  25 #include "Counters.h"
  26 #include "Encoding.h"
  27 #include "Language.h"
  28 #include "LaTeXFeatures.h"
  29 #include "Layout.h"
  30 #include "Font.h"
  31 #include "LyXRC.h"
  32 #include "Row.h"
  33 #include "OutputParams.h"
  34 #include "paragraph_funcs.h"
  35 #include "sgml.h"
  36 #include "TextClass.h"
  37 #include "TexRow.h"
  38 #include "VSpace.h"
  39
  40 #include "frontends/FontMetrics.h"
  41
  42 #include "insets/InsetBibitem.h"
  43 #include "insets/InsetOptArg.h"
  44
  45 #include "support/assert.h"
  46 #include "support/convert.h"
  47 #include "support/debug.h"
  48 #include "support/gettext.h"
  49 #include "support/lstrings.h"
  50 #include "support/textutils.h"
  51
  52 #include <boost/bind.hpp>
  53 #include <boost/crc.hpp>
  54
  55 #include <algorithm>
  56 #include <list>
  57 #include <stack>
  58 #include <sstream>
  59
  60 using namespace std;
  61 using namespace lyx::support;
  62
  63 namespace lyx {
  64
  65
  66 ParagraphMetrics::ParagraphMetrics(Paragraph const & par) :
  67         position_(-1), par_(&par)
  68 {}
  69
  70
  71 ParagraphMetrics & ParagraphMetrics::operator=(
  72         ParagraphMetrics const & pm)
  73 {
  74         rows_ = pm.rows_;
  75         dim_ = pm.dim_;
  76         par_ = pm.par_;
  77         position_ = pm.position_;
  78         return *this;
  79 }
  80
  81
  82 void ParagraphMetrics::reset(Paragraph const & par)
  83 {
  84         par_ = &par;
  85         dim_ = Dimension();
  86         //position_ = -1;
  87 }
  88
  89
  90 size_t ParagraphMetrics::computeRowSignature(Row const & row,
  91                 BufferParams const & bparams) const
  92 {
  93         boost::crc_32_type crc;
  94         for (pos_type i = row.pos(); i < row.endpos(); ++i) {
  95                 char_type const b[] = { par_->getChar(i) };
  96                 crc.process_bytes(b, sizeof(char_type));
  97                 if (bparams.trackChanges) {
  98                         Change change = par_->lookupChange(i);
  99                         char_type const b[] = { change.type };
 100                         // 1 byte is enough to encode Change::Type
 101                         crc.process_bytes(b, 1);
 102                 }
 103         }
 104
 105         Dimension const & d = row.dimension();
 106         char_type const b[] = { row.sel_beg, row.sel_end, d.wid, d.asc, d.des};
 107         // Each of the variable to process is 4 bytes: 4x5 = 20
 108         crc.process_bytes(b, 20);
 109
 110         return crc.checksum();
 111 }
 112
 113
 114 void ParagraphMetrics::setPosition(int position)
 115 {
 116         position_ = position;
 117 }
 118
 119
 120 Dimension const & ParagraphMetrics::insetDimension(Inset const * inset) const
 121 {
 122         InsetDims::const_iterator it = inset_dims_.find(inset);
 123         if (it != inset_dims_.end())
 124                 return it->second;
 125
 126         static Dimension dummy;
 127         return dummy;
 128 }
 129
 130
 131 void ParagraphMetrics::setInsetDimension(Inset const * inset,
 132                 Dimension const & dim)
 133 {
 134         inset_dims_[inset] = dim;
 135 }
 136
 137
 138 Row & ParagraphMetrics::getRow(pos_type pos, bool boundary)
 139 {
 140         LASSERT(!rows().empty(), /**/);
 141
 142         // If boundary is set we should return the row on which
 143         // the character before is inside.
 144         if (pos > 0 && boundary)
 145                 --pos;
 146
 147         RowList::iterator rit = rows_.end();
 148         RowList::iterator const begin = rows_.begin();
 149
 150         for (--rit; rit != begin && rit->pos() > pos; --rit)
 151                 ;
 152
 153         return *rit;
 154 }
 155
 156
 157 Row const & ParagraphMetrics::getRow(pos_type pos, bool boundary) const
 158 {
 159         LASSERT(!rows().empty(), /**/);
 160
 161         // If boundary is set we should return the row on which
 162         // the character before is inside.
 163         if (pos > 0 && boundary)
 164                 --pos;
 165
 166         RowList::const_iterator rit = rows_.end();
 167         RowList::const_iterator const begin = rows_.begin();
 168
 169         for (--rit; rit != begin && rit->pos() > pos; --rit)
 170                 ;
 171
 172         return *rit;
 173 }
 174
 175
 176 size_t ParagraphMetrics::pos2row(pos_type pos) const
 177 {
 178         LASSERT(!rows().empty(), /**/);
 179
 180         RowList::const_iterator rit = rows_.end();
 181         RowList::const_iterator const begin = rows_.begin();
 182
 183         for (--rit; rit != begin && rit->pos() > pos; --rit)
 184                 ;
 185
 186         return rit - begin;
 187 }
 188
 189
 190 void ParagraphMetrics::dump() const
 191 {
 192         lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
 193         for (size_t i = 0; i != rows_.size(); ++i) {
 194                 lyxerr << "  row " << i << ":   ";
 195                 rows_[i].dump();
 196         }
 197 }
 198
 199 int ParagraphMetrics::rightMargin(BufferView const & bv) const
 200 {
 201         BufferParams const & params = bv.buffer().params();
 202         DocumentClass const & tclass = params.documentClass();
 203         frontend::FontMetrics const & fm = theFontMetrics(params.getFont());
 204         int const r_margin =
 205                 bv.rightMargin()
 206                 + fm.signedWidth(tclass.rightmargin())
 207                 + fm.signedWidth(par_->layout().rightmargin)
 208                 * 4 / (par_->getDepth() + 4);
 209
 210         return r_margin;
 211 }
 212
 213
 214 int ParagraphMetrics::singleWidth(pos_type pos, Font const & font) const
 215 {
 216         // The most special cases are handled first.
 217         if (Inset const * inset = par_->getInset(pos))
 218                 return insetDimension(inset).wid;
 219
 220         char_type c = par_->getChar(pos);
 221
 222         if (!isPrintable(c))
 223                 return theFontMetrics(font).width(c);
 224
 225         Language const * language = font.language();
 226         if (language->rightToLeft()) {
 227                 if (language->lang() == "arabic_arabtex" ||
 228                         language->lang() == "arabic_arabi" ||
 229                         language->lang() == "farsi") {
 230                                 if (Encodings::isArabicComposeChar(c))
 231                                         return 0;
 232                                 c = par_->transformChar(c, pos);
 233                 } else if (language->lang() == "hebrew" &&
 234                                 Encodings::isHebrewComposeChar(c)) {
 235                         return 0;
 236                 }
 237         }
 238         return theFontMetrics(font).width(c);
 239 }
 240
 241
 242 bool ParagraphMetrics::hfillExpansion(Row const & row, pos_type pos) const
 243 {
 244         if (!par_->isHfill(pos))
 245                 return false;
 246
 247         LASSERT(pos >= row.pos() && pos < row.endpos(), /**/);
 248
 249         // expand at the end of a row only if there is another hfill on the same row
 250         if (pos == row.endpos() - 1) {
 251                 for (pos_type i = row.pos(); i < pos; i++) {
 252                         if (par_->isHfill(i))
 253                                 return true;
 254                 }
 255                 return false;
 256         }
 257
 258         // expand at the beginning of a row only if it is the first row of a paragraph
 259         if (pos == row.pos()) {
 260                 return pos == 0;
 261         }
 262
 263         // do not expand in some labels
 264         if (par_->layout().margintype != MARGIN_MANUAL && pos < par_->beginOfBody())
 265                 return false;
 266
 267         // if there is anything between the first char of the row and
 268         // the specified position that is neither a newline nor an hfill,
 269         // the hfill will be expanded, otherwise it won't
 270         for (pos_type i = row.pos(); i < pos; i++) {
 271                 if (!par_->isNewline(i) && !par_->isHfill(i))
 272                         return true;
 273         }
 274         return false;
 275 }
 276
 277 } // namespace lyx