src/gui/text/qglyphrun.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qglobal.h"
  43
  44 #if !defined(QT_NO_RAWFONT)
  45
  46 #include "qglyphrun.h"
  47 #include "qglyphrun_p.h"
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 /*!
  52     \class QGlyphRun
  53     \brief The QGlyphRun class provides direct access to the internal glyphs in a font.
  54     \since 4.8
  55
  56     \ingroup text
  57     \mainclass
  58
  59     When Qt displays a string of text encoded in Unicode, it will first convert the Unicode points
  60     into a list of glyph indexes and a list of positions based on one or more fonts. The Unicode
  61     representation of the text and the QFont object will in this case serve as a convenient
  62     abstraction that hides the details of what actually takes place when displaying the text
  63     on-screen. For instance, by the time the text actually reaches the screen, it may be represented
  64     by a set of fonts in addition to the one specified by the user, e.g. in case the originally
  65     selected font did not support all the writing systems contained in the text.
  66
  67     Under certain circumstances, it can be useful as an application developer to have more low-level
  68     control over which glyphs in a specific font are drawn to the screen. This could for instance
  69     be the case in applications that use an external font engine and text shaper together with Qt.
  70     QGlyphRun provides an interface to the raw data needed to get text on the screen. It
  71     contains a list of glyph indexes, a position for each glyph and a font.
  72
  73     It is the user's responsibility to ensure that the selected font actually contains the
  74     provided glyph indexes.
  75
  76     QTextLayout::glyphRuns() or QTextFragment::glyphRuns() can be used to convert unicode encoded
  77     text into a list of QGlyphRun objects, and QPainter::drawGlyphRun() can be used to draw the
  78     glyphs.
  79
  80     \note Please note that QRawFont is considered local to the thread in which it is constructed.
  81     This in turn means that a new QRawFont will have to be created and set on the QGlyphRun if it is
  82     moved to a different thread. If the QGlyphRun contains a reference to a QRawFont from a different
  83     thread than the current, it will not be possible to draw the glyphs using a QPainter, as the
  84     QRawFont is considered invalid and inaccessible in this case.
  85 */
  86
  87
  88 /*!
  89     Constructs an empty QGlyphRun object.
  90 */
  91 QGlyphRun::QGlyphRun() : d(new QGlyphRunPrivate)
  92 {
  93 }
  94
  95 /*!
  96     Constructs a QGlyphRun object which is a copy of \a other.
  97 */
  98 QGlyphRun::QGlyphRun(const QGlyphRun &other)
  99 {
 100     d = other.d;
 101 }
 102
 103 /*!
 104     Destroys the QGlyphRun.
 105 */
 106 QGlyphRun::~QGlyphRun()
 107 {
 108     // Required for QExplicitlySharedDataPointer
 109 }
 110
 111 /*!
 112     \internal
 113 */
 114 void QGlyphRun::detach()
 115 {
 116     if (d->ref != 1)
 117         d.detach();
 118 }
 119
 120 /*!
 121     Assigns \a other to this QGlyphRun object.
 122 */
 123 QGlyphRun &QGlyphRun::operator=(const QGlyphRun &other)
 124 {
 125     d = other.d;
 126     return *this;
 127 }
 128
 129 /*!
 130     Compares \a other to this QGlyphRun object. Returns true if the list of glyph indexes,
 131     the list of positions and the font are all equal, otherwise returns false.
 132 */
 133 bool QGlyphRun::operator==(const QGlyphRun &other) const
 134 {
 135     if (d == other.d)
 136         return true;
 137
 138     if ((d->glyphIndexDataSize != other.d->glyphIndexDataSize)
 139      || (d->glyphPositionDataSize != other.d->glyphPositionDataSize)) {
 140         return false;
 141     }
 142
 143     for (int i=0; i<qMax(d->glyphIndexDataSize, d->glyphPositionDataSize); ++i) {
 144         if (i < d->glyphIndexDataSize && d->glyphIndexData[i] != other.d->glyphIndexData[i])
 145            return false;
 146
 147         if (i < d->glyphPositionDataSize && d->glyphPositionData[i] != other.d->glyphPositionData[i])
 148            return false;
 149     }
 150
 151
 152     return (d->overline == other.d->overline
 153             && d->underline == other.d->underline
 154             && d->strikeOut == other.d->strikeOut
 155             && d->rawFont == other.d->rawFont);
 156 }
 157
 158 /*!
 159     Compares \a other to this QGlyphRun object. Returns true if any of the list of glyph
 160     indexes, the list of positions or the font are different, otherwise returns false.
 161 */
 162 bool QGlyphRun::operator!=(const QGlyphRun &other) const
 163 {
 164     return !(*this == other);
 165 }
 166
 167 /*!
 168     Returns the font selected for this QGlyphRun object.
 169
 170     \sa setRawFont()
 171 */
 172 QRawFont QGlyphRun::rawFont() const
 173 {
 174     return d->rawFont;
 175 }
 176
 177 /*!
 178     Sets the font in which to look up the glyph indexes to \a font.
 179
 180     \sa rawFont(), setGlyphIndexes()
 181 */
 182 void QGlyphRun::setRawFont(const QRawFont &rawFont)
 183 {
 184     detach();
 185     d->rawFont = rawFont;
 186 }
 187
 188 /*!
 189     Returns the glyph indexes for this QGlyphRun object.
 190
 191     \sa setGlyphIndexes(), setPositions()
 192 */
 193 QVector<quint32> QGlyphRun::glyphIndexes() const
 194 {
 195     if (d->glyphIndexes.constData() == d->glyphIndexData) {
 196         return d->glyphIndexes;
 197     } else {
 198         QVector<quint32> indexes(d->glyphIndexDataSize);
 199         qMemCopy(indexes.data(), d->glyphIndexData, d->glyphIndexDataSize * sizeof(quint32));
 200         return indexes;
 201     }
 202 }
 203
 204 /*!
 205     Set the glyph indexes for this QGlyphRun object to \a glyphIndexes. The glyph indexes must
 206     be valid for the selected font.
 207 */
 208 void QGlyphRun::setGlyphIndexes(const QVector<quint32> &glyphIndexes)
 209 {
 210     detach();
 211     d->glyphIndexes = glyphIndexes; // Keep a reference to the QVector to avoid copying
 212     d->glyphIndexData = glyphIndexes.constData();
 213     d->glyphIndexDataSize = glyphIndexes.size();
 214 }
 215
 216 /*!
 217     Returns the position of the edge of the baseline for each glyph in this set of glyph indexes.
 218 */
 219 QVector<QPointF> QGlyphRun::positions() const
 220 {
 221     if (d->glyphPositions.constData() == d->glyphPositionData) {
 222         return d->glyphPositions;
 223     } else {
 224         QVector<QPointF> glyphPositions(d->glyphPositionDataSize);
 225         qMemCopy(glyphPositions.data(), d->glyphPositionData,
 226                  d->glyphPositionDataSize * sizeof(QPointF));
 227         return glyphPositions;
 228     }
 229 }
 230
 231 /*!
 232     Sets the positions of the edge of the baseline for each glyph in this set of glyph indexes to
 233     \a positions.
 234 */
 235 void QGlyphRun::setPositions(const QVector<QPointF> &positions)
 236 {
 237     detach();
 238     d->glyphPositions = positions; // Keep a reference to the vector to avoid copying
 239     d->glyphPositionData = positions.constData();
 240     d->glyphPositionDataSize = positions.size();
 241 }
 242
 243 /*!
 244     Clears all data in the QGlyphRun object.
 245 */
 246 void QGlyphRun::clear()
 247 {
 248     detach();
 249     d->rawFont = QRawFont();
 250     d->strikeOut = false;
 251     d->overline = false;
 252     d->underline = false;
 253
 254     setPositions(QVector<QPointF>());
 255     setGlyphIndexes(QVector<quint32>());
 256 }
 257
 258 /*!
 259     Sets the glyph indexes and positions of this QGlyphRun to use the first \a size
 260     elements in the arrays \a glyphIndexArray and \a glyphPositionArray. The data is
 261     \e not copied. The caller must guarantee that the arrays are not deleted as long
 262     as this QGlyphRun and any copies of it exists.
 263
 264     \sa setGlyphIndexes(), setPositions()
 265 */
 266 void QGlyphRun::setRawData(const quint32 *glyphIndexArray, const QPointF *glyphPositionArray,
 267                            int size)
 268 {
 269     detach();
 270     d->glyphIndexes.clear();
 271     d->glyphPositions.clear();
 272
 273     d->glyphIndexData = glyphIndexArray;
 274     d->glyphPositionData = glyphPositionArray;
 275     d->glyphIndexDataSize = d->glyphPositionDataSize = size;
 276 }
 277
 278 /*!
 279    Returns true if this QGlyphRun should be painted with an overline decoration.
 280
 281    \sa setOverline()
 282 */
 283 bool QGlyphRun::overline() const
 284 {
 285     return d->overline;
 286 }
 287
 288 /*!
 289   Indicates that this QGlyphRun should be painted with an overline decoration if \a overline is true.
 290   Otherwise the QGlyphRun should be painted with no overline decoration.
 291
 292   \sa overline()
 293 */
 294 void QGlyphRun::setOverline(bool overline)
 295 {
 296     detach();
 297     d->overline = overline;
 298 }
 299
 300 /*!
 301    Returns true if this QGlyphRun should be painted with an underline decoration.
 302
 303    \sa setUnderline()
 304 */
 305 bool QGlyphRun::underline() const
 306 {
 307     return d->underline;
 308 }
 309
 310 /*!
 311   Indicates that this QGlyphRun should be painted with an underline decoration if \a underline is
 312   true. Otherwise the QGlyphRun should be painted with no underline decoration.
 313
 314   \sa underline()
 315 */
 316 void QGlyphRun::setUnderline(bool underline)
 317 {
 318     detach();
 319     d->underline = underline;
 320 }
 321
 322 /*!
 323    Returns true if this QGlyphRun should be painted with a strike out decoration.
 324
 325    \sa setStrikeOut()
 326 */
 327 bool QGlyphRun::strikeOut() const
 328 {
 329     return d->strikeOut;
 330 }
 331
 332 /*!
 333   Indicates that this QGlyphRun should be painted with an strike out decoration if \a strikeOut is
 334   true. Otherwise the QGlyphRun should be painted with no strike out decoration.
 335
 336   \sa strikeOut()
 337 */
 338 void QGlyphRun::setStrikeOut(bool strikeOut)
 339 {
 340     detach();
 341     d->strikeOut = strikeOut;
 342 }
 343
 344 /*!
 345   Returns the smallest rectangle that contains all glyphs in this QGlyphRun.
 346
 347   \since 5.0
 348 */
 349 QRectF QGlyphRun::boundingRect() const
 350 {
 351     qreal minX, minY, maxX, maxY;
 352
 353     for (int i=0; i<qMin(d->glyphPositions.size(), d->glyphIndexes.size()); ++i) {
 354         QRectF glyphRect = d->rawFont.boundingRect(d->glyphIndexes.at(i));
 355         glyphRect.translate(d->glyphPositions.at(i));
 356
 357         if (i == 0) {
 358             minX = glyphRect.left();
 359             minY = glyphRect.top();
 360             maxX = glyphRect.right();
 361             maxY = glyphRect.bottom();
 362         } else {
 363             minX = qMin(glyphRect.left(), minX);
 364             minY = qMin(glyphRect.top(), minY);
 365             maxX = qMax(glyphRect.right(),maxX);
 366             maxY = qMax(glyphRect.bottom(), maxY);
 367         }
 368     }
 369
 370     return QRectF(QPointF(minX, minY), QPointF(maxX, maxY));
 371 }
 372
 373 QT_END_NAMESPACE
 374
 375 #endif // QT_NO_RAWFONT