3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
13 * \author Jürgen Vigna
15 * Full author contact details are available in file CREDITS.
20 #include "ParagraphMetrics.h"
23 #include "BufferParams.h"
24 #include "BufferView.h"
28 #include "LaTeXFeatures.h"
33 #include "OutputParams.h"
35 #include "TextClass.h"
38 #include "frontends/FontMetrics.h"
40 #include "insets/InsetBibitem.h"
41 #include "insets/InsetArgument.h"
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"
50 #include <boost/crc.hpp>
58 using namespace lyx::support;
63 ParagraphMetrics::ParagraphMetrics(Paragraph const & par) :
64 position_(-1), par_(&par)
68 ParagraphMetrics & ParagraphMetrics::operator=(
69 ParagraphMetrics const & pm)
74 position_ = pm.position_;
79 void ParagraphMetrics::reset(Paragraph const & par)
87 size_t ParagraphMetrics::computeRowSignature(Row const & row,
88 BufferView const & bv) const
90 boost::crc_32_type crc;
91 for (pos_type i = row.pos(); i < row.endpos(); ++i) {
92 if (par_->isInset(i)) {
93 Inset const * in = par_->getInset(i);
94 Dimension const d = in->dimension(bv);
95 int const b[] = { d.wid, d.asc, d.des };
96 crc.process_bytes(b, sizeof(b));
98 char_type const b[] = { par_->getChar(i) };
99 crc.process_bytes(b, sizeof(char_type));
101 if (bv.buffer().params().track_changes) {
102 Change change = par_->lookupChange(i);
103 char_type const b[] = { static_cast<char_type>(change.type) };
104 // 1 byte is enough to encode Change::Type
105 crc.process_bytes(b, 1);
109 pos_type const b1[] = { row.sel_beg, row.sel_end };
110 crc.process_bytes(b1, sizeof(b1));
112 Dimension const & d = row.dimension();
113 int const b2[] = { row.begin_margin_sel,
115 d.wid, d.asc, d.des };
116 crc.process_bytes(b2, sizeof(b2));
117 crc.process_bytes(&row.separator, sizeof(row.separator));
119 return crc.checksum();
123 void ParagraphMetrics::setPosition(int position)
125 position_ = position;
129 Row & ParagraphMetrics::getRow(pos_type pos, bool boundary)
131 LBUFERR(!rows().empty());
133 // If boundary is set we should return the row on which
134 // the character before is inside.
135 if (pos > 0 && boundary)
138 RowList::iterator rit = rows_.end();
139 RowList::iterator const begin = rows_.begin();
141 for (--rit; rit != begin && rit->pos() > pos; --rit)
148 Row const & ParagraphMetrics::getRow(pos_type pos, bool boundary) const
150 LBUFERR(!rows().empty());
152 // If boundary is set we should return the row on which
153 // the character before is inside.
154 if (pos > 0 && boundary)
157 RowList::const_iterator rit = rows_.end();
158 RowList::const_iterator const begin = rows_.begin();
160 for (--rit; rit != begin && rit->pos() > pos; --rit)
167 size_t ParagraphMetrics::pos2row(pos_type pos) const
169 LBUFERR(!rows().empty());
171 RowList::const_iterator rit = rows_.end();
172 RowList::const_iterator const begin = rows_.begin();
174 for (--rit; rit != begin && rit->pos() > pos; --rit)
181 void ParagraphMetrics::dump() const
183 lyxerr << "Paragraph::dump: rows.size(): " << rows_.size() << endl;
184 for (size_t i = 0; i != rows_.size(); ++i) {
185 lyxerr << " row " << i << ": " << rows_[i];
189 int ParagraphMetrics::rightMargin(BufferView const & bv) const
191 BufferParams const & params = bv.buffer().params();
192 DocumentClass const & tclass = params.documentClass();
193 frontend::FontMetrics const & fm = theFontMetrics(params.getFont());
196 + fm.signedWidth(tclass.rightmargin())
197 + fm.signedWidth(par_->layout().rightmargin)
198 * 4 / (par_->getDepth() + 4);
204 // FIXME: this code seems bogus. Audit and rewrite (see bug #9860).
205 bool ParagraphMetrics::hfillExpansion(Row const & row, pos_type pos) const
207 if (!par_->isHfill(pos))
210 LASSERT(pos >= row.pos() && pos < row.endpos(), return false);
212 // expand at the end of a row only if there is another hfill on the same row
213 if (pos == row.endpos() - 1) {
214 for (pos_type i = row.pos(); i < pos; i++) {
215 if (par_->isHfill(i))
221 // expand at the beginning of a row only if it is the first row of a paragraph
222 if (pos == row.pos())
225 // do not expand in some labels
226 if (par_->layout().margintype != MARGIN_MANUAL && pos < par_->beginOfBody())
229 // if there is anything between the first char of the row and
230 // the specified position that is neither a newline nor an hfill,
231 // the hfill will be expanded, otherwise it won't
232 for (pos_type i = row.pos(); i < pos; i++) {
233 if (!par_->isNewline(i) && !par_->isEnvSeparator(i) && !par_->isHfill(i))