src/frontends/FontMetrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file FontMetrics.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef FONT_METRICS_H
  15 #define FONT_METRICS_H
  16
  17 #include "support/strfwd.h"
  18
  19 /**
  20  * A class holding helper functions for determining
  21  * the screen dimensions of fonts.
  22  *
  23  * The geometry is the standard typographical geometry,
  24  * as follows :
  25  *
  26  * --------------+------------------<maxAscent
  27  *               |          |
  28  *               <-------> (right bearing)
  29  *               <-> (left bearing)
  30  * char ascent>___          |
  31  *               ^   oooo   |  oooo
  32  *   origin>____ |  oo  oo  | oo  oo
  33  *              \|  oo  oo  | oo  oo
  34  * --------------+---ooooo--|--oooo-<baseline
  35  *               |      oo  |
  36  * char          |  oo  oo  |
  37  * descent>______|   oooo   |
  38  *               <-  width ->
  39  * --------------+----------+-------<maxDescent
  40  *
  41  * Caution: All char_type and docstring arguments of any method of this class
  42  * are no UCS4 chars or strings if the font is a symbol font. They simply
  43  * denote the code points of the font instead. You have to keep this in mind
  44  * when you implement the methods in a frontend. You must not pass these
  45  * parameters to a unicode conversion function in particular.
  46  */
  47
  48 namespace lyx {
  49
  50 class Dimension;
  51
  52 namespace frontend {
  53
  54 class FontMetrics
  55 {
  56 public:
  57         virtual ~FontMetrics() {}
  58
  59         /// return the maximum ascent of the font
  60         virtual int maxAscent() const = 0;
  61         /// return the maximum descent of the font
  62         virtual int maxDescent() const = 0;
  63         /// return default dimension of the font.
  64         /// \warning \c width is set to zero.
  65         virtual Dimension const defaultDimension() const = 0;
  66         /// return the em size
  67         virtual int em() const = 0;
  68         /// return the x height
  69         virtual int xHeight() const = 0;
  70         /// return the width of a line for underlining
  71         virtual int lineWidth() const = 0;
  72         /// return the distance from the base line to where an underline
  73         /// should be drawn.
  74         virtual int underlinePos() const = 0;
  75         /// return the distance from the base line to where the strike out line
  76         /// should be drawn.
  77         virtual int strikeoutPos() const = 0;
  78         /// return true if font is not upright (italic or oblique)
  79         virtual bool italic() const = 0;
  80         /// return slope for italic font
  81         virtual double italicSlope() const = 0;
  82
  83         /// return the width of the char in the font
  84         virtual int width(char_type c) const = 0;
  85         /// return the ascent of the char in the font
  86         virtual int ascent(char_type c) const = 0;
  87         /// return the descent of the char in the font
  88         virtual int descent(char_type c) const = 0;
  89         /// return the left bearing of the char in the font
  90         virtual int lbearing(char_type c) const = 0;
  91         /// return the right bearing of the char in the font
  92         virtual int rbearing(char_type c) const = 0;
  93         /// return the width of the string in the font
  94         virtual int width(docstring const & s) const = 0;
  95         /// FIXME ??
  96         virtual int signedWidth(docstring const & s) const = 0;
  97         /**
  98          * return the x offset of a position in the string. The
  99          * direction of the string is forced, and the returned value
 100          * is from the left edge of the word, not from the start of the string.
 101          * \param rtl is true for right-to-left layout
 102          * \param ws is the amount of extra inter-word space applied text justification.
 103          */
 104         virtual int pos2x(docstring const & s, int pos, bool rtl, double ws) const = 0;
 105         /**
 106          * return the position in the string for a given x offset. The
 107          * direction of the string is forced, and the returned value
 108          * is from the left edge of the word, not from the start of the string.
 109          * the offset x is updated to match the closest position in the string.
 110          * \param rtl is true for right-to-left layout
 111          * \param ws is the amount of extra inter-word space applied text justification.
 112          */
 113         virtual int x2pos(docstring const & s, int & x, bool rtl, double ws) const = 0;
 114         /**
 115          * Break string at width at most x.
 116          * \return true if successful
 117          * \param rtl is true for right-to-left layout
 118          * \param force is false for breaking at word separator, true for
 119          *   arbitrary position.
 120          */
 121         virtual bool breakAt(docstring & s, int & x, bool rtl, bool force) const = 0;
 122         /// return char dimension for the font.
 123         virtual Dimension const dimension(char_type c) const = 0;
 124         /**
 125          * fill in width,ascent,descent with the values for the
 126          * given string in the font.
 127          */
 128         virtual void rectText(docstring const & str,
 129                 int & width,
 130                 int & ascent,
 131                 int & descent) const = 0;
 132         /**
 133          * fill in width,ascent,descent with the values for the
 134          * given string in the font for a button with given offset.
 135          */
 136         virtual void buttonText(docstring const & str,
 137                 const int offset,
 138                 int & width,
 139                 int & ascent,
 140                 int & descent) const = 0;
 141
 142         /// return the maximum descent of the font
 143         inline int maxHeight() const { return maxAscent() + maxDescent(); }
 144
 145         /// return the descent of the char in the font
 146         inline int height(char_type c) const { return ascent(c) + descent(c); }
 147
 148         /// return the inner width of the char in the font
 149         inline int center(char_type c) const {
 150                 return (rbearing(c) - lbearing(c)) / 2;
 151         }
 152
 153         /// return the number of expanding characters taken into account for
 154         /// increased inter-word spacing during justification
 155         virtual int countExpanders(docstring const & str) const = 0;
 156 };
 157
 158
 159 } // namespace frontend
 160
 161 class Font;
 162 class FontInfo;
 163
 164 /// Implementation is in Application.cpp
 165 frontend::FontMetrics const & theFontMetrics(Font const & f);
 166 frontend::FontMetrics const & theFontMetrics(FontInfo const & fi);
 167
 168 } // namespace lyx
 169
 170 #endif // FONT_METRICS_H