3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Matthias Ettrich
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
13 * Full author contact details are available in file CREDITS.
18 #include "support/Length.h"
22 #include "support/debug.h"
23 #include "support/docstream.h"
24 #include "support/lstrings.h"
25 #include "support/lyxlib.h"
31 using namespace lyx::support;
36 /////////////////////////////////////////////////////////////////////
40 /////////////////////////////////////////////////////////////////////
42 Length::Length(string const & data)
46 if (!isValidLength(data, &tmp))
47 return; // should raise an exception
54 string const Length::asString() const
57 if (unit_ != UNIT_NONE)
58 os << formatFPNumber(val_) << unit_name[unit_]; // setw?
63 docstring const Length::asDocstring() const
66 if (unit_ != UNIT_NONE)
67 os << from_ascii(formatFPNumber(val_))
68 << from_ascii(unit_name[unit_]); // setw?
73 string const Length::asLatexString() const
76 // Do not allow scientific notation (e.g. 1.2e+03), since this is not valid
80 os << formatFPNumber(val_ / 100.0) << "\\textwidth";
83 os << formatFPNumber(val_ / 100.0) << "\\columnwidth";
86 os << formatFPNumber(val_ / 100.0) << "\\paperwidth";
89 os << formatFPNumber(val_ / 100.0) << "\\linewidth";
92 os << formatFPNumber(val_ / 100.0) << "\\textheight";
95 os << formatFPNumber(val_ / 100.0) << "\\paperheight";
98 os << formatFPNumber(val_ / 100.0) << "\\baselineskip";
103 os << formatFPNumber(val_) << unit_name[unit_];
110 string const Length::asHTMLString() const
118 os << formatFPNumber(val_) << "pt";
126 os << formatFPNumber(val_) << unit_name[unit_];
129 os << formatFPNumber(val_ / 12.0) << "pt";
132 os << formatFPNumber(val_ / 18.0) << "em";
141 // what it's a percentage of probably won't make sense for HTML,
142 // so we'll assume people have chosen these appropriately
143 os << formatFPNumber(val_) << '%';
153 int Length::inPixels(int text_width, int em_width_base) const
155 // Zoom factor specified by user in percent
156 double const zoom = lyxrc.currentZoom / 100.0; // [percent]
158 // DPI setting for monitor: pixels/inch
159 double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
161 double const em_width_in = (em_width_base > 0)
162 ? em_width_base / (zoom * dpi)
164 // A different estimate for em_width is
165 // theFontMetrics(FontInfo(sane_font)).em()
166 // but this estimate might not be more accurate as the screen font
167 // is different then the latex font.
169 // Pixel values are scaled so that the ratio
170 // between lengths and font sizes on the screen
171 // is the same as on paper.
173 double const text_width_in = text_width / (zoom * dpi);
174 double const result = zoom * dpi * inInch(text_width_in, em_width_in);
175 return support::iround(result);
179 double Length::inInch(double text_width, double em_width) const
185 // Scaled point: sp = 1/65536 pt
186 result = val_ / (72.27 * 65536); // 4736286.7
189 // Point: 1 pt = 1/72.27 inch
190 result = val_ / 72.27; // 72.27
193 // Big point: 1 bp = 1/72 inch
194 result = val_ / 72; // 72
197 // Didot: 1157dd = 1238 pt?
198 result = val_ / (72.27 / (0.376 * 2.845)); // 67.559735
201 // Millimeter: 1 mm = 1/25.4 inch
202 result = val_ / 25.4; // 25.4
205 // Pica: 1 pc = 12 pt
206 result = val_ / (72.27 / 12); // 6.0225
209 // Cicero: 1 cc = 12 dd
211 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
214 // Centimeter: 1 cm = 1/2.54 inch
215 result = val_ / 2.54; // 2.54
222 // Ex: The height of an "x"
223 // 0.4305 is the ration between 1ex and 1em in cmr10
224 result = val_ * em_width * 0.4305;
227 // Em: The width of an "m"
228 result = val_ * em_width;
231 // math unit = 1/18em
232 result = val_ * em_width / 18;
234 case Length::PCW: // Always % of workarea
237 result = val_ * text_width / 100;
240 // paperwidth/textwidth is 1.7 for A4 paper with default margins
241 result = val_ * text_width * 1.7 / 100;
244 result = val_ * text_width * 1.787 / 100;
247 result = val_ * text_width * 2.2 / 100;
250 // baselineskip is approximately 1.2 times the font size for the cmr fonts
251 // The value actually depends on the current paragraph (see TextMetrics::setRowHeight),
252 // but we do not have this information here.
253 result = val_ * em_width * 1.2 / 100;
255 case Length::UNIT_NONE:
256 result = 0; // this cannot happen
263 int Length::inBP() const
265 // return any Length value as a one with
266 // the PostScript point, called bp (big points)
268 double const text_width_in = 210.0 / 2.54; // assume A4
269 double const em_width_in = 10.0 / 72.27;
270 double const result = 72.0 * inInch(text_width_in, em_width_in);
271 return support::iround(result);
275 Length::UNIT Length::defaultUnit()
277 return lyxrc.default_length_unit;
281 /////////////////////////////////////////////////////////////////////
285 /////////////////////////////////////////////////////////////////////
287 GlueLength::GlueLength(string const & data)
289 if (!isValidGlueLength(data, this))
290 LYXERR0("Invalid glue length " + data);
294 string const GlueLength::asString() const
299 ostringstream buffer;
301 buffer << formatFPNumber(len_.value());
303 if (plus_.zero() && minus_.zero()) {
304 buffer << unit_name[len_.unit()];
310 if (len_.unit() != plus_.unit())
311 buffer << unit_name[len_.unit()];
312 buffer << '+' << formatFPNumber(plus_.value());
313 buffer << unit_name[plus_.unit()];
317 // just len and minus
319 if (len_.unit() != minus_.unit())
320 buffer << unit_name[len_.unit()];
321 buffer << '-' << formatFPNumber(minus_.value());
322 buffer << unit_name[minus_.unit()];
326 // ok, len, plus AND minus
329 if (minus_ == plus_) {
330 if (len_.unit() != minus_.unit())
331 buffer << unit_name[len_.unit()];
332 buffer << "+-" << formatFPNumber(minus_.value());
333 buffer << unit_name[minus_.unit()];
337 // this is so rare a case, why bother minimising units ?
339 buffer << unit_name[len_.unit()];
340 buffer << '+' << formatFPNumber(plus_.value()) << unit_name[plus_.unit()];
341 buffer << '-' << formatFPNumber(minus_.value()) << unit_name[minus_.unit()];
347 string const GlueLength::asLatexString() const
349 ostringstream buffer;
350 // use Length::asLatexString() to handle also the percent lengths
351 buffer << len_.Length::asLatexString();
353 buffer << " plus " << plus_.Length::asLatexString();
355 buffer << " minus " << minus_.Length::asLatexString();
360 bool operator==(GlueLength const & l1, GlueLength const & l2)
362 return l1.len() == l2.len()
363 && l1.plus() == l2.plus()
364 && l1.minus() == l2.minus();