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 "sgml.h"
  35 #include "TextClass.h"
  36 #include "TexRow.h"
  37
  38 #include "frontends/FontMetrics.h"
  39
  40 #include "insets/InsetBibitem.h"
  41 #include "insets/InsetArgument.h"
  42
  43 #include "support/lassert.h"
  44 #include "support/debug.h"
  45 #include "support/ExceptionMessage.h"
  46 #include "support/gettext.h"
  47 #include "support/lstrings.h"
  48 #include "support/textutils.h"
  49
  50 #include "support/bind.h"
  51 #include <boost/crc.hpp>
  52
  53 #include <algorithm>
  54 #include <list>
  55 #include <stack>
  56 #include <sstream>
  57
  58 using namespace std;
  59 using namespace lyx::support;
  60
  61 namespace lyx {
  62
  63
  64 ParagraphMetrics::ParagraphMetrics(Paragraph const & par) :
  65         position_(-1), par_(&par)
  66 {}
  67
  68
  69 ParagraphMetrics & ParagraphMetrics::operator=(
  70         ParagraphMetrics const & pm)
  71 {
  72         rows_ = pm.rows_;
  73         dim_ = pm.dim_;
  74         par_ = pm.par_;
  75         position_ = pm.position_;
  76         return *this;
  77 }
  78
  79
  80 void ParagraphMetrics::reset(Paragraph const & par)
  81 {
  82         par_ = &par;
  83         dim_ = Dimension();
  84         //position_ = -1;
  85 }
  86
  87
  88 size_t ParagraphMetrics::computeRowSignature(Row const & row,
  89                 BufferParams const & bparams) const
  90 {
  91         boost::crc_32_type crc;
  92         for (pos_type i = row.pos(); i < row.endpos(); ++i) {
  93                 char_type const b[] = { par_->getChar(i) };
  94                 crc.process_bytes(b, sizeof(char_type));
  95                 if (bparams.track_changes) {
  96                         Change change = par_->lookupChange(i);
  97                         char_type const b[] = { static_cast<char_type>(change.type) };
  98                         // 1 byte is enough to encode Change::Type
  99                         crc.process_bytes(b, 1);
 100                 }
 101         }
 102
 103         Dimension const & d = row.dimension();
 104         char_type const b[] = { static_cast<char_type>(row.sel_beg),
 105                                 static_cast<char_type>(row.sel_end),
 106                 row.begin_margin_sel, row.end_margin_sel, d.wid, d.asc, d.des};
 107         crc.process_bytes(b, sizeof(b));
 108
 109         return crc.checksum();
 110 }
 111
 112
 113 void ParagraphMetrics::setPosition(int position)
 114 {
 115         position_ = position;
 116 }
 117
 118
 119 Dimension const & ParagraphMetrics::insetDimension(Inset const * inset) const
 120 {
 121         InsetDims::const_iterator it = inset_dims_.find(inset);
 122         if (it != inset_dims_.end())
 123                 return it->second;
 124
 125         static Dimension dummy;
 126         return dummy;
 127 }
 128
 129
 130 void ParagraphMetrics::setInsetDimension(Inset const * inset,
 131                 Dimension const & dim)
 132 {
 133         inset_dims_[inset] = dim;
 134 }
 135
 136
 137 Row & ParagraphMetrics::getRow(pos_type pos, bool boundary)
 138 {
 139         LBUFERR(!rows().empty());
 140
 141         // If boundary is set we should return the row on which
 142         // the character before is inside.
 143         if (pos > 0 && boundary)
 144                 --pos;
 145
 146         RowList::iterator rit = rows_.end();
 147         RowList::iterator const begin = rows_.begin();
 148
 149         for (--rit; rit != begin && rit->pos() > pos; --rit)
 150                 ;
 151
 152         return *rit;
 153 }
 154
 155
 156 Row const & ParagraphMetrics::getRow(pos_type pos, bool boundary) const
 157 {
 158         LBUFERR(!rows().empty());
 159
 160         // If boundary is set we should return the row on which
 161         // the character before is inside.
 162         if (pos > 0 && boundary)
 163                 --pos;
 164
 165         RowList::const_iterator rit = rows_.end();
 166         RowList::const_iterator const begin = rows_.begin();
 167
 168         for (--rit; rit != begin && rit->pos() > pos; --rit)
 169                 ;
 170
 171         return *rit;
 172 }
 173
 174
 175 size_t ParagraphMetrics::pos2row(pos_type pos) const
 176 {
 177         LBUFERR(!rows().empty());
 178
 179         RowList::const_iterator rit = rows_.end();
 180         RowList::const_iterator const begin = rows_.begin();
 181
 182         for (--rit; rit != begin && rit->pos() > pos; --rit)
 183                 ;
 184
 185         return rit - begin;
 186 }
 187
 188
 189 void ParagraphMetrics::dump() const
 190 {
 191         lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
 192         for (size_t i = 0; i != rows_.size(); ++i) {
 193                 lyxerr << "  row " << i << ":   " << rows_[i];
 194         }
 195 }
 196
 197 int ParagraphMetrics::rightMargin(BufferView const & bv) const
 198 {
 199         BufferParams const & params = bv.buffer().params();
 200         DocumentClass const & tclass = params.documentClass();
 201         frontend::FontMetrics const & fm = theFontMetrics(params.getFont());
 202         int const r_margin =
 203                 bv.rightMargin()
 204                 + fm.signedWidth(tclass.rightmargin())
 205                 + fm.signedWidth(par_->layout().rightmargin)
 206                 * 4 / (par_->getDepth() + 4);
 207
 208         return r_margin;
 209 }
 210
 211
 212 int ParagraphMetrics::singleWidth(pos_type pos, Font const & font) const
 213 {
 214         // The most special cases are handled first.
 215         if (Inset const * inset = par_->getInset(pos))
 216                 return insetDimension(inset).wid;
 217
 218         char_type const c = par_->getChar(pos);
 219
 220         if (c == '\t')
 221                 return 4 * theFontMetrics(font).width(' ');
 222
 223         // Note that this function is only called in
 224         // RowPainter::paintText, and only used for characters that do
 225         // not require handling of compose chars or ligatures. It can
 226         // therefore be kept simple.
 227         return theFontMetrics(font).width(c);
 228 }
 229
 230
 231 bool ParagraphMetrics::hfillExpansion(Row const & row, pos_type pos) const
 232 {
 233         if (!par_->isHfill(pos))
 234                 return false;
 235
 236         LASSERT(pos >= row.pos() && pos < row.endpos(), return false);
 237
 238         // expand at the end of a row only if there is another hfill on the same row
 239         if (pos == row.endpos() - 1) {
 240                 for (pos_type i = row.pos(); i < pos; i++) {
 241                         if (par_->isHfill(i))
 242                                 return true;
 243                 }
 244                 return false;
 245         }
 246
 247         // expand at the beginning of a row only if it is the first row of a paragraph
 248         if (pos == row.pos())
 249                 return pos == 0;
 250
 251         // do not expand in some labels
 252         if (par_->layout().margintype != MARGIN_MANUAL && pos < par_->beginOfBody())
 253                 return false;
 254
 255         // if there is anything between the first char of the row and
 256         // the specified position that is neither a newline nor an hfill,
 257         // the hfill will be expanded, otherwise it won't
 258         for (pos_type i = row.pos(); i < pos; i++) {
 259                 if (!par_->isNewline(i) && !par_->isEnvSeparator(i) && !par_->isHfill(i))
 260                         return true;
 261         }
 262         return false;
 263 }
 264
 265 } // namespace lyx