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,
 107                                 row.end_margin_sel,
 108                                 d.wid, d.asc, d.des };
 109         crc.process_bytes(b, sizeof(b));
 110         crc.process_bytes(&row.separator, sizeof(row.separator));
 111
 112         return crc.checksum();
 113 }
 114
 115
 116 void ParagraphMetrics::setPosition(int position)
 117 {
 118         position_ = position;
 119 }
 120
 121
 122 Row & ParagraphMetrics::getRow(pos_type pos, bool boundary)
 123 {
 124         LBUFERR(!rows().empty());
 125
 126         // If boundary is set we should return the row on which
 127         // the character before is inside.
 128         if (pos > 0 && boundary)
 129                 --pos;
 130
 131         RowList::iterator rit = rows_.end();
 132         RowList::iterator const begin = rows_.begin();
 133
 134         for (--rit; rit != begin && rit->pos() > pos; --rit)
 135                 ;
 136
 137         return *rit;
 138 }
 139
 140
 141 Row const & ParagraphMetrics::getRow(pos_type pos, bool boundary) const
 142 {
 143         LBUFERR(!rows().empty());
 144
 145         // If boundary is set we should return the row on which
 146         // the character before is inside.
 147         if (pos > 0 && boundary)
 148                 --pos;
 149
 150         RowList::const_iterator rit = rows_.end();
 151         RowList::const_iterator const begin = rows_.begin();
 152
 153         for (--rit; rit != begin && rit->pos() > pos; --rit)
 154                 ;
 155
 156         return *rit;
 157 }
 158
 159
 160 size_t ParagraphMetrics::pos2row(pos_type pos) const
 161 {
 162         LBUFERR(!rows().empty());
 163
 164         RowList::const_iterator rit = rows_.end();
 165         RowList::const_iterator const begin = rows_.begin();
 166
 167         for (--rit; rit != begin && rit->pos() > pos; --rit)
 168                 ;
 169
 170         return rit - begin;
 171 }
 172
 173
 174 void ParagraphMetrics::dump() const
 175 {
 176         lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
 177         for (size_t i = 0; i != rows_.size(); ++i) {
 178                 lyxerr << "  row " << i << ":   " << rows_[i];
 179         }
 180 }
 181
 182 int ParagraphMetrics::rightMargin(BufferView const & bv) const
 183 {
 184         BufferParams const & params = bv.buffer().params();
 185         DocumentClass const & tclass = params.documentClass();
 186         frontend::FontMetrics const & fm = theFontMetrics(params.getFont());
 187         int const r_margin =
 188                 bv.rightMargin()
 189                 + fm.signedWidth(tclass.rightmargin())
 190                 + fm.signedWidth(par_->layout().rightmargin)
 191                 * 4 / (par_->getDepth() + 4);
 192
 193         return r_margin;
 194 }
 195
 196
 197 // FIXME: this code seems bogus. Audit and rewrite (see bug #9860).
 198 bool ParagraphMetrics::hfillExpansion(Row const & row, pos_type pos) const
 199 {
 200         if (!par_->isHfill(pos))
 201                 return false;
 202
 203         LASSERT(pos >= row.pos() && pos < row.endpos(), return false);
 204
 205         // expand at the end of a row only if there is another hfill on the same row
 206         if (pos == row.endpos() - 1) {
 207                 for (pos_type i = row.pos(); i < pos; i++) {
 208                         if (par_->isHfill(i))
 209                                 return true;
 210                 }
 211                 return false;
 212         }
 213
 214         // expand at the beginning of a row only if it is the first row of a paragraph
 215         if (pos == row.pos())
 216                 return pos == 0;
 217
 218         // do not expand in some labels
 219         if (par_->layout().margintype != MARGIN_MANUAL && pos < par_->beginOfBody())
 220                 return false;
 221
 222         // if there is anything between the first char of the row and
 223         // the specified position that is neither a newline nor an hfill,
 224         // the hfill will be expanded, otherwise it won't
 225         for (pos_type i = row.pos(); i < pos; i++) {
 226                 if (!par_->isNewline(i) && !par_->isEnvSeparator(i) && !par_->isHfill(i))
 227                         return true;
 228         }
 229         return false;
 230 }
 231
 232 } // namespace lyx