src/frontends/font_metrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file font_metrics.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  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef FONT_METRICS_H
  14 #define FONT_METRICS_H
  15
  16 #include <string>
  17
  18
  19 class LyXFont;
  20
  21 /**
  22  * A namespace holding helper functions for determining
  23  * the screen dimensions of fonts.
  24  *
  25  * The geometry is the standard typographical geometry,
  26  * as follows :
  27  *
  28  * --------------+------------------<maxAscent
  29  *               |          |
  30  *               <-------> (right bearing)
  31  *               <-> (left bearing)
  32  * char ascent>___          |
  33  *               ^   oooo   |  oooo
  34  *   origin>____ |  oo  oo  | oo  oo
  35  *              \|  oo  oo  | oo  oo
  36  * --------------+---ooooo--|--oooo-<baseline
  37  *               |      oo  |
  38  * char          |  oo  oo  |
  39  * descent>______|   oooo   |
  40  *               <-  width ->
  41  * --------------+----------+-------<maxDescent
  42  *
  43  */
  44 namespace font_metrics {
  45         /// return the maximum ascent of the font
  46         int maxAscent(LyXFont const & f);
  47         /// return the maximum descent of the font
  48         int maxDescent(LyXFont const & f);
  49         /// return the maximum descent of the font
  50         inline int maxHeight(LyXFont const & f) {
  51                 return maxAscent(f) + maxDescent(f);
  52         }
  53         /// return the ascent of the char in the font
  54         int ascent(char c, LyXFont const & f);
  55         /// return the descent of the char in the font
  56         int descent(char c, LyXFont const & f);
  57         /// return the descent of the char in the font
  58         inline int height(char c, LyXFont const & f) {
  59                 return ascent(c, f) + descent(c, f);
  60         }
  61         /// return the left bearing of the char in the font
  62         int lbearing(char c, LyXFont const & f);
  63         /// return the right bearing of the char in the font
  64         int rbearing(char c, LyXFont const & f);
  65         /// return the inner width of the char in the font
  66         inline int center(char c, LyXFont const & f) {
  67                 return (rbearing(c, f) - lbearing(c, f)) / 2;
  68         }
  69         /// return the width of the string in the font
  70         int width(char const * s, size_t n, LyXFont const & f);
  71         /// return the width of the char in the font
  72         inline int width(char c, LyXFont const & f) {
  73                 return width(&c, 1, f);
  74         }
  75         /// return the width of the string in the font
  76         inline int width(std::string const & s, LyXFont const & f) {
  77                 return s.empty() ? 0 : width(s.data(), s.length(), f);
  78         }
  79         /// FIXME ??
  80         int signedWidth(std::string const & s, LyXFont const & f);
  81         /**
  82          * fill in width,ascent,descent with the values for the
  83          * given string in the font.
  84          */
  85         void rectText(std::string const & str, LyXFont const & font,
  86                 int & width,
  87                 int & ascent,
  88                 int & descent);
  89         /**
  90          * fill in width,ascent,descent with the values for the
  91          * given string in the font for a button.
  92          */
  93         void buttonText(std::string const & str, LyXFont const & font,
  94                 int & width,
  95                 int & ascent,
  96                 int & descent);
  97 }
  98
  99 #endif // FONT_METRICS_H