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.
20 #include "MetricsInfo.h"
22 #include "frontends/FontMetrics.h"
24 #include "support/debug.h"
25 #include "support/docstream.h"
26 #include "support/lstrings.h"
27 #include "support/lyxlib.h"
33 using namespace lyx::support;
38 /////////////////////////////////////////////////////////////////////
42 /////////////////////////////////////////////////////////////////////
45 : val_(0), unit_(Length::UNIT_NONE)
49 Length::Length(double v, Length::UNIT u)
54 Length::Length(string const & data)
55 : val_(0), unit_(Length::PT)
59 if (!isValidLength(data, &tmp))
60 return; // should raise an exception
67 string const Length::asString() const
70 if (unit_ != UNIT_NONE)
71 os << formatFPNumber(val_) << unit_name[unit_]; // setw?
76 docstring const Length::asDocstring() const
79 if (unit_ != UNIT_NONE)
80 os << from_ascii(formatFPNumber(val_))
81 << from_ascii(unit_name[unit_]); // setw?
86 string const Length::asLatexString() const
89 // Do not allow scientific notation (e.g. 1.2e+03), since this is not valid
93 os << formatFPNumber(val_ / 100.0) << "\\textwidth";
96 os << formatFPNumber(val_ / 100.0) << "\\columnwidth";
99 os << formatFPNumber(val_ / 100.0) << "\\paperwidth";
102 os << formatFPNumber(val_ / 100.0) << "\\linewidth";
105 os << formatFPNumber(val_ / 100.0) << "\\textheight";
108 os << formatFPNumber(val_ / 100.0) << "\\paperheight";
113 os << formatFPNumber(val_) << unit_name[unit_];
120 string const Length::asHTMLString() const
128 os << formatFPNumber(val_) << "pt";
136 os << formatFPNumber(val_) << unit_name[unit_];
139 os << formatFPNumber(val_ / 12.0) << "pt";
142 os << formatFPNumber(val_ / 18.0) << "em";
150 // what it's a percentage of probably won't make sense for HTML,
151 // so we'll assume people have chosen these appropriately
152 os << formatFPNumber(val_) << '%';
162 double Length::value() const
168 Length::UNIT Length::unit() const
174 void Length::value(double v)
180 void Length::unit(Length::UNIT u)
186 bool Length::zero() const
192 bool Length::empty() const
194 return unit_ == Length::UNIT_NONE;
198 int Length::inPixels(int text_width, int em_width_base) const
200 // Zoom factor specified by user in percent
201 double const zoom = lyxrc.zoom / 100.0; // [percent]
203 // DPI setting for monitor: pixels/inch
204 double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
206 double const em_width_in = (em_width_base > 0)
207 ? em_width_base / (zoom * dpi)
209 // A different estimate for em_width is
210 // theFontMetrics(FontInfo(sane_font)).em()
211 // but this estimate might not be more accurate as the screen font
212 // is different then the latex font.
214 // Pixel values are scaled so that the ratio
215 // between lengths and font sizes on the screen
216 // is the same as on paper.
218 double const text_width_in = text_width / (zoom * dpi);
219 double const result = zoom * dpi * inInch(text_width_in, em_width_in);
220 return support::iround(result);
224 double Length::inInch(double text_width, double em_width) const
230 // Scaled point: sp = 1/65536 pt
231 result = val_ / (72.27 * 65536); // 4736286.7
234 // Point: 1 pt = 1/72.27 inch
235 result = val_ / 72.27; // 72.27
238 // Big point: 1 bp = 1/72 inch
239 result = val_ / 72; // 72
242 // Didot: 1157dd = 1238 pt?
243 result = val_ / (72.27 / (0.376 * 2.845)); // 67.559735
246 // Millimeter: 1 mm = 1/25.4 inch
247 result = val_ / 25.4; // 25.4
250 // Pica: 1 pc = 12 pt
251 result = val_ / (72.27 / 12); // 6.0225
254 // Cicero: 1 cc = 12 dd
256 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
259 // Centimeter: 1 cm = 1/2.54 inch
260 result = val_ / 2.54; // 2.54
267 // Ex: The height of an "x"
268 // 0.4305 is the ration between 1ex and 1em in cmr10
269 result = val_ * em_width * 0.4305;
272 // Em: The width of an "m"
273 result = val_ * em_width;
276 // math unit = 1/18em
277 result = val_ * em_width / 18;
279 case Length::PCW: // Always % of workarea
282 result = val_ * text_width / 100;
285 // paperwidth/textwidth is 1.7 for A4 paper with default margins
286 result = val_ * text_width * 1.7 / 100;
289 result = val_ * text_width * 1.787 / 100;
292 result = val_ * text_width * 2.2 / 100;
294 case Length::UNIT_NONE:
295 result = 0; // this cannot happen
302 int Length::inPixels(MetricsBase const & base) const
304 FontInfo fi = base.font;
305 if (unit_ == Length::MU)
306 // mu is 1/18th of an em in the math symbol font
307 fi.setFamily(SYMBOL_FAMILY);
309 // Math style is only taken into account in the case of mu
310 fi.setStyle(LM_ST_TEXT);
311 return inPixels(base.textwidth, theFontMetrics(fi).em());
315 int Length::inBP() const
317 // return any Length value as a one with
318 // the PostScript point, called bp (big points)
320 double const text_width_in = 210.0 / 2.54; // assume A4
321 double const em_width_in = 10.0 / 72.27;
322 double result = 72.0 * inInch(text_width_in, em_width_in);
323 return support::iround(result);
327 Length::UNIT Length::defaultUnit()
329 return lyxrc.default_length_unit;
334 bool operator==(Length const & l1, Length const & l2)
336 return l1.value() == l2.value() && l1.unit() == l2.unit();
340 bool operator!=(Length const & l1, Length const & l2)
346 /////////////////////////////////////////////////////////////////////
350 /////////////////////////////////////////////////////////////////////
353 GlueLength::GlueLength(Length const & len)
358 GlueLength::GlueLength(Length const & len, Length const & plus,
359 Length const & minus)
360 : len_(len), plus_(plus), minus_(minus)
364 GlueLength::GlueLength(string const & data)
366 if (!isValidGlueLength(data, this))
367 LYXERR0("Invalid glue length " + data);
371 string const GlueLength::asString() const
376 ostringstream buffer;
378 buffer << formatFPNumber(len_.value());
380 if (plus_.zero() && minus_.zero()) {
381 buffer << unit_name[len_.unit()];
387 if (len_.unit() != plus_.unit())
388 buffer << unit_name[len_.unit()];
389 buffer << '+' << formatFPNumber(plus_.value());
390 buffer << unit_name[plus_.unit()];
394 // just len and minus
396 if (len_.unit() != minus_.unit())
397 buffer << unit_name[len_.unit()];
398 buffer << '-' << formatFPNumber(minus_.value());
399 buffer << unit_name[minus_.unit()];
403 // ok, len, plus AND minus
406 if (minus_ == plus_) {
407 if (len_.unit() != minus_.unit())
408 buffer << unit_name[len_.unit()];
409 buffer << "+-" << formatFPNumber(minus_.value());
410 buffer << unit_name[minus_.unit()];
414 // this is so rare a case, why bother minimising units ?
416 buffer << unit_name[len_.unit()];
417 buffer << '+' << formatFPNumber(plus_.value()) << unit_name[plus_.unit()];
418 buffer << '-' << formatFPNumber(minus_.value()) << unit_name[minus_.unit()];
424 string const GlueLength::asLatexString() const
426 ostringstream buffer;
427 // use Length::asLatexString() to handle also the percent lengths
428 buffer << len_.Length::asLatexString();
430 buffer << " plus " << plus_.Length::asLatexString();
432 buffer << " minus " << minus_.Length::asLatexString();
437 Length const & GlueLength::len() const
443 Length const & GlueLength::plus() const
449 Length const & GlueLength::minus() const
455 bool operator==(GlueLength const & l1, GlueLength const & l2)
457 return l1.len() == l2.len()
458 && l1.plus() == l2.plus()
459 && l1.minus() == l2.minus();
463 bool operator!=(GlueLength const & l1, GlueLength const & l2)