2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 The LyX Team.
10 * ====================================================== */
15 #pragma implementation "vspace.h"
23 #include "BufferView.h"
24 #include "support/lstrings.h"
30 static const int num_units = LyXLength::UNIT_NONE;
32 // I am not sure if "mu" should be possible to select (Lgb)
33 static char const * unit_name[num_units] = { "sp", "pt", "bp", "dd",
34 "mm", "pc", "cc", "cm",
35 "in", "ex", "em", "mu" };
38 LyXLength::UNIT unitFromString (string const & data)
41 while ((i < num_units) && (data != unit_name[i])) ++i;
42 return static_cast<LyXLength::UNIT>(i);
45 /* The following static items form a simple scanner for
46 * length strings, used by isValid[Glue]Length. See comments there.
48 static float number[4] = { 0, 0, 0, 0 };
49 static LyXLength::UNIT unit[4] = { LyXLength::UNIT_NONE,
52 LyXLength::UNIT_NONE };
53 //static int number_index, unit_index;
54 int number_index, unit_index;
58 void lyx_advance(string & data, unsigned int n)
65 bool isEndOfData(string const & data)
67 return frontStrip(data).empty();
72 char nextToken(string & data)
74 data = frontStrip(data);
77 else if (data[0] == '+') {
80 } else if (prefixIs(data, "plus")) {
83 } else if (data[0] == '-') {
86 } else if (prefixIs(data, "minus")) {
90 string::size_type i = data.find_first_not_of("0123456789.");
93 if (number_index > 3) return 'E';
97 // we have found some number
98 if (i == string::npos) {
102 buffer = data.substr(0, i);
104 lyx_advance(data, i);
106 if (isStrDbl(buffer)) {
107 number[number_index] = strToDbl(buffer);
113 i = data.find_first_not_of("abcdefghijklmnopqrstuvwxyz");
115 if (unit_index > 3) return 'E';
119 // we have found some alphabetical string
120 if (i == string::npos) {
124 buffer = data.substr(0, i);
126 // possibly we have "mmplus" string or similar
127 if (buffer.size() > 5 && (buffer.substr(2,4) == string("plus") || buffer.substr(2,5) == string("minus"))) {
128 lyx_advance(data, 2);
129 unit[unit_index] = unitFromString(buffer.substr(0, 2));
131 lyx_advance(data, i);
132 unit[unit_index] = unitFromString(buffer);
135 if (unit[unit_index] != LyXLength::UNIT_NONE) {
138 } else return 'E'; // Error
146 char const * pattern;
147 int plus_val_index, minus_val_index,
148 plus_uni_index, minus_uni_index;
153 LaTeXLength table[] = {
154 { "nu", 0, 0, 0, 0 },
155 { "nu+nu", 2, 0, 2, 0 },
156 { "nu+nu-nu", 2, 3, 2, 3 },
157 { "nu+-nu", 2, 2, 2, 2 },
158 { "nu-nu", 0, 2, 0, 2 },
159 { "nu-nu+nu", 3, 2, 3, 2 },
160 { "nu-+nu", 2, 2, 2, 2 },
161 { "n+nu", 2, 0, 1, 0 },
162 { "n+n-nu", 2, 3, 1, 1 },
163 { "n+-nu", 2, 2, 1, 1 },
164 { "n-nu", 0, 2, 0, 1 },
165 { "n-n+nu", 3, 2, 1, 1 },
166 { "n-+nu", 2, 2, 1, 1 },
167 { "", 0, 0, 0, 0 } // sentinel, must be empty
171 bool isValidGlueLength (string const & data, LyXGlueLength * result)
173 // This parser is table-driven. First, it constructs a "pattern"
174 // that describes the sequence of tokens in "data". For example,
175 // "n-nu" means: number, minus sign, number, unit. As we go along,
176 // numbers and units are stored into static arrays. Then, "pattern"
177 // is searched in the "table". If it is found, the associated
178 // table entries tell us which number and unit should go where
179 // in the LyXLength structure. Example: if "data" has the "pattern"
180 // "nu+nu-nu", the associated table entries are "2, 3, 2, 3".
181 // That means, "plus_val" is the second number that was seen
182 // in the input, "minus_val" is the third number, and "plus_uni"
183 // and "minus_uni" are the second and third units, respectively.
184 // ("val" and "uni" are always the first items seen in "data".)
185 // This is the most elegant solution I could find -- a straight-
186 // forward approach leads to very long, tedious code that would be
187 // much harder to understand and maintain. (AS)
191 string buffer = frontStrip(data);
193 // To make isValidGlueLength recognize negative values as
194 // the first number this little hack is needed:
195 short val_sign = 1; // positive as default
198 lyx_advance(buffer, 1);
202 lyx_advance(buffer, 1);
210 int pattern_index = 0, table_index = 0;
213 number_index = unit_index = 1; // entries at index 0 are sentinels
215 // construct "pattern" from "data"
216 while (!isEndOfData (buffer)) {
217 if (pattern_index > 20) return false;
218 pattern[pattern_index] = nextToken (buffer);
219 if (pattern[pattern_index] == 'E') return false;
222 pattern[pattern_index] = '\0';
224 // search "pattern" in "table"
226 while (compare(pattern, table[table_index].pattern)) {
228 if (!*table[table_index].pattern) return false;
231 // Get the values from the appropriate places. If an index
232 // is zero, the corresponding array value is zero or UNIT_NONE,
233 // so we needn't check this.
235 result->val = number[1] * val_sign;
236 result->uni = unit[1];
237 result->plus_val = number[table[table_index].plus_val_index];
238 result->minus_val = number[table[table_index].minus_val_index];
239 result->plus_uni = unit [table[table_index].plus_uni_index];
240 result->minus_uni = unit [table[table_index].minus_uni_index];
246 bool isValidLength(string const & data, LyXLength * result)
248 /// This is a trimmed down version of isValidGlueLength.
249 /// The parser may seem overkill for lengths without
250 /// glue, but since we already have it, using it is
251 /// easier than writing something from scratch.
256 int pattern_index = 0;
259 // To make isValidLength recognize negative values
260 // this little hack is needed:
261 short val_sign = 1; // positive as default
264 lyx_advance(buffer, 1);
268 lyx_advance(buffer, 1);
276 number_index = unit_index = 1; // entries at index 0 are sentinels
278 // construct "pattern" from "data"
279 while (!isEndOfData (buffer)) {
280 if (pattern_index > 2) return false;
281 pattern[pattern_index] = nextToken (buffer);
282 if (pattern[pattern_index] == 'E') return false;
285 pattern[pattern_index] = '\0';
287 // only the most basic pattern is accepted here
288 if (compare(pattern, "nu") != 0) return false;
290 // It _was_ a correct length string.
291 // Store away the values we found.
293 result->val = number[1] * val_sign;
294 result->uni = unit[1];
302 LyXLength::LyXLength(string const & data)
306 if (!isValidLength (data, &tmp))
307 return; // should raise an exception
315 string const LyXLength::asString() const
317 std::ostringstream buffer;
318 buffer << val << unit_name[uni]; // setw?
319 return buffer.str().c_str();
323 /* LyXGlueLength class
326 LyXGlueLength::LyXGlueLength (string const & data)
328 LyXGlueLength tmp(0.0, PT);
330 if (!isValidGlueLength (data, &tmp))
331 return; // should raise an exception
335 plus_val = tmp.plus_val;
336 plus_uni = tmp.plus_uni;
337 minus_val = tmp.minus_val;
338 minus_uni = tmp.minus_uni;
343 string const LyXGlueLength::asString() const
345 std::ostringstream buffer;
348 if (minus_val != 0.0)
349 if ((uni == plus_uni) && (uni == minus_uni))
350 if (plus_val == minus_val)
351 buffer << val << "+-"
352 << plus_val << unit_name[uni];
359 if (plus_uni == minus_uni
360 && plus_val == minus_val)
361 buffer << val << unit_name[uni]
363 << unit_name[plus_uni];
366 buffer << val << unit_name[uni]
368 << unit_name[plus_uni]
370 << unit_name[minus_uni];
373 buffer << val << '+' << plus_val
376 buffer << val << unit_name[uni]
378 << unit_name[plus_uni];
381 if (minus_val != 0.0)
382 if (uni == minus_uni)
383 buffer << val << '-' << minus_val
387 buffer << val << unit_name[uni]
389 << unit_name[minus_uni];
391 buffer << val << unit_name[uni];
393 return buffer.str().c_str();
397 string const LyXGlueLength::asLatexString() const
399 std::ostringstream buffer;
402 if (minus_val != 0.0)
403 buffer << val << unit_name[uni]
405 << plus_val << unit_name[plus_uni]
407 << minus_val << unit_name[minus_uni];
409 buffer << val << unit_name[uni]
411 << plus_val << unit_name[plus_uni];
413 if (minus_val != 0.0)
414 buffer << val << unit_name[uni]
416 << minus_val << unit_name[minus_uni];
418 buffer << val << unit_name[uni];
420 return buffer.str().c_str();
427 VSpace::VSpace (string const & data)
428 : kin (NONE), len (0.0, LyXLength::PT)
434 string input = strip(data);
436 int length = input.length();
438 if (length > 1 && input[length-1] == '*') {
440 input.erase(length - 1);
443 if (prefixIs (input, "defskip")) kin = DEFSKIP;
444 else if (prefixIs (input, "smallskip")) kin = SMALLSKIP;
445 else if (prefixIs (input, "medskip")) kin = MEDSKIP;
446 else if (prefixIs (input, "bigskip")) kin = BIGSKIP;
447 else if (prefixIs (input, "vfill")) kin = VFILL;
448 else if (isValidGlueLength (input, &len))
450 else if (sscanf(input.c_str(), "%f", &value) == 1) {
451 // This last one is for reading old .lyx files
452 // without units in added_space_top/bottom.
453 // Let unit default to centimeters here.
455 len = LyXGlueLength (value, LyXLength::CM);
460 bool VSpace::operator==(VSpace const & other) const
462 if (this->kin == other.kin)
463 if (this->kin == LENGTH)
464 if (this->len == other.len)
465 return this->kp == other.kp;
469 return this->kp == other.kp;
475 string const VSpace::asLyXCommand() const
481 case DEFSKIP: result = "defskip"; break;
482 case SMALLSKIP: result = "smallskip"; break;
483 case MEDSKIP: result = "medskip"; break;
484 case BIGSKIP: result = "bigskip"; break;
485 case VFILL: result = "vfill"; break;
486 case LENGTH: result = len.asString(); break;
488 if (kp && (kin != NONE) && (kin != DEFSKIP))
489 return result += '*';
495 string const VSpace::asLatexCommand(BufferParams const & params) const
498 case NONE: return string();
500 return params.getDefSkip().asLatexCommand(params);
501 case SMALLSKIP: return kp ? "\\vspace*{\\smallskipamount}"
503 case MEDSKIP: return kp ? "\\vspace*{\\medskipamount}"
505 case BIGSKIP: return kp ? "\\vspace*{\\bigskipamount}"
507 case VFILL: return kp ? "\\vspace*{\\fill}"
509 case LENGTH: return kp ? "\\vspace*{" + len.asLatexString() + '}'
510 : "\\vspace{" + len.asLatexString() + '}';
512 return string(); // should never be reached
516 int VSpace::inPixels(BufferView * bv) const
518 // Height of a normal line in pixels (zoom factor considered)
519 int height = bv->text->DefaultHeight(); // [pixels]
522 skip = bv->buffer()->params.getDefSkip().inPixels(bv);
524 return inPixels(height, skip);
527 int VSpace::inPixels(int default_height, int default_skip) const
529 // Height of a normal line in pixels (zoom factor considered)
530 int height = default_height; // [pixels]
532 // Zoom factor specified by user in percent
533 float const zoom = lyxrc.zoom / 100.0; // [percent]
535 // DPI setting for monitor: pixels/inch
536 float const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
538 // We want the result in pixels
547 // This is how the skips are normally defined by
548 // LateX. But there should be some way to change
549 // this per document.
550 case SMALLSKIP: return height / 4;
551 case MEDSKIP: return height / 2;
552 case BIGSKIP: return height;
553 case VFILL: return 3 * height;
554 // leave space for the vfill symbol
556 // Pixel values are scaled so that the ratio
557 // between lengths and font sizes on the screen
558 // is the same as on paper.
560 // we don't care about sign of value, we
561 // can't display negative anyway
564 short val_sign = value < 0.0 ? -1 : 1;
566 switch (len.unit()) {
568 // Scaled point: sp = 1/65536 pt
569 result = zoom * dpi * value
570 / (72.27 * 65536); // 4736286.7
573 // Point: 1 pt = 1/72.27 inch
574 result = zoom * dpi * value
578 // Big point: 1 bp = 1/72 inch
579 result = zoom * dpi * value
583 // Didot: 1157dd = 1238 pt?
584 result = zoom * dpi * value
585 / (72.27 / (0.376 * 2.845)); // 67.559735
588 // Millimeter: 1 mm = 1/25.4 inch
589 result = zoom * dpi * value
593 // Pica: 1 pc = 12 pt
594 result = zoom * dpi * value
595 / (72.27 / 12); // 6.0225
598 // Cicero: 1 cc = 12 dd
599 result = zoom * dpi * value
600 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
603 // Centimeter: 1 cm = 1/2.54 inch
604 result = zoom * dpi * value
609 result = zoom * dpi * value;
612 // Ex: The height of an "x"
613 result = zoom * value * height / 2; // what to / width?
615 case LyXLength::EM: // what to / width?
616 // Em: The width of an "m"
617 result = zoom * value * height / 2; // Why 2?
619 case LyXLength::MU: // This is probably only allowed in
621 result = zoom * value * height;
623 case LyXLength::UNIT_NONE:
624 result = 0; // this cannot happen
627 return int (result * val_sign + 0.5);
629 return 0; // never reached