src/Length.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Length.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Matthias Ettrich
   8  * \author Lars Gullik Bjønnes
   9  * \author Jean-Marc Lasgouttes
  10  * \author John Levon
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef LENGTH_H
  16 #define LENGTH_H
  17
  18 #include "support/strfwd.h"
  19
  20
  21 namespace lyx {
  22
  23 // Solaris/x86 version 9 and earlier define these
  24 #undef PC
  25 #undef SP
  26
  27 /////////////////////////////////////////////////////////////////////
  28 //
  29 // Length
  30 //
  31 /////////////////////////////////////////////////////////////////////
  32
  33
  34 /**
  35  * Length - Represents latex length measurement
  36  */
  37 class Length {
  38 public:
  39         /// length units
  40         enum UNIT {
  41                 BP, ///< Big point (72bp = 1in), also PostScript point
  42                 CC, ///< Cicero = 12dd = 4.531mm
  43                 CM, ///< Centimeter = 10mm = 2.371pc
  44                 DD, ///< Didot point = 1/72 of a French inch, = 0.376mm
  45                 EM, ///< Width of capital "M" in current font.
  46                 EX, ///< Height of a small "x" for the current font.
  47                 IN, ///< Inch = 25.4mm = 72.27pt = 6.022pc
  48                 MM, ///< Millimeter = 2.845pt
  49                 MU, ///< Math unit (18mu = 1em) for positioning in math mode
  50                 PC, ///< Pica = 12pt = 4.218mm
  51                 PT, ///< Point = 1/72.27in = 0.351mm
  52                 SP, ///< Scaled point (65536sp = 1pt) TeX's smallest unit.
  53                 PTW, //< Percent of TextWidth
  54                 PCW, //< Percent of ColumnWidth
  55                 PPW, //< Percent of PageWidth
  56                 PLW, //< Percent of LineWidth
  57                 PTH, //< Percent of TextHeight          // Herbert 2002-05-16
  58                 PPH, //< Percent of PaperHeight         // Herbert 2002-05-16
  59                 BLS, //< Percent of BaselineSkip        // uwestoehr 2017-04-01
  60                 UNIT_NONE ///< no unit
  61         };
  62
  63         ///
  64         Length();
  65         ///
  66         Length(double v, Length::UNIT u);
  67
  68         /// "data" must be a decimal number, followed by a unit
  69         explicit Length(std::string const & data);
  70
  71         ///
  72         double value() const;
  73         ///
  74         Length::UNIT unit() const;
  75         ///
  76         void value(double);
  77         ///
  78         void unit(Length::UNIT unit);
  79         ///
  80         bool zero() const;
  81         ///
  82         bool empty() const;
  83         /// return string representation
  84         std::string const asString() const;
  85         /// return string representation
  86         docstring const asDocstring() const;
  87         /// return string representation for LaTeX
  88         std::string const asLatexString() const;
  89         /// return string representation for HTML
  90         std::string const asHTMLString() const;
  91         /** return the on-screen size of this length.
  92          *
  93          *      If the second argument is not provided, then the unit EM will
  94          *      only be approximated. It is better if possible to use
  95          *      FontMetrics::em() to get this value.
  96          */
  97         int inPixels(int text_width, int em_width = 0) const;
  98
  99         /// return the value in Big Postscript points.
 100         /// Caution: Inaccurate for em, ex, mu and percent units.
 101         int inBP() const;
 102
 103         /// return the default unit (centimeter or inch)
 104         static UNIT defaultUnit();
 105
 106         friend bool isValidLength(std::string const & data, Length * result);
 107
 108 private:
 109         /// Convert value to inch for text width and em width given in inch
 110         double inInch(double text_width, double em_width) const;
 111         ///
 112         double val_;
 113         ///
 114         Length::UNIT unit_;
 115 };
 116
 117 ///
 118 bool operator==(Length const & l1, Length const & l2);
 119 ///
 120 bool operator!=(Length const & l1, Length const & l2);
 121 /** Test whether \p data represents a valid length.
 122  *
 123  * \returns whether \p data is a valid length
 124  * \param data Length in LyX format. Since the only difference between LyX
 125  * and LaTeX format is the representation of length variables as units (e.g.
 126  * \c text% vs. \c \\textwidth) you can actually use this function as well
 127  * for testing LaTeX lengths as long as they only contain real units like pt.
 128  * \param result Pointer to a Length variable. If \p result is not 0 and
 129  * \p data is valid, the length represented by it is stored into \p result.
 130  */
 131 bool isValidLength(std::string const & data, Length * result = 0);
 132 /// return the LyX name of the given unit number
 133 char const * stringFromUnit(int unit);
 134
 135
 136 /////////////////////////////////////////////////////////////////////
 137 //
 138 // GlueLength
 139 //
 140 /////////////////////////////////////////////////////////////////////
 141
 142 class GlueLength {
 143 public:
 144         ///
 145         GlueLength() {}
 146         ///
 147         explicit GlueLength(Length const & len);
 148         ///
 149         GlueLength(Length const & len,
 150                       Length const & plus,
 151                       Length const & minus);
 152
 153         /** "data" must be a decimal number, followed by a unit, and
 154           optional "glue" indicated by "+" and "-".  You may abbreviate
 155           reasonably.  Examples:
 156           1.2 cm  //  4mm +2pt  //  2cm -4mm +2mm  //  4+0.1-0.2cm
 157           The traditional Latex format is also accepted, like
 158           4cm plus 10pt minus 10pt */
 159         explicit GlueLength(std::string const & data);
 160
 161         ///
 162         Length const & len() const;
 163         ///
 164         Length const & plus() const;
 165         ///
 166         Length const & minus() const;
 167
 168
 169         /// conversion
 170         std::string const asString() const;
 171         ///
 172         std::string const asLatexString() const;
 173
 174         friend bool isValidGlueLength(std::string const & data,
 175                                       GlueLength* result);
 176
 177 private:
 178         /// the normal vlaue
 179         Length len_;
 180         /// extra stretch
 181         Length plus_;
 182         /// extra shrink
 183         Length minus_;
 184 };
 185
 186 ///
 187 bool operator==(GlueLength const & l1, GlueLength const & l2);
 188 ///
 189 bool operator!=(GlueLength const & l1, GlueLength const & l2);
 190 /** If "data" is valid, the length represented by it is
 191     stored into "result", if that is not 0. */
 192 bool isValidGlueLength(std::string const & data, GlueLength * result = 0);
 193
 194 /// the number of units possible
 195 extern int const num_units;
 196
 197 /**
 198  * array of unit names
 199  *
 200  * FIXME: I am not sure if "mu" should be possible to select (Lgb)
 201  */
 202 extern char const * const unit_name[];
 203 extern char const * const unit_name_gui[];
 204
 205 /// return the unit given a string representation such as "cm"
 206 Length::UNIT unitFromString(std::string const & data);
 207
 208
 209 } // namespace lyx
 210
 211 #endif // LENGTH_H